API Reference
- Switchboard API
- POSTPreview the output of a transformer.
- boards
- 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
- GET
- 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
hubs
Post organisations hubs boards
Creates a board associated with the given Hub ID.
POST
/
organisations
/
{organisationId}
/
hubs
/
{hubId}
/
boards
curl --request POST \
--url https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/hubs/{hubId}/boards \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>"
}'
{
"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
Body
application/json
Payload to create a new Board belonging to a Hub.
The body is of type object
.
Response
201
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}/hubs/{hubId}/boards \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>"
}'
{
"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>"
}