Plant

Operations

GET/plantsGET/plants/countGET/plants/findOneGET/plants/{id}GET/plants/{id}/divisionsGET/plants/{id}/divisions/countGET/plants/{id}/divisions/{fk}GET/plants/{id}/employeeManagersGET/plants/{id}/employeeManagers/countGET/plants/{id}/employeeManagers/{fk}GET/plants/{id}/existsGET/plants/{id}/plantAddressDetailsGET/plants/{id}/plantRegion

---

GET /plants

GET

/plants

Find all instances of the model matched by filter from the data source.

Parameters

Query Parameters

filter

Filter defining fields, where, include, order, offset, and limit

Typestring

Responses

Request was successful

Content-Type

application/json

[

{

"number": "string",

"description": "string",

"address": "string",

"region": {

},

"location": "string",

"radius": 100,

"dvirEmails": [

"string"

],

"timeZone": "string",

"id": "string",

"companyId": "string",

"createdAt": "string",

"updatedAt": "string",

"plantRegionId": "string",

"addressDetails": "string"

}

]

GET

/plants

Playground

Variables

Key

Value

filter

Samples

cURL

JavaScript

PHP

Python

---

GET /plants/count

GET

/plants/count

Count instances of the model matched by where from the data source.

Parameters

Query Parameters

where

Criteria to match model instances

Typestring

Responses

Request was successful

Content-Type

application/json

{

"count": 0

}

GET

/plants/count

Playground

Variables

Key

Value

where

Samples

cURL

JavaScript

PHP

Python

---

GET /plants/findOne

GET

/plants/findOne

Find first instance of the model matched by filter from the data source.

Parameters

Query Parameters

filter

Filter defining fields, where, include, order, offset, and limit

Typestring

Responses

Request was successful

Content-Type

application/json

{

"number": "string",

"description": "string",

"address": "string",

"region": {

},

"location": "string",

"radius": 100,

"dvirEmails": [

"string"

],

"timeZone": "string",

"id": "string",

"companyId": "string",

"createdAt": "string",

"updatedAt": "string",

"plantRegionId": "string",

"addressDetails": "string"

}

GET

/plants/findOne

Playground

Variables

Key

Value

filter

Samples

cURL

JavaScript

PHP

Python

---

GET /plants/{id}

GET

/plants/{id}

Find a model instance by {{id}} from the data source.

Parameters

Path Parameters

id*

Model id

Typestring

Required

Query Parameters

filter

Filter defining fields and include

Typestring

Responses

Request was successful

Content-Type

application/json

{

"number": "string",

"description": "string",

"address": "string",

"region": {

},

"location": "string",

"radius": 100,

"dvirEmails": [

"string"

],

"timeZone": "string",

"id": "string",

"companyId": "string",

"createdAt": "string",

"updatedAt": "string",

"plantRegionId": "string",

"addressDetails": "string"

}

GET

/plants/{id}

Playground

Variables

Key

Value

id*

filter

Samples

cURL

JavaScript

PHP

Python

---

GET /plants/{id}/divisions

GET

/plants/{id}/divisions

Queries divisions of Plant.

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

filter

Typestring

Responses

Request was successful

Content-Type

application/json

[

{

"name": "string",

"code": "string",

"externalId": "string",

"id": "string",

"parentId": "string",

"companyId": "string",

"createdAt": "string",

"updatedAt": "string"

}

]

GET

/plants/{id}/divisions

Playground

Variables

Key

Value

id*

filter

Samples

cURL

JavaScript

PHP

Python

---

GET /plants/{id}/divisions/count

GET

/plants/{id}/divisions/count

Counts divisions of Plant.

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

where

Criteria to match model instances

Typestring

Responses

Request was successful

Content-Type

application/json

{

"count": 0

}

GET

/plants/{id}/divisions/count

Playground

Variables

Key

Value

id*

where

Samples

cURL

JavaScript

PHP

Python

---

GET /plants/{id}/divisions/{fk}

GET

/plants/{id}/divisions/{fk}

Find a related item by id for divisions.

Parameters

Path Parameters

fk*

Foreign key for divisions

Typestring

Required

id*

PersistedModel id

Typestring

Required

Responses

Request was successful

Content-Type

application/json

{

"name": "string",

"code": "string",

"externalId": "string",

"id": "string",

"parentId": "string",

"companyId": "string",

"createdAt": "string",

"updatedAt": "string"

}

GET

/plants/{id}/divisions/{fk}

Playground

Variables

Key

Value

fk*

id*

Samples

cURL

JavaScript

PHP

Python

---

GET /plants/{id}/employeeManagers

GET

/plants/{id}/employeeManagers

Queries employeeManagers of Plant.

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

filter

Typestring

Responses

Request was successful

Content-Type

application/json

[

{

"name": "string",

"number": "string",

"email": "string",

"phoneNumber": "string",

"type": "regular",

"clockInAllowedAt": "string",

"hireDate": "string",

"active": true,

"externalId": "string",

"receivesLateClockInNotifications": true,

"id": "string",

"companyId": "string",

"divisionId": "string",

"plantId": "string",

"truckId": "string",

"createdAt": "string",

"updatedAt": "string",

"typeId": "string",

"timeCategoryIds": [

"string"

],

"defaultTimeCategoryId": "string"

}

]

GET

/plants/{id}/employeeManagers

Playground

Variables

Key

Value

id*

filter

Samples

cURL

JavaScript

PHP

Python

---

GET /plants/{id}/employeeManagers/count

GET

/plants/{id}/employeeManagers/count

Counts employeeManagers of Plant.

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

where

Criteria to match model instances

Typestring

Responses

Request was successful

Content-Type

application/json

{

"count": 0

}

GET

/plants/{id}/employeeManagers/count

Playground

Variables

Key

Value

id*

where

Samples

cURL

JavaScript

PHP

Python

---

GET /plants/{id}/employeeManagers/{fk}

GET

/plants/{id}/employeeManagers/{fk}

Find a related item by id for employeeManagers.

Parameters

Path Parameters

fk*

Foreign key for employeeManagers

Typestring

Required

id*

PersistedModel id

Typestring

Required

Responses

Request was successful

Content-Type

application/json

{

"name": "string",

"number": "string",

"email": "string",

"phoneNumber": "string",

"type": "regular",

"clockInAllowedAt": "string",

"hireDate": "string",

"active": true,

"externalId": "string",

"receivesLateClockInNotifications": true,

"id": "string",

"companyId": "string",

"divisionId": "string",

"plantId": "string",

"truckId": "string",

"createdAt": "string",

"updatedAt": "string",

"typeId": "string",

"timeCategoryIds": [

"string"

],

"defaultTimeCategoryId": "string"

}

GET

/plants/{id}/employeeManagers/{fk}

Playground

Variables

Key

Value

fk*

id*

Samples

cURL

JavaScript

PHP

Python

---

GET /plants/{id}/exists

GET

/plants/{id}/exists

Check whether a model instance exists in the data source.

Parameters

Path Parameters

id*

Model id

Typestring

Required

Responses

Request was successful

Content-Type

application/json

{

"exists": true

}

GET

/plants/{id}/exists

Playground

Variables

Key

Value

id*

Samples

cURL

JavaScript

PHP

Python

---

GET /plants/{id}/plantAddressDetails

GET

/plants/{id}/plantAddressDetails

Fetches hasOne relation plantAddressDetails.

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

refresh

Typeboolean

Responses

Request was successful

Content-Type

application/json

{

"streetAddress": "string",

"city": "string",

"state": "string",

"zipcode": "string",

"id": "string"

}

GET

/plants/{id}/plantAddressDetails

Playground

Variables

Key

Value

id*

refresh

Samples

cURL

JavaScript

PHP

Python

---

GET /plants/{id}/plantRegion

GET

/plants/{id}/plantRegion

Fetches belongsTo relation plantRegion.

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

refresh

Typeboolean

Responses

Request was successful

Content-Type

application/json

{

"name": "string",

"description": "string",

"id": "string",

"companyId": "string",

"plantIds": [

"string"

],

"createdAt": "string",

"updatedAt": "string"

}

GET

/plants/{id}/plantRegion

Playground

Variables

Key

Value

id*

refresh

Samples

cURL

JavaScript

PHP

Python

---