Skip to content

Return board summaries.

GET
/api/workspace/admin/boards/boards
curl --request GET \
--url https://example.com/api/workspace/admin/boards/boards
  • None
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
Array<object>
nullable

Board list item for administration screens.

object
Id

Board id.

string
nullable
Key

Stable board key.

string
nullable
DataEntityDefinitionId

Owned Part EntityDefinition id used for board payload data.

string
nullable
DisplayName

Board display name.

string
nullable
Description

Board description.

string
nullable
IsActive

Whether the board can be used for runtime process activity.

boolean
BoardType
integer format: int32
Allowed values: 0 1
BoardCycleActivationMode
integer format: int32
Allowed values: 0 1 2
TagsEnabled

Whether board item tags are enabled.

boolean
DueDateEnabled

Whether board due dates are enabled.

boolean
AllowedActions

Allowed actions for one board.

object
CanUpdate

Whether board identity can be updated.

boolean
CanDelete

Whether board can be deleted.

boolean
CanActivate

Whether board can be activated.

boolean
CanDeactivate

Whether board can be deactivated.

boolean
CanManageConfiguration

Whether board configuration can be changed.

boolean
TargetDefinitionCount

Number of attached target definitions.

integer format: int32
StatusCount

Number of non-deleted statuses.

integer format: int32
TransitionCount

Number of transitions.

integer format: int32
OpenItemCount

Number of open board items.

integer format: int32
ItemCount

Total number of board items.

integer format: int32
CycleCount

Total number of board cycles.

integer format: int32
RowVersion

Board row version.

string format: uuid
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
{
"Data": [
{
"BoardType": 0,
"BoardCycleActivationMode": 0
}
],
"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"
}