AssignmentEvent

The AssignmentEvents within an Assignment. AssignmentEvents are the central part of Artesa. AssignmentEvents can be scheduled, are used for time tracking and are the entry point for calculation.

Operations

GET/v1/assignment-events/specGET/v1/assignment-eventsPOST/v1/assignment-eventsGET/v1/assignment-events/{assignmentEventId}DELETE/v1/assignment-events/{assignmentEventId}PATCH/v1/assignment-events/{assignmentEventId}GET/v1/assignment-events/{assignmentEventId}/uploadsPOST/v1/assignment-events/{assignmentEventId}/uploadsGET/v1/assignment-events/{assignmentEventId}/uploads/{uploadId}DELETE/v1/assignment-events/{assignmentEventId}/uploads/{uploadId}PATCH/v1/assignment-events/{assignmentEventId}/uploads/{uploadId}

---

OpenAPI Spec

GET

/v1/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

/v1/assignment-events/spec

Playground

Samples

---

List AssignmentEvents

GET

/v1/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

id

assignmentId

typeId

name

startsAt

endsAt

completedAt

confirmedAt

isAllDay

isOutward

externalId

createdAt

updatedAt

Responses

List response

Content-Type

application/json

{

"page": 0,

"pages": 0,

"size": 10,

"items": [

{

"id": 0,

"name": "string",

"startsAt": "string",

"endsAt": "string",

"plannedEmployeeCount": 0,

"workingTimePerDay": 0,

"completedAt": "string",

"confirmedAt": "string",

"note": "string",

"order": 0,

"isAllDay": true,

"isOutward": true,

"externalId": "string",

"workDays": 0,

"manPower": 0,

"typeId": 0,

"assignmentId": 0,

"groupId": 0,

"assignedUsers": [

0

],

"assignedGangs": [

0

],

"addressStartFrom": {

"supplement": "string",

"street": "string",

"clarification": "string",

"zip": "string",

"city": "string",

"state": "string",

"country": "string",

"latitude": 0,

"longitude": 0,

"externalId": "string",

"link": "string"

},

"addressDestination": {

"supplement": "string",

"street": "string",

"clarification": "string",

"zip": "string",

"city": "string",

"state": "string",

"country": "string",

"latitude": 0,

"longitude": 0,

"externalId": "string",

"link": "string"

},

"addressReturnTo": {

"supplement": "string",

"street": "string",

"clarification": "string",

"zip": "string",

"city": "string",

"state": "string",

"country": "string",

"latitude": 0,

"longitude": 0,

"externalId": "string",

"link": "string"

},

"createdAt": "string",

"updatedAt": "string"

}

]

}

GET

/v1/assignment-events

Playground

Server

Authorization

apiKey

Variables

Key

Value

page

size

id

assignmentId

typeId

name

startsAt

endsAt

completedAt

confirmedAt

isAllDay

isOutward

externalId

createdAt

updatedAt

Samples

---

Create a new AssignmentEvent

POST

/v1/assignment-events

Create a new AssignmentEvent

Authorizations

apiKey

Type

HTTP (bearer)

Request Body

application/json

{

"name": null,

"startsAt": null,

"endsAt": null,

"plannedEmployeeCount": 0,

"workDays": 0,

"workingTimePerDay": 0,

"manPower": 0,

"completedAt": true,

"confirmedAt": true,

"note": null,

"order": 0,

"isAllDay": true,

"isOutward": true,

"externalId": null,

"assignmentId": 0,

"typeId": 0,

"groupId": null,

"assignedUsers": [

0

],

"assignedGangs": [

0

],

"addressStartFrom": "string",

"addressDestination": "string",

"addressReturnTo": "string"

}

Responses

AssignmentEvent found

Content-Type

application/json

{

"id": 0,

"name": "string",

"startsAt": "string",

"endsAt": "string",

"plannedEmployeeCount": 0,

"workingTimePerDay": 0,

"completedAt": "string",

"confirmedAt": "string",

"note": "string",

"order": 0,

"isAllDay": true,

"isOutward": true,

"externalId": "string",

"workDays": 0,

"manPower": 0,

"typeId": 0,

"assignmentId": 0,

"groupId": 0,

"assignedUsers": [

0

],

"assignedGangs": [

0

],

"addressStartFrom": {

"supplement": "string",

"street": "string",

"clarification": "string",

"zip": "string",

"city": "string",

"state": "string",

"country": "string",

"latitude": 0,

"longitude": 0,

"externalId": "string",

"link": "string"

},

"addressDestination": {

"supplement": "string",

"street": "string",

"clarification": "string",

"zip": "string",

"city": "string",

"state": "string",

"country": "string",

"latitude": 0,

"longitude": 0,

"externalId": "string",

"link": "string"

},

"addressReturnTo": {

"supplement": "string",

"street": "string",

"clarification": "string",

"zip": "string",

"city": "string",

"state": "string",

"country": "string",

"latitude": 0,

"longitude": 0,

"externalId": "string",

"link": "string"

},

"createdAt": "string",

"updatedAt": "string"

}

POST

/v1/assignment-events

Playground

Server

Authorization

apiKey

Body

Samples

---

Get an AssignmentEvent

GET

/v1/assignment-events/{assignmentEventId}

Get an AssignmentEvent by ID

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Path Parameters

assignmentEventId*

Type

integer

Required

Format

"int32"

Responses

AssignmentEvent found

Content-Type

application/json

{

"id": 0,

"name": "string",

"startsAt": "string",

"endsAt": "string",

"plannedEmployeeCount": 0,

"workingTimePerDay": 0,

"completedAt": "string",

"confirmedAt": "string",

"note": "string",

"order": 0,

"isAllDay": true,

"isOutward": true,

"externalId": "string",

"workDays": 0,

"manPower": 0,

"typeId": 0,

"assignmentId": 0,

"groupId": 0,

"assignedUsers": [

0

],

"assignedGangs": [

0

],

"addressStartFrom": {

"supplement": "string",

"street": "string",

"clarification": "string",

"zip": "string",

"city": "string",

"state": "string",

"country": "string",

"latitude": 0,

"longitude": 0,

"externalId": "string",

"link": "string"

},

"addressDestination": {

"supplement": "string",

"street": "string",

"clarification": "string",

"zip": "string",

"city": "string",

"state": "string",

"country": "string",

"latitude": 0,

"longitude": 0,

"externalId": "string",

"link": "string"

},

"addressReturnTo": {

"supplement": "string",

"street": "string",

"clarification": "string",

"zip": "string",

"city": "string",

"state": "string",

"country": "string",

"latitude": 0,

"longitude": 0,

"externalId": "string",

"link": "string"

},

"createdAt": "string",

"updatedAt": "string"

}

GET

/v1/assignment-events/{assignmentEventId}

Playground

Server

Authorization

apiKey

Variables

Key

Value

assignmentEventId*

Samples

---

Delete an AssignmentEvent

DELETE

/v1/assignment-events/{assignmentEventId}

Delete an AssignmentEvent by ID

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Path Parameters

assignmentEventId*

Type

integer

Required

Format

"int32"

Responses

Successfully removed

DELETE

/v1/assignment-events/{assignmentEventId}

Playground

Server

Authorization

apiKey

Variables

Key

Value

assignmentEventId*

Samples

---

Update an AssignmentEvent

PATCH

/v1/assignment-events/{assignmentEventId}

Update an AssignmentEvent by ID

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Path Parameters

assignmentEventId*

Type

integer

Required

Format

"int32"

Request Body

application/json

{

"name": "string",

"startsAt": "string",

"endsAt": "string",

"plannedEmployeeCount": 0,

"workDays": 0,

"workingTimePerDay": 0,

"manPower": 0,

"completedAt": true,

"confirmedAt": true,

"note": "string",

"order": 0,

"isAllDay": true,

"isOutward": true,

"externalId": "string",

"groupId": 0,

"assignedUsers": [

0

],

"assignedGangs": [

0

],

"addressStartFrom": "string",

"addressDestination": "string",

"addressReturnTo": "string"

}

Responses

AssignmentEvent found

Content-Type

application/json

{

"id": 0,

"name": "string",

"startsAt": "string",

"endsAt": "string",

"plannedEmployeeCount": 0,

"workingTimePerDay": 0,

"completedAt": "string",

"confirmedAt": "string",

"note": "string",

"order": 0,

"isAllDay": true,

"isOutward": true,

"externalId": "string",

"workDays": 0,

"manPower": 0,

"typeId": 0,

"assignmentId": 0,

"groupId": 0,

"assignedUsers": [

0

],

"assignedGangs": [

0

],

"addressStartFrom": {

"supplement": "string",

"street": "string",

"clarification": "string",

"zip": "string",

"city": "string",

"state": "string",

"country": "string",

"latitude": 0,

"longitude": 0,

"externalId": "string",

"link": "string"

},

"addressDestination": {

"supplement": "string",

"street": "string",

"clarification": "string",

"zip": "string",

"city": "string",

"state": "string",

"country": "string",

"latitude": 0,

"longitude": 0,

"externalId": "string",

"link": "string"

},

"addressReturnTo": {

"supplement": "string",

"street": "string",

"clarification": "string",

"zip": "string",

"city": "string",

"state": "string",

"country": "string",

"latitude": 0,

"longitude": 0,

"externalId": "string",

"link": "string"

},

"createdAt": "string",

"updatedAt": "string"

}

PATCH

/v1/assignment-events/{assignmentEventId}

Playground

Server

Authorization

apiKey

Variables

Key

Value

assignmentEventId*

Body

Samples

---

List all uploads for an assignment event

GET

/v1/assignment-events/{assignmentEventId}/uploads

List all uploads for a specific assignment event.

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Path Parameters

assignmentEventId*

Type

integer

Required

Format

"int32"

Query Parameters

page

Type

number

Minimum

0

Default

0

size

Type

number

Minimum

1

Maximum

20

Default

10

id

categoryId

Responses

List response

Content-Type

application/json

{

"page": 0,

"pages": 0,

"size": 10,

"items": [

{

"id": 0,

"mimeType": "string",

"fileSize": 0,

"fileName": "string",

"description": "string",

"downloadUrl": "string",

"categoryId": 0,

"createdAt": "string",

"updatedAt": "string",

"assignmentEventId": 0,

"additionalProperties": "string"

}

]

}

GET

/v1/assignment-events/{assignmentEventId}/uploads

Playground

Server

Authorization

apiKey

Variables

Key

Value

assignmentEventId*

page

size

id

categoryId

Samples

---

Create a new assignment event upload

POST

/v1/assignment-events/{assignmentEventId}/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

assignmentEventId*

Type

integer

Required

Format

"int32"

Request Body

multipart/form-data

object

Format"binary"

Responses

AssignmentEvent upload found

Content-Type

application/json

{

"id": 0,

"mimeType": "string",

"fileSize": 0,

"fileName": "string",

"description": "string",

"downloadUrl": "string",

"categoryId": 0,

"createdAt": "string",

"updatedAt": "string",

"assignmentEventId": 0,

"additionalProperties": "string"

}

POST

/v1/assignment-events/{assignmentEventId}/uploads

Playground

Server

Authorization

apiKey

Variables

Key

Value

assignmentEventId*

Body

file*

categoryId

description

Samples

---

Get a specific upload for an assignment event

GET

/v1/assignment-events/{assignmentEventId}/uploads/{uploadId}

Get a specific upload for an assignment event by its ID.

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Path Parameters

assignmentEventId*

Type

integer

Required

Format

"int32"

uploadId*

Type

integer

Required

Format

"int32"

Responses

AssignmentEvent upload found

Content-Type

application/json

{

"id": 0,

"mimeType": "string",

"fileSize": 0,

"fileName": "string",

"description": "string",

"downloadUrl": "string",

"categoryId": 0,

"createdAt": "string",

"updatedAt": "string",

"assignmentEventId": 0,

"additionalProperties": "string"

}

GET

/v1/assignment-events/{assignmentEventId}/uploads/{uploadId}

Playground

Server

Authorization

apiKey

Variables

Key

Value

assignmentEventId*

uploadId*

Samples

---

Delete a specific upload for an assignment event

DELETE

/v1/assignment-events/{assignmentEventId}/uploads/{uploadId}

Delete a specific upload for an assignment event by its ID.

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Path Parameters

assignmentEventId*

Type

integer

Required

Format

"int32"

uploadId*

Type

integer

Required

Format

"int32"

Responses

Successfully removed

DELETE

/v1/assignment-events/{assignmentEventId}/uploads/{uploadId}

Playground

Server

Authorization

apiKey

Variables

Key

Value

assignmentEventId*

uploadId*

Samples

---

Update a specific upload for an assignment event

PATCH

/v1/assignment-events/{assignmentEventId}/uploads/{uploadId}

Update a specific upload for an assignment event by its ID.

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Path Parameters

assignmentEventId*

Type

integer

Required

Format

"int32"

uploadId*

Type

integer

Required

Format

"int32"

Request Body

application/json

{

"description": "string",

"categoryId": 0,

"fileName": "string"

}

Responses

AssignmentEvent upload found

Content-Type

application/json

{

"id": 0,

"mimeType": "string",

"fileSize": 0,

"fileName": "string",

"description": "string",

"downloadUrl": "string",

"categoryId": 0,

"createdAt": "string",

"updatedAt": "string",

"assignmentEventId": 0,

"additionalProperties": "string"

}

PATCH

/v1/assignment-events/{assignmentEventId}/uploads/{uploadId}

Playground

Server

Authorization

apiKey

Variables

Key

Value

assignmentEventId*

uploadId*

Body

Samples

---

AssignmentEventUpload

Operations

GET/v1/assignment-events/{assignmentEventId}/uploadsPOST/v1/assignment-events/{assignmentEventId}/uploadsGET/v1/assignment-events/{assignmentEventId}/uploads/{uploadId}DELETE/v1/assignment-events/{assignmentEventId}/uploads/{uploadId}PATCH/v1/assignment-events/{assignmentEventId}/uploads/{uploadId}

---

List all uploads for an assignment event

GET

/v1/assignment-events/{assignmentEventId}/uploads

List all uploads for a specific assignment event.

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Path Parameters

assignmentEventId*

Type

integer

Required

Format

"int32"

Query Parameters

page

Type

number

Minimum

0

Default

0

size

Type

number

Minimum

1

Maximum

20

Default

10

id

categoryId

Responses

List response

Content-Type

application/json

{

"page": 0,

"pages": 0,

"size": 10,

"items": [

{

"id": 0,

"mimeType": "string",

"fileSize": 0,

"fileName": "string",

"description": "string",

"downloadUrl": "string",

"categoryId": 0,

"createdAt": "string",

"updatedAt": "string",

"assignmentEventId": 0,

"additionalProperties": "string"

}

]

}

GET

/v1/assignment-events/{assignmentEventId}/uploads

Playground

Server

Authorization

apiKey

Variables

Key

Value

assignmentEventId*

page

size

id

categoryId

Samples

---

Create a new assignment event upload

POST

/v1/assignment-events/{assignmentEventId}/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

assignmentEventId*

Type

integer

Required

Format

"int32"

Request Body

multipart/form-data

object

Format"binary"

Responses

AssignmentEvent upload found

Content-Type

application/json

{

"id": 0,

"mimeType": "string",

"fileSize": 0,

"fileName": "string",

"description": "string",

"downloadUrl": "string",

"categoryId": 0,

"createdAt": "string",

"updatedAt": "string",

"assignmentEventId": 0,

"additionalProperties": "string"

}

POST

/v1/assignment-events/{assignmentEventId}/uploads

Playground

Server

Authorization

apiKey

Variables

Key

Value

assignmentEventId*

Body

file*

categoryId

description

Samples