Skip to content

AssignmentEventType​

The kinds of work step a company defines in its settings, such as installation or maintenance. Every AssignmentEvent has one, by its typeUuid, and takes its defaults from it when created. Types are set up in Artesa, so this API only reads them.


OpenAPI Spec​

GET
/v2/assignment-event-types/spec

Get OpenAPI 3.1.0 spec for AssignmentEventType API

Responses​

Returns OpenAPI 3.1.0 spec for AssignmentEventType API

application/json
JSON
{
}

Playground​

Samples​


List AssignmentEventTypes​

GET
/v2/assignment-event-types

List AssignmentEventTypes

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
deactivatedAt
createdAt
updatedAt

Responses​

List response

application/json
JSON
{
  
"page": 0,
  
"pages": 0,
  
"size": 10,
  
"items": [
  
  
{
  
  
  
"uuid": "string",
  
  
  
"name": "string",
  
  
  
"shortName": "string",
  
  
  
"color": "string",
  
  
  
"order": 0,
  
  
  
"deactivatedAt": "string",
  
  
  
"createdAt": "string",
  
  
  
"updatedAt": "string"
  
  
}
  
]
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Get an AssignmentEventType​

GET
/v2/assignment-event-types/{assignmentEventTypeUuid}

Get an AssignmentEventType by ID

Authorizations​

apiKey
Type
HTTP (bearer)

Parameters​

Path Parameters

assignmentEventTypeUuid*
Type
string
Required
Format
"uuid"

Responses​

AssignmentEventType found

application/json
JSON
{
  
"uuid": "string",
  
"name": "string",
  
"shortName": "string",
  
"color": "string",
  
"order": 0,
  
"deactivatedAt": "string",
  
"createdAt": "string",
  
"updatedAt": "string"
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​