Get organisations apps operations

Retrieve the set of all operations available for the App specified by appId.

GET /organisations/{organisationId}/apps/{appId}/operations

Try it

cURL

cURL

curl --request GET \
  --url https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/apps/{appId}/operations \
  --header 'Authorization: <api-key>'

200

{
  "totalCount": 123,
  "next": "<string>",
  "prev": "<string>",
  "items": [
    {
      "id": "GET /organisations/{organisationId}/apps/{appId}",
      "path": "<string>",
      "method": "<string>",
      "name": "<string>",
      "type": "<string>",
      "description": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Path Parameters

organisationId · string · required

appId · string · required

Response

200

application/json

GetAppOperationsResponse is the response definition containing all Operations available to an App.

totalCount · integer · required

next · string

prev · string

items · object[]

Show child attributes

items. id · string · required

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

Example:

"GET /organisations/{organisationId}/apps/{appId}"

items. path · string · required

The endpoint path for use in finding the path in the API spec.

items. method · string · required

Method is the HTTP method of the request.

items. name · string · required

A human-friendly name based on the operation ID.

items. type · string · required

Type is the type of operation, possible values are "request" and "callback":

• "request" indicates that the operation is initiated by Switchboard
• "callback" indicates that the operation is initiated by the application and sends data to Switchboard

items. description · string

A human-friendly description of what this operation does.