Assignment

Assignments hold all information about the assignment/order/job.

Operations

GET/v1/assignments/specGET/v1/assignmentsPOST/v1/assignmentsGET/v1/assignments/{assignmentId}DELETE/v1/assignments/{assignmentId}PATCH/v1/assignments/{assignmentId}

---

OpenAPI Spec

GET

/v1/assignments/spec

Get OpenAPI 3.1.0 spec for Assignment API

Responses

The spec itself as json

Content-Type

application/json

{

}

GET

/v1/assignments/spec

Playground

Samples

cURL

JavaScript

PHP

Python

---

List Assignments

GET

/v1/assignments

List Assignments

Authorizations

apiKey

TypeHTTP (bearer)

Parameters

Query Parameters

page

Typenumber

minimum0

default0

size

Typenumber

minimum1

maximum20

default10

name

number

customerId

projectId

typeId

externalId

createdAt

updatedAt

Responses

List response

Content-Type

application/json

{

"page": 0,

"pages": 0,

"size": 10,

"items": [

{

"id": 0,

"number": "string",

"name": "string",

"comment": "string",

"notesBackOffice": "string",

"color": "string",

"address": {

"supplement": "string",

"street": "string",

"clarification": "string",

"zip": "string",

"city": "string",

"state": "string",

"country": "string",

"latitude": 0,

"longitude": 0,

"externalId": "string"

},

"customerId": 0,

"projectId": 0,

"typeId": 0,

"externalId": "string",

"createdAt": "string",

"updatedAt": "string"

}

]

}

GET

/v1/assignments

Playground

Server

Authorization

apiKey

Variables

Key

Value

page

size

name

number

customerId

projectId

typeId

externalId

createdAt

updatedAt

Samples

cURL

JavaScript

PHP

Python

---

Create a new Assignment

POST

/v1/assignments

Create a new Assignment

Authorizations

apiKey

TypeHTTP (bearer)

Request Body

application/json

{

"number": null,

"name": null,

"comment": null,

"notesBackOffice": null,

"color": null,

"address": {

"supplement": null,

"street": null,

"clarification": null,

"zip": null,

"city": null,

"state": null,

"country": null,

"externalId": null

},

"customerId": null,

"projectId": null,

"typeId": null,

"externalId": null

}

Responses

Assignment found

Content-Type

application/json

{

"id": 0,

"number": "string",

"name": "string",

"comment": "string",

"notesBackOffice": "string",

"color": "string",

"address": {

"supplement": "string",

"street": "string",

"clarification": "string",

"zip": "string",

"city": "string",

"state": "string",

"country": "string",

"latitude": 0,

"longitude": 0,

"externalId": "string"

},

"customerId": 0,

"projectId": 0,

"typeId": 0,

"externalId": "string",

"createdAt": "string",

"updatedAt": "string"

}

POST

/v1/assignments

Playground

Server

Authorization

apiKey

Body

Samples

cURL

JavaScript

PHP

Python

---

Get an Assignment

GET

/v1/assignments/{assignmentId}

Get an Assignment by ID

Authorizations

apiKey

TypeHTTP (bearer)

Parameters

Path Parameters

assignmentId*

Typeinteger

Required

formatint32

Responses

Assignment found

Content-Type

application/json

{

"id": 0,

"number": "string",

"name": "string",

"comment": "string",

"notesBackOffice": "string",

"color": "string",

"address": {

"supplement": "string",

"street": "string",

"clarification": "string",

"zip": "string",

"city": "string",

"state": "string",

"country": "string",

"latitude": 0,

"longitude": 0,

"externalId": "string"

},

"customerId": 0,

"projectId": 0,

"typeId": 0,

"externalId": "string",

"createdAt": "string",

"updatedAt": "string"

}

GET

/v1/assignments/{assignmentId}

Playground

Server

Authorization

apiKey

Variables

Key

Value

assignmentId*

Samples

cURL

JavaScript

PHP

Python

---

Delete an Assignment

DELETE

/v1/assignments/{assignmentId}

Delete an Assignment by ID

Authorizations

apiKey

TypeHTTP (bearer)

Parameters

Path Parameters

assignmentId*

Typeinteger

Required

formatint32

Responses

Successfully removed

DELETE

/v1/assignments/{assignmentId}

Playground

Server

Authorization

apiKey

Variables

Key

Value

assignmentId*

Samples

cURL

JavaScript

PHP

Python

---

Update an Assignment

PATCH

/v1/assignments/{assignmentId}

Update an Assignment by ID

Authorizations

apiKey

TypeHTTP (bearer)

Parameters

Path Parameters

assignmentId*

Typeinteger

Required

formatint32

Request Body

application/json

{

"number": "string",

"name": "string",

"comment": "string",

"notesBackOffice": "string",

"color": "string",

"address": {

"supplement": "string",

"street": "string",

"clarification": "string",

"zip": "string",

"city": "string",

"state": "string",

"country": "string",

"externalId": "string"

},

"customerId": 0,

"projectId": 0,

"typeId": 0,

"externalId": "string"

}

Responses

Assignment found

Content-Type

application/json

{

"id": 0,

"number": "string",

"name": "string",

"comment": "string",

"notesBackOffice": "string",

"color": "string",

"address": {

"supplement": "string",

"street": "string",

"clarification": "string",

"zip": "string",

"city": "string",

"state": "string",

"country": "string",

"latitude": 0,

"longitude": 0,

"externalId": "string"

},

"customerId": 0,

"projectId": 0,

"typeId": 0,

"externalId": "string",

"createdAt": "string",

"updatedAt": "string"

}

PATCH

/v1/assignments/{assignmentId}

Playground

Server

Authorization

apiKey

Variables

Key

Value

assignmentId*

Body

Samples

cURL

JavaScript

PHP

Python

---