Put organisations boards - Versori User Documentation

Authorizations

Authorization

string

header

required

Path Parameters

organisationId

string

required

boardId

string

required

Body

application/json

Payload to update an existing Board. The `id` and `orgId` fields are immutable and must match the fields from the URL. This is a full replace/update, any unset fields will be unset in the database.

string

required

orgId

string

required

name

string

required

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

createdAt

string

required

updatedAt

string

required

hubId

string

activePublishInfo

object

BoardPublishInfo provides information on a published board instance

activePublishInfo.id

string

required

activePublishInfo.taskId

string

required

TaskID is a unique identifier for the execution of a board. Each time a board is (re)published a new task ID will be generated.

activePublishInfo.lastEventId

string

required

LastEventID is the last observed event before this board was published. This may not be the last event on the stream for this board, since the observer may not have replayed all events at the time of publish. As such, the version of the board which will be executed is defined by this field, and not necessarily the latest event on the stream.

activePublishInfo.listeners

object[]

required

activePublishInfo.createdAt

string

required

activePublishInfo.updatedAt

string

required

activePublishInfo.deletedAt

string

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.

recentPublishHistory.id

string

required

recentPublishHistory.taskId

string

required

TaskID is a unique identifier for the execution of a board. Each time a board is (re)published a new task ID will be generated.

recentPublishHistory.lastEventId

string

required

recentPublishHistory.listeners

object[]

required

recentPublishHistory.createdAt

string

required

recentPublishHistory.updatedAt

string

required

recentPublishHistory.deletedAt

string

deletedAt

string

Response

200

application/json

A single Board result

string

required

orgId

string

required

name

string

required

status

enum<string>

required

Available options:

unknown,

draft,

publishing,

published,

unpublishing

createdAt

string

required

updatedAt

string

required

hubId

string

activePublishInfo

object

BoardPublishInfo provides information on a published board instance

activePublishInfo.id

string

required

activePublishInfo.taskId

string

required

TaskID is a unique identifier for the execution of a board. Each time a board is (re)published a new task ID will be generated.

activePublishInfo.lastEventId

string

required

activePublishInfo.listeners

object[]

required

activePublishInfo.createdAt

string

required

activePublishInfo.updatedAt

string

required

activePublishInfo.deletedAt

string

recentPublishHistory

object[]

recentPublishHistory.id

string

required

recentPublishHistory.taskId

string

required

TaskID is a unique identifier for the execution of a board. Each time a board is (re)published a new task ID will be generated.

recentPublishHistory.lastEventId

string

required

recentPublishHistory.listeners

object[]

required

recentPublishHistory.createdAt

string

required

recentPublishHistory.updatedAt

string

required

recentPublishHistory.deletedAt

string

deletedAt

string

API Reference

Authorizations

Path Parameters

Body

Response