Skip to content

Reads every Workflow whose Subject is this Board using Board ManageConfiguration permission.

GET
/api/workspace/workflow/configuration/boards/{boardId}/presentation
curl --request GET \
--url https://example.com/api/workspace/workflow/configuration/boards/example/presentation \
--header 'Authorization: Bearer <token>'
boardId
required
string
access_token
string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

OK

Media typeapplication/json
object
Data

Complete Board membership and an opaque optimistic presentation/membership snapshot token.

object
BoardId
string
nullable
Version
string
nullable
Items
Array<object>
nullable

One automatically affiliated Workflow and its display-only settings on its Subject Board.

object
WorkflowDefinitionId
string
nullable
DisplayName
string
nullable
SortOrder
integer format: int32
Visible
boolean
CanOpenDefinition
boolean
ShowInSignalBar
boolean
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Forbidden

Media typeapplication/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Not Found

Media typeapplication/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}