API Reference
- Switchboard API
- POSTPreview the output of a transformer.
- 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
- GET
- hubs
- data-mappings
- apps
- operations
- schemas
- GETGet organisations schema utils signed url
- POSTPost organisations schema utils source url
- POSTPost organisations schema utils info
- connections
- credentials
- GETGet organisations signed url
- POST
boards
Post organisations myfirstboard
Create a Demo Board for the provided organisation. No request body required as all parameters provided by server.
POST
/
organisations
/
{organisationId}
/
myFirstBoard
curl --request POST \
--url https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/myFirstBoard \
--header 'Authorization: <api-key>'
{
"id": "<string>",
"orgId": "<string>",
"name": "<string>",
"hubId": "<string>",
"status": "unknown",
"activePublishInfo": {
"id": "<string>",
"taskId": "<string>",
"lastEventId": "<string>",
"listeners": [
{
"id": "<string>",
"appNodeId": "<string>",
"operationNodeId": "<string>",
"url": "<string>",
"contentType": "<string>",
"security": {},
"additionalHeaders": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"recentPublishHistory": [
{
"id": "<string>",
"taskId": "<string>",
"lastEventId": "<string>",
"listeners": [
{
"id": "<string>",
"appNodeId": "<string>",
"operationNodeId": "<string>",
"url": "<string>",
"contentType": "<string>",
"security": {},
"additionalHeaders": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z",
"tags": {},
"thumbnailUrl": "<string>"
}
Authorizations
Path Parameters
Response
200
application/json
A single Board result
The response is of type object
.
curl --request POST \
--url https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/myFirstBoard \
--header 'Authorization: <api-key>'
{
"id": "<string>",
"orgId": "<string>",
"name": "<string>",
"hubId": "<string>",
"status": "unknown",
"activePublishInfo": {
"id": "<string>",
"taskId": "<string>",
"lastEventId": "<string>",
"listeners": [
{
"id": "<string>",
"appNodeId": "<string>",
"operationNodeId": "<string>",
"url": "<string>",
"contentType": "<string>",
"security": {},
"additionalHeaders": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"recentPublishHistory": [
{
"id": "<string>",
"taskId": "<string>",
"lastEventId": "<string>",
"listeners": [
{
"id": "<string>",
"appNodeId": "<string>",
"operationNodeId": "<string>",
"url": "<string>",
"contentType": "<string>",
"security": {},
"additionalHeaders": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z",
"tags": {},
"thumbnailUrl": "<string>"
}