Skip to content

AssignmentEventSeries​

Recurring work steps: a series repeats an event of an assignment by an RFC 5545 rule. Its occurrences are ordinary AssignmentEvents with seriesUuid set. Series are set up in Artesa, so this API only reads them.


OpenAPI Spec​

GET
/v2/assignment-event-series/spec

Get OpenAPI 3.1.0 spec for AssignmentEventSeries API

Responses​

Returns OpenAPI 3.1.0 spec for AssignmentEventSeries API

application/json
JSON
{
}

Playground​

Samples​


List AssignmentEventSeries​

GET
/v2/assignment-event-series

List AssignmentEventSeries

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
assignmentUuid
startsOn
createdAt
updatedAt

Responses​

List response

application/json
JSON
{
  
"page": 0,
  
"pages": 0,
  
"size": 10,
  
"items": [
  
  
{
  
  
  
"uuid": "string",
  
  
  
"rrule": "string",
  
  
  
"startsOn": "string",
  
  
  
"exdates": [
  
  
  
  
"string"
  
  
  
],
  
  
  
"materializedUntil": "string",
  
  
  
"order": 0,
  
  
  
"assignmentUuid": "string",
  
  
  
"groupUuid": "string",
  
  
  
"createdAt": "string",
  
  
  
"updatedAt": "string"
  
  
}
  
]
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Get an AssignmentEventSery​

GET
/v2/assignment-event-series/{seriesUuid}

Get an AssignmentEventSeries by ID

Authorizations​

apiKey
Type
HTTP (bearer)

Parameters​

Path Parameters

seriesUuid*
Type
string
Required
Format
"uuid"

Responses​

AssignmentEventSeries found

application/json
JSON
{
  
"uuid": "string",
  
"rrule": "string",
  
"startsOn": "string",
  
"exdates": [
  
  
"string"
  
],
  
"materializedUntil": "string",
  
"order": 0,
  
"assignmentUuid": "string",
  
"groupUuid": "string",
  
"createdAt": "string",
  
"updatedAt": "string"
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​