boards
- GETGet organisations boards
- POSTPost organisations boards
- POSTPost organisations myfirstboard
- PUTPut organisations boards
- DELDelete organisations boards
- POSTPreview the output of a Code Action.
- POSTPost organisations boards actors test
- POSTPost organisations boards publish
- POSTPost organisations boards unpublish
- GETGet organisations boards out of date board nodes
- GETGet organisations boards variables
- PUTPut organisations boards variables
- PUTPut organisations boards variablesglobal
- PUTPut organisations boards variablesdynamic
- GETGet organisations out of date board nodes
- GETGet organisations boards actors codelogs
- GETGet organisations boards execution logs
- POSTPost organisations board instances incoming webhooks
- POSTPost organisations board instances trigger execution
hubs
- GETGet organisations hubs
- POSTPost organisations hubs
- PUTPut organisations hubs
- DELDelete organisations hubs
- GETGet organisations hubs boards
- POSTPost organisations hubs boards
- GETGet organisations hubs boards integration info
- GETGet organisations hubs users
- GETGet organisations hubs boards users
- POSTPost organisations hubs boards users
- DELDelete organisations hubs boards users
data-mappings
- GETGet organisations data mappings
- POSTPost organisations data mappings
- PUTPut organisations data mappings
- DELDelete organisations data mappings
- GETGet organisations data mappings entries
- POSTPost organisations data mappings entries
- PUTPut organisations data mappings entries
- DELDelete organisations data mappings entries
apps
operations
schemas
- GETGet organisations schemas
- POSTPost organisations schemas
- GETGet organisations schemas info
- DELDelete organisations schemas
- POSTPost organisations schemas clone
- POSTPost organisations schemas publish
- GETGet organisations schemas operations
- POSTPost organisations schemas operations
- PUTPut organisations schemas operations
- DELDelete organisations schemas operations
- GETGet organisations schemas components
- POSTPost organisations schemas components
- PUTPut organisations schemas components
- DELDelete organisations schemas components
- POSTPost organisations schemas delete components
- POSTPost organisations schemas operation builder
- PUTPut organisations schemas import
- POSTPost organisations schema utils import
connections
credentials
curl --request POST \
--url https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/apps/{appId}/operation-builder \
--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": {}
}Post organisations apps operation builder
BuildSchemaOperationForApp validates and uses the schema builder to fill in any possible fields on a proposed new schema operation for an app.
curl --request POST \
--url https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/apps/{appId}/operation-builder \
--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
Path Parameters
OrganisationID is the ID of the organisation that the schema belongs to.
AppId is the app identifier
Body
BuildSchemaOperationRequest contains the necessary parameters to build a new schema operation.
The ID of the schema this object belongs to.
The ID of the operation, for OpenAPI this will be the operationId field if set, otherwise the request's
type and path.
The http method that the operation uses.
GET, PUT, POST, DELETE, OPTIONS, HEAD, PATCH, TRACE, SQL A human-friendly description of what this operation does.
A human-friendly name based on the operation ID.
The path used to call the operation.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The name of the operation parameter.
The type of the operation parameter.
string, integer, number, boolean The location of the operation parameter.
path, query, header, cookie Whether the parameter is required.
The request body of the operation.
The response body of the operation.
The callbacks of the operation.
An optional map of components the operation refers to indexed by ref.
Response
BuildSchemaOperationResponse is returned after a schema operation has been built.
The ID of the schema this object belongs to.
The ID of the operation, for OpenAPI this will be the operationId field if set, otherwise the request's
type and path.
The http method that the operation uses.
GET, PUT, POST, DELETE, OPTIONS, HEAD, PATCH, TRACE, SQL A human-friendly description of what this operation does.
A human-friendly name based on the operation ID.
The path used to call the operation.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The name of the operation parameter.
The type of the operation parameter.
string, integer, number, boolean The location of the operation parameter.
path, query, header, cookie Whether the parameter is required.
The request body of the operation.
The response body of the operation.
The callbacks of the operation.
An optional map of components the operation refers to indexed by ref.