AssignmentEvent

The work steps within an assignment, the central part of Artesa: they are scheduled, tracked and calculated. An occurrence of a recurring series is one too, with seriesUuid set.

Operations

GET/v2/assignment-events/specGET/v2/assignment-eventsPOST/v2/assignment-eventsGET/v2/assignment-events/{assignmentEventUuid}DELETE/v2/assignment-events/{assignmentEventUuid}PATCH/v2/assignment-events/{assignmentEventUuid}GET/v2/assignment-events/{assignmentEventUuid}/uploadsPOST/v2/assignment-events/{assignmentEventUuid}/uploadsGET/v2/assignment-events/{assignmentEventUuid}/uploads/{uploadUuid}DELETE/v2/assignment-events/{assignmentEventUuid}/uploads/{uploadUuid}PATCH/v2/assignment-events/{assignmentEventUuid}/uploads/{uploadUuid}

---

OpenAPI Spec

GET

/v2/assignment-events/spec

Get OpenAPI 3.1.0 spec for AssignmentEvent API

Responses

Returns OpenAPI 3.1.0 spec for AssignmentEvent API

Content-Type

application/json

{

}

GET

/v2/assignment-events/spec

Playground

Samples

---

List AssignmentEvents

GET

/v2/assignment-events

List AssignmentEvents

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

typeUuid

groupUuid

seriesUuid

seriesOccurrenceDate

name

startsAt

endsAt

completedAt

confirmedAt

isAllDay

isOutward

externalId

createdAt

updatedAt

Responses

List response

Content-Type

application/json

{

  

"page": 0,

  

"pages": 0,

  

"size": 10,

  

"items": [

  

  

{

  

  

  

"uuid": "string",

  

  

  

"name": "string",

  

  

  

"startsAt": "string",

  

  

  

"endsAt": "string",

  

  

  

"plannedEmployeeCount": 0,

  

  

  

"workingTimePerDay": 0,

  

  

  

"workDays": 0,

  

  

  

"manPower": 0,

  

  

  

"completedAt": "string",

  

  

  

"confirmedAt": "string",

  

  

  

"note": "string",

  

  

  

"order": 0,

  

  

  

"isAllDay": true,

  

  

  

"isOutward": true,

  

  

  

"externalId": "string",

  

  

  

"assignmentUuid": "string",

  

  

  

"typeUuid": "string",

  

  

  

"groupUuid": "string",

  

  

  

"seriesUuid": "string",

  

  

  

"seriesOccurrenceDate": "string",

  

  

  

"userUuids": [

  

  

  

  

"string"

  

  

  

],

  

  

  

"gangUuids": [

  

  

  

  

"string"

  

  

  

],

  

  

  

"addressStartFrom": {

  

  

  

  

"link": "string",

  

  

  

  

"supplement": "string",

  

  

  

  

"street": "string",

  

  

  

  

"clarification": "string",

  

  

  

  

"zip": "string",

  

  

  

  

"city": "string",

  

  

  

  

"state": "string",

  

  

  

  

"country": "string",

  

  

  

  

"externalId": "string",

  

  

  

  

"latitude": 0,

  

  

  

  

"longitude": 0

  

  

  

},

  

  

  

"addressDestination": {

  

  

  

  

"link": "string",

  

  

  

  

"supplement": "string",

  

  

  

  

"street": "string",

  

  

  

  

"clarification": "string",

  

  

  

  

"zip": "string",

  

  

  

  

"city": "string",

  

  

  

  

"state": "string",

  

  

  

  

"country": "string",

  

  

  

  

"externalId": "string",

  

  

  

  

"latitude": 0,

  

  

  

  

"longitude": 0

  

  

  

},

  

  

  

"addressReturnTo": {

  

  

  

  

"link": "string",

  

  

  

  

"supplement": "string",

  

  

  

  

"street": "string",

  

  

  

  

"clarification": "string",

  

  

  

  

"zip": "string",

  

  

  

  

"city": "string",

  

  

  

  

"state": "string",

  

  

  

  

"country": "string",

  

  

  

  

"externalId": "string",

  

  

  

  

"latitude": 0,

  

  

  

  

"longitude": 0

  

  

  

},

  

  

  

"createdAt": "string",

  

  

  

"updatedAt": "string"

  

  

}

  

]

}

GET

/v2/assignment-events

Playground

Server

Authorization

apiKey

Variables

Key

Value

page

size

uuid

assignmentUuid

typeUuid

groupUuid

seriesUuid

seriesOccurrenceDate

name

startsAt

endsAt

completedAt

confirmedAt

isAllDay

isOutward

externalId

createdAt

updatedAt

Samples

---

Create a new AssignmentEvent

POST

/v2/assignment-events

Create a new AssignmentEvent

Authorizations

apiKey

Type

HTTP (bearer)

Request Body

application/json

{

  

"uuid": "string",

  

"assignmentUuid": "string",

  

"typeUuid": "string",

  

"name": "string",

  

"startsAt": "string",

  

"endsAt": "string",

  

"completedAt": true,

  

"confirmedAt": true,

  

"note": "string",

  

"order": 0,

  

"externalId": "string",

  

"groupUuid": "string",

  

"userUuids": [

  

  

"string"

  

],

  

"gangUuids": [

  

  

"string"

  

],

  

"plannedEmployeeCount": 0,

  

"workDays": 0,

  

"workingTimePerDay": 0,

  

"manPower": 0,

  

"isAllDay": true,

  

"isOutward": true,

  

"addressStartFrom": {

  

  

"link": "string"

  

},

  

"addressDestination": {

  

  

"link": "string"

  

},

  

"addressReturnTo": {

  

  

"link": "string"

  

}

}

Responses

AssignmentEvent found

Content-Type

application/json

{

  

"uuid": "string",

  

"name": "string",

  

"startsAt": "string",

  

"endsAt": "string",

  

"plannedEmployeeCount": 0,

  

"workingTimePerDay": 0,

  

"workDays": 0,

  

"manPower": 0,

  

"completedAt": "string",

  

"confirmedAt": "string",

  

"note": "string",

  

"order": 0,

  

"isAllDay": true,

  

"isOutward": true,

  

"externalId": "string",

  

"assignmentUuid": "string",

  

"typeUuid": "string",

  

"groupUuid": "string",

  

"seriesUuid": "string",

  

"seriesOccurrenceDate": "string",

  

"userUuids": [

  

  

"string"

  

],

  

"gangUuids": [

  

  

"string"

  

],

  

"addressStartFrom": {

  

  

"link": "string",

  

  

"supplement": "string",

  

  

"street": "string",

  

  

"clarification": "string",

  

  

"zip": "string",

  

  

"city": "string",

  

  

"state": "string",

  

  

"country": "string",

  

  

"externalId": "string",

  

  

"latitude": 0,

  

  

"longitude": 0

  

},

  

"addressDestination": {

  

  

"link": "string",

  

  

"supplement": "string",

  

  

"street": "string",

  

  

"clarification": "string",

  

  

"zip": "string",

  

  

"city": "string",

  

  

"state": "string",

  

  

"country": "string",

  

  

"externalId": "string",

  

  

"latitude": 0,

  

  

"longitude": 0

  

},

  

"addressReturnTo": {

  

  

"link": "string",

  

  

"supplement": "string",

  

  

"street": "string",

  

  

"clarification": "string",

  

  

"zip": "string",

  

  

"city": "string",

  

  

"state": "string",

  

  

"country": "string",

  

  

"externalId": "string",

  

  

"latitude": 0,

  

  

"longitude": 0

  

},

  

"createdAt": "string",

  

"updatedAt": "string"

}

POST

/v2/assignment-events

Playground

Server

Authorization

apiKey

Body

Samples

---

Get an AssignmentEvent

GET

/v2/assignment-events/{assignmentEventUuid}

Get an AssignmentEvent by ID

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Path Parameters

assignmentEventUuid*

Type

string

Required

Format

"uuid"

Responses

AssignmentEvent found

Content-Type

application/json

{

  

"uuid": "string",

  

"name": "string",

  

"startsAt": "string",

  

"endsAt": "string",

  

"plannedEmployeeCount": 0,

  

"workingTimePerDay": 0,

  

"workDays": 0,

  

"manPower": 0,

  

"completedAt": "string",

  

"confirmedAt": "string",

  

"note": "string",

  

"order": 0,

  

"isAllDay": true,

  

"isOutward": true,

  

"externalId": "string",

  

"assignmentUuid": "string",

  

"typeUuid": "string",

  

"groupUuid": "string",

  

"seriesUuid": "string",

  

"seriesOccurrenceDate": "string",

  

"userUuids": [

  

  

"string"

  

],

  

"gangUuids": [

  

  

"string"

  

],

  

"addressStartFrom": {

  

  

"link": "string",

  

  

"supplement": "string",

  

  

"street": "string",

  

  

"clarification": "string",

  

  

"zip": "string",

  

  

"city": "string",

  

  

"state": "string",

  

  

"country": "string",

  

  

"externalId": "string",

  

  

"latitude": 0,

  

  

"longitude": 0

  

},

  

"addressDestination": {

  

  

"link": "string",

  

  

"supplement": "string",

  

  

"street": "string",

  

  

"clarification": "string",

  

  

"zip": "string",

  

  

"city": "string",

  

  

"state": "string",

  

  

"country": "string",

  

  

"externalId": "string",

  

  

"latitude": 0,

  

  

"longitude": 0

  

},

  

"addressReturnTo": {

  

  

"link": "string",

  

  

"supplement": "string",

  

  

"street": "string",

  

  

"clarification": "string",

  

  

"zip": "string",

  

  

"city": "string",

  

  

"state": "string",

  

  

"country": "string",

  

  

"externalId": "string",

  

  

"latitude": 0,

  

  

"longitude": 0

  

},

  

"createdAt": "string",

  

"updatedAt": "string"

}

GET

/v2/assignment-events/{assignmentEventUuid}

Playground

Server

Authorization

apiKey

Variables

Key

Value

assignmentEventUuid*

Samples

---

Delete an AssignmentEvent

DELETE

/v2/assignment-events/{assignmentEventUuid}

Delete an AssignmentEvent by ID

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Path Parameters

assignmentEventUuid*

Type

string

Required

Format

"uuid"

Responses

Successfully removed

DELETE

/v2/assignment-events/{assignmentEventUuid}

Playground

Server

Authorization

apiKey

Variables

Key

Value

assignmentEventUuid*

Samples

---

Update an AssignmentEvent

PATCH

/v2/assignment-events/{assignmentEventUuid}

Update an AssignmentEvent by ID

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Path Parameters

assignmentEventUuid*

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"name": "string",

  

"startsAt": "string",

  

"endsAt": "string",

  

"completedAt": true,

  

"confirmedAt": true,

  

"note": "string",

  

"order": 0,

  

"externalId": "string",

  

"groupUuid": "string",

  

"userUuids": [

  

  

"string"

  

],

  

"gangUuids": [

  

  

"string"

  

],

  

"plannedEmployeeCount": 0,

  

"workDays": 0,

  

"workingTimePerDay": 0,

  

"manPower": 0,

  

"isAllDay": true,

  

"isOutward": true,

  

"addressStartFrom": {

  

  

"link": "string"

  

},

  

"addressDestination": {

  

  

"link": "string"

  

},

  

"addressReturnTo": {

  

  

"link": "string"

  

}

}

Responses

AssignmentEvent found

Content-Type

application/json

{

  

"uuid": "string",

  

"name": "string",

  

"startsAt": "string",

  

"endsAt": "string",

  

"plannedEmployeeCount": 0,

  

"workingTimePerDay": 0,

  

"workDays": 0,

  

"manPower": 0,

  

"completedAt": "string",

  

"confirmedAt": "string",

  

"note": "string",

  

"order": 0,

  

"isAllDay": true,

  

"isOutward": true,

  

"externalId": "string",

  

"assignmentUuid": "string",

  

"typeUuid": "string",

  

"groupUuid": "string",

  

"seriesUuid": "string",

  

"seriesOccurrenceDate": "string",

  

"userUuids": [

  

  

"string"

  

],

  

"gangUuids": [

  

  

"string"

  

],

  

"addressStartFrom": {

  

  

"link": "string",

  

  

"supplement": "string",

  

  

"street": "string",

  

  

"clarification": "string",

  

  

"zip": "string",

  

  

"city": "string",

  

  

"state": "string",

  

  

"country": "string",

  

  

"externalId": "string",

  

  

"latitude": 0,

  

  

"longitude": 0

  

},

  

"addressDestination": {

  

  

"link": "string",

  

  

"supplement": "string",

  

  

"street": "string",

  

  

"clarification": "string",

  

  

"zip": "string",

  

  

"city": "string",

  

  

"state": "string",

  

  

"country": "string",

  

  

"externalId": "string",

  

  

"latitude": 0,

  

  

"longitude": 0

  

},

  

"addressReturnTo": {

  

  

"link": "string",

  

  

"supplement": "string",

  

  

"street": "string",

  

  

"clarification": "string",

  

  

"zip": "string",

  

  

"city": "string",

  

  

"state": "string",

  

  

"country": "string",

  

  

"externalId": "string",

  

  

"latitude": 0,

  

  

"longitude": 0

  

},

  

"createdAt": "string",

  

"updatedAt": "string"

}

PATCH

/v2/assignment-events/{assignmentEventUuid}

Playground

Server

Authorization

apiKey

Variables

Key

Value

assignmentEventUuid*

Body

Samples

---

List AssignmentEventUploads

GET

/v2/assignment-events/{assignmentEventUuid}/uploads

List the uploads of an assignment event.

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Path Parameters

assignmentEventUuid*

Type

string

Required

Format

"uuid"

Query Parameters

page

Type

number

Minimum

0

Default

0

size

Type

number

Minimum

1

Maximum

20

Default

10

uuid

categoryUuid

Responses

List response

Content-Type

application/json

{

  

"page": 0,

  

"pages": 0,

  

"size": 10,

  

"items": [

  

  

{

  

  

  

"uuid": "string",

  

  

  

"mimeType": "string",

  

  

  

"fileSize": 0,

  

  

  

"fileName": "string",

  

  

  

"description": "string",

  

  

  

"downloadUrl": "string",

  

  

  

"categoryUuid": "string",

  

  

  

"createdAt": "string",

  

  

  

"updatedAt": "string",

  

  

  

"assignmentEventUuid": "string"

  

  

}

  

]

}

GET

/v2/assignment-events/{assignmentEventUuid}/uploads

Playground

Server

Authorization

apiKey

Variables

Key

Value

assignmentEventUuid*

page

size

uuid

categoryUuid

Samples

---

Create a new AssignmentEventUpload

POST

/v2/assignment-events/{assignmentEventUuid}/uploads

Create a new upload for an assignment event. The file must be provided as multipart/form-data.

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Path Parameters

assignmentEventUuid*

Type

string

Required

Format

"uuid"

Request Body

multipart/form-data

Format"binary"

UUIDv7 string

Format"uuid7"

Description of the upload

UploadCategory uuid

Format"uuid7"

Responses

AssignmentEvent upload found

Content-Type

application/json

{

  

"uuid": "string",

  

"mimeType": "string",

  

"fileSize": 0,

  

"fileName": "string",

  

"description": "string",

  

"downloadUrl": "string",

  

"categoryUuid": "string",

  

"createdAt": "string",

  

"updatedAt": "string",

  

"assignmentEventUuid": "string"

}

POST

/v2/assignment-events/{assignmentEventUuid}/uploads

Playground

Server

Authorization

apiKey

Variables

Key

Value

assignmentEventUuid*

Body

file*

uuid

description

categoryUuid

Samples

---

Get an AssignmentEventUpload

GET

/v2/assignment-events/{assignmentEventUuid}/uploads/{uploadUuid}

Get an upload of the assignment event by its uuid; 404 if it isn't the assignment event's.

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Path Parameters

assignmentEventUuid*

Type

string

Required

Format

"uuid"

uploadUuid*

Type

string

Required

Format

"uuid"

Responses

AssignmentEvent upload found

Content-Type

application/json

{

  

"uuid": "string",

  

"mimeType": "string",

  

"fileSize": 0,

  

"fileName": "string",

  

"description": "string",

  

"downloadUrl": "string",

  

"categoryUuid": "string",

  

"createdAt": "string",

  

"updatedAt": "string",

  

"assignmentEventUuid": "string"

}

GET

/v2/assignment-events/{assignmentEventUuid}/uploads/{uploadUuid}

Playground

Server

Authorization

apiKey

Variables

Key

Value

assignmentEventUuid*

uploadUuid*

Samples

---

Delete an AssignmentEventUpload

DELETE

/v2/assignment-events/{assignmentEventUuid}/uploads/{uploadUuid}

Delete an upload of the assignment event by its uuid; 404 if it isn't the assignment event's.

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Path Parameters

assignmentEventUuid*

Type

string

Required

Format

"uuid"

uploadUuid*

Type

string

Required

Format

"uuid"

Responses

Successfully removed

DELETE

/v2/assignment-events/{assignmentEventUuid}/uploads/{uploadUuid}

Playground

Server

Authorization

apiKey

Variables

Key

Value

assignmentEventUuid*

uploadUuid*

Samples

---

Update an AssignmentEventUpload

PATCH

/v2/assignment-events/{assignmentEventUuid}/uploads/{uploadUuid}

Update an upload of the assignment event by its uuid; 404 if it isn't the assignment event's.

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Path Parameters

assignmentEventUuid*

Type

string

Required

Format

"uuid"

uploadUuid*

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"description": "string",

  

"categoryUuid": "string",

  

"fileName": "string"

}

Responses

AssignmentEvent upload found

Content-Type

application/json

{

  

"uuid": "string",

  

"mimeType": "string",

  

"fileSize": 0,

  

"fileName": "string",

  

"description": "string",

  

"downloadUrl": "string",

  

"categoryUuid": "string",

  

"createdAt": "string",

  

"updatedAt": "string",

  

"assignmentEventUuid": "string"

}

PATCH

/v2/assignment-events/{assignmentEventUuid}/uploads/{uploadUuid}

Playground

Server

Authorization

apiKey

Variables

Key

Value

assignmentEventUuid*

uploadUuid*

Body

Samples

---

AssignmentEventUpload

Operations

GET/v2/assignment-events/{assignmentEventUuid}/uploadsPOST/v2/assignment-events/{assignmentEventUuid}/uploadsGET/v2/assignment-events/{assignmentEventUuid}/uploads/{uploadUuid}DELETE/v2/assignment-events/{assignmentEventUuid}/uploads/{uploadUuid}PATCH/v2/assignment-events/{assignmentEventUuid}/uploads/{uploadUuid}

---

List AssignmentEventUploads

GET

/v2/assignment-events/{assignmentEventUuid}/uploads

List the uploads of an assignment event.

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Path Parameters

assignmentEventUuid*

Type

string

Required

Format

"uuid"

Query Parameters

page

Type

number

Minimum

0

Default

0

size

Type

number

Minimum

1

Maximum

20

Default

10

uuid

categoryUuid

Responses

List response

Content-Type

application/json

{

  

"page": 0,

  

"pages": 0,

  

"size": 10,

  

"items": [

  

  

{

  

  

  

"uuid": "string",

  

  

  

"mimeType": "string",

  

  

  

"fileSize": 0,

  

  

  

"fileName": "string",

  

  

  

"description": "string",

  

  

  

"downloadUrl": "string",

  

  

  

"categoryUuid": "string",

  

  

  

"createdAt": "string",

  

  

  

"updatedAt": "string",

  

  

  

"assignmentEventUuid": "string"

  

  

}

  

]

}

GET

/v2/assignment-events/{assignmentEventUuid}/uploads

Playground

Server

Authorization

apiKey

Variables

Key

Value

assignmentEventUuid*

page

size

uuid

categoryUuid

Samples

---

Create a new AssignmentEventUpload

POST

/v2/assignment-events/{assignmentEventUuid}/uploads

Create a new upload for an assignment event. The file must be provided as multipart/form-data.

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Path Parameters

assignmentEventUuid*

Type

string

Required

Format

"uuid"

Request Body

multipart/form-data

Format"binary"

UUIDv7 string

Format"uuid7"

Description of the upload

UploadCategory uuid

Format"uuid7"

Responses

AssignmentEvent upload found

Content-Type

application/json

{

  

"uuid": "string",

  

"mimeType": "string",

  

"fileSize": 0,

  

"fileName": "string",

  

"description": "string",

  

"downloadUrl": "string",

  

"categoryUuid": "string",

  

"createdAt": "string",

  

"updatedAt": "string",

  

"assignmentEventUuid": "string"

}

POST

/v2/assignment-events/{assignmentEventUuid}/uploads

Playground

Server

Authorization

apiKey

Variables

Key

Value

assignmentEventUuid*

Body

file*

uuid

description

categoryUuid

Samples

---

Get an AssignmentEventUpload

GET

/v2/assignment-events/{assignmentEventUuid}/uploads/{uploadUuid}

Get an upload of the assignment event by its uuid; 404 if it isn't the assignment event's.

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Path Parameters

assignmentEventUuid*

Type

string

Required

Format

"uuid"

uploadUuid*

Type

string

Required

Format

"uuid"

Responses

AssignmentEvent upload found

Content-Type

application/json

{

  

"uuid": "string",

  

"mimeType": "string",

  

"fileSize": 0,

  

"fileName": "string",

  

"description": "string",

  

"downloadUrl": "string",

  

"categoryUuid": "string",

  

"createdAt": "string",

  

"updatedAt": "string",

  

"assignmentEventUuid": "string"

}

GET

/v2/assignment-events/{assignmentEventUuid}/uploads/{uploadUuid}

Playground

Server

Authorization

apiKey

Variables

Key

Value

assignmentEventUuid*

uploadUuid*

Samples

---

Delete an AssignmentEventUpload

DELETE

/v2/assignment-events/{assignmentEventUuid}/uploads/{uploadUuid}

Delete an upload of the assignment event by its uuid; 404 if it isn't the assignment event's.

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Path Parameters

assignmentEventUuid*

Type

string

Required

Format

"uuid"

uploadUuid*

Type

string

Required

Format

"uuid"

Responses

Successfully removed

DELETE

/v2/assignment-events/{assignmentEventUuid}/uploads/{uploadUuid}

Playground

Server

Authorization

apiKey

Variables

Key

Value

assignmentEventUuid*

uploadUuid*

Samples

---

Update an AssignmentEventUpload

PATCH

/v2/assignment-events/{assignmentEventUuid}/uploads/{uploadUuid}

Update an upload of the assignment event by its uuid; 404 if it isn't the assignment event's.

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Path Parameters

assignmentEventUuid*

Type

string

Required

Format

"uuid"

uploadUuid*

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"description": "string",

  

"categoryUuid": "string",

  

"fileName": "string"

}

Responses

AssignmentEvent upload found

Content-Type

application/json

{

  

"uuid": "string",

  

"mimeType": "string",

  

"fileSize": 0,

  

"fileName": "string",

  

"description": "string",

  

"downloadUrl": "string",

  

"categoryUuid": "string",

  

"createdAt": "string",

  

"updatedAt": "string",

  

"assignmentEventUuid": "string"

}

PATCH

/v2/assignment-events/{assignmentEventUuid}/uploads/{uploadUuid}

Playground

Server

Authorization

apiKey

Variables

Key

Value

assignmentEventUuid*

uploadUuid*

Body

Samples

---