POST
/
organisations
/
{organisationId}
/
boards
curl --request POST \
  --url https://api.switchboard.svc.versori.io/v1alpha1/organisations/{organisationId}/boards \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "edges": {},
  "hubId": "<string>",
  "name": "<string>",
  "nodes": {}
}'
{
  "activePublishInfo": {
    "createdAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "lastEventId": "<string>",
    "listeners": [
      {
        "additionalHeaders": {},
        "appNodeId": "<string>",
        "contentType": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "deletedAt": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "operationNodeId": "<string>",
        "security": {},
        "updatedAt": "2023-11-07T05:31:56Z",
        "url": "<string>"
      }
    ],
    "taskId": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z",
  "hubId": "<string>",
  "id": "<string>",
  "name": "<string>",
  "orgId": "<string>",
  "recentPublishHistory": [
    {
      "createdAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "lastEventId": "<string>",
      "listeners": [
        {
          "additionalHeaders": {},
          "appNodeId": "<string>",
          "contentType": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "deletedAt": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "operationNodeId": "<string>",
          "security": {},
          "updatedAt": "2023-11-07T05:31:56Z",
          "url": "<string>"
        }
      ],
      "taskId": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "status": "unknown",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organisationId
string
required

Body

application/json
edges
object
hubId
string
name
string
required
nodes
object

Response

200 - application/json
activePublishInfo
object

BoardPublishInfo provides information on a published board instance

createdAt
string
required
deletedAt
string
hubId
string
id
string
required
name
string
required
orgId
string
required
recentPublishHistory
object[]

RecentPublishHistory is an array of BoardPublishInfo containing up to the last 5 publishes for a board. If full history is required, users should use the ListPublishHistory operation for a paginated view.

status
enum<string>
required

BoardStatus is used to indicate the status of a board. The "unknown" status is used in case of inconsistencies in the database with the Board scheduler and the API cannot deduce the correct status without administrator intervention.

If the status is "unknown", then clients should assume it's in a draft/published state based on whether the board has an "activePublishInfo" field. If a board cannot be published due to it already being published and the "activePublishInfo" field is null, users should contact support.

Available options:
unknown,
draft,
publishing,
published,
unpublishing
updatedAt
string
required