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}

---

OpenAPI Spec

GET

/v1/assignment-events/spec

Get OpenAPI 3.1.0 spec for AssignmentEvent API

Responses

The spec itself as json

Content-Type

application/json

{

}

GET

/v1/assignment-events/spec

Playground

Samples

cURL

JavaScript

PHP

Python

---

List AssignmentEvents

GET

/v1/assignment-events

List AssignmentEvents

Authorizations

apiKey

TypeHTTP (bearer)

Parameters

Query Parameters

page

Typenumber

minimum0

default0

size

Typenumber

minimum1

maximum20

default10

name

typeId

startsAt

endsAt

completedAt

confirmedAt

isAllDay

Typeboolean

isOutward

Typeboolean

assignmentId

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

],

"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

name

typeId

startsAt

endsAt

completedAt

confirmedAt

isAllDay

isOutward

assignmentId

externalId

createdAt

updatedAt

Samples

cURL

JavaScript

PHP

Python

---

Create a new AssignmentEvent

POST

/v1/assignment-events

Create a new AssignmentEvent

Authorizations

apiKey

TypeHTTP (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

],

"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

],

"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

cURL

JavaScript

PHP

Python

---

Get an AssignmentEvent

GET

/v1/assignment-events/{assignmentEventId}

Get an AssignmentEvent by ID

Authorizations

apiKey

TypeHTTP (bearer)

Parameters

Path Parameters

assignmentEventId*

Typeinteger

Required

formatint32

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

],

"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

cURL

JavaScript

PHP

Python

---

Delete an AssignmentEvent

DELETE

/v1/assignment-events/{assignmentEventId}

Delete an AssignmentEvent by ID

Authorizations

apiKey

TypeHTTP (bearer)

Parameters

Path Parameters

assignmentEventId*

Typeinteger

Required

formatint32

Responses

Successfully removed

DELETE

/v1/assignment-events/{assignmentEventId}

Playground

Server

Authorization

apiKey

Variables

Key

Value

assignmentEventId*

Samples

cURL

JavaScript

PHP

Python

---

Update an AssignmentEvent

PATCH

/v1/assignment-events/{assignmentEventId}

Update an AssignmentEvent by ID

Authorizations

apiKey

TypeHTTP (bearer)

Parameters

Path Parameters

assignmentEventId*

Typeinteger

Required

formatint32

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

],

"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

],

"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

cURL

JavaScript

PHP

Python

---