Return Boards administration setup data.

GET

/api/workspace/admin/boards/setup

curl --request GET \
  --url https://example.com/api/workspace/admin/boards/setup

Authorizations

• None

Parameters

Query Parameters

access_token

string

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

Responses

200

OK

Media typeapplication/json

object

Data

Board administration setup model.

object

EntityDefinitions

Selectable entity definitions.

Array<object>

nullable

Selectable entity definition for board setup.

object

Id

Entity definition id.

string

nullable

Name

Entity definition technical name.

string

nullable

DisplayNameSingular

Singular display name.

string

nullable

DisplayNamePlural

Plural display name.

string

nullable

Roles

Selectable workspace roles.

Array<object>

nullable

Selectable workspace role for board setup.

object

Id

Role id.

string

nullable

Name

Role name.

string

nullable

Users

Selectable workspace users.

Array<object>

nullable

Selectable workspace user for board setup.

object

Id

User id.

string

nullable

Name

User display name.

string

nullable

ResponsibilityGroups

Selectable workspace responsibility groups.

Array<object>

nullable

Selectable responsibility group for board setup.

object

Id

Group id.

string

nullable

Name

Group display name.

string

nullable

StatusMetaTypes

Supported status meta types.

Array<object>

nullable

Selectable board status meta type.

object

Value

integer format: int32

Allowed values: 0 1 2

Name

Enum name.

string

nullable

BoardTypes

Supported board runtime types.

Array<object>

nullable

Selectable board runtime type.

object

Value

integer format: int32

Allowed values: 0 1

Name

Enum name.

string

nullable

BoardCycleActivationModes

Supported cycle activation modes.

Array<object>

nullable

Selectable board cycle activation mode.

object

Value

integer format: int32

Allowed values: 0 1 2

Name

Enum name.

string

nullable

ResponsibilitySubjectTypes

Supported responsibility assignment subject types.

Array<object>

nullable

Selectable concrete responsibility subject type.

object

Value

integer format: int32

Allowed values: 0 1

Name

Enum name.

string

nullable

TargetRepeatPolicies

Supported target repeat policies.

Array<object>

nullable

Selectable board target repeat policy.

object

Value

integer format: int32

Allowed values: 0 1 2

Name

Enum name.

string

nullable

CreateCommentPolicies

Supported process comment creation policies.

Array<object>

nullable

Selectable process comment creation policy.

object

Value

integer format: int32

Allowed values: 0 1 2

Name

Enum name.

string

nullable

ReadCommentPolicies

Supported process comment read policies.

Array<object>

nullable

Selectable process comment read policy.

object

Value

integer format: int32

Allowed values: 0 1 2

Name

Enum name.

string

nullable

CreateAttachmentPolicies

Supported process attachment creation policies.

Array<object>

nullable

Selectable process attachment creation policy.

object

Value

integer format: int32

Allowed values: 0 1 2

Name

Enum name.

string

nullable

ReadAttachmentPolicies

Supported process attachment read policies.

Array<object>

nullable

Selectable process attachment read policy.

object

Value

integer format: int32

Allowed values: 0 1 2

Name

Enum name.

string

nullable

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": {
    "StatusMetaTypes": [
      {
        "Value": 0
      }
    ],
    "BoardTypes": [
      {
        "Value": 0
      }
    ],
    "BoardCycleActivationModes": [
      {
        "Value": 0
      }
    ],
    "ResponsibilitySubjectTypes": [
      {
        "Value": 0
      }
    ],
    "TargetRepeatPolicies": [
      {
        "Value": 0
      }
    ],
    "CreateCommentPolicies": [
      {
        "Value": 0
      }
    ],
    "ReadCommentPolicies": [
      {
        "Value": 0
      }
    ],
    "CreateAttachmentPolicies": [
      {
        "Value": 0
      }
    ],
    "ReadAttachmentPolicies": [
      {
        "Value": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

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

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}