Artesa API

Appearance

OpenAPI Spec​

GET
/v2/assignments/spec

Get OpenAPI 3.1.0 spec for Assignment API

Responses​

Returns OpenAPI 3.1.0 spec for Assignment API

application/json
JSON
{
}

Playground​

Samples​

List Assignments​

GET
/v2/assignments

List Assignments

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
customerUuid
projectUuid
typeUuid
responsibleUserUuid
statusUuid
name
number
externalId
createdAt
updatedAt

Responses​

List response

application/json
JSON
{
  
"page": 0,
  
"pages": 0,
  
"size": 10,
  
"items": [
  
  
{
  
  
  
"uuid": "string",
  
  
  
"number": "string",
  
  
  
"name": "string",
  
  
  
"comment": "string",
  
  
  
"notesBackOffice": "string",
  
  
  
"color": "string",
  
  
  
"address": {
  
  
  
  
"link": "string",
  
  
  
  
"supplement": "string",
  
  
  
  
"street": "string",
  
  
  
  
"clarification": "string",
  
  
  
  
"zip": "string",
  
  
  
  
"city": "string",
  
  
  
  
"state": "string",
  
  
  
  
"country": "string",
  
  
  
  
"externalId": "string",
  
  
  
  
"latitude": 0,
  
  
  
  
"longitude": 0
  
  
  
},
  
  
  
"customerUuid": "string",
  
  
  
"projectUuid": "string",
  
  
  
"typeUuid": "string",
  
  
  
"responsibleUserUuid": "string",
  
  
  
"statusUuid": "string",
  
  
  
"externalId": "string",
  
  
  
"createdAt": "string",
  
  
  
"updatedAt": "string"
  
  
}
  
]
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Create a new Assignment​

POST
/v2/assignments

Create a new Assignment

Authorizations​

apiKey
Type
HTTP (bearer)

Request Body​

application/json
JSON
{
  
"uuid": "string",
  
"number": null,
  
"name": null,
  
"comment": null,
  
"notesBackOffice": null,
  
"color": null,
  
"address": {
  
  
"link": "string"
  
},
  
"customerUuid": "string",
  
"projectUuid": "string",
  
"typeUuid": "string",
  
"responsibleUserUuid": "string",
  
"statusUuid": "string",
  
"externalId": null
}

Responses​

Assignment found

application/json
JSON
{
  
"uuid": "string",
  
"number": "string",
  
"name": "string",
  
"comment": "string",
  
"notesBackOffice": "string",
  
"color": "string",
  
"address": {
  
  
"link": "string",
  
  
"supplement": "string",
  
  
"street": "string",
  
  
"clarification": "string",
  
  
"zip": "string",
  
  
"city": "string",
  
  
"state": "string",
  
  
"country": "string",
  
  
"externalId": "string",
  
  
"latitude": 0,
  
  
"longitude": 0
  
},
  
"customerUuid": "string",
  
"projectUuid": "string",
  
"typeUuid": "string",
  
"responsibleUserUuid": "string",
  
"statusUuid": "string",
  
"externalId": "string",
  
"createdAt": "string",
  
"updatedAt": "string"
}

Playground​

Server
Authorization
Body

Samples​

Get an Assignment​

GET
/v2/assignments/{assignmentUuid}

Get an Assignment by ID

Authorizations​

apiKey
Type
HTTP (bearer)

Parameters​

Path Parameters

assignmentUuid*
Type
string
Required
Format
"uuid"

Responses​

Assignment found

application/json
JSON
{
  
"uuid": "string",
  
"number": "string",
  
"name": "string",
  
"comment": "string",
  
"notesBackOffice": "string",
  
"color": "string",
  
"address": {
  
  
"link": "string",
  
  
"supplement": "string",
  
  
"street": "string",
  
  
"clarification": "string",
  
  
"zip": "string",
  
  
"city": "string",
  
  
"state": "string",
  
  
"country": "string",
  
  
"externalId": "string",
  
  
"latitude": 0,
  
  
"longitude": 0
  
},
  
"customerUuid": "string",
  
"projectUuid": "string",
  
"typeUuid": "string",
  
"responsibleUserUuid": "string",
  
"statusUuid": "string",
  
"externalId": "string",
  
"createdAt": "string",
  
"updatedAt": "string"
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Delete an Assignment​

DELETE
/v2/assignments/{assignmentUuid}

Delete an Assignment by ID

Authorizations​

apiKey
Type
HTTP (bearer)

Parameters​

Path Parameters

assignmentUuid*
Type
string
Required
Format
"uuid"

Responses​

Successfully removed

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Update an Assignment​

PATCH
/v2/assignments/{assignmentUuid}

Update an Assignment by ID

Authorizations​

apiKey
Type
HTTP (bearer)

Parameters​

Path Parameters

assignmentUuid*
Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
{
  
"number": "string",
  
"name": "string",
  
"comment": "string",
  
"notesBackOffice": "string",
  
"color": "string",
  
"address": {
  
  
"link": "string"
  
},
  
"customerUuid": "string",
  
"projectUuid": "string",
  
"typeUuid": "string",
  
"responsibleUserUuid": "string",
  
"statusUuid": "string",
  
"externalId": "string"
}

Responses​

Assignment found

application/json
JSON
{
  
"uuid": "string",
  
"number": "string",
  
"name": "string",
  
"comment": "string",
  
"notesBackOffice": "string",
  
"color": "string",
  
"address": {
  
  
"link": "string",
  
  
"supplement": "string",
  
  
"street": "string",
  
  
"clarification": "string",
  
  
"zip": "string",
  
  
"city": "string",
  
  
"state": "string",
  
  
"country": "string",
  
  
"externalId": "string",
  
  
"latitude": 0,
  
  
"longitude": 0
  
},
  
"customerUuid": "string",
  
"projectUuid": "string",
  
"typeUuid": "string",
  
"responsibleUserUuid": "string",
  
"statusUuid": "string",
  
"externalId": "string",
  
"createdAt": "string",
  
"updatedAt": "string"
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​

List AssignmentUploads​

GET
/v2/assignments/{assignmentUuid}/uploads

List every file on the assignment: its own and those of its events, event groups and forms. An event's files are also listed under its /v2/assignment-events/{assignmentEventUuid}/uploads. Get, update and delete take any of them.

Authorizations​

apiKey
Type
HTTP (bearer)

Parameters​

Path Parameters

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

application/json
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",
  
  
  
"assignmentUuid": "string"
  
  
}
  
]
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Create a new AssignmentUpload​

POST
/v2/assignments/{assignmentUuid}/uploads

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

Authorizations​

apiKey
Type
HTTP (bearer)

Parameters​

Path Parameters

assignmentUuid*
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​

Assignment upload found

application/json
JSON
{
  
"uuid": "string",
  
"mimeType": "string",
  
"fileSize": 0,
  
"fileName": "string",
  
"description": "string",
  
"downloadUrl": "string",
  
"categoryUuid": "string",
  
"createdAt": "string",
  
"updatedAt": "string",
  
"assignmentUuid": "string"
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​

Get an AssignmentUpload​

GET
/v2/assignments/{assignmentUuid}/uploads/{uploadUuid}

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

Authorizations​

apiKey
Type
HTTP (bearer)

Parameters​

Path Parameters

assignmentUuid*
Type
string
Required
Format
"uuid"
uploadUuid*
Type
string
Required
Format
"uuid"

Responses​

Assignment upload found

application/json
JSON
{
  
"uuid": "string",
  
"mimeType": "string",
  
"fileSize": 0,
  
"fileName": "string",
  
"description": "string",
  
"downloadUrl": "string",
  
"categoryUuid": "string",
  
"createdAt": "string",
  
"updatedAt": "string",
  
"assignmentUuid": "string"
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Delete an AssignmentUpload​

DELETE
/v2/assignments/{assignmentUuid}/uploads/{uploadUuid}

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

Authorizations​

apiKey
Type
HTTP (bearer)

Parameters​

Path Parameters

assignmentUuid*
Type
string
Required
Format
"uuid"
uploadUuid*
Type
string
Required
Format
"uuid"

Responses​

Successfully removed

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Update an AssignmentUpload​

PATCH
/v2/assignments/{assignmentUuid}/uploads/{uploadUuid}

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

Authorizations​

apiKey
Type
HTTP (bearer)

Parameters​

Path Parameters

assignmentUuid*
Type
string
Required
Format
"uuid"
uploadUuid*
Type
string
Required
Format
"uuid"

Request Body​

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

Responses​

Assignment upload found

application/json
JSON
{
  
"uuid": "string",
  
"mimeType": "string",
  
"fileSize": 0,
  
"fileName": "string",
  
"description": "string",
  
"downloadUrl": "string",
  
"categoryUuid": "string",
  
"createdAt": "string",
  
"updatedAt": "string",
  
"assignmentUuid": "string"
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​

List AssignmentUploads​

GET
/v2/assignments/{assignmentUuid}/uploads

List every file on the assignment: its own and those of its events, event groups and forms. An event's files are also listed under its /v2/assignment-events/{assignmentEventUuid}/uploads. Get, update and delete take any of them.

Authorizations​

apiKey
Type
HTTP (bearer)

Parameters​

Path Parameters

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

application/json
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",
  
  
  
"assignmentUuid": "string"
  
  
}
  
]
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Create a new AssignmentUpload​

POST
/v2/assignments/{assignmentUuid}/uploads

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

Authorizations​

apiKey
Type
HTTP (bearer)

Parameters​

Path Parameters

assignmentUuid*
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​

Assignment upload found

application/json
JSON
{
  
"uuid": "string",
  
"mimeType": "string",
  
"fileSize": 0,
  
"fileName": "string",
  
"description": "string",
  
"downloadUrl": "string",
  
"categoryUuid": "string",
  
"createdAt": "string",
  
"updatedAt": "string",
  
"assignmentUuid": "string"
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​

Get an AssignmentUpload​

GET
/v2/assignments/{assignmentUuid}/uploads/{uploadUuid}

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

Authorizations​

apiKey
Type
HTTP (bearer)

Parameters​

Path Parameters

assignmentUuid*
Type
string
Required
Format
"uuid"
uploadUuid*
Type
string
Required
Format
"uuid"

Responses​

Assignment upload found

application/json
JSON
{
  
"uuid": "string",
  
"mimeType": "string",
  
"fileSize": 0,
  
"fileName": "string",
  
"description": "string",
  
"downloadUrl": "string",
  
"categoryUuid": "string",
  
"createdAt": "string",
  
"updatedAt": "string",
  
"assignmentUuid": "string"
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Delete an AssignmentUpload​

DELETE
/v2/assignments/{assignmentUuid}/uploads/{uploadUuid}

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

Authorizations​

apiKey
Type
HTTP (bearer)

Parameters​

Path Parameters

assignmentUuid*
Type
string
Required
Format
"uuid"
uploadUuid*
Type
string
Required
Format
"uuid"

Responses​

Successfully removed

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Update an AssignmentUpload​

PATCH
/v2/assignments/{assignmentUuid}/uploads/{uploadUuid}

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

Authorizations​

apiKey
Type
HTTP (bearer)

Parameters​

Path Parameters

assignmentUuid*
Type
string
Required
Format
"uuid"
uploadUuid*
Type
string
Required
Format
"uuid"

Request Body​

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

Responses​

Assignment upload found

application/json
JSON
{
  
"uuid": "string",
  
"mimeType": "string",
  
"fileSize": 0,
  
"fileName": "string",
  
"description": "string",
  
"downloadUrl": "string",
  
"categoryUuid": "string",
  
"createdAt": "string",
  
"updatedAt": "string",
  
"assignmentUuid": "string"
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​

Copyright © Artesa GmbH