Polygon Department

GetById

GET/production-api/polygondepartment/getbyid

Retrieve a ProductionPolygonDepartment by its ID

Authorization

Bearer

AuthorizationBearer <token>

Access Token used to access this API (JWT bearer token).

In: header

Query Parameters

id*integer

The ID of the desired ProductionPolygonDepartment

Response Body

`application/json`

curl -X GET "https://example.com/production-api/polygondepartment/getbyid?id=0"

{  "id": 0,  "startAt": "2019-08-24T14:15:22Z",  "finishAt": "2019-08-24T14:15:22Z",  "deliverAt": "2019-08-24T14:15:22Z",  "productionValue": 0,  "productionPolygonId": 0,  "productionDepartmentId": 0,  "productionPackageId": 0}

Empty

GetByDepartment

GET/production-api/polygondepartment/getbydepartment

Retrieve all ProductionPolygonDepartment belonging to a specific ProductionDepartment

Authorization

Bearer

AuthorizationBearer <token>

Access Token used to access this API (JWT bearer token).

In: header

Query Parameters

productionDepartmentId*integer

The ID of the ProductionDepartment

Response Body

`application/json`

curl -X GET "https://example.com/production-api/polygondepartment/getbydepartment?productionDepartmentId=0"

[  {    "id": 0,    "startAt": "2019-08-24T14:15:22Z",    "finishAt": "2019-08-24T14:15:22Z",    "deliverAt": "2019-08-24T14:15:22Z",    "productionValue": 0,    "productionPolygonId": 0,    "productionDepartmentId": 0,    "productionPackageId": 0  }]

Empty

GetByPolygon

GET/production-api/polygondepartment/getbypolygon

Retrieve all ProductionPolygonDepartment belonging to a specific ProductionPolygon

Authorization

Bearer

AuthorizationBearer <token>

Access Token used to access this API (JWT bearer token).

In: header

Query Parameters

productionPolygonId*integer

The ID of the ProductionPolygon

Response Body

`application/json`

curl -X GET "https://example.com/production-api/polygondepartment/getbypolygon?productionPolygonId=0"

[  {    "id": 0,    "startAt": "2019-08-24T14:15:22Z",    "finishAt": "2019-08-24T14:15:22Z",    "deliverAt": "2019-08-24T14:15:22Z",    "productionValue": 0,    "productionPolygonId": 0,    "productionDepartmentId": 0,    "productionPackageId": 0  }]

Empty

Create

PUT/production-api/polygondepartment/create

Creates a new ProductionPolygonDepartment

Authorization

Bearer

AuthorizationBearer <token>

Access Token used to access this API (JWT bearer token).

In: header

Request Body

The desired ProductionPolygonDepartment

TypeScript Definitions

Use the request body type in TypeScript.

id?integer

The ProductionPolygonDepartment ID, should not be set when creating a new instance

startAt?string

The DateTime on which the attached polygon has entered the department

finishAt?|

Optional DateTime indicating when the polygon will finished in the department

deliverAt?|

Optional DateTime indicating when the polygon will be delivered

productionValue?|

Optional float value indicating the amount of "work" that is required for the polygon

productionPolygonId?integer

The attached ProductionPolygon ID

productionDepartmentId?integer

The attached ProductionDepartment ID

productionPackageId?|

Optional ProductionPackage ID that the polygon will use when entering the department

Response Body

`application/json`

curl -X PUT "https://example.com/production-api/polygondepartment/create" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": 0,  "startAt": "2019-08-24T14:15:22Z",  "finishAt": "2019-08-24T14:15:22Z",  "deliverAt": "2019-08-24T14:15:22Z",  "productionValue": 0,  "productionPolygonId": 0,  "productionDepartmentId": 0,  "productionPackageId": 0}

Empty

Update

PATCH/production-api/polygondepartment/update

Updates an existing ProductionPolygonDepartment

Authorization

Bearer

AuthorizationBearer <token>

Access Token used to access this API (JWT bearer token).

In: header

Request Body

The updated ProductionPolygonDepartment model

TypeScript Definitions

Use the request body type in TypeScript.

id?integer

The ProductionPolygonDepartment ID, should not be set when creating a new instance

startAt?string

The DateTime on which the attached polygon has entered the department

finishAt?|

Optional DateTime indicating when the polygon will finished in the department

deliverAt?|

Optional DateTime indicating when the polygon will be delivered

productionValue?|

Optional float value indicating the amount of "work" that is required for the polygon

productionPolygonId?integer

The attached ProductionPolygon ID

productionDepartmentId?integer

The attached ProductionDepartment ID

productionPackageId?|

Optional ProductionPackage ID that the polygon will use when entering the department

Response Body

`application/json`

curl -X PATCH "https://example.com/production-api/polygondepartment/update" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": 0,  "startAt": "2019-08-24T14:15:22Z",  "finishAt": "2019-08-24T14:15:22Z",  "deliverAt": "2019-08-24T14:15:22Z",  "productionValue": 0,  "productionPolygonId": 0,  "productionDepartmentId": 0,  "productionPackageId": 0}

Empty

Delete

DELETE/production-api/polygondepartment/delete

Deletes an existing ProductionPolygonDepartment

Authorization

Bearer

AuthorizationBearer <token>

Access Token used to access this API (JWT bearer token).

In: header

Query Parameters

id*integer

The ProductionPolygonDepartment ID

Response Body

curl -X DELETE "https://example.com/production-api/polygondepartment/delete?id=0"

Empty

200application/json

401

404

200application/json

401

200application/json

401

200application/json

400

401

200application/json

400

401

200

401

404

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`