Skip to main content
POST
/
organisations
/
{organisationId}
/
apps
/
{appId}
/
operations
cURL
curl --request POST \
  --url https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/apps/{appId}/operations \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "schemaId": "<string>",
  "id": "<string>",
  "method": "GET",
  "description": "<string>",
  "name": "<string>",
  "path": "<string>",
  "request": {
    "parameters": [
      {
        "name": "<string>",
        "type": "string",
        "location": "path",
        "required": true
      }
    ],
    "body": {}
  },
  "response": {},
  "callbacks": {},
  "components": {}
}
'
{
  "schemaId": "<string>",
  "id": "<string>",
  "method": "GET",
  "description": "<string>",
  "name": "<string>",
  "path": "<string>",
  "request": {
    "parameters": [
      {
        "name": "<string>",
        "type": "string",
        "location": "path",
        "required": true
      }
    ],
    "body": {}
  },
  "response": {},
  "callbacks": {},
  "components": {}
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
organisationId
string
required
​
appId
string
required

Body

application/json

CreateAppOperationRequest is the request body for creating a new Operation for an App.

​
schemaId
string
required

The ID of the schema this object belongs to.

​
id
string

The ID of the operation, for OpenAPI this will be the operationId field if set, otherwise the request's type and path.

​
method
enum<string>

The http method that the operation uses.

Available options:
GET,
PUT,
POST,
DELETE,
OPTIONS,
HEAD,
PATCH,
TRACE,
SQL
​
description
string

A human-friendly description of what this operation does.

​
name
string

A human-friendly name based on the operation ID.

​
path
string

The path used to call the operation.

​
request
object
​
response
object

The response body of the operation.

​
callbacks
object

The callbacks of the operation.

​
components
object

An optional map of components the operation refers to indexed by ref.

Response

GetAppOperationSchemaResponse is the response definition containing the schema for a newly created Operation.

​
schemaId
string
required

The ID of the schema this object belongs to.

​
id
string

The ID of the operation, for OpenAPI this will be the operationId field if set, otherwise the request's type and path.

​
method
enum<string>

The http method that the operation uses.

Available options:
GET,
PUT,
POST,
DELETE,
OPTIONS,
HEAD,
PATCH,
TRACE,
SQL
​
description
string

A human-friendly description of what this operation does.

​
name
string

A human-friendly name based on the operation ID.

​
path
string

The path used to call the operation.

​
request
object
​
response
object

The response body of the operation.

​
callbacks
object

The callbacks of the operation.

​
components
object

An optional map of components the operation refers to indexed by ref.