Artesa API

Appearance

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

application/json
JSON
{
}

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
id
assignmentId
typeId
name
startsAt
endsAt
completedAt
confirmedAt
isAllDay
Typeboolean
isOutward
Typeboolean
externalId
createdAt
updatedAt

Responses​

List response

application/json
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"
}
]
}

Playground​

Server
Authorization
Variables
Key
Value

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

application/json
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"
}

Playground​

Server
Authorization
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
Format"int32"

Responses​

AssignmentEvent found

application/json
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"
}

Playground​

Server
Authorization
Variables
Key
Value

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
Format"int32"

Responses​

Successfully removed

Playground​

Server
Authorization
Variables
Key
Value

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
Format"int32"

Request Body​

application/json
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

application/json
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"
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​

cURL
JavaScript
PHP
Python

List all uploads for an assignment event​

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

List all uploads for a specific assignment event.

Authorizations​

apiKey
TypeHTTP (bearer)

Parameters​

Path Parameters

assignmentEventId*
Typeinteger
Required
Format"int32"

Query Parameters

page
Typenumber
Minimum0
Default0
size
Typenumber
Minimum1
Maximum20
Default10
id
categoryId

Responses​

List response

application/json
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"
}
]
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

cURL
JavaScript
PHP
Python

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

Parameters​

Path Parameters

assignmentEventId*
Typeinteger
Required
Format"int32"

Request Body​

multipart/form-data
object
Format"binary"

Responses​

AssignmentEvent upload found

application/json
JSON
{
"id": 0,
"mimeType": "string",
"fileSize": 0,
"fileName": "string",
"description": "string",
"downloadUrl": "string",
"categoryId": 0,
"createdAt": "string",
"updatedAt": "string",
"assignmentEventId": 0,
"additionalProperties": "string"
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​

cURL
JavaScript
PHP
Python

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

Parameters​

Path Parameters

assignmentEventId*
Typeinteger
Required
Format"int32"
uploadId*
Typeinteger
Required
Format"int32"

Responses​

AssignmentEvent upload found

application/json
JSON
{
"id": 0,
"mimeType": "string",
"fileSize": 0,
"fileName": "string",
"description": "string",
"downloadUrl": "string",
"categoryId": 0,
"createdAt": "string",
"updatedAt": "string",
"assignmentEventId": 0,
"additionalProperties": "string"
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

cURL
JavaScript
PHP
Python

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

Parameters​

Path Parameters

assignmentEventId*
Typeinteger
Required
Format"int32"
uploadId*
Typeinteger
Required
Format"int32"

Responses​

Successfully removed

Playground​

Server
Authorization
Variables
Key
Value

Samples​

cURL
JavaScript
PHP
Python

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

Parameters​

Path Parameters

assignmentEventId*
Typeinteger
Required
Format"int32"
uploadId*
Typeinteger
Required
Format"int32"

Request Body​

application/json
JSON
{
"description": "string",
"categoryId": 0,
"fileName": "string"
}

Responses​

AssignmentEvent upload found

application/json
JSON
{
"id": 0,
"mimeType": "string",
"fileSize": 0,
"fileName": "string",
"description": "string",
"downloadUrl": "string",
"categoryId": 0,
"createdAt": "string",
"updatedAt": "string",
"assignmentEventId": 0,
"additionalProperties": "string"
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​

cURL
JavaScript
PHP
Python

List all uploads for an assignment event​

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

List all uploads for a specific assignment event.

Authorizations​

apiKey
TypeHTTP (bearer)

Parameters​

Path Parameters

assignmentEventId*
Typeinteger
Required
Format"int32"

Query Parameters

page
Typenumber
Minimum0
Default0
size
Typenumber
Minimum1
Maximum20
Default10
id
categoryId

Responses​

List response

application/json
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"
}
]
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

cURL
JavaScript
PHP
Python

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

Parameters​

Path Parameters

assignmentEventId*
Typeinteger
Required
Format"int32"

Request Body​

multipart/form-data
object
Format"binary"

Responses​

AssignmentEvent upload found

application/json
JSON
{
"id": 0,
"mimeType": "string",
"fileSize": 0,
"fileName": "string",
"description": "string",
"downloadUrl": "string",
"categoryId": 0,
"createdAt": "string",
"updatedAt": "string",
"assignmentEventId": 0,
"additionalProperties": "string"
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​

cURL
JavaScript
PHP
Python

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

Parameters​

Path Parameters

assignmentEventId*
Typeinteger
Required
Format"int32"
uploadId*
Typeinteger
Required
Format"int32"

Responses​

AssignmentEvent upload found

application/json
JSON
{
"id": 0,
"mimeType": "string",
"fileSize": 0,
"fileName": "string",
"description": "string",
"downloadUrl": "string",
"categoryId": 0,
"createdAt": "string",
"updatedAt": "string",
"assignmentEventId": 0,
"additionalProperties": "string"
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

cURL
JavaScript
PHP
Python

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

Parameters​

Path Parameters

assignmentEventId*
Typeinteger
Required
Format"int32"
uploadId*
Typeinteger
Required
Format"int32"

Responses​

Successfully removed

Playground​

Server
Authorization
Variables
Key
Value

Samples​

cURL
JavaScript
PHP
Python

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

Parameters​

Path Parameters

assignmentEventId*
Typeinteger
Required
Format"int32"
uploadId*
Typeinteger
Required
Format"int32"

Request Body​

application/json
JSON
{
"description": "string",
"categoryId": 0,
"fileName": "string"
}

Responses​

AssignmentEvent upload found

application/json
JSON
{
"id": 0,
"mimeType": "string",
"fileSize": 0,
"fileName": "string",
"description": "string",
"downloadUrl": "string",
"categoryId": 0,
"createdAt": "string",
"updatedAt": "string",
"assignmentEventId": 0,
"additionalProperties": "string"
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​

cURL
JavaScript
PHP
Python