AssignmentStatusType

The statuses an assignment moves through, named in the settings. category says what a status means — new, in progress, done or cancelled — whatever it is called. They are set up in Artesa, so this API only reads them.

Operations

GET/v2/assignment-status-types/specGET/v2/assignment-status-typesGET/v2/assignment-status-types/{assignmentStatusTypeUuid}

---

OpenAPI Spec

GET

/v2/assignment-status-types/spec

Get OpenAPI 3.1.0 spec for AssignmentStatusType API

Responses

Returns OpenAPI 3.1.0 spec for AssignmentStatusType API

Content-Type

application/json

{

}

GET

/v2/assignment-status-types/spec

Playground

Samples

---

List AssignmentStatusTypes

GET

/v2/assignment-status-types

List AssignmentStatusTypes

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Query Parameters

page

Type

number

Minimum

0

Default

0

size

Type

number

Minimum

1

Maximum

20

Default

10

uuid

name

category

deactivatedAt

createdAt

updatedAt

Responses

List response

Content-Type

application/json

{

  

"page": 0,

  

"pages": 0,

  

"size": 10,

  

"items": [

  

  

{

  

  

  

"uuid": "string",

  

  

  

"name": "string",

  

  

  

"order": 0,

  

  

  

"category": "string",

  

  

  

"deactivatedAt": "string",

  

  

  

"createdAt": "string",

  

  

  

"updatedAt": "string"

  

  

}

  

]

}

GET

/v2/assignment-status-types

Playground

Server

Authorization

apiKey

Variables

Key

Value

page

size

uuid

name

category

deactivatedAt

createdAt

updatedAt

Samples

---

Get an AssignmentStatusType

GET

/v2/assignment-status-types/{assignmentStatusTypeUuid}

Get an AssignmentStatusType by ID

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Path Parameters

assignmentStatusTypeUuid*

Type

string

Required

Format

"uuid"

Responses

AssignmentStatusType found

Content-Type

application/json

{

  

"uuid": "string",

  

"name": "string",

  

"order": 0,

  

"category": "string",

  

"deactivatedAt": "string",

  

"createdAt": "string",

  

"updatedAt": "string"

}

GET

/v2/assignment-status-types/{assignmentStatusTypeUuid}

Playground

Server

Authorization

apiKey

Variables

Key

Value

assignmentStatusTypeUuid*

Samples

---