Jovix API API Reference
Provides ability to track and monitor Material Readiness in the Jovix product.
API Endpoint
https://server_address/jovixSchemes: https
Version: v1
Attachments
GET /api/v1/attachments/{id}/file
Gets the attachment file.
id
(no description)
type
integer
(int32)
in
path
200 OK
OK
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
"object"
Authentication
GET /api/v1/token
This request authenticates the user and returns an access token for use in authenticated calls to the Jovix API.
The client is authenticated by means of an Authorization header included in the request. There are two authentication schemes supported:
- The 'Basic' scheme must be used for initial authentication. Credentials should be formatted as usual for basic authentication. (
https://en.wikipedia.org/wiki/Basic_access_authentication)
- The 'Bearer' scheme should be used with subsequent requests to refresh a token that has expired or is nearing expiration. This scheme requires a JSON Web Token token on the Authorization header. Using a token helps minimize the transmission of user credentials over the network. (
https://en.wikipedia.org/wiki/JSON_Web_Token)
If the user is successfully authenticated, the response will be an object containing both an access token and a refresh token.
If the passed credentials or refresh token are not valid for any reason, then the response will be a 401.
OK
401 Unauthorized
Unauthorized
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"accessToken": "string",
"refreshToken": "string"
}
Catalog Items
GET /api/v1/catalog-items
Gets a list of catalog items that meet the specified filter criteria.
Available Filter Operator(s):
- Exact Match ==
- Starts With =^
- Contains =@
Filter(s) using ==, =^, =@:
- name
- description
- shortDescription
Filter(s) using ==:
- projectId
- materialTypeId
- disciplineId
filter
(no description)
type
string
in
query
page
(no description)
type
integer
(int32)
in
query
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"centerOfGravity": "string",
"description": "string",
"notes": "string",
"size": "string",
"shortDescription": "string",
"specializedTrailer": "boolean",
"tagNumber": "string",
"volume": "string",
"length": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"width": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"height": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"weight": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"discipline": {
"id": "integer (int32)",
"name": "string"
},
"materialType": {
"id": "integer (int32)",
"name": "string"
},
"project": {
"id": "integer (int32)",
"name": "string"
},
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
},
"customField_1": "string",
"customField_2": "string",
"customField_3": "string",
"customField_4": "string",
"customField_5": "string",
"customField_6": "string",
"customField_7": "string",
"customField_8": "string",
"customField_9": "string",
"customField_10": "string",
"customField_11": "string",
"customField_12": "string",
"customField_13": "string",
"customField_14": "string",
"customField_15": "string",
"customField_16": "string",
"customField_17": "string",
"customField_18": "string",
"customField_19": "string",
"customField_20": "string",
"customField_21": "string",
"customField_22": "string",
"customField_23": "string",
"customField_24": "string",
"customField_25": "string",
"customField_26": "string",
"customField_27": "string",
"customField_28": "string",
"customField_29": "string",
"customField_30": "string"
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
POST /api/v1/catalog-items
Creates a catalog item with the fields provided.
Required Fields:
- name
- project.id
If length, width, height, or weight is specified, then the associated unitOfMeasure property is required:
- length.unitOfMeasure.Id
- width.unitOfMeasure.Id
- height.unitOfMeasure.Id
- weight.unitOfMeasure.Id
Request Content-Types: application/json, text/json
Request Example
{
"name": "string",
"centerOfGravity": "string",
"description": "string",
"notes": "string",
"shortDescription": "string",
"size": "string",
"tagNumber": "string",
"volume": "string",
"specializedTrailer": "boolean",
"project": {
"id": "integer (int32)"
},
"materialType": {
"id": "integer (int32)"
},
"unitOfMeasure": {
"id": "integer (int32)"
},
"discipline": {
"id": "integer (int32)"
},
"length": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)"
}
},
"width": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)"
}
},
"height": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)"
}
},
"weight": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)"
}
},
"customField_1": "object",
"customField_2": "object",
"customField_3": "object",
"customField_4": "object",
"customField_5": "object",
"customField_6": "object",
"customField_7": "object",
"customField_8": "object",
"customField_9": "object",
"customField_10": "object",
"customField_11": "object",
"customField_12": "object",
"customField_13": "object",
"customField_14": "object",
"customField_15": "object",
"customField_16": "object",
"customField_17": "object",
"customField_18": "object",
"customField_19": "object",
"customField_20": "object",
"customField_21": "object",
"customField_22": "object",
"customField_23": "object",
"customField_24": "object",
"customField_25": "object",
"customField_26": "object",
"customField_27": "object",
"customField_28": "object",
"customField_29": "object",
"customField_30": "object"
}
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"centerOfGravity": "string",
"description": "string",
"notes": "string",
"size": "string",
"shortDescription": "string",
"specializedTrailer": "boolean",
"tagNumber": "string",
"volume": "string",
"length": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"width": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"height": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"weight": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"discipline": {
"id": "integer (int32)",
"name": "string"
},
"materialType": {
"id": "integer (int32)",
"name": "string"
},
"project": {
"id": "integer (int32)",
"name": "string"
},
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
},
"customField_1": "string",
"customField_2": "string",
"customField_3": "string",
"customField_4": "string",
"customField_5": "string",
"customField_6": "string",
"customField_7": "string",
"customField_8": "string",
"customField_9": "string",
"customField_10": "string",
"customField_11": "string",
"customField_12": "string",
"customField_13": "string",
"customField_14": "string",
"customField_15": "string",
"customField_16": "string",
"customField_17": "string",
"customField_18": "string",
"customField_19": "string",
"customField_20": "string",
"customField_21": "string",
"customField_22": "string",
"customField_23": "string",
"customField_24": "string",
"customField_25": "string",
"customField_26": "string",
"customField_27": "string",
"customField_28": "string",
"customField_29": "string",
"customField_30": "string"
}
}
GET /api/v1/catalog-items/{id}
Gets a catalog item with the specified identifier.
id
(no description)
type
integer
(int32)
in
path
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"centerOfGravity": "string",
"description": "string",
"notes": "string",
"size": "string",
"shortDescription": "string",
"specializedTrailer": "boolean",
"tagNumber": "string",
"volume": "string",
"length": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"width": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"height": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"weight": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"discipline": {
"id": "integer (int32)",
"name": "string"
},
"materialType": {
"id": "integer (int32)",
"name": "string"
},
"project": {
"id": "integer (int32)",
"name": "string"
},
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
},
"customField_1": "string",
"customField_2": "string",
"customField_3": "string",
"customField_4": "string",
"customField_5": "string",
"customField_6": "string",
"customField_7": "string",
"customField_8": "string",
"customField_9": "string",
"customField_10": "string",
"customField_11": "string",
"customField_12": "string",
"customField_13": "string",
"customField_14": "string",
"customField_15": "string",
"customField_16": "string",
"customField_17": "string",
"customField_18": "string",
"customField_19": "string",
"customField_20": "string",
"customField_21": "string",
"customField_22": "string",
"customField_23": "string",
"customField_24": "string",
"customField_25": "string",
"customField_26": "string",
"customField_27": "string",
"customField_28": "string",
"customField_29": "string",
"customField_30": "string"
}
}
DELETE /api/v1/catalog-items/{id}
Deletes the catalog item with the specified identifier.
id
(no description)
type
integer
(int32)
in
path
204 No Content
No Content
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
NotFound
409 Conflict
Conflict
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
PATCH /api/v1/catalog-items/{id}
Updates specified values on a catalog item.
Updatable fields:
- materialType
- unitOfMeasure
- description
- shortDescription
- length
- width
- height
- weight
- volume
- centerOfGravity
- size
- specializedTrailer
- discipline
- tagNumber
- notes
- configured custom fields
id
(no description)
type
integer
(int32)
in
path
Request Content-Types: application/json, text/json
Request Example
"object"
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"centerOfGravity": "string",
"description": "string",
"notes": "string",
"size": "string",
"shortDescription": "string",
"specializedTrailer": "boolean",
"tagNumber": "string",
"volume": "string",
"length": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"width": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"height": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"weight": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"discipline": {
"id": "integer (int32)",
"name": "string"
},
"materialType": {
"id": "integer (int32)",
"name": "string"
},
"project": {
"id": "integer (int32)",
"name": "string"
},
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
},
"customField_1": "string",
"customField_2": "string",
"customField_3": "string",
"customField_4": "string",
"customField_5": "string",
"customField_6": "string",
"customField_7": "string",
"customField_8": "string",
"customField_9": "string",
"customField_10": "string",
"customField_11": "string",
"customField_12": "string",
"customField_13": "string",
"customField_14": "string",
"customField_15": "string",
"customField_16": "string",
"customField_17": "string",
"customField_18": "string",
"customField_19": "string",
"customField_20": "string",
"customField_21": "string",
"customField_22": "string",
"customField_23": "string",
"customField_24": "string",
"customField_25": "string",
"customField_26": "string",
"customField_27": "string",
"customField_28": "string",
"customField_29": "string",
"customField_30": "string"
}
}
GET /api/v1/catalog-items/{id}/quantities
Returns the specified quantity for the specified catalog item.
Required Filter(s):
- name (i.e. name=requestable, see: Available Quantities)
- jobId or siteId must be provided. Optionally, both can be provided.
Available Quantities:
- requestable
- requested
- openRequested
- issued
id
(no description)
type
integer
(int32)
in
path
name
(no description)
type
string
in
query
jobId
(no description)
type
string
in
query
siteId
(no description)
type
string
in
query
OK
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"name": "string",
"quantity": "number (double)"
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
GET /api/v1/catalog-items/modified
Returns recently modified catalog items.
since
(no description)
type
string
in
query
pageToken
(no description)
type
string
in
query
limit
(no description)
type
integer
(int32)
in
query
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"pagingToken": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"shortDescription": "string",
"description": "string",
"project": {
"id": "00000000-0000-0000-0000-000000000000"
},
"materialType": {
"id": "integer (int32)"
},
"discipline": {
"id": "integer (int32)"
},
"unitOfMeasure": {
"id": "00000000-0000-0000-0000-000000000000"
},
"lengthUnitOfMeasureID": "00000000-0000-0000-0000-000000000000",
"widthUnitOfMeasureID": "00000000-0000-0000-0000-000000000000",
"heightUnitOfMeasureID": "00000000-0000-0000-0000-000000000000",
"weightUnitOfMeasureID": "00000000-0000-0000-0000-000000000000",
"volume": "string",
"centerOfGravity": "string",
"asmeClassification": "string",
"htsClassification": "string",
"htsDescription": "string",
"hazardousMaterialsClassification": "string",
"hazardousMaterialsDescription": "string",
"storageRequirement": "string",
"safetyClassification": "string",
"handlingInstructions": "string",
"isAssetNumberRequired": "boolean",
"isSerialNumberRequired": "boolean",
"isHeatNumberRequired": "boolean",
"isLotNumberRequired": "boolean",
"isShelfLifeRequired": "boolean",
"isPMRequired": "boolean",
"notes": "string",
"properShippingName": "string",
"isLimitedQuantity": "boolean",
"isMSDSRequired": "boolean",
"size": "string",
"procurementPackage": "string",
"specification": "string",
"isManualHot": "boolean",
"manualHotDate": "string (date-time)",
"manualUnHotDate": "string (date-time)",
"isAssembly": "boolean",
"hasAccessories": "boolean",
"accessoriesCount": "integer (int32)",
"subComponentCount": "integer (int32)",
"totalRequiredMaterialCodeCount": "integer (int32)",
"engineeredQuantity": "number (double)",
"tagNumber": "string",
"isSpecializedTrailerRequired": "boolean",
"length": "number (double)",
"lengthNormalized": "number (double)",
"width": "number (double)",
"widthNormalized": "number (double)",
"height": "number (double)",
"heightNormalized": "number (double)",
"weight": "number (double)",
"weightNormalized": "number (double)",
"loadMethod": "string",
"unloadMethod": "string",
"cF_1": "string",
"cF_2": "string",
"cF_3": "string",
"cF_4": "string",
"cF_5": "string",
"cF_6": "string",
"cF_7": "string",
"cF_8": "string",
"cF_9": "string",
"cF_10": "string",
"cF_11": "string",
"cF_12": "string",
"cF_13": "string",
"cF_14": "string",
"cF_15": "string",
"cF_16": "string",
"cF_17": "string",
"cF_18": "string",
"cF_19": "string",
"cF_20": "string",
"cF_21": "string",
"cF_22": "string",
"cF_23": "string",
"cF_24": "string",
"cF_25": "string",
"cF_26": "string",
"cF_27": "string",
"cF_28": "string",
"cF_29": "string",
"cF_30": "string"
}
]
}
Drawing Items
GET /api/v1/drawing-items
Gets a list of drawing items with the specified filters.
Available Filter Operator(s):
- Exact Match ==
- Starts With =^
- Contains =@
Filter(s) using ==, =^, =@:
- projectName
Filter(s) using ==, =^, =@:
- jobName
Filter(s) using ==, =^, =@:
- drawingName
Filter(s) using ==, =^, =@:
- catalogItemName
filter
(no description)
type
string
in
query
page
(no description)
type
integer
(int32)
in
query
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"quantity": "number (double)",
"site": {
"id": "integer (int32)",
"name": "string"
},
"catalogItem": {
"id": "integer (int32)",
"name": "string"
},
"drawing": {
"id": "integer (int32)",
"name": "string"
}
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Employees
POST /api/v1/employees
Creates a employee with the fields provided.
Required Fields:
- name
- project.id
- firstName
- lastName
Request Content-Types: application/json, text/json
Request Example
{
"name": "string",
"project": {
"id": "integer (int32)"
},
"firstName": "string",
"middleName": "string",
"lastName": "string",
"suffix": "string",
"user": {
"id": "integer (int32)"
},
"company": {
"name": "string"
}
}
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"suffix": "string",
"user": {
"id": "integer (int32)"
},
"company": {
"name": "string"
},
"project": {
"id": "integer (int32)"
}
}
}
Facilities
GET /api/v1/facilities
Gets a list of facilities that meet the specified filter criteria.
Available Filter Operator(s):
- Exact Match ==
- Starts With =^
- Contains =@
Filter(s) using ==, =^, =@:
- name
Filter(s) using ==:
- jobId
- siteId
filter
(no description)
type
string
in
query
page
(no description)
type
integer
(int32)
in
query
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"description": "string",
"job": {
"id": "integer (int32)"
},
"site": {
"id": "integer (int32)"
}
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
POST /api/v1/facilities
Creates a new facility with the fields provided.
Required Fields:
- name
- site.Id
Request Content-Types: application/json, text/json
Request Example
{
"id": "integer (int32)",
"name": "string",
"description": "string",
"job": {
"id": "integer (int32)"
},
"site": {
"id": "integer (int32)"
}
}
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"description": "string",
"job": {
"id": "integer (int32)"
},
"site": {
"id": "integer (int32)"
}
}
}
DELETE /api/v1/facilities/{facilityId}
Deletes the facility with the specified identifier.
facilityId
(no description)
type
integer
(int32)
in
path
204 No Content
No Content
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
409 Conflict
Conflict
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
GET /api/v1/facilities/{id}
Gets a facility with the specified identifier.
id
(no description)
type
integer
(int32)
in
path
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"description": "string",
"job": {
"id": "integer (int32)"
},
"site": {
"id": "integer (int32)"
}
},
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
PATCH /api/v1/facilities/{id}
Updates specified values on a facility.
Updatable Fields:
- name
- jobId
- description
id
(no description)
type
integer
(int32)
in
path
Request Content-Types: application/json, text/json
Request Example
{
"name": "string",
"description": "string",
"job": {
"id": "integer (int32)"
},
"site": {
"id": "integer (int32)"
}
}
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"description": "string",
"job": {
"id": "integer (int32)"
},
"site": {
"id": "integer (int32)"
}
}
}
Flags
GET /api/v1/flags
Gets a list of flags.
Available Filters:
- isActive (default)
- isMobileFlag
- isReceiptFlag
- isMaterialFlag
- isShippingUnitFlag
filter
(no description)
type
string
in
query
200 OK
OK
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"flagCode": "string",
"abbreviation": "string",
"isMobileFlag": "boolean",
"isReceiptFlag": "boolean",
"isShippingUnitFlag": "boolean",
"hasTextField": "boolean",
"isActive": "boolean",
"isOsdFlag": "boolean",
"isMaterialFlag": "boolean",
"columnNumber": "integer (int32)"
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
GET /api/v1/flags/{id}/description-options
Gets the description options for the specified flag.
id
(no description)
type
integer
(int32)
in
path
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"name": "string"
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Inventory Types
GET /api/v1/inventory-types
Returns a list of inventory types.
200 OK
OK
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Jobs
GET /api/v1/jobs
Gets a list of jobs that meet the specified filter criteria.
Available Filter Operator(s):
- Exact Match ==
- Starts With =^
- Contains =@
Filter(s) using ==, =^, =@:
- name
- abbreviation
Filter(s) using ==:
- projectId
- isActive
filter
(no description)
type
string
in
query
page
(no description)
type
integer
(int32)
in
query
200 OK
OK
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"description": "string",
"abbreviation": "string",
"isActive": "boolean",
"project": {
"id": "integer (int32)"
}
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
POST /api/v1/jobs
Creates a job with the fields provided.
Required Fields:
- name
- abbreviation
- project.Id
Request Content-Types: application/json, text/json
Request Example
{
"id": "integer (int32)",
"name": "string",
"description": "string",
"abbreviation": "string",
"isActive": "boolean",
"project": {
"id": "integer (int32)"
}
}
200 OK
OK
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"description": "string",
"abbreviation": "string",
"isActive": "boolean",
"project": {
"id": "integer (int32)"
}
}
}
GET /api/v1/jobs/{id}
Gets a job with the specified identifier.
id
(no description)
type
integer
(int32)
in
path
OK
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"description": "string",
"abbreviation": "string",
"isActive": "boolean",
"project": {
"id": "integer (int32)"
}
},
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
DELETE /api/v1/jobs/{id}
Deletes a job with the specified identifier.
id
(no description)
type
integer
(int32)
in
path
204 No Content
No Content
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
409 Conflict
Conflict
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
PATCH /api/v1/jobs/{id}
Updates specified values on a job.
Updatable Fields:
- name
- abbreviation
- description
- isActive
id
(no description)
type
integer
(int32)
in
path
Request Content-Types: application/json, text/json
Request Example
"object"
200 OK
OK
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"description": "string",
"abbreviation": "string",
"isActive": "boolean",
"project": {
"id": "integer (int32)"
}
}
}
Material Issue Items
GET /api/v1/material-issue-items
Gets a list of material issue items with the specified filter criteria.
Available Filter Operator(s):
- Exact Match ==
Filter(s):
- materialIssueId
filter
(no description)
type
string
in
query
page
(no description)
type
integer
(int32)
in
query
200 OK
OK
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"quantityIssued": "number (double)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"materialIssue": {
"id": "integer (int32)"
},
"material": {
"id": "integer (int32)"
},
"pickListPickedItem": {
"id": "integer (int32)"
}
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
POST /api/v1/material-issue-items
Creates a new issue item with the fields provided.
Required fields:
- materialIssue.Id
- quantityIssued
- material.Id OR pickListPickedItem.Id
Request Content-Types: application/json, text/json
Request Example
{
"quantityIssued": "number (double)",
"materialIssue": {
"id": "integer (int32)"
},
"material": {
"id": "integer (int32)"
},
"pickListPickedItem": {
"id": "integer (int32)"
}
}
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"quantityIssued": "number (double)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"materialIssue": {
"id": "integer (int32)"
},
"material": {
"id": "integer (int32)"
},
"pickListPickedItem": {
"id": "integer (int32)"
}
}
}
GET /api/v1/material-issue-items/{id}
Gets a material issue item with the specified identifier.
id
(no description)
type
integer
(int32)
in
path
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"quantityIssued": "number (double)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"materialIssue": {
"id": "integer (int32)"
},
"material": {
"id": "integer (int32)"
},
"pickListPickedItem": {
"id": "integer (int32)"
}
}
}
DELETE /api/v1/material-issue-items/{id}
Deletes the material issue item with the specified identifier.
id
(no description)
type
integer
(int32)
in
path
204 No Content
No Content
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
409 Conflict
Conflict
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
PATCH /api/v1/material-issue-items/{id}
Updates specified values on a material issue item.
Updatable Fields:
- quantityIssued
id
(no description)
type
integer
(int32)
in
path
Request Content-Types: application/json, text/json
Request Example
{
"quantityIssued": "number (double)"
}
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"quantityIssued": "number (double)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"materialIssue": {
"id": "integer (int32)"
},
"material": {
"id": "integer (int32)"
},
"pickListPickedItem": {
"id": "integer (int32)"
}
}
}
Material Issues
GET /api/v1/material-issues
Gets a list of material issues with the specified filter criteria.
Available Filter Operator(s):
- Exact Match ==
- Starts With =^
- Contains =@
Filter(s) using ==, =^, =@:
- name
Filter(s) using ==:
- jobId
- statusId
Default Status Ids:
- Open - 0
- In Process - 1
- Submitted - 2
- Closed - 3
- Rejected - 4
filter
(no description)
type
string
in
query
page
(no description)
type
integer
(int32)
in
query
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"job": {
"id": "integer (int32)"
},
"dateIssued": "string (date-time)",
"issuedToEmployee": {
"id": "integer (int32)"
},
"issuedByEmployee": {
"id": "integer (int32)"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"notes": "string",
"description": "string"
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
POST /api/v1/material-issues
Creates a material issue with the fields provided.
Required fields:
- name
- job
- issuedToEmployee.Id (Only if project setting for "Require 'Issued To' and 'Issued By' at MIR creation" is enabled)
- issuedByEmployee.Id (Only if project setting for "Require 'Issued To' and 'Issued By' at MIR creation" is enabled)
Request Content-Types: application/json, text/json
Request Example
{
"name": "string",
"description": "string",
"job": {
"id": "integer (int32)"
},
"issuedToEmployee": {
"id": "integer (int32)"
},
"issuedByEmployee": {
"id": "integer (int32)"
},
"notes": "string",
"dateIssued": "string (date-time)"
}
200 OK
OK
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"job": {
"id": "integer (int32)"
},
"dateIssued": "string (date-time)",
"issuedToEmployee": {
"id": "integer (int32)"
},
"issuedByEmployee": {
"id": "integer (int32)"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"notes": "string",
"description": "string"
}
}
GET /api/v1/material-issues/{id}
Gets a material issue with the specified identifier.
id
(no description)
type
integer
(int32)
in
path
200 OK
OK
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"job": {
"id": "integer (int32)"
},
"dateIssued": "string (date-time)",
"issuedToEmployee": {
"id": "integer (int32)"
},
"issuedByEmployee": {
"id": "integer (int32)"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"notes": "string",
"description": "string"
}
}
DELETE /api/v1/material-issues/{id}
Deletes the material issue with the specified identifier.
id
(no description)
type
integer
(int32)
in
path
204 No Content
No Content
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
409 Conflict
Conflict
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
PATCH /api/v1/material-issues/{id}
Updates a material issue with the provided details.
Updatable fields:
- description
- notes
- issuedToEmployee - Only if project setting for "Require 'Issued To' and 'Issued By' at MIR creation" is disabled
- issuedByEmployee - Only if project setting for "Require 'Issued To' and 'Issued By' at MIR creation" is disabled
id
(no description)
type
integer
(int32)
in
path
Request Content-Types: application/json, text/json
Request Example
"object"
200 OK
OK
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"job": {
"id": "integer (int32)"
},
"dateIssued": "string (date-time)",
"issuedToEmployee": {
"id": "integer (int32)"
},
"issuedByEmployee": {
"id": "integer (int32)"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"notes": "string",
"description": "string"
}
}
Materials
GET /api/v1/materials
Gets a list of materials that meet the specified filter criteria.
Available Filter Operator(s):
- Exact Match ==
- Starts With =^
- Contains =@
- Greater Than or Equal To >=
- Less Than or Equal To <=
Filter(s) using ==, =^, =@:
- name
Filter(s) using ==:
- projectid
- catalogItemid
- jobid
- siteid
- facilityid
- namedLocationid
- yardid
- statusid
- inventorytypeid
Filter(s) using ==, >=, <=:
- datecreated
- datemodified
- dateissued
- datestatuslastchanged
Barcode filter by possible values:
- RFID Tag
- barcode field value
- GUID (global unique identifier)
Barcode Examples:
/materials?barcode=abcd
/materials?barcode=0D44010511001838
/materials?barcode=93169D93-5121-4B87-95E9-19AC724F1793
Gets material information specified by include criteria.
Include Operators:
- *default (optional) : returns pre-specified list of material fields
- *all : returns all (default and additional) fields
- .* : returns additional information on supported nested fields
Supported nested fields:
- catalogItem
Available Include fields:
Optional fields included by *default
- id
- name
- project
- catalogItem
- job
- status
- quantity
- inventoryType
- location
- area
- system
- building
- barcode
- supplier
- serialNumber
- tagNumber
- assetNumber
- heatNumber
- lotNumber
- shelfLifeExpiration
- preventativeMaintenanceDueDate
- notes
- flags
Additional optional fields excluded by *default
- Custom Fields
filter
(no description)
type
string
in
query
barcode
(no description)
type
string
in
query
include
(no description)
type
string
in
query
page
(no description)
type
integer
(int32)
in
query
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)",
"name": "string"
},
"catalogItem": {
"id": "integer (int32)",
"name": "string",
"centerOfGravity": "string",
"description": "string",
"notes": "string",
"size": "string",
"shortDescription": "string",
"specializedTrailer": "boolean",
"storageRequirement": "string",
"tagNumber": "string",
"volume": "string",
"length": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"width": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"height": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"weight": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"discipline": {
"id": "integer (int32)",
"name": "string"
},
"materialType": {
"id": "integer (int32)",
"name": "string"
},
"project": {
"id": "integer (int32)",
"name": "string"
},
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
},
"customFields": "object"
},
"job": {
"id": "integer (int32)",
"name": "string"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"quantity": "number (double)",
"inventoryType": {
"id": "integer (int32)",
"name": "string"
},
"location": {
"latitude": "number (double)",
"longitude": "number (double)",
"dateLocated": "string (date-time)",
"horizontalErrorMeters": "number (double)",
"namedLocation": {
"id": "integer (int32)",
"name": "string"
},
"yard": {
"id": "integer (int32)"
},
"zones": [
null
]
}
}
]
}
POST /api/v1/materials
Creates a material with the fields provided.
Required Fields:
- job.Id
- catalogItem.Id
- quantity
Potentially Required Fields (based on project and/or catalogItem requirements):
- customField_1 through customField_30
- serialNumber
- assetNumber
- heatNumber
- lotNumber
- shelfLifeExpiration
Request Content-Types: application/json, text/json
Request Example
{
"job": {
"id": "integer (int32)"
},
"catalogItem": {
"id": "integer (int32)"
},
"quantity": "number (double)",
"status": {
"id": "integer (int32)"
},
"inventoryType": {
"id": "integer (int32)"
},
"location": {
"namedLocation": {
"id": "integer (int32)"
}
},
"area": {
"id": "integer (int32)"
},
"system": {
"id": "integer (int32)"
},
"building": {
"id": "integer (int32)"
},
"supplier": {
"id": "integer (int32)"
},
"sequenceNumber": "integer (int32)",
"serialNumber": "string",
"assetNumber": "string",
"heatNumber": "string",
"lotNumber": "string",
"notes": "string",
"barcode": "string",
"shelfLifeExpiration": "string (date-time)",
"flags": [
{
"name": "string",
"description": "string"
}
],
"customField_1": "object",
"customField_2": "object",
"customField_3": "object",
"customField_4": "object",
"customField_5": "object",
"customField_6": "object",
"customField_7": "object",
"customField_8": "object",
"customField_9": "object",
"customField_10": "object",
"customField_11": "object",
"customField_12": "object",
"customField_13": "object",
"customField_14": "object",
"customField_15": "object",
"customField_16": "object",
"customField_17": "object",
"customField_18": "object",
"customField_19": "object",
"customField_20": "object",
"customField_21": "object",
"customField_22": "object",
"customField_23": "object",
"customField_24": "object",
"customField_25": "object",
"customField_26": "object",
"customField_27": "object",
"customField_28": "object",
"customField_29": "object",
"customField_30": "object"
}
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)",
"name": "string"
},
"catalogItem": {
"id": "integer (int32)",
"name": "string"
},
"job": {
"id": "integer (int32)",
"name": "string"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"quantity": "number (double)",
"inventoryType": {
"id": "integer (int32)",
"name": "string"
},
"location": {
"latitude": "number (double)",
"longitude": "number (double)",
"dateLocated": "string (date-time)",
"horizontalErrorMeters": "number (double)",
"namedLocation": {
"id": "integer (int32)",
"name": "string"
},
"yard": {
"id": "integer (int32)"
},
"zones": [
{
"id": "integer (int32)"
}
]
},
"area": {
"id": "integer (int32)",
"name": "string"
},
"system": {
"id": "integer (int32)",
"name": "string"
},
"building": {
"id": "integer (int32)",
"name": "string"
},
"barcode": "string",
"supplier": {
"id": "integer (int32)",
"name": "string"
},
"serialNumber": "string",
"tagNumber": "string",
"assetNumber": "string",
"heatNumber": "string",
"lotNumber": "string",
"shelfLifeExpiration": "string (date-time)",
"preventativeMaintenanceDueDate": "string (date-time)",
"notes": "string",
"flags": [
{
"name": "string",
"description": "string"
}
],
"customField_1": "string",
"customField_2": "string",
"customField_3": "string",
"customField_4": "string",
"customField_5": "string",
"customField_6": "string",
"customField_7": "string",
"customField_8": "string",
"customField_9": "string",
"customField_10": "string",
"customField_11": "string",
"customField_12": "string",
"customField_13": "string",
"customField_14": "string",
"customField_15": "string",
"customField_16": "string",
"customField_17": "string",
"customField_18": "string",
"customField_19": "string",
"customField_20": "string",
"customField_21": "string",
"customField_22": "string",
"customField_23": "string",
"customField_24": "string",
"customField_25": "string"
}
}
GET /api/v1/materials/{id}
Gets a material with specified identifier.
id
(no description)
type
integer
(int32)
in
path
200 OK
OK
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)",
"name": "string"
},
"catalogItem": {
"id": "integer (int32)",
"name": "string"
},
"job": {
"id": "integer (int32)",
"name": "string"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"quantity": "number (double)",
"inventoryType": {
"id": "integer (int32)",
"name": "string"
},
"location": {
"latitude": "number (double)",
"longitude": "number (double)",
"dateLocated": "string (date-time)",
"horizontalErrorMeters": "number (double)",
"namedLocation": {
"id": "integer (int32)",
"name": "string"
},
"yard": {
"id": "integer (int32)"
},
"zones": [
{
"id": "integer (int32)"
}
]
},
"area": {
"id": "integer (int32)",
"name": "string"
},
"system": {
"id": "integer (int32)",
"name": "string"
},
"building": {
"id": "integer (int32)",
"name": "string"
},
"barcode": "string",
"supplier": {
"id": "integer (int32)",
"name": "string"
},
"serialNumber": "string",
"tagNumber": "string",
"assetNumber": "string",
"heatNumber": "string",
"lotNumber": "string",
"shelfLifeExpiration": "string (date-time)",
"preventativeMaintenanceDueDate": "string (date-time)",
"notes": "string",
"flags": [
{
"name": "string",
"description": "string"
}
],
"customField_1": "string",
"customField_2": "string",
"customField_3": "string",
"customField_4": "string",
"customField_5": "string",
"customField_6": "string",
"customField_7": "string",
"customField_8": "string",
"customField_9": "string",
"customField_10": "string",
"customField_11": "string",
"customField_12": "string",
"customField_13": "string",
"customField_14": "string",
"customField_15": "string",
"customField_16": "string",
"customField_17": "string",
"customField_18": "string",
"customField_19": "string",
"customField_20": "string",
"customField_21": "string",
"customField_22": "string",
"customField_23": "string"
}
}
DELETE /api/v1/materials/{id}
Deletes the material with the specified identifier.
id
(no description)
type
integer
(int32)
in
path
204 No Content
No Content
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
409 Conflict
Conflict
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
PATCH /api/v1/materials/{id}
Updates specified values on a material.
Updatable Fields -
- status.id
- quantity
- inventoryType.id
- namedLocation.id
- area.id
- system.id
- building.id
- barcode
- supplier.id
- serialNumber
- assetNumber
- heatNumber
- lotNumber
- shelfLifeExpiration
- notes
- flags
- customFields
id
(no description)
type
integer
(int32)
in
path
Request Content-Types: application/json, text/json
Request Example
{
"status": {
"id": "integer (int32)"
},
"quantity": "number (double)",
"inventoryType": {
"id": "integer (int32)"
},
"location": {
"latitude": "number (double)",
"longitude": "number (double)",
"dateLocated": "string (date-time)",
"horizontalErrorMeters": "number (double)",
"namedLocation": {
"id": "integer (int32)",
"name": "string"
},
"yard": {
"id": "integer (int32)"
},
"zones": [
{
"id": "integer (int32)"
}
]
},
"area": {
"id": "integer (int32)"
},
"system": {
"id": "integer (int32)"
},
"building": {
"id": "integer (int32)"
},
"barcode": "string",
"supplier": {
"id": "integer (int32)"
},
"serialNumber": "string",
"assetNumber": "string",
"heatNumber": "string",
"lotNumber": "string",
"shelfLifeExpiration": "string (date-time)",
"notes": "string",
"flags": [
{
"name": "string",
"description": "string"
}
],
"customField_1": "object",
"customField_2": "object",
"customField_3": "object",
"customField_4": "object",
"customField_5": "object",
"customField_6": "object",
"customField_7": "object",
"customField_8": "object",
"customField_9": "object",
"customField_10": "object",
"customField_11": "object",
"customField_12": "object",
"customField_13": "object",
"customField_14": "object",
"customField_15": "object",
"customField_16": "object",
"customField_17": "object",
"customField_18": "object",
"customField_19": "object",
"customField_20": "object",
"customField_21": "object",
"customField_22": "object",
"customField_23": "object",
"customField_24": "object",
"customField_25": "object",
"customField_26": "object",
"customField_27": "object",
"customField_28": "object",
"customField_29": "object",
"customField_30": "object"
}
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)",
"name": "string"
},
"catalogItem": {
"id": "integer (int32)",
"name": "string"
},
"job": {
"id": "integer (int32)",
"name": "string"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"quantity": "number (double)",
"inventoryType": {
"id": "integer (int32)",
"name": "string"
},
"location": {
"latitude": "number (double)",
"longitude": "number (double)",
"dateLocated": "string (date-time)",
"horizontalErrorMeters": "number (double)",
"namedLocation": {
"id": "integer (int32)",
"name": "string"
},
"yard": {
"id": "integer (int32)"
},
"zones": [
{
"id": "integer (int32)"
}
]
},
"area": {
"id": "integer (int32)",
"name": "string"
},
"system": {
"id": "integer (int32)",
"name": "string"
},
"building": {
"id": "integer (int32)",
"name": "string"
},
"barcode": "string",
"supplier": {
"id": "integer (int32)",
"name": "string"
},
"serialNumber": "string",
"tagNumber": "string",
"assetNumber": "string",
"heatNumber": "string",
"lotNumber": "string",
"shelfLifeExpiration": "string (date-time)",
"preventativeMaintenanceDueDate": "string (date-time)",
"notes": "string",
"flags": [
{
"name": "string",
"description": "string"
}
],
"customField_1": "string",
"customField_2": "string",
"customField_3": "string",
"customField_4": "string",
"customField_5": "string",
"customField_6": "string",
"customField_7": "string",
"customField_8": "string",
"customField_9": "string",
"customField_10": "string",
"customField_11": "string",
"customField_12": "string",
"customField_13": "string",
"customField_14": "string",
"customField_15": "string",
"customField_16": "string",
"customField_17": "string",
"customField_18": "string",
"customField_19": "string",
"customField_20": "string",
"customField_21": "string",
"customField_22": "string",
"customField_23": "string",
"customField_24": "string",
"customField_25": "string"
}
}
GET /api/v1/materials/{id}/barcodes
Gets all barcodes associated to the material with specified identifier.
id
(no description)
type
integer
(int32)
in
path
OK
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
"string"
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
GET /api/v1/materials/{id}/labels
Gets a list of material templates that meet the specified filter criteria.
Available Filter Operator:
- Exact Match ==
Filter:
- isDefault
Font sizes:
- Small = 0
- Medium = 1
- Large = 2
- XLarge = 3
Number of lines:
Specify value (max 5) or use 0 for Auto
id
(no description)
type
integer
(int32)
in
path
filter
(no description)
type
string
in
query
page
(no description)
type
integer
(int32)
in
query
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"templateType": {
"id": "integer (int32)",
"name": "string"
},
"isDefault": "boolean",
"isActive": "boolean",
"labelHeight": "number (double)",
"labelWidth": "number (double)",
"barcodePosition": "string",
"barcode": "string",
"fields": [
{
"order": "integer (int32)",
"caption": "string",
"hideBlank": "boolean",
"numberOfLines": "integer (int32)",
"fontSize": "integer (int32)",
"value": "string"
}
]
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
GET /api/v1/materials/{id}/labels/{labelId}
Gets the label template with the specified identifier for the specified material
Font sizes:
- Small = 0
- Medium = 1
- Large = 2
- XLarge = 3
Number of lines:
Specify value (max 5) or use 0 for Auto
id
(no description)
type
integer
(int32)
in
path
labelId
(no description)
type
integer
(int32)
in
path
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"templateType": {
"id": "integer (int32)",
"name": "string"
},
"isDefault": "boolean",
"isActive": "boolean",
"labelHeight": "number (double)",
"labelWidth": "number (double)",
"barcodePosition": "string",
"barcode": "string",
"fields": [
{
"order": "integer (int32)",
"caption": "string",
"hideBlank": "boolean",
"numberOfLines": "integer (int32)",
"fontSize": "integer (int32)",
"value": "string"
}
]
}
}
GET /api/v1/materials/{id}/location
Gets the current location of the material with the specified identifier.
id
(no description)
type
integer
(int32)
in
path
OK
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": {
"latitude": "number (double)",
"longitude": "number (double)",
"dateLocated": "string",
"namedLocation": {
"id": "integer (int32)",
"name": "string",
"facility": {
"id": "integer (int32)",
"name": "string",
"site": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
},
"job": {
"id": "integer (int32)",
"name": "string"
}
}
},
"site": {
"id": "integer (int32)",
"name": "string"
},
"yard": {
"id": "integer (int32)",
"name": "string",
"positionTop": "number (double)",
"positionLeft": "number (double)",
"positionRight": "number (double)",
"positionBottom": "number (double)"
},
"horizontalErrorMeters": "number (double)",
"zoneIds": [
"integer (int32)"
]
},
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
POST /api/v1/materials/{id}/location
Submits a GPS location for a material to be considered for calculating a more accurate GPS location. The material's named location will be cleared, if set.
id
(no description)
type
integer
(int32)
in
path
Request Content-Types: application/json, text/json
Request Example
{
"latitude": "number (double)",
"longitude": "number (double)",
"dateLocated": "string",
"namedLocation": {
"id": "integer (int32)",
"name": "string",
"facility": {
"id": "integer (int32)",
"name": "string",
"site": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
},
"job": {
"id": "integer (int32)",
"name": "string"
}
}
},
"site": {
"id": "integer (int32)",
"name": "string"
},
"yard": {
"id": "integer (int32)",
"name": "string",
"positionTop": "number (double)",
"positionLeft": "number (double)",
"positionRight": "number (double)",
"positionBottom": "number (double)"
},
"horizontalErrorMeters": "number (double)",
"zoneIds": [
"integer (int32)"
]
}
OK
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": {
"latitude": "number (double)",
"longitude": "number (double)",
"dateLocated": "string",
"namedLocation": {
"id": "integer (int32)",
"name": "string",
"facility": {
"id": "integer (int32)",
"name": "string",
"site": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
},
"job": {
"id": "integer (int32)",
"name": "string"
}
}
},
"site": {
"id": "integer (int32)",
"name": "string"
},
"yard": {
"id": "integer (int32)",
"name": "string",
"positionTop": "number (double)",
"positionLeft": "number (double)",
"positionRight": "number (double)",
"positionBottom": "number (double)"
},
"horizontalErrorMeters": "number (double)",
"zoneIds": [
"integer (int32)"
]
},
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
PATCH /api/v1/materials/{id}/location
Updates a material's named location. The material's GPS location will be cleared, if set.
id
(no description)
type
integer
(int32)
in
path
Request Content-Types: application/json, text/json
Request Example
"object"
OK
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": {
"latitude": "number (double)",
"longitude": "number (double)",
"dateLocated": "string",
"namedLocation": {
"id": "integer (int32)",
"name": "string",
"facility": {
"id": "integer (int32)",
"name": "string",
"site": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
},
"job": {
"id": "integer (int32)",
"name": "string"
}
}
},
"site": {
"id": "integer (int32)",
"name": "string"
},
"yard": {
"id": "integer (int32)",
"name": "string",
"positionTop": "number (double)",
"positionLeft": "number (double)",
"positionRight": "number (double)",
"positionBottom": "number (double)"
},
"horizontalErrorMeters": "number (double)",
"zoneIds": [
"integer (int32)"
]
},
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Location
GET /api/v1/materials/{id}/location
Gets the current location of the material with the specified identifier.
id
(no description)
type
integer
(int32)
in
path
OK
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": {
"latitude": "number (double)",
"longitude": "number (double)",
"dateLocated": "string",
"namedLocation": {
"id": "integer (int32)",
"name": "string",
"facility": {
"id": "integer (int32)",
"name": "string",
"site": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
},
"job": {
"id": "integer (int32)",
"name": "string"
}
}
},
"site": {
"id": "integer (int32)",
"name": "string"
},
"yard": {
"id": "integer (int32)",
"name": "string",
"positionTop": "number (double)",
"positionLeft": "number (double)",
"positionRight": "number (double)",
"positionBottom": "number (double)"
},
"horizontalErrorMeters": "number (double)",
"zoneIds": [
"integer (int32)"
]
},
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
POST /api/v1/materials/{id}/location
Submits a GPS location for a material to be considered for calculating a more accurate GPS location. The material's named location will be cleared, if set.
id
(no description)
type
integer
(int32)
in
path
Request Content-Types: application/json, text/json
Request Example
{
"latitude": "number (double)",
"longitude": "number (double)",
"dateLocated": "string",
"namedLocation": {
"id": "integer (int32)",
"name": "string",
"facility": {
"id": "integer (int32)",
"name": "string",
"site": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
},
"job": {
"id": "integer (int32)",
"name": "string"
}
}
},
"site": {
"id": "integer (int32)",
"name": "string"
},
"yard": {
"id": "integer (int32)",
"name": "string",
"positionTop": "number (double)",
"positionLeft": "number (double)",
"positionRight": "number (double)",
"positionBottom": "number (double)"
},
"horizontalErrorMeters": "number (double)",
"zoneIds": [
"integer (int32)"
]
}
OK
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": {
"latitude": "number (double)",
"longitude": "number (double)",
"dateLocated": "string",
"namedLocation": {
"id": "integer (int32)",
"name": "string",
"facility": {
"id": "integer (int32)",
"name": "string",
"site": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
},
"job": {
"id": "integer (int32)",
"name": "string"
}
}
},
"site": {
"id": "integer (int32)",
"name": "string"
},
"yard": {
"id": "integer (int32)",
"name": "string",
"positionTop": "number (double)",
"positionLeft": "number (double)",
"positionRight": "number (double)",
"positionBottom": "number (double)"
},
"horizontalErrorMeters": "number (double)",
"zoneIds": [
"integer (int32)"
]
},
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
PATCH /api/v1/materials/{id}/location
Updates a material's named location. The material's GPS location will be cleared, if set.
id
(no description)
type
integer
(int32)
in
path
Request Content-Types: application/json, text/json
Request Example
"object"
OK
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": {
"latitude": "number (double)",
"longitude": "number (double)",
"dateLocated": "string",
"namedLocation": {
"id": "integer (int32)",
"name": "string",
"facility": {
"id": "integer (int32)",
"name": "string",
"site": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
},
"job": {
"id": "integer (int32)",
"name": "string"
}
}
},
"site": {
"id": "integer (int32)",
"name": "string"
},
"yard": {
"id": "integer (int32)",
"name": "string",
"positionTop": "number (double)",
"positionLeft": "number (double)",
"positionRight": "number (double)",
"positionBottom": "number (double)"
},
"horizontalErrorMeters": "number (double)",
"zoneIds": [
"integer (int32)"
]
},
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Named Locations
GET /api/v1/named-locations
Gets a list of matching named locations.
Required Filter(s):
- name
When filtering by facilityId and/or siteId, the name constraint must also be provided.
filter
(no description)
type
string
in
query
page
(no description)
type
integer
(int32)
in
query
OK
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"facility": {
"id": "integer (int32)",
"name": "string",
"site": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
},
"job": {
"id": "integer (int32)",
"name": "string"
}
}
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
POST /api/v1/named-locations
Creates a new named location with fields provided.
Request Content-Types: application/json, text/json
Request Example
{
"id": "integer (int32)",
"name": "string",
"facility": {
"id": "integer (int32)"
},
"barcode": "string"
}
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"facility": {
"id": "integer (int32)"
},
"barcode": "string"
}
}
GET /api/v1/named-locations/{id}
Gets a named location with specified identifier.
id
(no description)
type
integer
(int32)
in
path
expand
(no description)
type
string
in
query
fields
(no description)
type
string
in
query
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"facility": {
"id": "integer (int32)",
"name": "string",
"site": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
},
"job": {
"id": "integer (int32)",
"name": "string"
}
}
},
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
DELETE /api/v1/named-locations/{id}
Deletes a named location with specified identifier.
id
(no description)
type
integer
(int32)
in
path
204 No Content
No Content
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
409 Conflict
Conflict
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
PATCH /api/v1/named-locations/{id}
Updates specified values on a named location.
Updatable Fields:
- name
- facilityId
- barcode
id
(no description)
type
integer
(int32)
in
path
Request Content-Types: application/json, text/json
Request Example
"object"
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"facility": {
"id": "integer (int32)"
},
"barcode": "string"
}
}
Pick List Items
GET /api/v1/pick-list-items
Gets a list of pick list items with the specified filter criteria.
Available Filter Operator(s):
- Exact Match ==
- Starts With =^
- Contains =@
- Not Equal To !=
Filter(s) using ==, =^, =@:
- pickListName
Filter(s) using ==, =@:
- stagedLocation
- catalogItemName
- materialName
Filter(s) using ==, !=:
- remainingQuantity
Filter(s) using ==:
- pickListId
Include Operators:
- *default (optional) : returns pre-specified list of pick list item fields
- *all : returns all (default and additional) fields
Available Include fields:
Optional fields included by *default
- id
- lineNumber
- subLineNumber
- catalogItem
- pickList
- material
- pickQuantity
- pickedQuantity
- remainingQuantity
Additional optional fields excluded by *default
- withdrawalRequestItem
- stagedLocation
Sort syntax:
sort={property1},{property2}:{direction},{property3}:{direction}...
Sort direction (optional):
- ASC = Ascending (default)
- DESC = Descending
Sortable properties:
- catalogItem.name
- material.name
- lineNumber
- subLineNumber
- stagedLocation
filter
(no description)
type
string
in
query
include
(no description)
type
string
in
query
page
(no description)
type
integer
(int32)
in
query
sort
(no description)
type
string
in
query
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"pickQuantity": "number (double)",
"catalogItem": {
"id": "integer (int32)",
"name": "string",
"centerOfGravity": "string",
"description": "string",
"notes": "string",
"size": "string",
"shortDescription": "string",
"specializedTrailer": "boolean",
"storageRequirement": "string",
"tagNumber": "string",
"volume": "string",
"length": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"width": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"height": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"weight": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"discipline": {
"id": "integer (int32)",
"name": "string"
},
"materialType": {
"id": "integer (int32)",
"name": "string"
},
"project": {
"id": "integer (int32)",
"name": "string"
},
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
},
"customFields": "object"
},
"pickList": {
"id": "integer (int32)",
"name": "string",
"description": "string",
"job": {
"id": "integer (int32)",
"name": "string",
"description": "string",
"abbreviation": "string",
"isActive": "boolean",
"project": {
"id": "integer (int32)"
}
},
"site": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string"
}
}
}
}
]
}
POST /api/v1/pick-list-items
Creates a pick list with the fields provided.
Required Fields:
- pickList.Id
- catalogItem.Id
- material.Id
- pickQuantity
Note: Both catalogItem.Id and material.Id cannot be specified in the same request.
Request Content-Types: application/json, text/json
Request Example
{
"pickList": {
"id": "integer (int32)"
},
"catalogItem": {
"id": "integer (int32)"
},
"material": {
"id": "integer (int32)"
},
"pickQuantity": "number (double)"
}
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"pickQuantity": "number (double)",
"catalogItem": {
"id": "integer (int32)"
},
"pickList": {
"id": "integer (int32)"
},
"material": {
"id": "integer (int32)"
}
}
}
GET /api/v1/pick-list-items/{id}
Gets a pick list item with the specified identifier.
id
(no description)
type
integer
(int32)
in
path
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"pickQuantity": "number (double)",
"catalogItem": {
"id": "integer (int32)"
},
"pickList": {
"id": "integer (int32)"
},
"material": {
"id": "integer (int32)"
}
}
}
DELETE /api/v1/pick-list-items/{id}
Deletes the pick list item with the specified identifier.
id
(no description)
type
integer
(int32)
in
path
204 No Content
No Content
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
409 Conflict
Conflict
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
PATCH /api/v1/pick-list-items/{id}
Updates specified values on a pick list item.
Updatable Fields:
- pickQuantity
id
(no description)
type
integer
(int32)
in
path
Request Content-Types: application/json, text/json
Request Example
"object"
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"pickQuantity": "number (double)",
"catalogItem": {
"id": "integer (int32)"
},
"pickList": {
"id": "integer (int32)"
},
"material": {
"id": "integer (int32)"
}
}
}
Pick Lists
GET /api/v1/pick-lists
Gets a list of pick lists with the specified filters.
Available Filter Operator(s):
- Exact Match ==
- Starts With =^
- Contains =@
- Not Equal !=
Filter(s) using ==, =^, =@:
- name
- stagedLocation
Filter(s) using ==:
- jobId
- statusId
- siteId
- assignedTo.name
- assignedTo.id
Filter(s) using !=:
- statusId
Sort syntax:
sort={property1},{property2}:{direction},{property3}:{direction}...
Sort direction (optional):
- ASC = Ascending (default)
- DESC = Descending
Sortable properties:
- name
- stagedLocation
- datePickStarted
- datePickRequested
- datePickFinished
Default Jovix Pick List Statuses:
- Open = 0
- In Process = 1
- Closed = 2
filter
(no description)
type
string
in
query
include
(no description)
type
string
in
query
page
(no description)
type
integer
(int32)
in
query
sort
(no description)
type
string
in
query
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"description": "string",
"job": {
"id": "integer (int32)",
"name": "string",
"description": "string",
"abbreviation": "string",
"isActive": "boolean",
"project": {
"id": "integer (int32)"
}
},
"site": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"datePickRequested": "string (date-time)",
"datePickStarted": "string (date-time)",
"datePickFinished": "string (date-time)",
"stagedLocation": "string",
"assignedTo": {
"id": "integer (int32)",
"name": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"internalId": "string",
"company": "string",
"isSupplierUser": "boolean",
"isLocked": "boolean",
"isMobileUser": "boolean",
"phone": "string",
"email": "string"
},
"pickedBy": {
"id": "integer (int32)",
"name": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"internalId": "string",
"company": "string",
"isSupplierUser": "boolean",
"isLocked": "boolean",
"isMobileUser": "boolean",
"phone": "string",
"email": "string"
},
"customFields": "object"
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
POST /api/v1/pick-lists
Creates a pick list with the fields provided.
Required Fields:
- name
- site.Id
- job.Id (if project setting 'require job on pick list' is selected)
Request Content-Types: application/json, text/json
Request Example
{
"name": "string",
"description": "string",
"job": {
"id": "integer (int32)"
},
"site": {
"id": "integer (int32)"
}
}
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"description": "string",
"stagedLocation": "string",
"job": {
"id": "integer (int32)",
"name": "string"
},
"site": {
"id": "integer (int32)"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"datePickStarted": "string (date-time)",
"datePickRequested": "string (date-time)",
"datePickFinished": "string (date-time)"
}
}
GET /api/v1/pick-lists/{id}
Gets a pick list with the specified identifier.
id
(no description)
type
integer
(int32)
in
path
include
(no description)
type
string
in
query
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"description": "string",
"job": {
"id": "integer (int32)",
"name": "string",
"description": "string",
"abbreviation": "string",
"isActive": "boolean",
"project": {
"id": "integer (int32)"
}
},
"site": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"datePickRequested": "string (date-time)",
"datePickStarted": "string (date-time)",
"datePickFinished": "string (date-time)",
"stagedLocation": "string",
"assignedTo": {
"id": "integer (int32)",
"name": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"internalId": "string",
"company": "string",
"isSupplierUser": "boolean",
"isLocked": "boolean",
"isMobileUser": "boolean",
"phone": "string",
"email": "string"
},
"pickedBy": {
"id": "integer (int32)",
"name": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"internalId": "string",
"company": "string",
"isSupplierUser": "boolean",
"isLocked": "boolean",
"isMobileUser": "boolean",
"phone": "string",
"email": "string"
},
"customFields": "object"
}
}
DELETE /api/v1/pick-lists/{id}
Deletes the pick list with the specified identifier.
id
(no description)
type
integer
(int32)
in
path
204 No Content
No Content
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
409 Conflict
Conflict
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
PATCH /api/v1/pick-lists/{id}
Updates specified values on a pick list.
Updatable Fields:
- description
- job.Id
id
(no description)
type
integer
(int32)
in
path
Request Content-Types: application/json, text/json
Request Example
"object"
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"description": "string",
"stagedLocation": "string",
"job": {
"id": "integer (int32)",
"name": "string"
},
"site": {
"id": "integer (int32)"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"datePickStarted": "string (date-time)",
"datePickRequested": "string (date-time)",
"datePickFinished": "string (date-time)"
}
}
Purchase Order Delivery Lines
GET /api/v1/purchase-order-delivery-lines
Gets a list of purchase order delivery lines that meet the specified filter criteria.
Available Filter Operator(s):
- Exact Match ==
- Starts With =^
- Contains =@
Filter(s) using ==, =^, =@:
- srn
- catalogItemName
- barcode
- rfidTag
- purchaseOrderNumber
Filter(s) using ==:
- purchaseOrderLineItemId
- purchaseOrderId
- isOnShippingUnit
- shippingUnitName
- isReceived
Barcode filter by possible values:
- RFID Tag
- barcode value
Barcode Examples:
- /purchase-order-delivery-lines?barcode=0D44010511001838
- /purchase-order-delivery-lines?barcode=abcd
Sort syntax:
sort={property1},{property2}:{direction},{property3}:{direction}...
Sort direction (optional):
- ASC = Ascending (default)
- DESC = Descending
Sortable properties:
- lineNumber
- subLineNumber
- catalogItem.name
- purchaseOrderLineItem.lineNumber
- purchaseOrderLineItem.subLineNumber
- purchaseOrderLineItem.purchaseOrder.name
filter
(no description)
type
string
in
query
barcode
(no description)
type
string
in
query
page
(no description)
type
integer
(int32)
in
query
sort
(no description)
type
string
in
query
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"quantity": "number (double)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"srn": "string",
"catalogItem": {
"id": "integer (int32)",
"name": "string",
"centerOfGravity": "string",
"description": "string",
"notes": "string",
"size": "string",
"shortDescription": "string",
"specializedTrailer": "boolean",
"tagNumber": "string",
"volume": "string",
"length": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"width": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"height": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"weight": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"discipline": {
"id": "integer (int32)",
"name": "string"
},
"materialType": {
"id": "integer (int32)",
"name": "string"
},
"project": {
"id": "integer (int32)",
"name": "string"
},
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
},
"customField_1": "string",
"customField_2": "string",
"customField_3": "string",
"customField_4": "string",
"customField_5": "string",
"customField_6": "string",
"customField_7": "string",
"customField_8": "string",
"customField_9": "string",
"customField_10": "string",
"customField_11": "string",
"customField_12": "string",
"customField_13": "string",
"customField_14": "string",
"customField_15": "string",
"customField_16": "string",
"customField_17": "string",
"customField_18": "string",
"customField_19": "string",
"customField_20": "string",
"customField_21": "string",
"customField_22": "string",
"customField_23": "string",
"customField_24": "string",
"customField_25": "string",
"customField_26": "string",
"customField_27": "string",
"customField_28": "string",
"customField_29": "string",
"customField_30": "string"
}
}
]
}
POST /api/v1/purchase-order-delivery-lines
Creates a new purchase order delivery line with the fields provided.
Required Fields:
- purchaseOrderLineItem.Id
- catalogItem.Id
- quantity
Request Content-Types: application/json, text/json
Request Example
{
"id": "integer (int32)",
"quantity": "number (double)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"srn": "string",
"catalogItem": {
"id": "integer (int32)",
"name": "string",
"centerOfGravity": "string",
"description": "string",
"notes": "string",
"size": "string",
"shortDescription": "string",
"specializedTrailer": "boolean",
"tagNumber": "string",
"volume": "string",
"length": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"width": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"height": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"weight": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"discipline": {
"id": "integer (int32)",
"name": "string"
},
"materialType": {
"id": "integer (int32)",
"name": "string"
},
"project": {
"id": "integer (int32)",
"name": "string"
},
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
},
"customField_1": "string",
"customField_2": "string",
"customField_3": "string",
"customField_4": "string",
"customField_5": "string",
"customField_6": "string",
"customField_7": "string",
"customField_8": "string",
"customField_9": "string",
"customField_10": "string",
"customField_11": "string",
"customField_12": "string",
"customField_13": "string",
"customField_14": "string",
"customField_15": "string",
"customField_16": "string",
"customField_17": "string",
"customField_18": "string",
"customField_19": "string",
"customField_20": "string",
"customField_21": "string",
"customField_22": "string",
"customField_23": "string",
"customField_24": "string",
"customField_25": "string",
"customField_26": "string",
"customField_27": "string",
"customField_28": "string",
"customField_29": "string",
"customField_30": "string"
},
"purchaseOrderLineItem": {
"id": "integer (int32)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"purchaseOrder": {}
}
}
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": {
"id": "integer (int32)",
"quantity": "number (double)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"srn": "string",
"catalogItem": {
"id": "integer (int32)",
"name": "string",
"centerOfGravity": "string",
"description": "string",
"notes": "string",
"size": "string",
"shortDescription": "string",
"specializedTrailer": "boolean",
"tagNumber": "string",
"volume": "string",
"length": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"width": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"height": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"weight": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"discipline": {
"id": "integer (int32)",
"name": "string"
},
"materialType": {
"id": "integer (int32)",
"name": "string"
},
"project": {
"id": "integer (int32)",
"name": "string"
},
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
},
"customField_1": "string",
"customField_2": "string",
"customField_3": "string",
"customField_4": "string",
"customField_5": "string",
"customField_6": "string",
"customField_7": "string",
"customField_8": "string",
"customField_9": "string",
"customField_10": "string",
"customField_11": "string",
"customField_12": "string",
"customField_13": "string",
"customField_14": "string",
"customField_15": "string",
"customField_16": "string",
"customField_17": "string",
"customField_18": "string",
"customField_19": "string",
"customField_20": "string",
"customField_21": "string",
"customField_22": "string",
"customField_23": "string",
"customField_24": "string",
"customField_25": "string",
"customField_26": "string",
"customField_27": "string",
"customField_28": "string",
"customField_29": "string",
"customField_30": "string"
},
"purchaseOrderLineItem": {}
}
}
GET /api/v1/purchase-order-delivery-lines/{deliveryLineId}
Gets a purchase order delivery line with the specified identifier.
deliveryLineId
(no description)
type
integer
(int32)
in
path
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"quantity": "number (double)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"srn": "string",
"catalogItem": {
"id": "integer (int32)",
"name": "string",
"centerOfGravity": "string",
"description": "string",
"notes": "string",
"size": "string",
"shortDescription": "string",
"specializedTrailer": "boolean",
"tagNumber": "string",
"volume": "string",
"length": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"width": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"height": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"weight": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"discipline": {
"id": "integer (int32)",
"name": "string"
},
"materialType": {
"id": "integer (int32)",
"name": "string"
},
"project": {
"id": "integer (int32)",
"name": "string"
},
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
},
"customField_1": "string",
"customField_2": "string",
"customField_3": "string",
"customField_4": "string",
"customField_5": "string",
"customField_6": "string",
"customField_7": "string",
"customField_8": "string",
"customField_9": "string",
"customField_10": "string",
"customField_11": "string",
"customField_12": "string",
"customField_13": "string",
"customField_14": "string",
"customField_15": "string",
"customField_16": "string",
"customField_17": "string",
"customField_18": "string",
"customField_19": "string",
"customField_20": "string",
"customField_21": "string",
"customField_22": "string",
"customField_23": "string",
"customField_24": "string",
"customField_25": "string",
"customField_26": "string",
"customField_27": "string",
"customField_28": "string",
"customField_29": "string",
"customField_30": "string"
},
"purchaseOrderLineItem": {
"id": "integer (int32)",
"lineNumber": "integer (int32)"
}
}
}
DELETE /api/v1/purchase-order-delivery-lines/{deliveryLineId}
Deletes the purchase order delivery line with the specified identifier.
deliveryLineId
(no description)
type
integer
(int32)
in
path
204 No Content
No Content
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
409 Conflict
Conflict
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
PATCH /api/v1/purchase-order-delivery-lines/{deliveryLineId}
Updates specified values on a purchase order delivery line
Updatable Fields:
- quantity
- materialStage.rfidTag
deliveryLineId
(no description)
type
integer
(int32)
in
path
Request Content-Types: application/json, text/json
Request Example
"object"
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": {
"id": "integer (int32)",
"quantity": "number (double)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"srn": "string",
"catalogItem": {
"id": "integer (int32)",
"name": "string",
"centerOfGravity": "string",
"description": "string",
"notes": "string",
"size": "string",
"shortDescription": "string",
"specializedTrailer": "boolean",
"tagNumber": "string",
"volume": "string",
"length": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"width": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"height": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"weight": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"discipline": {
"id": "integer (int32)",
"name": "string"
},
"materialType": {
"id": "integer (int32)",
"name": "string"
},
"project": {
"id": "integer (int32)",
"name": "string"
},
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
},
"customField_1": "string",
"customField_2": "string",
"customField_3": "string",
"customField_4": "string",
"customField_5": "string",
"customField_6": "string",
"customField_7": "string",
"customField_8": "string",
"customField_9": "string",
"customField_10": "string",
"customField_11": "string",
"customField_12": "string",
"customField_13": "string",
"customField_14": "string",
"customField_15": "string",
"customField_16": "string",
"customField_17": "string",
"customField_18": "string",
"customField_19": "string",
"customField_20": "string",
"customField_21": "string",
"customField_22": "string",
"customField_23": "string",
"customField_24": "string",
"customField_25": "string",
"customField_26": "string",
"customField_27": "string",
"customField_28": "string",
"customField_29": "string",
"customField_30": "string"
},
"purchaseOrderLineItem": {}
}
}
GET /api/v1/purchase-order-delivery-lines/{deliveryLineId}/barcode
Gets the barcode for the purchase order delivery line with the specified identifier.
deliveryLineId
(no description)
type
integer
(int32)
in
path
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": {
"value": "string"
},
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
GET /api/v1/purchase-order-delivery-lines/{id}/labels
Gets the label templates for the specified purchase order delivery line
Filter using ==:
- isDefault
Font sizes:
- Small = 0
- Medium = 1
- Large = 2
- XLarge = 3
Number of lines:
Specify value (max 5) or use 0 for Auto
id
(no description)
type
integer
(int32)
in
path
filter
(no description)
type
string
in
query
page
(no description)
type
integer
(int32)
in
query
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"templateType": {
"id": "integer (int32)",
"name": "string"
},
"isDefault": "boolean",
"isActive": "boolean",
"labelHeight": "number (double)",
"labelWidth": "number (double)",
"barcodePosition": "string",
"barcode": "string",
"fields": [
{
"order": "integer (int32)",
"caption": "string",
"hideBlank": "boolean",
"numberOfLines": "integer (int32)",
"fontSize": "integer (int32)",
"value": "string"
}
]
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
GET /api/v1/purchase-order-delivery-lines/{id}/labels/{labelId}
Gets the label template with the specified identifier for the specified purchase order delivery line
Font sizes:
- Small = 0
- Medium = 1
- Large = 2
- XLarge = 3
Number of lines:
Specify value (max 5) or use 0 for Auto
id
(no description)
type
integer
(int32)
in
path
labelId
(no description)
type
integer
(int32)
in
path
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"templateType": {
"id": "integer (int32)",
"name": "string"
},
"isDefault": "boolean",
"isActive": "boolean",
"labelHeight": "number (double)",
"labelWidth": "number (double)",
"barcodePosition": "string",
"barcode": "string",
"fields": [
{
"order": "integer (int32)",
"caption": "string",
"hideBlank": "boolean",
"numberOfLines": "integer (int32)",
"fontSize": "integer (int32)",
"value": "string"
}
]
}
}
Purchase Order Items
GET /api/v1/purchase-order-items
Gets a list of purchase order items that meet the specified filter criteria.
Available Filter Operator(s):
- Exact Match ==
- Starts With =^
- Contains =@
Filter(s) using ==, =^, =@:
- catalogItemName
Filter(s) using ==:
- purchaseOrderId
filter
(no description)
type
string
in
query
page
(no description)
type
integer
(int32)
in
query
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"purchaseOrder": {
"id": "integer (int32)",
"name": "string"
},
"catalogItem": {
"id": "integer (int32)",
"name": "string"
},
"acceptableOverage": "number (double)",
"acceptableShortage": "number (double)"
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
POST /api/v1/purchase-order-items
Creates a Purchase order item with the fields provided.
Required Fields:
- purchaseOrder.Id
- catalogItem.Id
Request Content-Types: application/json, text/json
Request Example
{
"purchaseOrder": {
"id": "integer (int32)"
},
"catalogItem": {
"id": "integer (int32)"
},
"acceptableOverage": "number (double)",
"acceptableShortage": "number (double)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)"
}
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
NotFound
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"purchaseOrder": {
"id": "integer (int32)",
"name": "string"
},
"catalogItem": {
"id": "integer (int32)",
"name": "string"
},
"acceptableOverage": "number (double)",
"acceptableShortage": "number (double)"
}
}
GET /api/v1/purchase-order-items/{id}
Gets the purchase order item for the specified id.
id
(no description)
type
integer
(int32)
in
path
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": {
"id": "integer (int32)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"purchaseOrder": {
"id": "integer (int32)",
"name": "string"
},
"catalogItem": {
"id": "integer (int32)",
"name": "string"
},
"acceptableOverage": "number (double)",
"acceptableShortage": "number (double)"
},
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
DELETE /api/v1/purchase-order-items/{id}
Deletes the purchase order item with the specified identifier.
id
(no description)
type
integer
(int32)
in
path
204 No Content
No Content
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
409 Conflict
Conflict
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
PATCH /api/v1/purchase-order-items/{id}
Updates specified values on a purchase order line item.
Updatable Fields:
- notes
- acceptableOverage
- acceptableShortage
id
(no description)
type
integer
(int32)
in
path
Request Content-Types: application/json, text/json
Request Example
"object"
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"purchaseOrder": {
"id": "integer (int32)",
"name": "string"
},
"catalogItem": {
"id": "integer (int32)",
"name": "string"
},
"acceptableOverage": "number (double)",
"acceptableShortage": "number (double)"
}
}
Purchase Orders
GET /api/v1/purchase-orders
Gets a list of purchase orders that meet the specified criteria.
Available Filter Operator(s):
- Exact Match ==
- Starts With =^
- Contains =@
Filter(s) using ==, =^, =@:
- name
Filter(s) using ==:
- jobId
- supplierId
- statusId
filter
(no description)
type
string
in
query
page
(no description)
type
integer
(int32)
in
query
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"job": {
"id": "integer (int32)",
"name": "string"
},
"supplier": {
"id": "integer (int32)",
"name": "string"
},
"dateSubmitted": "string (date-time)",
"dateFinalized": "string (date-time)",
"status": {
"id": "integer (int32)"
},
"targetDeliveryDate": "string (date-time)",
"targetShipDate": "string (date-time)",
"notes": "string"
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
POST /api/v1/purchase-orders
Creates a new purchase order with the provided fields.
Required Fields:
- name
- job.Id
- supplier.Id
Request Content-Types: application/json, text/json
Request Example
{
"name": "string",
"job": {
"id": "integer (int32)"
},
"supplier": {
"id": "integer (int32)"
},
"dateSubmitted": "string (date-time)",
"dateFinalized": "string (date-time)",
"targetDeliveryDate": "string (date-time)",
"targetShipDate": "string (date-time)",
"notes": "string"
}
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"job": {
"id": "integer (int32)",
"name": "string"
},
"supplier": {
"id": "integer (int32)",
"name": "string"
},
"dateSubmitted": "string (date-time)",
"dateFinalized": "string (date-time)",
"status": {
"id": "integer (int32)"
},
"targetDeliveryDate": "string (date-time)",
"targetShipDate": "string (date-time)",
"notes": "string"
}
}
GET /api/v1/purchase-orders/{id}
Gets a purchase order with the specified identifier.
id
(no description)
type
integer
(int32)
in
path
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"job": {
"id": "integer (int32)",
"name": "string"
},
"supplier": {
"id": "integer (int32)",
"name": "string"
},
"dateSubmitted": "string (date-time)",
"dateFinalized": "string (date-time)",
"status": {
"id": "integer (int32)"
},
"targetDeliveryDate": "string (date-time)",
"targetShipDate": "string (date-time)",
"notes": "string"
},
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
DELETE /api/v1/purchase-orders/{id}
Deletes the purchase order with the specified identifier.
id
(no description)
type
integer
(int32)
in
path
204 No Content
No Content
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
409 Conflict
Conflict
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
PATCH /api/v1/purchase-orders/{id}
Updates specified values on a purchase order.
Updatable Fields:
- notes
- dateFinalized
- targetDeliveryDate
- targetShipDate
id
(no description)
type
integer
(int32)
in
path
Request Content-Types: application/json, text/json
Request Example
{
"dateFinalized": "string (date-time)",
"targetDeliveryDate": "string (date-time)",
"targetShipDate": "string (date-time)",
"notes": "string"
}
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"job": {
"id": "integer (int32)",
"name": "string"
},
"supplier": {
"id": "integer (int32)",
"name": "string"
},
"dateSubmitted": "string (date-time)",
"dateFinalized": "string (date-time)",
"status": {
"id": "integer (int32)"
},
"targetDeliveryDate": "string (date-time)",
"targetShipDate": "string (date-time)",
"notes": "string"
}
}
Receipt Items
GET /api/v1/receipt-items
Gets a list of receipts with the specified filters.
Available Filter Operator(s):
- Exact Match ==
Filter(s) using ==:
- receiptId
- shipmentItemId
- shippingUnitid
- materialId
filter
(no description)
type
string
in
query
page
(no description)
type
integer
(int32)
in
query
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"receipt": {
"id": "integer (int32)"
},
"lineNumber": "integer (int32)",
"shipmentItem": {
"id": "integer (int32)"
},
"shippingUnit": {
"id": "integer (int32)"
},
"material": {
"id": "integer (int32)"
},
"receivedQuantity": "number (double)",
"flags": [
{
"name": "string",
"description": "string"
}
]
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
POST /api/v1/receipt-items
Creates a receipt item with the fields provided.
Required Fields:
- receipt.Id
- shippingUnit.Id OR shipmentItem.Id
- material.Id (only if using shipmentItem)
- receivedQuantity
Request Content-Types: application/json, text/json
Request Example
{
"receipt": {
"id": "integer (int32)"
},
"shipmentItem": {
"id": "integer (int32)"
},
"receivedQuantity": "number (double)",
"location": {
"latitude": "number (double)",
"longitude": "number (double)",
"dateLocated": "string (date-time)",
"horizontalErrorMeters": "number (double)",
"namedLocation": {
"id": "integer (int32)",
"name": "string"
},
"yard": {
"id": "integer (int32)"
},
"zones": [
{
"id": "integer (int32)"
}
]
},
"shippingUnit": {
"id": "integer (int32)"
},
"material": {
"id": "integer (int32)"
},
"flags": [
{
"name": "string",
"description": "string"
}
]
}
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"receipt": {
"id": "integer (int32)"
},
"lineNumber": "integer (int32)",
"shipmentItem": {
"id": "integer (int32)"
},
"shippingUnit": {
"id": "integer (int32)"
},
"material": {
"id": "integer (int32)"
},
"location": {
"latitude": "number (double)",
"longitude": "number (double)",
"dateLocated": "string (date-time)",
"horizontalErrorMeters": "number (double)",
"namedLocation": {
"id": "integer (int32)",
"name": "string"
},
"yard": {
"id": "integer (int32)"
},
"zones": [
{
"id": "integer (int32)"
}
]
},
"receivedQuantity": "number (double)",
"flags": [
{
"name": "string",
"description": "string"
}
]
}
}
GET /api/v1/receipt-items/{id}
Gets a receipt item with the specified identifier.
id
(no description)
type
integer
(int32)
in
path
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"receipt": {
"id": "integer (int32)"
},
"lineNumber": "integer (int32)",
"shipmentItem": {
"id": "integer (int32)"
},
"shippingUnit": {
"id": "integer (int32)"
},
"material": {
"id": "integer (int32)"
},
"receivedQuantity": "number (double)",
"flags": [
{
"name": "string",
"description": "string"
}
]
}
}
DELETE /api/v1/receipt-items/{id}
Deletes the receipt item with the specified identifier.
id
(no description)
type
integer
(int32)
in
path
204 No Content
No Content
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
409 Conflict
Conflict
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
PATCH /api/v1/receipt-items/{id}
Updates specified values on a receipt item.
Updatable Fields:
- ReceivedQuantity
- location: latitude, longitude, horizontalErrorMeters
- flags: name, description
id
(no description)
type
integer
(int32)
in
path
Request Content-Types: application/json, text/json
Request Example
"object"
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"receipt": {
"id": "integer (int32)"
},
"lineNumber": "integer (int32)",
"shipmentItem": {
"id": "integer (int32)"
},
"shippingUnit": {
"id": "integer (int32)"
},
"material": {
"id": "integer (int32)"
},
"location": {
"latitude": "number (double)",
"longitude": "number (double)",
"dateLocated": "string (date-time)",
"horizontalErrorMeters": "number (double)",
"namedLocation": {
"id": "integer (int32)",
"name": "string"
},
"yard": {
"id": "integer (int32)"
},
"zones": [
{
"id": "integer (int32)"
}
]
},
"receivedQuantity": "number (double)",
"flags": [
{
"name": "string",
"description": "string"
}
]
}
}
Receipts
GET /api/v1/receipts
Gets a list of receipts with the specified filters.
Available Filter Operator(s):
- Exact Match ==
- Starts With =^
- Contains =@
Filter(s) using ==, =^, =@:
- name
Filter(s) using ==:
- receiptTypeId
- purchaseOrderId
- shipmentId
Default Jovix Receipt Types:
- None - 0
- Direct Receipt - 1
- Shipment - 2
- Purchase Order - 3
Default Receipt Status Ids:
- Open - 0
- In Process - 1
- Submitted - 2
- Completed - 3
filter
(no description)
type
string
in
query
page
(no description)
type
integer
(int32)
in
query
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"receiptType": "integer (int32)",
"status": {
"id": "integer (int32)"
},
"shipment": {
"id": "integer (int32)"
},
"purchaseOrder": {
"id": "integer (int32)"
},
"dateStarted": "string (date-time)",
"dateComplete": "string (date-time)",
"osdItemCount": "integer (int32)",
"notes": "string"
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
POST /api/v1/receipts
Creates a receipt with the fields provided.
Required Fields:
- name
- shipment.Id
Request Content-Types: application/json, text/json
Request Example
{
"name": "string",
"shipment": {
"id": "integer (int32)"
},
"dateStarted": "string (date-time)",
"notes": "string"
}
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"receiptType": "integer (int32)",
"status": {
"id": "integer (int32)"
},
"shipment": {
"id": "integer (int32)"
},
"purchaseOrder": {
"id": "integer (int32)"
},
"dateStarted": "string (date-time)",
"dateComplete": "string (date-time)",
"osdItemCount": "integer (int32)",
"notes": "string"
}
}
GET /api/v1/receipts/{id}
Gets a receipt with the specified identifier.
id
(no description)
type
integer
(int32)
in
path
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"receiptType": "integer (int32)",
"status": {
"id": "integer (int32)"
},
"shipment": {
"id": "integer (int32)"
},
"purchaseOrder": {
"id": "integer (int32)"
},
"dateStarted": "string (date-time)",
"dateComplete": "string (date-time)",
"osdItemCount": "integer (int32)",
"notes": "string"
}
}
DELETE /api/v1/receipts/{id}
Deletes the receipt with the specified identifier.
id
(no description)
type
integer
(int32)
in
path
204 No Content
No Content
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
PATCH /api/v1/receipts/{id}
Updates specified values on a receipt.
Updatable Fields:
- Notes
- DateStarted
id
(no description)
type
integer
(int32)
in
path
Request Content-Types: application/json, text/json
Request Example
"object"
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"receiptType": "integer (int32)",
"status": {
"id": "integer (int32)"
},
"shipment": {
"id": "integer (int32)"
},
"purchaseOrder": {
"id": "integer (int32)"
},
"dateStarted": "string (date-time)",
"dateComplete": "string (date-time)",
"osdItemCount": "integer (int32)",
"notes": "string"
}
}
RFID
GET /api/v1/tag-associations
Gets a list of matching Tag Associations.
Required Filter(s):
- rfid
OR
- inventoryItemId
filter
(no description)
type
string
in
query
limit
(no description)
type
integer
(int32)
in
query
200 OK
OK
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"inventoryItemId": "integer (int32)",
"rfidTagId": "integer (int32)",
"inventoryItemKey": "string",
"rfid": "string"
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
POST /api/v1/tag-associations
Creates an RFID tag association.
Expected body: { inventoryItemId OR shippingUnitId, rfid }
Request Content-Types: application/json, text/json
Request Example
{
"inventoryItemId": "integer (int32)",
"shippingUnitId": "integer (int32)",
"rfid": "string"
}
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
NotFound
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": {
"id": "integer (int32)",
"rfid": "string"
},
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Schedule Activities
GET /api/v1/schedule-activities
Gets a list of schedule activities that meet the specified filter criteria.
Available Filter Operator(s):
- Exact Match ==
- Starts With =^
- Contains =@
Filter(s) using ==, =^, =@:
- name
- externalProjectName
- workBreakdownStructureName
Filter(s) using ==:
- externalid
filter
(no description)
type
string
in
query
page
(no description)
type
integer
(int32)
in
query
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"activityType": "string",
"project": {
"id": "integer (int32)"
},
"job": {
"id": "integer (int32)",
"name": "string"
},
"externalId": "string",
"externalProjectId": "string",
"externalProjectName": "string",
"workBreakdownStructureId": "integer (int32)",
"workBreakdownStructureName": "string",
"startDate": "string (date-time)",
"finishDate": "string (date-time)",
"isActualStartDate": "boolean",
"isActualFinishDate": "boolean",
"totalFloat": "integer (int32)",
"freeFloat": "integer (int32)",
"activityCode1": "string",
"activityCode2": "string",
"activityCode3": "string",
"activityCode4": "string",
"activityCode5": "string"
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
POST /api/v1/schedule-activities
Creates a new schedule activity with the fields provided.
Required Fields:
- name
- activityType
- project.Id
- externalId
- externalProjectId
- externalProjectName
- workBreakdownStructureName
Request Content-Types: application/json, text/json
Request Example
{
"id": "integer (int32)",
"name": "string",
"activityType": "string",
"project": {
"id": "integer (int32)"
},
"job": {
"id": "integer (int32)",
"name": "string"
},
"externalId": "string",
"externalProjectId": "string",
"externalProjectName": "string",
"workBreakdownStructureId": "integer (int32)",
"workBreakdownStructureName": "string",
"startDate": "string (date-time)",
"finishDate": "string (date-time)",
"isActualStartDate": "boolean",
"isActualFinishDate": "boolean",
"totalFloat": "integer (int32)",
"freeFloat": "integer (int32)",
"activityCode1": "string",
"activityCode2": "string",
"activityCode3": "string",
"activityCode4": "string",
"activityCode5": "string"
}
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": {
"id": "integer (int32)"
},
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
GET /api/v1/schedule-activities/{id}
Gets a schedule activity with the specified identifier.
id
(no description)
type
integer
(int32)
in
path
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"activityType": "string",
"project": {
"id": "integer (int32)"
},
"job": {
"id": "integer (int32)",
"name": "string"
},
"externalId": "string",
"externalProjectId": "string",
"externalProjectName": "string",
"workBreakdownStructureId": "integer (int32)",
"workBreakdownStructureName": "string",
"startDate": "string (date-time)",
"finishDate": "string (date-time)",
"isActualStartDate": "boolean",
"isActualFinishDate": "boolean",
"totalFloat": "integer (int32)",
"freeFloat": "integer (int32)",
"activityCode1": "string",
"activityCode2": "string",
"activityCode3": "string",
"activityCode4": "string",
"activityCode5": "string"
},
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
DELETE /api/v1/schedule-activities/{id}
Deletes a scheduled activity with the specified identifier.
id
(no description)
type
integer
(int32)
in
path
204 No Content
No Content
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
PATCH /api/v1/schedule-activities/{id}
Updates specified values on a schedule activity
Updatable Fields:
- name
- job
- externalProjectId
- externalProjectName
- workBreakdownStructureId
- workBreakdownStructureName
- startDate
- finishDate
- isActualStartDate
- isActualFinishDate
- totalFloat
- freeFloat
- activityType
- activityCode
id
(no description)
type
integer
(int32)
in
path
Request Content-Types: application/json, text/json
Request Example
"object"
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"activityType": "string",
"project": {
"id": "integer (int32)"
},
"job": {
"id": "integer (int32)",
"name": "string"
},
"externalId": "string",
"externalProjectId": "string",
"externalProjectName": "string",
"workBreakdownStructureId": "integer (int32)",
"workBreakdownStructureName": "string",
"startDate": "string (date-time)",
"finishDate": "string (date-time)",
"isActualStartDate": "boolean",
"isActualFinishDate": "boolean",
"totalFloat": "integer (int32)",
"freeFloat": "integer (int32)",
"activityCode1": "string",
"activityCode2": "string",
"activityCode3": "string",
"activityCode4": "string",
"activityCode5": "string"
}
}
Shipment Items
GET /api/v1/shipment-items
Gets a list of shipment items that meet the specified filter criteria.
Available Filter Operator(s):
- Exact Match ==
Filter(s) using ==:
- shipmentId
- shippingUnitId
- purchaseOrderDeliveryLineId
Gets shipment item information specified by include criteria.
Include Operators:
- *default (optional) : returns pre-specified list of shipment item fields
- *all : returns all (default and additional) fields
- .* : returns additional information on supported nested fields
Supported nested fields:
- catalogItem.
Available Include fields:
Optional fields included by \default
- id
- lineNumber
- subLineNumber
- catalogItem
- purchaseOrderDeliveryLine
- material
- shippingUnit
- shipment
- materialStage
- quantityExpected
- packingListQuantity
Additional optional fields excluded by *default
- dateModified
- dateConfirmedShipped
- dateConfirmedArrived
filter
(no description)
type
string
in
query
include
(no description)
type
string
in
query
page
(no description)
type
integer
(int32)
in
query
showTotalCount
(no description)
type
boolean
in
query
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"catalogItem": {
"id": "integer (int32)",
"name": "string",
"centerOfGravity": "string",
"description": "string",
"notes": "string",
"size": "string",
"shortDescription": "string",
"specializedTrailer": "boolean",
"storageRequirement": "string",
"tagNumber": "string",
"volume": "string",
"length": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"width": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"height": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"weight": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"discipline": {
"id": "integer (int32)",
"name": "string"
},
"materialType": {
"id": "integer (int32)",
"name": "string"
},
"project": {
"id": "integer (int32)",
"name": "string"
},
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
},
"customFields": "object"
},
"purchaseOrderDeliveryLine": {
"id": "integer (int32)"
},
"material": {
"id": "integer (int32)"
},
"shippingUnit": {
"id": "integer (int32)"
},
"shipment": {
"id": "integer (int32)"
},
"materialStage": {
"barcode": "string",
"rfidTag": "string",
"inventoryTypeId": "integer (int32)"
},
"quantityExpected": "number (double)",
"packingListQuantity": "number (double)",
"dateConfirmedShipped": "string (date-time)",
"dateConfirmedArrived": "string (date-time)",
"dateModified": "string (date-time)"
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
POST /api/v1/shipment-items
Creates a new shipment item with the fields provided.
Required Fields:
- catalogItem.Id OR purchaseOrderDeliveryLine.Id
- shipment.Id OR shippingUnit.Id
- quantityExpected
Request Content-Types: application/json, text/json
Request Example
{
"id": "integer (int32)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"catalogItem": {
"id": "integer (int32)"
},
"shippingUnit": {
"id": "integer (int32)"
},
"shipment": {
"id": "integer (int32)"
},
"purchaseOrderDeliveryLine": {
"id": "integer (int32)"
},
"material": {
"id": "integer (int32)"
},
"materialStage": {
"barcode": "string",
"rfidTag": "string",
"inventoryTypeId": "integer (int32)"
},
"quantityExpected": "number (double)",
"packingListQuantity": "number (double)",
"dateConfirmedShipped": "string (date-time)",
"dateConfirmedArrived": "string (date-time)",
"dateModified": "string (date-time)"
}
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"catalogItem": {
"id": "integer (int32)"
},
"shippingUnit": {
"id": "integer (int32)"
},
"shipment": {
"id": "integer (int32)"
},
"purchaseOrderDeliveryLine": {
"id": "integer (int32)"
},
"material": {
"id": "integer (int32)"
},
"materialStage": {
"barcode": "string",
"rfidTag": "string",
"inventoryTypeId": "integer (int32)"
},
"quantityExpected": "number (double)",
"packingListQuantity": "number (double)",
"dateConfirmedShipped": "string (date-time)",
"dateConfirmedArrived": "string (date-time)",
"dateModified": "string (date-time)"
}
}
GET /api/v1/shipment-items/{id}
Gets a shipment item with the specified identifier.
id
(no description)
type
integer
(int32)
in
path
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"catalogItem": {
"id": "integer (int32)"
},
"shippingUnit": {
"id": "integer (int32)"
},
"shipment": {
"id": "integer (int32)"
},
"purchaseOrderDeliveryLine": {
"id": "integer (int32)"
},
"material": {
"id": "integer (int32)"
},
"materialStage": {
"barcode": "string",
"rfidTag": "string",
"inventoryTypeId": "integer (int32)"
},
"quantityExpected": "number (double)",
"packingListQuantity": "number (double)",
"dateConfirmedShipped": "string (date-time)",
"dateConfirmedArrived": "string (date-time)",
"dateModified": "string (date-time)"
}
}
DELETE /api/v1/shipment-items/{id}
Deletes the shipment item with the specified identifier.
id
(no description)
type
integer
(int32)
in
path
204 No Content
No Content
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
NotFound
409 Conflict
Conflict
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
PATCH /api/v1/shipment-items/{id}
Updates specified values on a shipment item.
Updatable Fields:
- quantityExpected
- materialStage
id
(no description)
type
integer
(int32)
in
path
Request Content-Types: application/json, text/json
Request Example
"object"
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"catalogItem": {
"id": "integer (int32)"
},
"shippingUnit": {
"id": "integer (int32)"
},
"shipment": {
"id": "integer (int32)"
},
"purchaseOrderDeliveryLine": {
"id": "integer (int32)"
},
"material": {
"id": "integer (int32)"
},
"materialStage": {
"barcode": "string",
"rfidTag": "string",
"inventoryTypeId": "integer (int32)"
},
"quantityExpected": "number (double)",
"packingListQuantity": "number (double)",
"dateConfirmedShipped": "string (date-time)",
"dateConfirmedArrived": "string (date-time)",
"dateModified": "string (date-time)"
}
}
Shipment Release Notices
GET /api/v1/shipment-release-notices
Gets a list of shipment release notices that meet the specified filter criteria.
Available Filter Operator(s):
- Exact Match ==
- Starts With =^
- Contains =@
Filter(s) using ==, =^, =@:
- name
- purchaseOrderName
filter
(no description)
type
string
in
query
page
(no description)
type
integer
(int32)
in
query
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"name": "string"
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Shipments
GET /api/v1/shipments
Gets a list of shipments that meet the specified filter criteria.
Available Filter Operator(s):
- Exact Match ==
- Starts With =^
- Contains =@
Filter(s) using ==, =^, =@:
- name
Filter(s) using ==:
- jobId
- puchaseOrderId
- supplierId
- toSiteId
- isTransfer
- statusId
filter
(no description)
type
string
in
query
page
(no description)
type
integer
(int32)
in
query
200 OK
OK
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"job": {
"id": "integer (int32)",
"name": "string"
},
"purchaseOrder": {
"id": "integer (int32)",
"name": "string"
},
"supplier": {
"id": "integer (int32)",
"name": "string"
},
"toSite": {
"id": "integer (int32)",
"name": "string"
},
"fromSite": {
"id": "integer (int32)",
"name": "string"
},
"isTransfer": "boolean",
"billOfLading": "string",
"vehicleNumber": "string",
"grossWeight": "string",
"packingListNumber": "string",
"release": {
"dateApproved": "string (date-time)"
},
"arrival": {
"date": "string (date-time)",
"dateConfirmed": "string (date-time)",
"confirmationNotes": "string"
},
"departure": {
"date": "string (date-time)",
"dateConfirmed": "string (date-time)",
"confirmationNotes": "string"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"dateModified": "string (date-time)"
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
POST /api/v1/shipments
Creates a shipment with the fields provided.
Required Fields:
- name
- job.Id
- toSite.Id
- fromSite.Id (if isTransfer == true)
- supplier.Id (if project setting 'Require Supplier on Shipments' is selected)
Note:
Both purchaseOrder.Id and Supplier.Id cannot be specified in the same request. One or the other can be specified but
neither are required, UNLESS the project setting 'Require Supplier on Shipments' is selected. If the purchaseOrder.Id is specified, the shipment.Supplier.Id is automatically set to the purchaseOrder.Supplier.Id.
Request Content-Types: application/json, text/json
Request Example
{
"name": "string",
"job": {
"id": "integer (int32)"
},
"purchaseOrder": {
"id": "integer (int32)"
},
"supplier": {
"id": "integer (int32)"
},
"fromSite": {
"id": "integer (int32)"
},
"toSite": {
"id": "integer (int32)"
},
"isTransfer": "boolean",
"billOfLading": "string",
"vehicleNumber": "string",
"grossWeight": "string",
"packingListNumber": "string",
"departure": {
"date": "string (date-time)",
"dateConfirmed": "string (date-time)",
"confirmationNotes": "string"
},
"arrival": {
"date": "string (date-time)",
"dateConfirmed": "string (date-time)",
"confirmationNotes": "string"
}
}
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"job": {
"id": "integer (int32)",
"name": "string"
},
"purchaseOrder": {
"id": "integer (int32)",
"name": "string"
},
"supplier": {
"id": "integer (int32)",
"name": "string"
},
"toSite": {
"id": "integer (int32)",
"name": "string"
},
"fromSite": {
"id": "integer (int32)",
"name": "string"
},
"isTransfer": "boolean",
"billOfLading": "string",
"vehicleNumber": "string",
"grossWeight": "string",
"packingListNumber": "string",
"release": {
"dateApproved": "string (date-time)"
},
"arrival": {
"date": "string (date-time)",
"dateConfirmed": "string (date-time)",
"confirmationNotes": "string"
},
"departure": {
"date": "string (date-time)",
"dateConfirmed": "string (date-time)",
"confirmationNotes": "string"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"dateModified": "string (date-time)"
}
}
GET /api/v1/shipments/{id}
Gets a shipment with the specified identifier.
id
(no description)
type
integer
(int32)
in
path
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"job": {
"id": "integer (int32)",
"name": "string"
},
"purchaseOrder": {
"id": "integer (int32)",
"name": "string"
},
"supplier": {
"id": "integer (int32)",
"name": "string"
},
"toSite": {
"id": "integer (int32)",
"name": "string"
},
"fromSite": {
"id": "integer (int32)",
"name": "string"
},
"isTransfer": "boolean",
"billOfLading": "string",
"vehicleNumber": "string",
"grossWeight": "string",
"packingListNumber": "string",
"release": {
"dateApproved": "string (date-time)"
},
"arrival": {
"date": "string (date-time)",
"dateConfirmed": "string (date-time)",
"confirmationNotes": "string"
},
"departure": {
"date": "string (date-time)",
"dateConfirmed": "string (date-time)",
"confirmationNotes": "string"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"dateModified": "string (date-time)"
}
}
DELETE /api/v1/shipments/{id}
Deletes the shipment with the specified identifier.
id
(no description)
type
integer
(int32)
in
path
204 No Content
No Content
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
409 Conflict
Conflict
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
PATCH /api/v1/shipments/{id}
Updates specified values on a shipment.
Updatable Fields:
- purchaseOrder
- supplier
- fromSite
- isTransfer
- billOfLading
- vehicleNumber
- grossWeight
- packingListNumber
- dateShipped
- dateArrived
id
(no description)
type
integer
(int32)
in
path
Request Content-Types: application/json, text/json
Request Example
"object"
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"job": {
"id": "integer (int32)",
"name": "string"
},
"purchaseOrder": {
"id": "integer (int32)",
"name": "string"
},
"supplier": {
"id": "integer (int32)",
"name": "string"
},
"toSite": {
"id": "integer (int32)",
"name": "string"
},
"fromSite": {
"id": "integer (int32)",
"name": "string"
},
"isTransfer": "boolean",
"billOfLading": "string",
"vehicleNumber": "string",
"grossWeight": "string",
"packingListNumber": "string",
"release": {
"dateApproved": "string (date-time)"
},
"arrival": {
"date": "string (date-time)",
"dateConfirmed": "string (date-time)",
"confirmationNotes": "string"
},
"departure": {
"date": "string (date-time)",
"dateConfirmed": "string (date-time)",
"confirmationNotes": "string"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"dateModified": "string (date-time)"
}
}
Shipping Unit Types
GET /api/v1/shipping-unit-types
Gets a list of matching shipping unit types.
Available Filter Operator(s):
- Exact Match ==
Filter(s) using ==:
- isActive
filter
(no description)
type
string
in
query
page
(no description)
type
integer
(int32)
in
query
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"isDefault": "boolean"
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Shipping Units
GET /api/v1/shipping-units
Gets a list of shipping units that meet the specified filter criteria.
Available Filter Operator(s):
- Exact Match ==
- Starts With =^
- Contains =@
Filter(s) using ==, =^, =@:
- name
- rfidTag
Filter(s) using ==:
- purchaseOrderId
- barcode
Gets shipping unit information specified by include criteria.
Include Operators:
- *default (optional) : returns pre-specified list of shipping unit fields
- *all : returns all (default and additional) fields
- .* : returns additional information on supported nested fields
Supported nested fields:
- createdByUser.*
- modifiedByUser.*
- job.*
Available Include fields:
Optional fields included by *default
- id
- name
- barcode
- shippingUnitType
- parentShippingUnit
- status
- job
- supplier
- purchaseOrder
- shipment
- location
- specializedTrailer
- rfidTags
- flags
Additional optional fields excluded by *default
- dateCreated
- dateModified
- createdByUser
- modifiedByUser
- length
- width
- height
- weight
- volume
Examples:
shipping-units?
or shipping-units?include=*default : returns all fields listed by default
shipping-units?include=name,rfidtags : returns only shipping unit name and related RFID tags
shipping-units?include=*default,createdByUser : returns all default fields and createdByUser information
shipping-units?include=createdByUser.* : returns nested information about created by user field only
shipping-units?include=*all : returns all (i.e., default and optional fields) unnested shipping unit information
shipping-units?include=*all,createdByUser.* : returns all shipping unit information and nested information about createdByUser
filter
(no description)
type
string
in
query
include
(no description)
type
string
in
query
page
(no description)
type
integer
(int32)
in
query
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"barcode": "string",
"shippingUnitType": {
"id": "integer (int32)",
"name": "string"
},
"parentShippingUnit": {
"id": "integer (int32)",
"name": "string"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"job": {
"id": "integer (int32)",
"name": "string",
"description": "string",
"abbreviation": "string",
"isActive": "boolean",
"project": {
"id": "integer (int32)"
}
},
"supplier": {
"id": "integer (int32)",
"name": "string"
},
"purchaseOrder": {
"id": "integer (int32)",
"name": "string"
},
"shipment": {
"id": "integer (int32)",
"name": "string"
},
"location": {
"latitude": "number (double)",
"longitude": "number (double)",
"dateLocated": "string (date-time)",
"horizontalErrorMeters": "number (double)",
"namedLocation": {
"id": "integer (int32)",
"name": "string"
},
"yard": {
"id": "integer (int32)"
},
"zones": [
{
"id": "integer (int32)"
}
]
},
"specializedTrailer": "boolean",
"dateCreated": "string (date-time)",
"createdByUser": {
"id": "integer (int32)",
"name": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"internalId": "string",
"company": "string",
"isSupplierUser": "boolean",
"isLocked": "boolean",
"isMobileUser": "boolean",
"phone": "string",
"email": "string"
},
"dateModified": "string (date-time)",
"modifiedByUser": {
"id": "integer (int32)",
"name": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"internalId": "string",
"company": "string",
"isSupplierUser": "boolean",
"isLocked": "boolean",
"isMobileUser": "boolean",
"phone": "string",
"email": "string"
},
"length": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
}
}
]
}
POST /api/v1/shipping-units
Creates a new shipping unit with the fields provided.
Required Fields:
- name
- job.Id
- shippingUnitType.Id
Note: Both shipment.Id and purchaseOrder.Id cannot be specified in the same request.
Request Content-Types: application/json, text/json
Request Example
{
"id": "integer (int32)",
"name": "string",
"barcode": "string",
"rfidTags": [
"string"
],
"shippingUnitType": {
"id": "integer (int32)"
},
"parentShippingUnit": {
"id": "integer (int32)"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"job": {
"id": "integer (int32)",
"name": "string"
},
"supplier": {
"id": "integer (int32)",
"name": "string"
},
"purchaseOrder": {
"id": "integer (int32)",
"name": "string"
},
"shipment": {
"id": "integer (int32)"
},
"location": {
"latitude": "number (double)",
"longitude": "number (double)",
"dateLocated": "string (date-time)",
"horizontalErrorMeters": "number (double)",
"namedLocation": {
"id": "integer (int32)",
"name": "string"
},
"yard": {
"id": "integer (int32)"
},
"zones": [
{
"id": "integer (int32)"
}
]
},
"specializedTrailer": "boolean",
"flags": [
{
"name": "string",
"description": "string"
}
]
}
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"barcode": "string",
"rfidTags": [
"string"
],
"shippingUnitType": {
"id": "integer (int32)"
},
"parentShippingUnit": {
"id": "integer (int32)"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"job": {
"id": "integer (int32)",
"name": "string"
},
"supplier": {
"id": "integer (int32)",
"name": "string"
},
"purchaseOrder": {
"id": "integer (int32)",
"name": "string"
},
"shipment": {
"id": "integer (int32)"
},
"location": {
"latitude": "number (double)",
"longitude": "number (double)",
"dateLocated": "string (date-time)",
"horizontalErrorMeters": "number (double)",
"namedLocation": {
"id": "integer (int32)",
"name": "string"
},
"yard": {
"id": "integer (int32)"
},
"zones": [
{
"id": "integer (int32)"
}
]
},
"specializedTrailer": "boolean",
"flags": [
{
"name": "string",
"description": "string"
}
]
},
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
GET /api/v1/shipping-units/{id}
Gets a shipping unit that matches the given id.
Include Operators:
- *default (optional) : returns pre-specified list of shipping unit fields
- *all : returns all (default and additional) fields
- .* : returns additional information on supported nested fields
Supported nested fields:
- createdByUser.*
- modifiedByUser.*
- job.*
Available Include fields:
Optional fields included by *default
- id
- name
- barcode
- shippingUnitType
- parentShippingUnit
- status
- job
- supplier
- purchaseOrder
- shipment
- location
- specializedTrailer
- rfidTags
- flags
Additional optional fields excluded by *default
- dateCreated
- dateModified
- createdByUser
- modifiedByUser
- length
- width
- height
- weight
- volume
id
(no description)
type
integer
(int32)
in
path
include
(no description)
type
string
in
query
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"barcode": "string",
"shippingUnitType": {
"id": "integer (int32)",
"name": "string"
},
"parentShippingUnit": {
"id": "integer (int32)",
"name": "string"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"job": {
"id": "integer (int32)",
"name": "string",
"description": "string",
"abbreviation": "string",
"isActive": "boolean",
"project": {
"id": "integer (int32)"
}
},
"supplier": {
"id": "integer (int32)",
"name": "string"
},
"purchaseOrder": {
"id": "integer (int32)",
"name": "string"
},
"shipment": {
"id": "integer (int32)",
"name": "string"
},
"location": {
"latitude": "number (double)",
"longitude": "number (double)",
"dateLocated": "string (date-time)",
"horizontalErrorMeters": "number (double)",
"namedLocation": {
"id": "integer (int32)",
"name": "string"
},
"yard": {
"id": "integer (int32)"
},
"zones": [
{
"id": "integer (int32)"
}
]
},
"specializedTrailer": "boolean",
"dateCreated": "string (date-time)",
"createdByUser": {
"id": "integer (int32)",
"name": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"internalId": "string",
"company": "string",
"isSupplierUser": "boolean",
"isLocked": "boolean",
"isMobileUser": "boolean",
"phone": "string",
"email": "string"
},
"dateModified": "string (date-time)",
"modifiedByUser": {
"id": "integer (int32)",
"name": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"internalId": "string",
"company": "string",
"isSupplierUser": "boolean",
"isLocked": "boolean",
"isMobileUser": "boolean",
"phone": "string",
"email": "string"
},
"length": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"width": {
"value": "number (double)"
}
}
}
GET /api/v1/shipping-units/{id}/labels
Gets a list of shipping unit templates that meet the specified filter criteria.
Available Filter Operator:
- Exact Match ==
Filter:
- isDefault
Font sizes:
- Small = 0
- Medium = 1
- Large = 2
- XLarge = 3
Number of lines:
Specify value (max 5) or use 0 for Auto
id
(no description)
type
integer
(int32)
in
path
filter
(no description)
type
string
in
query
page
(no description)
type
integer
(int32)
in
query
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"templateType": {
"id": "integer (int32)",
"name": "string"
},
"isDefault": "boolean",
"isActive": "boolean",
"labelHeight": "number (double)",
"labelWidth": "number (double)",
"barcodePosition": "string",
"barcode": "string",
"fields": [
{
"order": "integer (int32)",
"caption": "string",
"hideBlank": "boolean",
"numberOfLines": "integer (int32)",
"fontSize": "integer (int32)",
"value": "string"
}
]
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
GET /api/v1/shipping-units/{id}/labels/{labelId}
Gets the label template with the specified identifier for the specified shipping unit
Font sizes:
- Small = 0
- Medium = 1
- Large = 2
- XLarge = 3
Number of lines:
Specify value (max 5) or use 0 for Auto
id
(no description)
type
integer
(int32)
in
path
labelId
(no description)
type
integer
(int32)
in
path
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"templateType": {
"id": "integer (int32)",
"name": "string"
},
"isDefault": "boolean",
"isActive": "boolean",
"labelHeight": "number (double)",
"labelWidth": "number (double)",
"barcodePosition": "string",
"barcode": "string",
"fields": [
{
"order": "integer (int32)",
"caption": "string",
"hideBlank": "boolean",
"numberOfLines": "integer (int32)",
"fontSize": "integer (int32)",
"value": "string"
}
]
}
}
Sites
GET /api/v1/sites
Gets a list of sites that meet the specified filter criteria.
Available Filter Operator(s):
- Exact Match ==
- Starts With =^
- Contains =@
Filter(s) using ==, =^, =@:
- name
filter
(no description)
type
string
in
query
page
(no description)
type
integer
(int32)
in
query
200 OK
OK
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
POST /api/v1/sites
Creates a site with the fields provided.
Required Fields:
- name
- project.Id
Request Content-Types: application/json, text/json
Request Example
{
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
}
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
}
}
GET /api/v1/sites/{id}
Gets a site with the specified identifier.
id
(no description)
type
integer
(int32)
in
path
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
}
}
DELETE /api/v1/sites/{id}
Deletes the site with the specified identifier.
id
(no description)
type
integer
(int32)
in
path
204 No Content
No Content
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
409 Conflict
Conflict
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
PATCH /api/v1/sites/{id}
Updates specified values on a site.
Updatable Fields:
- Name
- isToLocation
- isFromLocation
- isWorkOrDeliverySite
- Address: All fields
id
(no description)
type
integer
(int32)
in
path
Request Content-Types: application/json, text/json
Request Example
"object"
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
}
}
Statuses
GET /api/v1/statuses
Gets a list of statuses that meet the specified filter criteria.
Filter(s) using ==, =^, =@:
- name
Filter(s) using ==:
- isActive (default: true)
filter
(no description)
type
string
in
query
page
(no description)
type
integer
(int32)
in
query
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"isPicked": "boolean",
"isActive": "boolean",
"isIssuable": "boolean",
"isRequestable": "boolean",
"autoDisassociate": "boolean",
"autoReturnToStock": "boolean",
"autoEndPreventativeMaintenance": "boolean",
"showOnMap": "boolean"
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
POST /api/v1/statuses
Creates a status with the fields provided.
Required Fields:
- name
- project.Id
Request Content-Types: application/json, text/json
Request Example
{
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"isPicked": "boolean",
"isActive": "boolean",
"isIssuable": "boolean",
"isRequestable": "boolean",
"autoDisassociate": "boolean",
"autoReturnToStock": "boolean",
"autoEndPreventativeMaintenance": "boolean",
"showOnMap": "boolean"
}
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"isPicked": "boolean",
"isActive": "boolean",
"isIssuable": "boolean",
"isRequestable": "boolean",
"autoDisassociate": "boolean",
"autoReturnToStock": "boolean",
"autoEndPreventativeMaintenance": "boolean",
"showOnMap": "boolean"
}
}
GET /api/v1/statuses/{id}
Gets a status with the specified identifier.
id
(no description)
type
integer
(int32)
in
path
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"isPicked": "boolean",
"isActive": "boolean",
"isIssuable": "boolean",
"isRequestable": "boolean",
"autoDisassociate": "boolean",
"autoReturnToStock": "boolean",
"autoEndPreventativeMaintenance": "boolean",
"showOnMap": "boolean"
},
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
DELETE /api/v1/statuses/{id}
Deletes the status with the specified identifier.
id
(no description)
type
integer
(int32)
in
path
204 No Content
No Content
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
PATCH /api/v1/statuses/{id}
Updates specified values on a status.
Updatable Fields:
- name
- requestable
- picked
- issuable
- showOnMap
- autoDisassociate
- autoReturnToStock
- autoEndPreventativeMaintenance
- isActive
id
(no description)
type
integer
(int32)
in
path
Request Content-Types: application/json, text/json
Request Example
"object"
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"isPicked": "boolean",
"isActive": "boolean",
"isIssuable": "boolean",
"isRequestable": "boolean",
"autoDisassociate": "boolean",
"autoReturnToStock": "boolean",
"autoEndPreventativeMaintenance": "boolean",
"showOnMap": "boolean"
}
}
Supplier
GET /api/v1/suppliers
Gets a list of suppliers.
include
(no description)
type
string
in
query
page
(no description)
type
integer
(int32)
in
query
200 OK
OK
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"code": "string",
"project": {
"id": "integer (int32)"
},
"addresses": [
{
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
}
]
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
GET /api/v1/suppliers/{id}
Gets a supplier with the specified identifier.
id
(no description)
type
integer
(int32)
in
path
include
(no description)
type
string
in
query
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"code": "string",
"project": {
"id": "integer (int32)"
},
"addresses": [
{
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
}
]
}
}
Units Of Measure
GET /api/v1/units-of-measure/{unitOfMeasureId}
Gets a unit of measure with the specified identifier.
unitOfMeasureId
(no description)
type
integer
(int32)
in
path
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"project": {
"id": "integer (int32)"
},
"name": "string",
"description": "string"
}
}
Users
GET /api/v1/users
Gets a list of users with the specified filter criteria.
Available Filter Operator(s):
- Exact Match ==
- Starts With =^
- Contains =@
Filter(s) using ==, =^, =@:
- name
- firstName
- lastName
- company
Filter(s) using ==:
- isSuperUser
- isActive
- isUserManager
- isLocked
- isMobileUser
- isSupplierUser
filter
(no description)
type
string
in
query
page
(no description)
type
integer
(int32)
in
query
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"company": "string",
"email": "string",
"employee": {
"id": "integer (int32)"
},
"firstName": "string",
"id": "integer (int32)",
"internalId": "string",
"isActive": "boolean",
"isLocked": "boolean",
"isMobileUser": "boolean",
"isSuperUser": "boolean",
"isSupplierUser": "boolean",
"isSupportUser": "boolean",
"isUserManager": "boolean",
"lastName": "string",
"middleName": "string",
"name": "string",
"phoneNumber": "string",
"title": {
"name": "string"
}
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
POST /api/v1/users
Creates a user with the fields provided.
Required Fields:
- name
- firstName
- lastName
Request Content-Types: application/json, text/json
Request Example
{
"id": "integer (int32)",
"name": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"internalId": "string",
"company": "string",
"isSupplierUser": "boolean",
"isLocked": "boolean",
"isMobileUser": "boolean",
"phone": "string",
"email": "string"
}
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"internalId": "string",
"company": "string",
"isSupplierUser": "boolean",
"isLocked": "boolean",
"isMobileUser": "boolean",
"phone": "string",
"email": "string"
}
}
GET /api/v1/users/{id}
Gets a user with the specified identifier.
id
(no description)
type
integer
(int32)
in
path
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": {
"company": "string",
"email": "string",
"employee": {
"id": "integer (int32)"
},
"firstName": "string",
"id": "integer (int32)",
"internalId": "string",
"isActive": "boolean",
"isLocked": "boolean",
"isMobileUser": "boolean",
"isSuperUser": "boolean",
"isSupplierUser": "boolean",
"isSupportUser": "boolean",
"isUserManager": "boolean",
"lastName": "string",
"middleName": "string",
"name": "string",
"phoneNumber": "string",
"title": {
"name": "string"
}
},
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
DELETE /api/v1/users/{id}
Deletes a user with specified identifier.
id
(no description)
type
integer
(int32)
in
path
204 No Content
No Content
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
422 Unprocessable Entity
422
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
PATCH /api/v1/users/{id}
Updates specified values on a user.
Updatable Fields:
- firstName
- middleName
- lastName
- internalId
- company
- isSupplierUser
- isActive
- isLocked
- isMobileUser
- phone
- email
id
(no description)
type
integer
(int32)
in
path
Request Content-Types: application/json, text/json
Request Example
"object"
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"internalId": "string",
"company": "string",
"isSupplierUser": "boolean",
"isLocked": "boolean",
"isMobileUser": "boolean",
"phone": "string",
"email": "string"
}
}
GET /api/v1/users/{id}/permissions
Gets the list of permissions for the user with the specified identifier.
Example:
/users/183/permissions
id
(no description)
type
integer
(int32)
in
path
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"materialsPermissions": {
"addAttachments": "boolean",
"editStatus": "boolean",
"modify": "boolean",
"view": "boolean"
}
}
Permissions
GET /api/v1/users/{id}/permissions
Gets the list of permissions for the user with the specified identifier.
Example:
/users/183/permissions
id
(no description)
type
integer
(int32)
in
path
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"materialsPermissions": {
"addAttachments": "boolean",
"editStatus": "boolean",
"modify": "boolean",
"view": "boolean"
}
}
Version
GET /api/v1/version
Gets version information for the available Jovix installation package.
Examples:
Get Version Number:
/version
200 OK
OK
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
"string"
GET /api/v1/version/package
Gets the available Jovix installation package.
Examples:
Get Jovix Package:
/version/package
200 OK
OK
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
"object"
GET /api/v1/versions
OK
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"api": "string",
"offlineTablet": "string",
"server": "string"
}
GET /api/v1/versions/offlinetablet/download
200 OK
OK
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
"object"
Withdrawal Request Items
GET /api/v1/withdrawal-request-items
Gets a list of withdrawal request items with the specified filters.
Available Filter Operator(s):
- Exact Match ==
- Starts With =^
- Contains =@
Filter(s) using ==, =^, =@:
- withdrawalRequestName
Filter(s) using ==:
- withdrawalRequestId
- catalogItemId
- deliverySiteId
Default Jovix Withdrawal Request Statuses:
- Requested = 0
- Partially Reserved = 1
- Reserved = 2
- Picking = 3
- Picked = 4
- Issued = 5
filter
(no description)
type
string
in
query
include
(no description)
type
string
in
query
page
(no description)
type
integer
(int32)
in
query
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"withdrawalRequest": {
"id": "integer (int32)",
"name": "string",
"notes": "string",
"description": "string",
"deliverByDate": "string (date-time)",
"requiredAtSiteDate": "string (date-time)",
"requestedOnDate": "string (date-time)",
"status": {
"id": "integer (int32)",
"name": "string"
},
"deliverySite": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
},
"pickSite": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
},
"job": {
"id": "integer (int32)",
"name": "string",
"description": "string",
"abbreviation": "string",
"isActive": "boolean",
"project": {
"id": "integer (int32)"
}
},
"customField_1": "string",
"customField_2": "string",
"customField_3": "string",
"customField_4": "string",
"customField_5": "string",
"customField_6": "string",
"customField_7": "string",
"customField_8": "string",
"customField_9": "string",
"customField_10": "string",
"customField_11": "string",
"customField_12": "string",
"customField_13": "string",
"customField_14": "string",
"customField_15": "string",
"customField_16": "string",
"customField_17": "string",
"customField_18": "string",
"customField_19": "string",
"customField_20": "string"
}
}
]
}
POST /api/v1/withdrawal-request-items
Creates a withdrawal request item with the fields provided.
Required Fields:
- withdrawalRequest.Id
- requestedQuantity
Either catalogItem.Id or workPackageItem.Id must be specified.
Request Content-Types: application/json, text/json
Request Example
{
"withdrawalRequest": {
"id": "integer (int32)"
},
"requestedQuantity": "number (double)",
"catalogItem": {
"id": "integer (int32)"
},
"workPackageItem": {
"id": "integer (int32)"
},
"isReserved": "boolean",
"customField_1": "object",
"customField_2": "object",
"customField_3": "object",
"customField_4": "object",
"customField_5": "object",
"customField_6": "object",
"customField_7": "object",
"customField_8": "object",
"customField_9": "object",
"customField_10": "object",
"customField_11": "object",
"customField_12": "object",
"customField_13": "object",
"customField_14": "object",
"customField_15": "object",
"customField_16": "object",
"customField_17": "object",
"customField_18": "object",
"customField_19": "object",
"customField_20": "object",
"customField_21": "object",
"customField_22": "object",
"customField_23": "object",
"customField_24": "object",
"customField_25": "object",
"customField_26": "object",
"customField_27": "object",
"customField_28": "object",
"customField_29": "object",
"customField_30": "object"
}
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"withdrawalRequest": {
"id": "integer (int32)",
"name": "string",
"notes": "string",
"description": "string",
"deliverByDate": "string (date-time)",
"requiredAtSiteDate": "string (date-time)",
"requestedOnDate": "string (date-time)",
"status": {
"id": "integer (int32)",
"name": "string"
},
"deliverySite": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
},
"pickSite": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
},
"job": {
"id": "integer (int32)",
"name": "string",
"description": "string",
"abbreviation": "string",
"isActive": "boolean",
"project": {
"id": "integer (int32)"
}
},
"customField_1": "string",
"customField_2": "string",
"customField_3": "string",
"customField_4": "string",
"customField_5": "string",
"customField_6": "string",
"customField_7": "string",
"customField_8": "string",
"customField_9": "string",
"customField_10": "string",
"customField_11": "string",
"customField_12": "string",
"customField_13": "string",
"customField_14": "string",
"customField_15": "string",
"customField_16": "string",
"customField_17": "string",
"customField_18": "string",
"customField_19": "string",
"customField_20": "string",
"customField_21": "string",
"customField_22": "string",
"customField_23": "string"
}
}
}
GET /api/v1/withdrawal-request-items/{id}
Gets a withdrawal request with the specified identifier.
Use the include parameter to define a fieldset or expansion.
Available Fieldsets:
-
default
-all
Available Expansions:
-catalogItem
-withdrawalRequest
-workPackageItem
id
(no description)
type
integer
(int32)
in
path
include
(no description)
type
string
in
query
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"withdrawalRequest": {
"id": "integer (int32)"
},
"workPackageItem": {
"id": "integer (int32)"
},
"catalogItem": {
"id": "integer (int32)"
},
"material": {
"id": "integer (int32)"
},
"requestedQuantity": "number (double)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"isReserved": "boolean",
"customField_1": "string",
"customField_2": "string",
"customField_3": "string",
"customField_4": "string",
"customField_5": "string",
"customField_6": "string",
"customField_7": "string",
"customField_8": "string",
"customField_9": "string",
"customField_10": "string",
"customField_11": "string",
"customField_12": "string",
"customField_13": "string",
"customField_14": "string",
"customField_15": "string",
"customField_16": "string",
"customField_17": "string",
"customField_18": "string",
"customField_19": "string",
"customField_20": "string",
"customField_21": "string",
"customField_22": "string",
"customField_23": "string",
"customField_24": "string",
"customField_25": "string",
"customField_26": "string",
"customField_27": "string",
"customField_28": "string",
"customField_29": "string",
"customField_30": "string"
}
}
DELETE /api/v1/withdrawal-request-items/{id}
Deletes a withdrawal request item by id.
id
(no description)
type
integer
(int32)
in
path
204 No Content
No Content
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
409 Conflict
Conflict
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
PATCH /api/v1/withdrawal-request-items/{id}
Updates specified values on a withdrawal request item.
Updatable Fields -
- requestedQuantity
- isReserved
- customFields
id
(no description)
type
integer
(int32)
in
path
Request Content-Types: application/json, text/json
Request Example
{
"requestedQuantity": "number (double)",
"isReserved": "boolean",
"customField_1": "object",
"customField_2": "object",
"customField_3": "object",
"customField_4": "object",
"customField_5": "object",
"customField_6": "object",
"customField_7": "object",
"customField_8": "object",
"customField_9": "object",
"customField_10": "object",
"customField_11": "object",
"customField_12": "object",
"customField_13": "object",
"customField_14": "object",
"customField_15": "object",
"customField_16": "object",
"customField_17": "object",
"customField_18": "object",
"customField_19": "object",
"customField_20": "object",
"customField_21": "object",
"customField_22": "object",
"customField_23": "object",
"customField_24": "object",
"customField_25": "object",
"customField_26": "object",
"customField_27": "object",
"customField_28": "object",
"customField_29": "object",
"customField_30": "object"
}
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"withdrawalRequest": {
"id": "integer (int32)",
"name": "string",
"notes": "string",
"description": "string",
"deliverByDate": "string (date-time)",
"requiredAtSiteDate": "string (date-time)",
"requestedOnDate": "string (date-time)",
"status": {
"id": "integer (int32)",
"name": "string"
},
"deliverySite": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
},
"pickSite": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
},
"job": {
"id": "integer (int32)",
"name": "string",
"description": "string",
"abbreviation": "string",
"isActive": "boolean",
"project": {
"id": "integer (int32)"
}
},
"customField_1": "string",
"customField_2": "string",
"customField_3": "string",
"customField_4": "string",
"customField_5": "string",
"customField_6": "string",
"customField_7": "string",
"customField_8": "string",
"customField_9": "string",
"customField_10": "string",
"customField_11": "string",
"customField_12": "string",
"customField_13": "string",
"customField_14": "string",
"customField_15": "string",
"customField_16": "string",
"customField_17": "string",
"customField_18": "string",
"customField_19": "string",
"customField_20": "string",
"customField_21": "string",
"customField_22": "string",
"customField_23": "string"
}
}
}
Withdrawal Requests
GET /api/v1/withdrawal-requests
Gets a list of withdrawal requests with the specified filters.
Available Filter Operator(s):
- Exact Match ==
- Starts With =^
- Contains =@
Filter(s) using ==, =^, =@:
- name
Filter(s) using ==, >=, <=:
- deliverByDate
Filter(s) using ==:
- jobId
- statusId
- deliverySiteId
- siteId
Default Jovix Withdrawal Request Statuses:
- Requested = 0
- Partially Reserved = 1
- Reserved = 2
- Picking = 3
- Picked = 4
- Issued = 5
filter
(no description)
type
string
in
query
include
(no description)
type
string
in
query
page
(no description)
type
integer
(int32)
in
query
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"notes": "string",
"description": "string",
"deliverByDate": "string (date-time)",
"requiredAtSiteDate": "string (date-time)",
"requestedOnDate": "string (date-time)",
"status": {
"id": "integer (int32)",
"name": "string"
},
"deliverySite": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
},
"pickSite": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
},
"job": {
"id": "integer (int32)",
"name": "string",
"description": "string",
"abbreviation": "string",
"isActive": "boolean",
"project": {
"id": "integer (int32)"
}
},
"customField_1": "string",
"customField_2": "string",
"customField_3": "string",
"customField_4": "string",
"customField_5": "string",
"customField_6": "string",
"customField_7": "string",
"customField_8": "string",
"customField_9": "string",
"customField_10": "string",
"customField_11": "string",
"customField_12": "string",
"customField_13": "string",
"customField_14": "string",
"customField_15": "string",
"customField_16": "string",
"customField_17": "string",
"customField_18": "string",
"customField_19": "string",
"customField_20": "string",
"customField_21": "string",
"customField_22": "string",
"customField_23": "string"
}
]
}
POST /api/v1/withdrawal-requests
Creates a withdrawal request with the fields provided.
Request Content-Types: application/json, text/json
Request Example
{
"name": "string",
"job": {
"id": "integer (int32)"
},
"deliverySite": {
"id": "integer (int32)"
},
"deliverByDate": "string (date-time)",
"requestedOnDate": "string (date-time)",
"description": "string",
"assignedToUser": {
"id": "integer (int32)"
},
"pickSite": {
"id": "integer (int32)"
},
"requiredAtSiteDate": "string (date-time)",
"deliverToEmployee": {
"id": "integer (int32)"
},
"deliverToPhoneNumber": "string",
"deliverToZone": {
"id": "integer (int32)"
},
"notes": "string",
"customField_1": "object",
"customField_2": "object",
"customField_3": "object",
"customField_4": "object",
"customField_5": "object",
"customField_6": "object",
"customField_7": "object",
"customField_8": "object",
"customField_9": "object",
"customField_10": "object",
"customField_11": "object",
"customField_12": "object",
"customField_13": "object",
"customField_14": "object",
"customField_15": "object",
"customField_16": "object",
"customField_17": "object",
"customField_18": "object",
"customField_19": "object",
"customField_20": "object",
"customField_21": "object",
"customField_22": "object",
"customField_23": "object",
"customField_24": "object",
"customField_25": "object",
"customField_26": "object",
"customField_27": "object",
"customField_28": "object",
"customField_29": "object",
"customField_30": "object"
}
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"notes": "string",
"description": "string",
"deliverByDate": "string (date-time)",
"requiredAtSiteDate": "string (date-time)",
"requestedOnDate": "string (date-time)",
"status": {
"id": "integer (int32)",
"name": "string"
},
"deliverySite": {
"id": "integer (int32)"
},
"pickSite": {
"id": "integer (int32)"
},
"job": {
"id": "integer (int32)"
},
"customField_1": "string",
"customField_2": "string",
"customField_3": "string",
"customField_4": "string",
"customField_5": "string",
"customField_6": "string",
"customField_7": "string",
"customField_8": "string",
"customField_9": "string",
"customField_10": "string",
"customField_11": "string",
"customField_12": "string",
"customField_13": "string",
"customField_14": "string",
"customField_15": "string",
"customField_16": "string",
"customField_17": "string",
"customField_18": "string",
"customField_19": "string",
"customField_20": "string",
"customField_21": "string",
"customField_22": "string",
"customField_23": "string",
"customField_24": "string",
"customField_25": "string",
"customField_26": "string",
"customField_27": "string",
"customField_28": "string",
"customField_29": "string",
"customField_30": "string"
}
}
GET /api/v1/withdrawal-requests/{id}
Gets a withdrawal request with the specified identifier.
id
(no description)
type
integer
(int32)
in
path
include
(no description)
type
string
in
query
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"notes": "string",
"description": "string",
"deliverByDate": "string (date-time)",
"requiredAtSiteDate": "string (date-time)",
"requestedOnDate": "string (date-time)",
"status": {
"id": "integer (int32)",
"name": "string"
},
"deliverySite": {
"id": "integer (int32)"
},
"pickSite": {
"id": "integer (int32)"
},
"job": {
"id": "integer (int32)"
},
"customField_1": "string",
"customField_2": "string",
"customField_3": "string",
"customField_4": "string",
"customField_5": "string",
"customField_6": "string",
"customField_7": "string",
"customField_8": "string",
"customField_9": "string",
"customField_10": "string",
"customField_11": "string",
"customField_12": "string",
"customField_13": "string",
"customField_14": "string",
"customField_15": "string",
"customField_16": "string",
"customField_17": "string",
"customField_18": "string",
"customField_19": "string",
"customField_20": "string",
"customField_21": "string",
"customField_22": "string",
"customField_23": "string",
"customField_24": "string",
"customField_25": "string",
"customField_26": "string",
"customField_27": "string",
"customField_28": "string",
"customField_29": "string",
"customField_30": "string"
}
}
DELETE /api/v1/withdrawal-requests/{id}
Deletes a withdrawal request by id.
id
(no description)
type
integer
(int32)
in
path
204 No Content
No Content
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
409 Conflict
Conflict
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
PATCH /api/v1/withdrawal-requests/{id}
Updates specified values on a withdrawal request.
Updatable Fields -
- name
- deliverySite.id
- assignedToUser.id
- deliverToEmployee.id
- deliverToZone.id
- pickSite.id
- description
- notes
- deliverToPhoneNumber.id
- requiredAtSiteDate
- deliverByDate
- requestedOnDate
- customFields
id
(no description)
type
integer
(int32)
in
path
Request Content-Types: application/json, text/json
Request Example
{
"name": "string",
"deliverySite": {
"id": "integer (int32)"
},
"pickSite": {
"id": "integer (int32)"
},
"deliverToEmployee": {
"id": "integer (int32)"
},
"assignedToUser": {
"id": "integer (int32)"
},
"deliverToZone": {
"id": "integer (int32)"
},
"deliverByDate": "string (date-time)",
"requestedOnDate": "string (date-time)",
"requiredAtSiteDate": "string (date-time)",
"description": "string",
"deliverToPhoneNumber": "string",
"notes": "string",
"customField_1": "object",
"customField_2": "object",
"customField_3": "object",
"customField_4": "object",
"customField_5": "object",
"customField_6": "object",
"customField_7": "object",
"customField_8": "object",
"customField_9": "object",
"customField_10": "object",
"customField_11": "object",
"customField_12": "object",
"customField_13": "object",
"customField_14": "object",
"customField_15": "object",
"customField_16": "object",
"customField_17": "object",
"customField_18": "object",
"customField_19": "object",
"customField_20": "object",
"customField_21": "object",
"customField_22": "object",
"customField_23": "object",
"customField_24": "object",
"customField_25": "object",
"customField_26": "object",
"customField_27": "object",
"customField_28": "object",
"customField_29": "object",
"customField_30": "object"
}
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"notes": "string",
"description": "string",
"deliverByDate": "string (date-time)",
"requiredAtSiteDate": "string (date-time)",
"requestedOnDate": "string (date-time)",
"status": {
"id": "integer (int32)",
"name": "string"
},
"deliverySite": {
"id": "integer (int32)"
},
"pickSite": {
"id": "integer (int32)"
},
"job": {
"id": "integer (int32)"
},
"customField_1": "string",
"customField_2": "string",
"customField_3": "string",
"customField_4": "string",
"customField_5": "string",
"customField_6": "string",
"customField_7": "string",
"customField_8": "string",
"customField_9": "string",
"customField_10": "string",
"customField_11": "string",
"customField_12": "string",
"customField_13": "string",
"customField_14": "string",
"customField_15": "string",
"customField_16": "string",
"customField_17": "string",
"customField_18": "string",
"customField_19": "string",
"customField_20": "string",
"customField_21": "string",
"customField_22": "string",
"customField_23": "string",
"customField_24": "string",
"customField_25": "string",
"customField_26": "string",
"customField_27": "string",
"customField_28": "string",
"customField_29": "string",
"customField_30": "string"
}
}
Work Package Items
GET /api/v1/work-package-items
Gets a list of work package items with the specified filter criteria.
Available Filter Operator(s):
- Exact Match ==
- Starts With =^
- Contains =@
Filter(s) using ==, =^, =@:
- workPackageName
Filter(s) using ==:
- workPackageId
filter
(no description)
type
string
in
query
page
(no description)
type
integer
(int32)
in
query
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"quantity": "number (double)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"catalogItem": {
"id": "integer (int32)"
},
"workPackage": {
"id": "integer (int32)"
}
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
POST /api/v1/work-package-items
Creates a new work package item with the fields provided.
Required Fields:
- workPackage.id
- catalogItem.Id
- quantity
Request Content-Types: application/json, text/json
Request Example
{
"quantity": "number (double)",
"catalogItem": {
"id": "integer (int32)"
},
"workPackage": {
"id": "integer (int32)"
}
}
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"quantity": "number (double)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"catalogItem": {
"id": "integer (int32)"
},
"workPackage": {
"id": "integer (int32)"
}
}
}
GET /api/v1/work-package-items/{id}
Gets a work package item with the specified identifier.
id
(no description)
type
integer
(int32)
in
path
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"quantity": "number (double)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"catalogItem": {
"id": "integer (int32)"
},
"workPackage": {
"id": "integer (int32)"
}
}
}
DELETE /api/v1/work-package-items/{id}
Deletes the work package item with the id specified.
id
(no description)
type
integer
(int32)
in
path
204 No Content
No Content
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
409 Conflict
Conflict
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
PATCH /api/v1/work-package-items/{id}
Updates specified fields on a work package item.
Updatable Fields:
-quantity
id
(no description)
type
integer
(int32)
in
path
Request Content-Types: application/json, text/json
Request Example
{
"quantity": "number (double)",
"drawingItem": {
"id": "integer (int32)"
}
}
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"quantity": "number (double)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"catalogItem": {
"id": "integer (int32)"
},
"workPackage": {
"id": "integer (int32)"
}
}
}
Work Packages
GET /api/v1/work-packages
Gets a list of work packages with the specified filter criteria.
Available Filter Operator(s):
- Exact Match ==
- Starts With =^
- Contains =@
- Greater Than or Equal To >=
- Less Than or Equal To <=
Filter(s) using ==, =^, =@:
- name
Filter(s) using ==:
- jobId
- workSiteId
- statusId
Filter(s) using ==, >=, <=:
- plannedStartDate
- requiredAtSiteDate
Default Jovix Work Package Statuses:
- Initial = 0
- Partially Reserved = 1
- Reserved = 2
- Requesting = 3
- Requested = 4
- Picking = 5
- Picked = 6
- Issued = 7
filter
(no description)
type
string
in
query
page
(no description)
type
integer
(int32)
in
query
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"description": "string",
"job": {
"id": "integer (int32)"
},
"workSite": {
"id": "integer (int32)"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"costCode": "string",
"system": {
"id": "integer (int32)"
},
"area": {
"id": "integer (int32)"
},
"building": {
"id": "integer (int32)"
},
"discipline": {
"id": "integer (int32)"
},
"plannedStartDate": "string (date-time)",
"requiredAtSiteDate": "string (date-time)",
"plannedFinishDate": "string (date-time)",
"estimatedManHours": "number (double)",
"notes": "string"
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
POST /api/v1/work-packages
Creates a work package with the fields provided.
Required Fields:
- name
- job.Id
- workSite.Id
Request Content-Types: application/json, text/json
Request Example
{
"name": "string",
"job": {
"id": "integer (int32)"
},
"workSite": {
"id": "integer (int32)"
},
"costCode": "string",
"system": {
"id": "integer (int32)"
},
"area": {
"id": "integer (int32)"
},
"building": {
"id": "integer (int32)"
},
"discipline": {
"id": "integer (int32)"
},
"plannedStartDate": "string (date-time)",
"plannedFinishDate": "string (date-time)",
"requiredAtSiteDate": "string (date-time)",
"estimatedManHours": "number (double)",
"notes": "string",
"description": "string"
}
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"description": "string",
"job": {
"id": "integer (int32)"
},
"workSite": {
"id": "integer (int32)"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"costCode": "string",
"system": {
"id": "integer (int32)"
},
"area": {
"id": "integer (int32)"
},
"building": {
"id": "integer (int32)"
},
"discipline": {
"id": "integer (int32)"
},
"plannedStartDate": "string (date-time)",
"requiredAtSiteDate": "string (date-time)",
"plannedFinishDate": "string (date-time)",
"estimatedManHours": "number (double)",
"notes": "string"
}
}
GET /api/v1/work-packages/{id}
Gets a work package with the specified identifier.
Default Jovix Work Package Statuses:
- Initial = 0
- Partially Reserved = 1
- Reserved = 2
- Requesting = 3
- Requested = 4
- Picking = 5
- Picked = 6
- Issued = 7
id
(no description)
type
integer
(int32)
in
path
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"description": "string",
"job": {
"id": "integer (int32)"
},
"workSite": {
"id": "integer (int32)"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"costCode": "string",
"system": {
"id": "integer (int32)"
},
"area": {
"id": "integer (int32)"
},
"building": {
"id": "integer (int32)"
},
"discipline": {
"id": "integer (int32)"
},
"plannedStartDate": "string (date-time)",
"requiredAtSiteDate": "string (date-time)",
"plannedFinishDate": "string (date-time)",
"estimatedManHours": "number (double)",
"notes": "string"
}
}
DELETE /api/v1/work-packages/{id}
Deletes the work package with the specified identifier.
id
(no description)
type
integer
(int32)
in
path
204 No Content
No Content
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
409 Conflict
Conflict
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
PATCH /api/v1/work-packages/{id}
Updates specified values on a work package.
Updatable Fields:
- description
- costCode
- system
- area
- building
- discipline
- plannedStartDate
- requiredAtSiteDate
- plannedFinishDate
- estimatedManHours
- notes
id
(no description)
type
integer
(int32)
in
path
Request Content-Types: application/json, text/json
Request Example
"object"
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
422 Unprocessable Entity
Unprocessable Entity
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"description": "string",
"job": {
"id": "integer (int32)"
},
"workSite": {
"id": "integer (int32)"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"costCode": "string",
"system": {
"id": "integer (int32)"
},
"area": {
"id": "integer (int32)"
},
"building": {
"id": "integer (int32)"
},
"discipline": {
"id": "integer (int32)"
},
"plannedStartDate": "string (date-time)",
"requiredAtSiteDate": "string (date-time)",
"plannedFinishDate": "string (date-time)",
"estimatedManHours": "number (double)",
"notes": "string"
}
}
Yards
GET /api/v1/yards
Gets a list of yards that meet the specified filter criteria.
Available Filter Operator(s):
- Exact Match ==
- Starts With =^
- Contains =@
Filter(s) using ==, =^, =@:
- name
Filter(s) using ==:
- jobId
- siteId
- isActive
filter
(no description)
type
string
in
query
page
(no description)
type
integer
(int32)
in
query
200 OK
OK
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"isActive": "boolean",
"job": {
"id": "integer (int32)",
"name": "string"
},
"name": "string",
"positionTop": "number (double)",
"positionLeft": "number (double)",
"positionRight": "number (double)",
"positionBottom": "number (double)",
"site": {
"id": "integer (int32)",
"name": "string"
}
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
GET /api/v1/yards/{id}/image
Gets the image for the yard with the specified identifier.
Examples:
/yards/123/image
id
(no description)
type
integer
(int32)
in
path
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": "string",
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
GET /api/v1/yards/{yardId}
Gets a yard with the specified identifier.
Examples:
/yards/123
yardId
(no description)
type
integer
(int32)
in
path
200 OK
OK
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": {
"id": "integer (int32)",
"isActive": "boolean",
"job": {
"id": "integer (int32)",
"name": "string"
},
"name": "string",
"positionTop": "number (double)",
"positionLeft": "number (double)",
"positionRight": "number (double)",
"positionBottom": "number (double)",
"site": {
"id": "integer (int32)",
"name": "string"
}
},
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Image
GET /api/v1/yards/{id}/image
Gets the image for the yard with the specified identifier.
Examples:
/yards/123/image
id
(no description)
type
integer
(int32)
in
path
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": "string",
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Zones
GET /api/v1/zones
Gets a list of zones that meet the specified filter criteria.
Available Filter Operator(s):
- Exact Match ==
- Starts With =^
- Contains =@
Filter(s) using ==, =^, =@:
- name
Filter(s) using ==:
- yardId
filter
(no description)
type
string
in
query
page
(no description)
type
integer
(int32)
in
query
200 OK
OK
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"yard": {
"id": "integer (int32)"
}
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
GET /api/v1/zones/{zoneId}
Gets a zone with specified identifier.
Examples:
Get Zone by identifier:
/zones/133
zoneId
(no description)
type
integer
(int32)
in
path
200 OK
OK
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
429 Too Many Requests
Too Many Requests
500 Internal Server Error
Unexpected Error
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"yard": {
"id": "integer (int32)"
}
},
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Schema Definitions
Jovix.Application.Response.ResponseContentForSingle[Jovix.Application.V1.CatalogItems.Views.CatalogItemView]: object
- include: string
- data: Jovix.Application.V1.CatalogItems.Views.CatalogItemView
Example
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"centerOfGravity": "string",
"description": "string",
"notes": "string",
"size": "string",
"shortDescription": "string",
"specializedTrailer": "boolean",
"tagNumber": "string",
"volume": "string",
"length": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"width": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"height": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"weight": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"discipline": {
"id": "integer (int32)",
"name": "string"
},
"materialType": {
"id": "integer (int32)",
"name": "string"
},
"project": {
"id": "integer (int32)",
"name": "string"
},
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
},
"customField_1": "string",
"customField_2": "string",
"customField_3": "string",
"customField_4": "string",
"customField_5": "string",
"customField_6": "string",
"customField_7": "string",
"customField_8": "string",
"customField_9": "string",
"customField_10": "string",
"customField_11": "string",
"customField_12": "string",
"customField_13": "string",
"customField_14": "string",
"customField_15": "string",
"customField_16": "string",
"customField_17": "string",
"customField_18": "string",
"customField_19": "string",
"customField_20": "string",
"customField_21": "string",
"customField_22": "string",
"customField_23": "string",
"customField_24": "string",
"customField_25": "string",
"customField_26": "string",
"customField_27": "string",
"customField_28": "string",
"customField_29": "string",
"customField_30": "string"
}
}
Jovix.Application.V1.CatalogItems.Views.CatalogItemView: object
- id: integer (int32)
- name: string
- centerOfGravity: string
- description: string
- notes: string
- size: string
- shortDescription: string
- specializedTrailer: boolean
- tagNumber: string
- volume: string
- length: Jovix.Application.V1.UnitsOfMeasure.MeasurementView
- width: Jovix.Application.V1.UnitsOfMeasure.MeasurementView
- height: Jovix.Application.V1.UnitsOfMeasure.MeasurementView
- weight: Jovix.Application.V1.UnitsOfMeasure.MeasurementView
- discipline: Jovix.Application.V1.GenericViews.IdAndNameView
- materialType: Jovix.Application.V1.GenericViews.IdAndNameView
- project: Jovix.Application.V1.GenericViews.IdAndNameView
- unitOfMeasure: Jovix.Application.V1.GenericViews.IdAndNameView
- customField_1: string
- customField_2: string
- customField_3: string
- customField_4: string
- customField_5: string
- customField_6: string
- customField_7: string
- customField_8: string
- customField_9: string
- customField_10: string
- customField_11: string
- customField_12: string
- customField_13: string
- customField_14: string
- customField_15: string
- customField_16: string
- customField_17: string
- customField_18: string
- customField_19: string
- customField_20: string
- customField_21: string
- customField_22: string
- customField_23: string
- customField_24: string
- customField_25: string
- customField_26: string
- customField_27: string
- customField_28: string
- customField_29: string
- customField_30: string
Example
{
"id": "integer (int32)",
"name": "string",
"centerOfGravity": "string",
"description": "string",
"notes": "string",
"size": "string",
"shortDescription": "string",
"specializedTrailer": "boolean",
"tagNumber": "string",
"volume": "string",
"length": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"width": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"height": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"weight": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"discipline": {
"id": "integer (int32)",
"name": "string"
},
"materialType": {
"id": "integer (int32)",
"name": "string"
},
"project": {
"id": "integer (int32)",
"name": "string"
},
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
},
"customField_1": "string",
"customField_2": "string",
"customField_3": "string",
"customField_4": "string",
"customField_5": "string",
"customField_6": "string",
"customField_7": "string",
"customField_8": "string",
"customField_9": "string",
"customField_10": "string",
"customField_11": "string",
"customField_12": "string",
"customField_13": "string",
"customField_14": "string",
"customField_15": "string",
"customField_16": "string",
"customField_17": "string",
"customField_18": "string",
"customField_19": "string",
"customField_20": "string",
"customField_21": "string",
"customField_22": "string",
"customField_23": "string",
"customField_24": "string",
"customField_25": "string",
"customField_26": "string",
"customField_27": "string",
"customField_28": "string",
"customField_29": "string",
"customField_30": "string"
}
Jovix.Application.V1.UnitsOfMeasure.MeasurementView: object
- value: number (double)
- unitOfMeasure: Jovix.Application.V1.GenericViews.IdAndNameView
Example
{
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
}
Jovix.Application.V1.GenericViews.IdAndNameView: object
- id: integer (int32)
- name: string
Example
{
"id": "integer (int32)",
"name": "string"
}
Jovix.Application.V1.CatalogItems.CatalogItemPost: object
- name: string (up to 150 chars)
- centerOfGravity: string (up to 150 chars)
- description: string (up to 1000 chars)
- notes: string (up to 1000 chars)
- shortDescription: string (up to 150 chars)
- size: string (up to 150 chars)
- tagNumber: string (up to 150 chars)
- volume: string (up to 150 chars)
- specializedTrailer: boolean
- project: Jovix.Application.V1.GenericViews.IdPost
- materialType: Jovix.Application.V1.GenericViews.IdPost
- unitOfMeasure: Jovix.Application.V1.GenericViews.IdPost
- discipline: Jovix.Application.V1.GenericViews.IdPost
- length: Jovix.Application.V1.UnitsOfMeasure.MeasurementPost
- width: Jovix.Application.V1.UnitsOfMeasure.MeasurementPost
- height: Jovix.Application.V1.UnitsOfMeasure.MeasurementPost
- weight: Jovix.Application.V1.UnitsOfMeasure.MeasurementPost
- customField_1: object
- customField_2: object
- customField_3: object
- customField_4: object
- customField_5: object
- customField_6: object
- customField_7: object
- customField_8: object
- customField_9: object
- customField_10: object
- customField_11: object
- customField_12: object
- customField_13: object
- customField_14: object
- customField_15: object
- customField_16: object
- customField_17: object
- customField_18: object
- customField_19: object
- customField_20: object
- customField_21: object
- customField_22: object
- customField_23: object
- customField_24: object
- customField_25: object
- customField_26: object
- customField_27: object
- customField_28: object
- customField_29: object
- customField_30: object
Example
{
"name": "string",
"centerOfGravity": "string",
"description": "string",
"notes": "string",
"shortDescription": "string",
"size": "string",
"tagNumber": "string",
"volume": "string",
"specializedTrailer": "boolean",
"project": {
"id": "integer (int32)"
},
"materialType": {
"id": "integer (int32)"
},
"unitOfMeasure": {
"id": "integer (int32)"
},
"discipline": {
"id": "integer (int32)"
},
"length": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)"
}
},
"width": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)"
}
},
"height": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)"
}
},
"weight": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)"
}
},
"customField_1": "object",
"customField_2": "object",
"customField_3": "object",
"customField_4": "object",
"customField_5": "object",
"customField_6": "object",
"customField_7": "object",
"customField_8": "object",
"customField_9": "object",
"customField_10": "object",
"customField_11": "object",
"customField_12": "object",
"customField_13": "object",
"customField_14": "object",
"customField_15": "object",
"customField_16": "object",
"customField_17": "object",
"customField_18": "object",
"customField_19": "object",
"customField_20": "object",
"customField_21": "object",
"customField_22": "object",
"customField_23": "object",
"customField_24": "object",
"customField_25": "object",
"customField_26": "object",
"customField_27": "object",
"customField_28": "object",
"customField_29": "object",
"customField_30": "object"
}
Jovix.Application.V1.GenericViews.IdPost: object
- id: integer (int32)
Example
{
"id": "integer (int32)"
}
Jovix.Application.V1.UnitsOfMeasure.MeasurementPost: object
- value: number (double) x ≥ 0
- unitOfMeasure: Jovix.Application.V1.GenericViews.IdPost
Example
{
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)"
}
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.CatalogItems.Views.CatalogItemView[]]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.CatalogItems.Views.CatalogItemView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"centerOfGravity": "string",
"description": "string",
"notes": "string",
"size": "string",
"shortDescription": "string",
"specializedTrailer": "boolean",
"tagNumber": "string",
"volume": "string",
"length": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"width": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"height": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"weight": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"discipline": {
"id": "integer (int32)",
"name": "string"
},
"materialType": {
"id": "integer (int32)",
"name": "string"
},
"project": {
"id": "integer (int32)",
"name": "string"
},
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
},
"customField_1": "string",
"customField_2": "string",
"customField_3": "string",
"customField_4": "string",
"customField_5": "string",
"customField_6": "string",
"customField_7": "string",
"customField_8": "string",
"customField_9": "string",
"customField_10": "string",
"customField_11": "string",
"customField_12": "string",
"customField_13": "string",
"customField_14": "string",
"customField_15": "string",
"customField_16": "string",
"customField_17": "string",
"customField_18": "string",
"customField_19": "string",
"customField_20": "string",
"customField_21": "string",
"customField_22": "string",
"customField_23": "string",
"customField_24": "string",
"customField_25": "string",
"customField_26": "string",
"customField_27": "string",
"customField_28": "string",
"customField_29": "string",
"customField_30": "string"
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.Response.PageLinks: object
- first: string
- last: string
- next: string
- previous: string
Example
{
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.GenericViews.QuantityView[]]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.GenericViews.QuantityView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"name": "string",
"quantity": "number (double)"
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.V1.GenericViews.QuantityView: object
- name: string
- quantity: number (double)
Example
{
"name": "string",
"quantity": "number (double)"
}
Jovix.Application.V1.ModifiedRecords[Jovix.Application.V1.CatalogItems.Views.CatalogItem]: object
- pagingToken: string
- data: Jovix.Application.V1.CatalogItems.Views.CatalogItem
Example
{
"pagingToken": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"shortDescription": "string",
"description": "string",
"project": {
"id": "00000000-0000-0000-0000-000000000000"
},
"materialType": {
"id": "integer (int32)"
},
"discipline": {
"id": "integer (int32)"
},
"unitOfMeasure": {
"id": "00000000-0000-0000-0000-000000000000"
},
"lengthUnitOfMeasureID": "00000000-0000-0000-0000-000000000000",
"widthUnitOfMeasureID": "00000000-0000-0000-0000-000000000000",
"heightUnitOfMeasureID": "00000000-0000-0000-0000-000000000000",
"weightUnitOfMeasureID": "00000000-0000-0000-0000-000000000000",
"volume": "string",
"centerOfGravity": "string",
"asmeClassification": "string",
"htsClassification": "string",
"htsDescription": "string",
"hazardousMaterialsClassification": "string",
"hazardousMaterialsDescription": "string",
"storageRequirement": "string",
"safetyClassification": "string",
"handlingInstructions": "string",
"isAssetNumberRequired": "boolean",
"isSerialNumberRequired": "boolean",
"isHeatNumberRequired": "boolean",
"isLotNumberRequired": "boolean",
"isShelfLifeRequired": "boolean",
"isPMRequired": "boolean",
"notes": "string",
"properShippingName": "string",
"isLimitedQuantity": "boolean",
"isMSDSRequired": "boolean",
"size": "string",
"procurementPackage": "string",
"specification": "string",
"isManualHot": "boolean",
"manualHotDate": "string (date-time)",
"manualUnHotDate": "string (date-time)",
"isAssembly": "boolean",
"hasAccessories": "boolean",
"accessoriesCount": "integer (int32)",
"subComponentCount": "integer (int32)",
"totalRequiredMaterialCodeCount": "integer (int32)",
"engineeredQuantity": "number (double)",
"tagNumber": "string",
"isSpecializedTrailerRequired": "boolean",
"length": "number (double)",
"lengthNormalized": "number (double)",
"width": "number (double)",
"widthNormalized": "number (double)",
"height": "number (double)",
"heightNormalized": "number (double)",
"weight": "number (double)",
"weightNormalized": "number (double)",
"loadMethod": "string",
"unloadMethod": "string",
"cF_1": "string",
"cF_2": "string",
"cF_3": "string",
"cF_4": "string",
"cF_5": "string",
"cF_6": "string",
"cF_7": "string",
"cF_8": "string",
"cF_9": "string",
"cF_10": "string",
"cF_11": "string",
"cF_12": "string",
"cF_13": "string",
"cF_14": "string",
"cF_15": "string",
"cF_16": "string",
"cF_17": "string",
"cF_18": "string",
"cF_19": "string",
"cF_20": "string",
"cF_21": "string",
"cF_22": "string",
"cF_23": "string",
"cF_24": "string",
"cF_25": "string",
"cF_26": "string",
"cF_27": "string",
"cF_28": "string",
"cF_29": "string",
"cF_30": "string",
"cF_Lookup1": "string"
}
]
}
Jovix.Application.V1.CatalogItems.Views.CatalogItem: object
- id: integer (int32)
- name: string
- shortDescription: string
- description: string
- project: Jovix.Application.V1.CatalogItems.Views.Project
- materialType: Jovix.Application.V1.GenericViews.IdView
- discipline: Jovix.Application.V1.CatalogItems.Views.Discipline
- unitOfMeasure: Jovix.Application.V1.CatalogItems.Views.UnitOfMeasure
- lengthUnitOfMeasureID: string (uuid)
- widthUnitOfMeasureID: string (uuid)
- heightUnitOfMeasureID: string (uuid)
- weightUnitOfMeasureID: string (uuid)
- volume: string
- centerOfGravity: string
- asmeClassification: string
- htsClassification: string
- htsDescription: string
- hazardousMaterialsClassification: string
- hazardousMaterialsDescription: string
- storageRequirement: string
- safetyClassification: string
- handlingInstructions: string
- isAssetNumberRequired: boolean
- isSerialNumberRequired: boolean
- isHeatNumberRequired: boolean
- isLotNumberRequired: boolean
- isShelfLifeRequired: boolean
- isPMRequired: boolean
- notes: string
- properShippingName: string
- isLimitedQuantity: boolean
- isMSDSRequired: boolean
- size: string
- procurementPackage: string
- specification: string
- isManualHot: boolean
- manualHotDate: string (date-time)
- manualUnHotDate: string (date-time)
- isAssembly: boolean
- hasAccessories: boolean
- accessoriesCount: integer (int32)
- subComponentCount: integer (int32)
- totalRequiredMaterialCodeCount: integer (int32)
- engineeredQuantity: number (double)
- tagNumber: string
- isSpecializedTrailerRequired: boolean
- length: number (double)
- lengthNormalized: number (double)
- width: number (double)
- widthNormalized: number (double)
- height: number (double)
- heightNormalized: number (double)
- weight: number (double)
- weightNormalized: number (double)
- loadMethod: string
- unloadMethod: string
- cF_1: string
- cF_2: string
- cF_3: string
- cF_4: string
- cF_5: string
- cF_6: string
- cF_7: string
- cF_8: string
- cF_9: string
- cF_10: string
- cF_11: string
- cF_12: string
- cF_13: string
- cF_14: string
- cF_15: string
- cF_16: string
- cF_17: string
- cF_18: string
- cF_19: string
- cF_20: string
- cF_21: string
- cF_22: string
- cF_23: string
- cF_24: string
- cF_25: string
- cF_26: string
- cF_27: string
- cF_28: string
- cF_29: string
- cF_30: string
- cF_Lookup1: string
- cF_Lookup2: string
- cF_Lookup3: string
- cF_Lookup4: string
- cF_Lookup5: string
Example
{
"id": "integer (int32)",
"name": "string",
"shortDescription": "string",
"description": "string",
"project": {
"id": "00000000-0000-0000-0000-000000000000"
},
"materialType": {
"id": "integer (int32)"
},
"discipline": {
"id": "integer (int32)"
},
"unitOfMeasure": {
"id": "00000000-0000-0000-0000-000000000000"
},
"lengthUnitOfMeasureID": "00000000-0000-0000-0000-000000000000",
"widthUnitOfMeasureID": "00000000-0000-0000-0000-000000000000",
"heightUnitOfMeasureID": "00000000-0000-0000-0000-000000000000",
"weightUnitOfMeasureID": "00000000-0000-0000-0000-000000000000",
"volume": "string",
"centerOfGravity": "string",
"asmeClassification": "string",
"htsClassification": "string",
"htsDescription": "string",
"hazardousMaterialsClassification": "string",
"hazardousMaterialsDescription": "string",
"storageRequirement": "string",
"safetyClassification": "string",
"handlingInstructions": "string",
"isAssetNumberRequired": "boolean",
"isSerialNumberRequired": "boolean",
"isHeatNumberRequired": "boolean",
"isLotNumberRequired": "boolean",
"isShelfLifeRequired": "boolean",
"isPMRequired": "boolean",
"notes": "string",
"properShippingName": "string",
"isLimitedQuantity": "boolean",
"isMSDSRequired": "boolean",
"size": "string",
"procurementPackage": "string",
"specification": "string",
"isManualHot": "boolean",
"manualHotDate": "string (date-time)",
"manualUnHotDate": "string (date-time)",
"isAssembly": "boolean",
"hasAccessories": "boolean",
"accessoriesCount": "integer (int32)",
"subComponentCount": "integer (int32)",
"totalRequiredMaterialCodeCount": "integer (int32)",
"engineeredQuantity": "number (double)",
"tagNumber": "string",
"isSpecializedTrailerRequired": "boolean",
"length": "number (double)",
"lengthNormalized": "number (double)",
"width": "number (double)",
"widthNormalized": "number (double)",
"height": "number (double)",
"heightNormalized": "number (double)",
"weight": "number (double)",
"weightNormalized": "number (double)",
"loadMethod": "string",
"unloadMethod": "string",
"cF_1": "string",
"cF_2": "string",
"cF_3": "string",
"cF_4": "string",
"cF_5": "string",
"cF_6": "string",
"cF_7": "string",
"cF_8": "string",
"cF_9": "string",
"cF_10": "string",
"cF_11": "string",
"cF_12": "string",
"cF_13": "string",
"cF_14": "string",
"cF_15": "string",
"cF_16": "string",
"cF_17": "string",
"cF_18": "string",
"cF_19": "string",
"cF_20": "string",
"cF_21": "string",
"cF_22": "string",
"cF_23": "string",
"cF_24": "string",
"cF_25": "string",
"cF_26": "string",
"cF_27": "string",
"cF_28": "string",
"cF_29": "string",
"cF_30": "string",
"cF_Lookup1": "string",
"cF_Lookup2": "string",
"cF_Lookup3": "string",
"cF_Lookup4": "string",
"cF_Lookup5": "string"
}
Jovix.Application.V1.CatalogItems.Views.Project: object
- id: string (uuid)
Example
{
"id": "00000000-0000-0000-0000-000000000000"
}
Jovix.Application.V1.GenericViews.IdView: object
- id: integer (int32)
Example
{
"id": "integer (int32)"
}
Jovix.Application.V1.CatalogItems.Views.Discipline: object
- id: integer (int32)
Example
{
"id": "integer (int32)"
}
Jovix.Application.V1.CatalogItems.Views.UnitOfMeasure: object
- id: string (uuid)
Example
{
"id": "00000000-0000-0000-0000-000000000000"
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.DrawingItems.Views.DrawingItemView[]]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.DrawingItems.Views.DrawingItemView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"quantity": "number (double)",
"site": {
"id": "integer (int32)",
"name": "string"
},
"catalogItem": {
"id": "integer (int32)",
"name": "string"
},
"drawing": {
"id": "integer (int32)",
"name": "string"
}
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.V1.DrawingItems.Views.DrawingItemView: object
- id: integer (int32)
- lineNumber: integer (int32)
- subLineNumber: integer (int32)
- quantity: number (double)
- site: Jovix.Application.V1.GenericViews.IdAndNameView
- catalogItem: Jovix.Application.V1.GenericViews.IdAndNameView
- drawing: Jovix.Application.V1.GenericViews.IdAndNameView
Example
{
"id": "integer (int32)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"quantity": "number (double)",
"site": {
"id": "integer (int32)",
"name": "string"
},
"catalogItem": {
"id": "integer (int32)",
"name": "string"
},
"drawing": {
"id": "integer (int32)",
"name": "string"
}
}
Jovix.Application.V1.Employees.Views.EmployeePost: object
- name: string (up to 50 chars)
- project: Jovix.Application.V1.GenericViews.IdPost
- firstName: string (up to 50 chars)
- middleName: string (up to 50 chars)
- lastName: string (up to 50 chars)
- suffix: string (up to 50 chars)
- user: Jovix.Application.V1.GenericViews.IdPost
- company: Jovix.Application.V1.GenericViews.NamePost
Example
{
"name": "string",
"project": {
"id": "integer (int32)"
},
"firstName": "string",
"middleName": "string",
"lastName": "string",
"suffix": "string",
"user": {
"id": "integer (int32)"
},
"company": {
"name": "string"
}
}
Jovix.Application.Response.ResponseContentForSingle[Jovix.Application.V1.Employees.Views.EmployeeResourceView]: object
- include: string
- data: Jovix.Application.V1.Employees.Views.EmployeeResourceView
Example
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"suffix": "string",
"user": {
"id": "integer (int32)"
},
"company": {
"name": "string"
},
"project": {
"id": "integer (int32)"
}
}
}
Jovix.Application.V1.Employees.Views.EmployeeResourceView: object
- id: integer (int32)
- name: string
- firstName: string
- middleName: string
- lastName: string
- suffix: string
- user: Jovix.Application.V1.GenericViews.IdView
- company: Jovix.Application.V1.GenericViews.NameView
- project: Jovix.Application.V1.GenericViews.IdView
Example
{
"id": "integer (int32)",
"name": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"suffix": "string",
"user": {
"id": "integer (int32)"
},
"company": {
"name": "string"
},
"project": {
"id": "integer (int32)"
}
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.Facilities.Views.FacilityResourceView]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.Facilities.Views.FacilityResourceView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"description": "string",
"job": {
"id": "integer (int32)"
},
"site": {
"id": "integer (int32)"
}
},
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.V1.Facilities.Views.FacilityResourceView: object
- id: integer (int32)
- name: string
- description: string
- job: Jovix.Application.V1.GenericViews.IdView
- site: Jovix.Application.V1.GenericViews.IdView
Example
{
"id": "integer (int32)",
"name": "string",
"description": "string",
"job": {
"id": "integer (int32)"
},
"site": {
"id": "integer (int32)"
}
}
Jovix.Application.Serialization.Patch[Jovix.Application.V1.Facilities.FacilityPatch]:
Example
{
"name": "string",
"description": "string",
"job": {
"id": "integer (int32)"
},
"site": {
"id": "integer (int32)"
}
}
Jovix.Application.V1.Facilities.FacilityPatch: object
- name: string
- description: string
- job: Jovix.Application.V1.GenericViews.IdPost
- site: Jovix.Application.V1.GenericViews.IdPost
Example
{
"name": "string",
"description": "string",
"job": {
"id": "integer (int32)"
},
"site": {
"id": "integer (int32)"
}
}
Jovix.Application.Response.ResponseContentForSingle[Jovix.Application.V1.Facilities.Views.FacilityResourceView]: object
- include: string
- data: Jovix.Application.V1.Facilities.Views.FacilityResourceView
Example
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"description": "string",
"job": {
"id": "integer (int32)"
},
"site": {
"id": "integer (int32)"
}
}
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.Facilities.Views.FacilityResourceView[]]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.Facilities.Views.FacilityResourceView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"description": "string",
"job": {
"id": "integer (int32)"
},
"site": {
"id": "integer (int32)"
}
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.Attachments.Attachment[]]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.Attachments.Attachment
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"dateAttached": "string (date-time)",
"fileNameWithExtension": "string",
"file": "string (byte)",
"extension": "string"
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.V1.Attachments.Attachment: object
- id: integer (int32)
- name: string
- dateAttached: string (date-time)
- fileNameWithExtension: string
- file: string (byte)
- extension: string
Example
{
"id": "integer (int32)",
"name": "string",
"dateAttached": "string (date-time)",
"fileNameWithExtension": "string",
"file": "string (byte)",
"extension": "string"
}
Jovix.Application.V1.Attachments.NewAttachment: object
- fileName: string
- fileBytes: string (byte)
Example
{
"fileName": "string",
"fileBytes": "string (byte)"
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.Locations.InventoryLocation]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.Locations.InventoryLocation
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": {
"latitude": "number (double)",
"longitude": "number (double)",
"dateLocated": "string",
"namedLocation": {
"id": "integer (int32)",
"name": "string",
"facility": {
"id": "integer (int32)",
"name": "string",
"site": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
},
"job": {
"id": "integer (int32)",
"name": "string"
}
}
},
"site": {
"id": "integer (int32)",
"name": "string"
},
"yard": {
"id": "integer (int32)",
"name": "string",
"positionTop": "number (double)",
"positionLeft": "number (double)",
"positionRight": "number (double)",
"positionBottom": "number (double)"
},
"horizontalErrorMeters": "number (double)",
"zoneIds": [
"integer (int32)"
]
},
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.V1.Locations.InventoryLocation: object
- latitude: number (double)
- longitude: number (double)
- dateLocated: string
- namedLocation: Jovix.Application.V1.Locations.NamedLocation
- site: Jovix.Application.V1.Sites.Views.SiteView
- yard: Jovix.Application.V1.Yards.Views.Yard
- horizontalErrorMeters: number (double)
- zoneIds: integer[]
Example
{
"latitude": "number (double)",
"longitude": "number (double)",
"dateLocated": "string",
"namedLocation": {
"id": "integer (int32)",
"name": "string",
"facility": {
"id": "integer (int32)",
"name": "string",
"site": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
},
"job": {
"id": "integer (int32)",
"name": "string"
}
}
},
"site": {
"id": "integer (int32)",
"name": "string"
},
"yard": {
"id": "integer (int32)",
"name": "string",
"positionTop": "number (double)",
"positionLeft": "number (double)",
"positionRight": "number (double)",
"positionBottom": "number (double)"
},
"horizontalErrorMeters": "number (double)",
"zoneIds": [
"integer (int32)"
]
}
Jovix.Application.V1.Locations.NamedLocation: object
- id: integer (int32)
- name: string
- facility: Jovix.Application.V1.Facilities.Views.FacilityView
Example
{
"id": "integer (int32)",
"name": "string",
"facility": {
"id": "integer (int32)",
"name": "string",
"site": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
},
"job": {
"id": "integer (int32)",
"name": "string"
}
}
}
Jovix.Application.V1.Sites.Views.SiteView: object
- id: integer (int32)
- name: string
Example
{
"id": "integer (int32)",
"name": "string"
}
Jovix.Application.V1.Yards.Views.Yard: object
- id: integer (int32)
- name: string
- positionTop: number (double)
- positionLeft: number (double)
- positionRight: number (double)
- positionBottom: number (double)
Example
{
"id": "integer (int32)",
"name": "string",
"positionTop": "number (double)",
"positionLeft": "number (double)",
"positionRight": "number (double)",
"positionBottom": "number (double)"
}
Jovix.Application.V1.Facilities.Views.FacilityView: object
- id: integer (int32)
- name: string
- site: Jovix.Application.V1.Sites.Views.SiteResourceView
- job: Jovix.Application.V1.GenericViews.IdAndNameView
Example
{
"id": "integer (int32)",
"name": "string",
"site": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
},
"job": {
"id": "integer (int32)",
"name": "string"
}
}
Jovix.Application.V1.Sites.Views.SiteResourceView: object
- id: integer (int32)
- name: string
- project: Jovix.Application.V1.GenericViews.IdView
- address: Jovix.Application.V1.Addresses.AddressResourceView
- isToLocation: boolean
- isFromLocation: boolean
- isWorkOrDeliverySite: boolean
Example
{
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
}
Jovix.Application.V1.Addresses.AddressResourceView: object
- name: string
- description: string
- contact: string
- phone1: string
- phone2: string
- street1: string
- street2: string
- city: string
- state: string
- zip: string
- country: string
- email: string
Example
{
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
}
Jovix.Application.V1.ModifiedRecords[Jovix.Application.V1.Inventories.InventoryItem]: object
- pagingToken: string
- data: Jovix.Application.V1.Inventories.InventoryItem
Example
{
"pagingToken": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"inventoryItemKey": "string",
"jobInfoId": "integer (int32)",
"instanceNumber": "integer (int32)",
"inventoryTypeNumber": "integer (int32)",
"itemTypeNumber": "integer (int32)",
"barcode": "string",
"catalogId": "integer (int32)",
"statusId": "integer (int32)",
"quantity": "number (double)",
"namedLocationId": "integer (int32)",
"notes": "string",
"serialNumber": "string",
"assetNumber": "string",
"heatNumber": "string",
"lotNumber": "string",
"tagNumber": "string",
"latitude": "number (double)",
"longitude": "number (double)",
"horizontalErrorMeters": "number (double)",
"dateLocated": "string (date-time)",
"cF_1": "string",
"cF_2": "string",
"cF_3": "string",
"cF_4": "string",
"cF_5": "string",
"cF_6": "string",
"cF_7": "string",
"cF_8": "string",
"cF_9": "string",
"cF_10": "string",
"cF_11": "string",
"cF_12": "string",
"cF_13": "string",
"cF_14": "string",
"cF_15": "string",
"cF_16": "string",
"cF_17": "string",
"cF_18": "string",
"cF_19": "string",
"cF_20": "string",
"cF_21": "string",
"cF_22": "string",
"cF_23": "string",
"cF_24": "string",
"cF_25": "string",
"cF_26": "string",
"cF_27": "string",
"cF_28": "string",
"cF_29": "string",
"cF_30": "string",
"cF_Lookup1": "string",
"cF_Lookup2": "string",
"cF_Lookup3": "string",
"cF_Lookup4": "string",
"cF_Lookup5": "string",
"job": {
"id": "integer (int32)",
"name": "string"
},
"catalogItem": {
"id": "integer (int32)",
"name": "string",
"shortDescription": "string",
"description": "string",
"project": {
"id": "00000000-0000-0000-0000-000000000000"
},
"materialType": {
"id": "integer (int32)"
},
"discipline": {
"id": "integer (int32)"
},
"unitOfMeasure": {
"id": "00000000-0000-0000-0000-000000000000"
},
"lengthUnitOfMeasureID": "00000000-0000-0000-0000-000000000000",
"widthUnitOfMeasureID": "00000000-0000-0000-0000-000000000000",
"heightUnitOfMeasureID": "00000000-0000-0000-0000-000000000000",
"weightUnitOfMeasureID": "00000000-0000-0000-0000-000000000000",
"volume": "string",
"centerOfGravity": "string",
"asmeClassification": "string",
"htsClassification": "string",
"htsDescription": "string",
"hazardousMaterialsClassification": "string",
"hazardousMaterialsDescription": "string",
"storageRequirement": "string",
"safetyClassification": "string",
"handlingInstructions": "string",
"isAssetNumberRequired": "boolean",
"isSerialNumberRequired": "boolean"
}
}
]
}
Jovix.Application.V1.Inventories.InventoryItem: object
- id: integer (int32)
- name: string
- inventoryItemKey: string
- jobInfoId: integer (int32)
- instanceNumber: integer (int32)
- inventoryTypeNumber: integer (int32)
- itemTypeNumber: integer (int32)
- barcode: string
- catalogId: integer (int32)
- statusId: integer (int32)
- quantity: number (double)
- namedLocationId: integer (int32)
- notes: string
- serialNumber: string
- assetNumber: string
- heatNumber: string
- lotNumber: string
- tagNumber: string
- latitude: number (double)
- longitude: number (double)
- horizontalErrorMeters: number (double)
- dateLocated: string (date-time)
- cF_1: string
- cF_2: string
- cF_3: string
- cF_4: string
- cF_5: string
- cF_6: string
- cF_7: string
- cF_8: string
- cF_9: string
- cF_10: string
- cF_11: string
- cF_12: string
- cF_13: string
- cF_14: string
- cF_15: string
- cF_16: string
- cF_17: string
- cF_18: string
- cF_19: string
- cF_20: string
- cF_21: string
- cF_22: string
- cF_23: string
- cF_24: string
- cF_25: string
- cF_26: string
- cF_27: string
- cF_28: string
- cF_29: string
- cF_30: string
- cF_Lookup1: string
- cF_Lookup2: string
- cF_Lookup3: string
- cF_Lookup4: string
- cF_Lookup5: string
- job: Jovix.Application.V1.Jobs.Views.JobView
- catalogItem: Jovix.Application.V1.CatalogItems.Views.CatalogItem
- status: Jovix.Application.V1.Statuses.InventoryStatus
- location: Jovix.Application.V1.Locations.InventoryLocation
- flags: Jovix.Application.V1.Inventories.InventoryItemFlag
Example
{
"id": "integer (int32)",
"name": "string",
"inventoryItemKey": "string",
"jobInfoId": "integer (int32)",
"instanceNumber": "integer (int32)",
"inventoryTypeNumber": "integer (int32)",
"itemTypeNumber": "integer (int32)",
"barcode": "string",
"catalogId": "integer (int32)",
"statusId": "integer (int32)",
"quantity": "number (double)",
"namedLocationId": "integer (int32)",
"notes": "string",
"serialNumber": "string",
"assetNumber": "string",
"heatNumber": "string",
"lotNumber": "string",
"tagNumber": "string",
"latitude": "number (double)",
"longitude": "number (double)",
"horizontalErrorMeters": "number (double)",
"dateLocated": "string (date-time)",
"cF_1": "string",
"cF_2": "string",
"cF_3": "string",
"cF_4": "string",
"cF_5": "string",
"cF_6": "string",
"cF_7": "string",
"cF_8": "string",
"cF_9": "string",
"cF_10": "string",
"cF_11": "string",
"cF_12": "string",
"cF_13": "string",
"cF_14": "string",
"cF_15": "string",
"cF_16": "string",
"cF_17": "string",
"cF_18": "string",
"cF_19": "string",
"cF_20": "string",
"cF_21": "string",
"cF_22": "string",
"cF_23": "string",
"cF_24": "string",
"cF_25": "string",
"cF_26": "string",
"cF_27": "string",
"cF_28": "string",
"cF_29": "string",
"cF_30": "string",
"cF_Lookup1": "string",
"cF_Lookup2": "string",
"cF_Lookup3": "string",
"cF_Lookup4": "string",
"cF_Lookup5": "string",
"job": {
"id": "integer (int32)",
"name": "string"
},
"catalogItem": {
"id": "integer (int32)",
"name": "string",
"shortDescription": "string",
"description": "string",
"project": {
"id": "00000000-0000-0000-0000-000000000000"
},
"materialType": {
"id": "integer (int32)"
},
"discipline": {
"id": "integer (int32)"
},
"unitOfMeasure": {
"id": "00000000-0000-0000-0000-000000000000"
},
"lengthUnitOfMeasureID": "00000000-0000-0000-0000-000000000000",
"widthUnitOfMeasureID": "00000000-0000-0000-0000-000000000000",
"heightUnitOfMeasureID": "00000000-0000-0000-0000-000000000000",
"weightUnitOfMeasureID": "00000000-0000-0000-0000-000000000000",
"volume": "string",
"centerOfGravity": "string",
"asmeClassification": "string",
"htsClassification": "string",
"htsDescription": "string",
"hazardousMaterialsClassification": "string",
"hazardousMaterialsDescription": "string",
"storageRequirement": "string",
"safetyClassification": "string",
"handlingInstructions": "string",
"isAssetNumberRequired": "boolean",
"isSerialNumberRequired": "boolean",
"isHeatNumberRequired": "boolean",
"isLotNumberRequired": "boolean",
"isShelfLifeRequired": "boolean",
"isPMRequired": "boolean"
}
}
Jovix.Application.V1.Jobs.Views.JobView: object
- id: integer (int32)
- name: string
Example
{
"id": "integer (int32)",
"name": "string"
}
Jovix.Application.V1.Statuses.InventoryStatus: object
- id: integer (int32)
- name: string
Example
{
"id": "integer (int32)",
"name": "string"
}
Jovix.Application.V1.Inventories.InventoryItemFlag: object
- name: string
- description: string
Example
{
"name": "string",
"description": "string"
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.GenericViews.IdAndNameView[]]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.GenericViews.IdAndNameView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"name": "string"
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.Response.ResponseContentForSingle[Jovix.Application.V1.Issues.Views.IssueView]: object
- include: string
- data: Jovix.Application.V1.Issues.Views.IssueView
Example
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"job": {
"id": "integer (int32)"
},
"dateIssued": "string (date-time)",
"issuedToEmployee": {
"id": "integer (int32)"
},
"issuedByEmployee": {
"id": "integer (int32)"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"notes": "string",
"description": "string"
}
}
Jovix.Application.V1.Issues.Views.IssueView: object
- id: integer (int32)
- name: string
- job: Jovix.Application.V1.GenericViews.IdView
- dateIssued: string (date-time)
- issuedToEmployee: Jovix.Application.V1.GenericViews.IdView
- issuedByEmployee: Jovix.Application.V1.GenericViews.IdView
- status: Jovix.Application.V1.GenericViews.IdAndNameView
- notes: string
- description: string
Example
{
"id": "integer (int32)",
"name": "string",
"job": {
"id": "integer (int32)"
},
"dateIssued": "string (date-time)",
"issuedToEmployee": {
"id": "integer (int32)"
},
"issuedByEmployee": {
"id": "integer (int32)"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"notes": "string",
"description": "string"
}
Jovix.Application.V1.Issues.Views.IssuePost: object
- name: string
- description: string
- job: Jovix.Application.V1.GenericViews.IdView
- issuedToEmployee: Jovix.Application.V1.GenericViews.IdView
- issuedByEmployee: Jovix.Application.V1.GenericViews.IdView
- notes: string
- dateIssued: string (date-time)
Example
{
"name": "string",
"description": "string",
"job": {
"id": "integer (int32)"
},
"issuedToEmployee": {
"id": "integer (int32)"
},
"issuedByEmployee": {
"id": "integer (int32)"
},
"notes": "string",
"dateIssued": "string (date-time)"
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.Issues.Views.IssueView[]]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.Issues.Views.IssueView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"job": {
"id": "integer (int32)"
},
"dateIssued": "string (date-time)",
"issuedToEmployee": {
"id": "integer (int32)"
},
"issuedByEmployee": {
"id": "integer (int32)"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"notes": "string",
"description": "string"
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.Response.ResponseContentForSingle[Jovix.Application.V1.IssueItems.Views.IssueItemView]: object
- include: string
- data: Jovix.Application.V1.IssueItems.Views.IssueItemView
Example
{
"include": "string",
"data": {
"id": "integer (int32)",
"quantityIssued": "number (double)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"materialIssue": {
"id": "integer (int32)"
},
"material": {
"id": "integer (int32)"
},
"pickListPickedItem": {
"id": "integer (int32)"
}
}
}
Jovix.Application.V1.IssueItems.Views.IssueItemView: object
- id: integer (int32)
- quantityIssued: number (double)
- lineNumber: integer (int32)
- subLineNumber: integer (int32)
- materialIssue: Jovix.Application.V1.GenericViews.IdView
- material: Jovix.Application.V1.GenericViews.IdView
- pickListPickedItem: Jovix.Application.V1.GenericViews.IdView
Example
{
"id": "integer (int32)",
"quantityIssued": "number (double)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"materialIssue": {
"id": "integer (int32)"
},
"material": {
"id": "integer (int32)"
},
"pickListPickedItem": {
"id": "integer (int32)"
}
}
Jovix.Application.Serialization.Patch[Jovix.Application.V1.IssueItems.Patch.IssueItemPatch]:
Example
{
"quantityIssued": "number (double)"
}
Jovix.Application.V1.IssueItems.Patch.IssueItemPatch: object
- quantityIssued: number (double) x ≥ 0
Example
{
"quantityIssued": "number (double)"
}
Jovix.Application.V1.IssueItems.Views.IssueItemPost: object
- quantityIssued: number (double)
- materialIssue: Jovix.Application.V1.GenericViews.IdView
- material: Jovix.Application.V1.GenericViews.IdView
- pickListPickedItem: Jovix.Application.V1.GenericViews.IdView
Example
{
"quantityIssued": "number (double)",
"materialIssue": {
"id": "integer (int32)"
},
"material": {
"id": "integer (int32)"
},
"pickListPickedItem": {
"id": "integer (int32)"
}
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.IssueItems.Views.IssueItemView[]]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.IssueItems.Views.IssueItemView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"quantityIssued": "number (double)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"materialIssue": {
"id": "integer (int32)"
},
"material": {
"id": "integer (int32)"
},
"pickListPickedItem": {
"id": "integer (int32)"
}
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.Jobs.Views.JobResourceView]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.Jobs.Views.JobResourceView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"description": "string",
"abbreviation": "string",
"isActive": "boolean",
"project": {
"id": "integer (int32)"
}
},
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.V1.Jobs.Views.JobResourceView: object
- id: integer (int32)
- name: string
- description: string
- abbreviation: string
- isActive: boolean
- project: Jovix.Application.V1.GenericViews.IdView
Example
{
"id": "integer (int32)",
"name": "string",
"description": "string",
"abbreviation": "string",
"isActive": "boolean",
"project": {
"id": "integer (int32)"
}
}
Jovix.Application.Response.ResponseContentForSingle[Jovix.Application.V1.Jobs.Views.JobResourceView]: object
- include: string
- data: Jovix.Application.V1.Jobs.Views.JobResourceView
Example
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"description": "string",
"abbreviation": "string",
"isActive": "boolean",
"project": {
"id": "integer (int32)"
}
}
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.Jobs.Views.JobResourceView[]]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.Jobs.Views.JobResourceView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"description": "string",
"abbreviation": "string",
"isActive": "boolean",
"project": {
"id": "integer (int32)"
}
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.Materials.Views.MaterialView]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.Materials.Views.MaterialView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)",
"name": "string"
},
"catalogItem": {
"id": "integer (int32)",
"name": "string"
},
"job": {
"id": "integer (int32)",
"name": "string"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"quantity": "number (double)",
"inventoryType": {
"id": "integer (int32)",
"name": "string"
},
"location": {
"latitude": "number (double)",
"longitude": "number (double)",
"dateLocated": "string (date-time)",
"horizontalErrorMeters": "number (double)",
"namedLocation": {
"id": "integer (int32)",
"name": "string"
},
"yard": {
"id": "integer (int32)"
},
"zones": [
{
"id": "integer (int32)"
}
]
},
"area": {
"id": "integer (int32)",
"name": "string"
},
"system": {
"id": "integer (int32)",
"name": "string"
},
"building": {
"id": "integer (int32)",
"name": "string"
},
"barcode": "string",
"supplier": {
"id": "integer (int32)",
"name": "string"
},
"serialNumber": "string",
"tagNumber": "string",
"assetNumber": "string",
"heatNumber": "string",
"lotNumber": "string",
"shelfLifeExpiration": "string (date-time)",
"preventativeMaintenanceDueDate": "string (date-time)",
"notes": "string",
"flags": [
{
"name": "string",
"description": "string"
}
],
"customField_1": "string",
"customField_2": "string",
"customField_3": "string",
"customField_4": "string",
"customField_5": "string",
"customField_6": "string",
"customField_7": "string",
"customField_8": "string",
"customField_9": "string",
"customField_10": "string",
"customField_11": "string",
"customField_12": "string",
"customField_13": "string",
"customField_14": "string",
"customField_15": "string",
"customField_16": "string",
"customField_17": "string",
"customField_18": "string",
"customField_19": "string",
"customField_20": "string",
"customField_21": "string",
"customField_22": "string",
"customField_23": "string",
"customField_24": "string"
}
}
Jovix.Application.V1.Materials.Views.MaterialView: object
- id: integer (int32)
- name: string
- project: Jovix.Application.V1.GenericViews.IdAndNameView
- catalogItem: Jovix.Application.V1.GenericViews.IdAndNameView
- job: Jovix.Application.V1.GenericViews.IdAndNameView
- status: Jovix.Application.V1.GenericViews.IdAndNameView
- quantity: number (double)
- inventoryType: Jovix.Application.V1.GenericViews.IdAndNameView
- location: Jovix.Application.V1.Locations.Views.LocationView
- area: Jovix.Application.V1.GenericViews.IdAndNameView
- system: Jovix.Application.V1.GenericViews.IdAndNameView
- building: Jovix.Application.V1.GenericViews.IdAndNameView
- barcode: string
- supplier: Jovix.Application.V1.GenericViews.IdAndNameView
- serialNumber: string
- tagNumber: string
- assetNumber: string
- heatNumber: string
- lotNumber: string
- shelfLifeExpiration: string (date-time)
- preventativeMaintenanceDueDate: string (date-time)
- notes: string
- flags: Jovix.Application.V1.Inventories.InventoryItemFlag
- customField_1: string
- customField_2: string
- customField_3: string
- customField_4: string
- customField_5: string
- customField_6: string
- customField_7: string
- customField_8: string
- customField_9: string
- customField_10: string
- customField_11: string
- customField_12: string
- customField_13: string
- customField_14: string
- customField_15: string
- customField_16: string
- customField_17: string
- customField_18: string
- customField_19: string
- customField_20: string
- customField_21: string
- customField_22: string
- customField_23: string
- customField_24: string
- customField_25: string
- customField_26: string
- customField_27: string
- customField_28: string
- customField_29: string
- customField_30: string
Example
{
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)",
"name": "string"
},
"catalogItem": {
"id": "integer (int32)",
"name": "string"
},
"job": {
"id": "integer (int32)",
"name": "string"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"quantity": "number (double)",
"inventoryType": {
"id": "integer (int32)",
"name": "string"
},
"location": {
"latitude": "number (double)",
"longitude": "number (double)",
"dateLocated": "string (date-time)",
"horizontalErrorMeters": "number (double)",
"namedLocation": {
"id": "integer (int32)",
"name": "string"
},
"yard": {
"id": "integer (int32)"
},
"zones": [
{
"id": "integer (int32)"
}
]
},
"area": {
"id": "integer (int32)",
"name": "string"
},
"system": {
"id": "integer (int32)",
"name": "string"
},
"building": {
"id": "integer (int32)",
"name": "string"
},
"barcode": "string",
"supplier": {
"id": "integer (int32)",
"name": "string"
},
"serialNumber": "string",
"tagNumber": "string",
"assetNumber": "string",
"heatNumber": "string",
"lotNumber": "string",
"shelfLifeExpiration": "string (date-time)",
"preventativeMaintenanceDueDate": "string (date-time)",
"notes": "string",
"flags": [
{
"name": "string",
"description": "string"
}
],
"customField_1": "string",
"customField_2": "string",
"customField_3": "string",
"customField_4": "string",
"customField_5": "string",
"customField_6": "string",
"customField_7": "string",
"customField_8": "string",
"customField_9": "string",
"customField_10": "string",
"customField_11": "string",
"customField_12": "string",
"customField_13": "string",
"customField_14": "string",
"customField_15": "string",
"customField_16": "string",
"customField_17": "string",
"customField_18": "string",
"customField_19": "string",
"customField_20": "string",
"customField_21": "string",
"customField_22": "string",
"customField_23": "string",
"customField_24": "string",
"customField_25": "string",
"customField_26": "string",
"customField_27": "string",
"customField_28": "string",
"customField_29": "string"
}
Jovix.Application.V1.Locations.Views.LocationView: object
- latitude: number (double)
- longitude: number (double)
- dateLocated: string (date-time)
- horizontalErrorMeters: number (double)
- namedLocation: Jovix.Application.V1.GenericViews.IdAndNameView
- yard: Jovix.Application.V1.GenericViews.IdView
- zones: Jovix.Application.V1.GenericViews.IdView
Example
{
"latitude": "number (double)",
"longitude": "number (double)",
"dateLocated": "string (date-time)",
"horizontalErrorMeters": "number (double)",
"namedLocation": {
"id": "integer (int32)",
"name": "string"
},
"yard": {
"id": "integer (int32)"
},
"zones": [
{
"id": "integer (int32)"
}
]
}
Jovix.Application.Serialization.Patch[Jovix.Application.V1.Materials.MaterialPatch]:
Example
{
"status": {
"id": "integer (int32)"
},
"quantity": "number (double)",
"inventoryType": {
"id": "integer (int32)"
},
"location": {
"latitude": "number (double)",
"longitude": "number (double)",
"dateLocated": "string (date-time)",
"horizontalErrorMeters": "number (double)",
"namedLocation": {
"id": "integer (int32)",
"name": "string"
},
"yard": {
"id": "integer (int32)"
},
"zones": [
{
"id": "integer (int32)"
}
]
},
"area": {
"id": "integer (int32)"
},
"system": {
"id": "integer (int32)"
},
"building": {
"id": "integer (int32)"
},
"barcode": "string",
"supplier": {
"id": "integer (int32)"
},
"serialNumber": "string",
"assetNumber": "string",
"heatNumber": "string",
"lotNumber": "string",
"shelfLifeExpiration": "string (date-time)",
"notes": "string",
"flags": [
{
"name": "string",
"description": "string"
}
],
"customField_1": "object",
"customField_2": "object",
"customField_3": "object",
"customField_4": "object",
"customField_5": "object",
"customField_6": "object",
"customField_7": "object",
"customField_8": "object",
"customField_9": "object",
"customField_10": "object",
"customField_11": "object",
"customField_12": "object",
"customField_13": "object",
"customField_14": "object",
"customField_15": "object",
"customField_16": "object",
"customField_17": "object",
"customField_18": "object",
"customField_19": "object",
"customField_20": "object",
"customField_21": "object",
"customField_22": "object",
"customField_23": "object",
"customField_24": "object",
"customField_25": "object",
"customField_26": "object",
"customField_27": "object",
"customField_28": "object",
"customField_29": "object",
"customField_30": "object"
}
Jovix.Application.V1.Materials.MaterialPatch: object
- status: Jovix.Application.V1.GenericViews.IdView
- quantity: number (double) x ≥ 0
- inventoryType: Jovix.Application.V1.GenericViews.IdView
- location: Jovix.Application.V1.Locations.Views.LocationView
- area: Jovix.Application.V1.GenericViews.IdView
- system: Jovix.Application.V1.GenericViews.IdView
- building: Jovix.Application.V1.GenericViews.IdView
- barcode: string (up to 150 chars)
- supplier: Jovix.Application.V1.GenericViews.IdView
- serialNumber: string (up to 150 chars)
- assetNumber: string (up to 150 chars)
- heatNumber: string (up to 150 chars)
- lotNumber: string (up to 150 chars)
- shelfLifeExpiration: string (date-time)
- notes: string (up to 1000 chars)
- flags: Jovix.Application.V1.MaterialFlags.Views.MaterialFlagCompactView
- customField_1: object
- customField_2: object
- customField_3: object
- customField_4: object
- customField_5: object
- customField_6: object
- customField_7: object
- customField_8: object
- customField_9: object
- customField_10: object
- customField_11: object
- customField_12: object
- customField_13: object
- customField_14: object
- customField_15: object
- customField_16: object
- customField_17: object
- customField_18: object
- customField_19: object
- customField_20: object
- customField_21: object
- customField_22: object
- customField_23: object
- customField_24: object
- customField_25: object
- customField_26: object
- customField_27: object
- customField_28: object
- customField_29: object
- customField_30: object
Example
{
"status": {
"id": "integer (int32)"
},
"quantity": "number (double)",
"inventoryType": {
"id": "integer (int32)"
},
"location": {
"latitude": "number (double)",
"longitude": "number (double)",
"dateLocated": "string (date-time)",
"horizontalErrorMeters": "number (double)",
"namedLocation": {
"id": "integer (int32)",
"name": "string"
},
"yard": {
"id": "integer (int32)"
},
"zones": [
{
"id": "integer (int32)"
}
]
},
"area": {
"id": "integer (int32)"
},
"system": {
"id": "integer (int32)"
},
"building": {
"id": "integer (int32)"
},
"barcode": "string",
"supplier": {
"id": "integer (int32)"
},
"serialNumber": "string",
"assetNumber": "string",
"heatNumber": "string",
"lotNumber": "string",
"shelfLifeExpiration": "string (date-time)",
"notes": "string",
"flags": [
{
"name": "string",
"description": "string"
}
],
"customField_1": "object",
"customField_2": "object",
"customField_3": "object",
"customField_4": "object",
"customField_5": "object",
"customField_6": "object",
"customField_7": "object",
"customField_8": "object",
"customField_9": "object",
"customField_10": "object",
"customField_11": "object",
"customField_12": "object",
"customField_13": "object",
"customField_14": "object",
"customField_15": "object",
"customField_16": "object",
"customField_17": "object",
"customField_18": "object",
"customField_19": "object",
"customField_20": "object",
"customField_21": "object",
"customField_22": "object",
"customField_23": "object",
"customField_24": "object",
"customField_25": "object",
"customField_26": "object",
"customField_27": "object",
"customField_28": "object",
"customField_29": "object",
"customField_30": "object"
}
Jovix.Application.V1.MaterialFlags.Views.MaterialFlagCompactView: object
- name: string
- description: string (up to 100 chars)
Example
{
"name": "string",
"description": "string"
}
Jovix.Application.Response.ResponseContentForSingle[Jovix.Application.V1.Materials.Views.MaterialView]: object
- include: string
- data: Jovix.Application.V1.Materials.Views.MaterialView
Example
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)",
"name": "string"
},
"catalogItem": {
"id": "integer (int32)",
"name": "string"
},
"job": {
"id": "integer (int32)",
"name": "string"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"quantity": "number (double)",
"inventoryType": {
"id": "integer (int32)",
"name": "string"
},
"location": {
"latitude": "number (double)",
"longitude": "number (double)",
"dateLocated": "string (date-time)",
"horizontalErrorMeters": "number (double)",
"namedLocation": {
"id": "integer (int32)",
"name": "string"
},
"yard": {
"id": "integer (int32)"
},
"zones": [
{
"id": "integer (int32)"
}
]
},
"area": {
"id": "integer (int32)",
"name": "string"
},
"system": {
"id": "integer (int32)",
"name": "string"
},
"building": {
"id": "integer (int32)",
"name": "string"
},
"barcode": "string",
"supplier": {
"id": "integer (int32)",
"name": "string"
},
"serialNumber": "string",
"tagNumber": "string",
"assetNumber": "string",
"heatNumber": "string",
"lotNumber": "string",
"shelfLifeExpiration": "string (date-time)",
"preventativeMaintenanceDueDate": "string (date-time)",
"notes": "string",
"flags": [
{
"name": "string",
"description": "string"
}
],
"customField_1": "string",
"customField_2": "string",
"customField_3": "string",
"customField_4": "string",
"customField_5": "string",
"customField_6": "string",
"customField_7": "string",
"customField_8": "string",
"customField_9": "string",
"customField_10": "string",
"customField_11": "string",
"customField_12": "string",
"customField_13": "string",
"customField_14": "string",
"customField_15": "string",
"customField_16": "string",
"customField_17": "string",
"customField_18": "string",
"customField_19": "string",
"customField_20": "string",
"customField_21": "string",
"customField_22": "string",
"customField_23": "string",
"customField_24": "string",
"customField_25": "string",
"customField_26": "string"
}
}
Jovix.Application.Response.ResponseContent[System.Collections.Generic.List[System.String]]: object
- include: string
- expand: string
- fieldSets: string
- data: string[]
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
"string"
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.V1.Materials.MaterialPost: object
- job: Jovix.Application.V1.GenericViews.IdPost
- catalogItem: Jovix.Application.V1.GenericViews.IdPost
- quantity: number (double) x ≥ 0
- status: Jovix.Application.V1.GenericViews.IdPost
- inventoryType: Jovix.Application.V1.GenericViews.IdPost
- location: Jovix.Application.V1.Locations.LocationPost
- area: Jovix.Application.V1.GenericViews.IdPost
- system: Jovix.Application.V1.GenericViews.IdPost
- building: Jovix.Application.V1.GenericViews.IdPost
- supplier: Jovix.Application.V1.GenericViews.IdPost
- sequenceNumber: integer (int32)
- serialNumber: string (up to 150 chars)
- assetNumber: string (up to 150 chars)
- heatNumber: string (up to 150 chars)
- lotNumber: string (up to 150 chars)
- notes: string (up to 1000 chars)
- barcode: string (up to 150 chars)
- shelfLifeExpiration: string (date-time)
- flags: Jovix.Application.V1.MaterialFlags.Views.MaterialFlagCompactView
- customField_1: object
- customField_2: object
- customField_3: object
- customField_4: object
- customField_5: object
- customField_6: object
- customField_7: object
- customField_8: object
- customField_9: object
- customField_10: object
- customField_11: object
- customField_12: object
- customField_13: object
- customField_14: object
- customField_15: object
- customField_16: object
- customField_17: object
- customField_18: object
- customField_19: object
- customField_20: object
- customField_21: object
- customField_22: object
- customField_23: object
- customField_24: object
- customField_25: object
- customField_26: object
- customField_27: object
- customField_28: object
- customField_29: object
- customField_30: object
Example
{
"job": {
"id": "integer (int32)"
},
"catalogItem": {
"id": "integer (int32)"
},
"quantity": "number (double)",
"status": {
"id": "integer (int32)"
},
"inventoryType": {
"id": "integer (int32)"
},
"location": {
"namedLocation": {
"id": "integer (int32)"
}
},
"area": {
"id": "integer (int32)"
},
"system": {
"id": "integer (int32)"
},
"building": {
"id": "integer (int32)"
},
"supplier": {
"id": "integer (int32)"
},
"sequenceNumber": "integer (int32)",
"serialNumber": "string",
"assetNumber": "string",
"heatNumber": "string",
"lotNumber": "string",
"notes": "string",
"barcode": "string",
"shelfLifeExpiration": "string (date-time)",
"flags": [
{
"name": "string",
"description": "string"
}
],
"customField_1": "object",
"customField_2": "object",
"customField_3": "object",
"customField_4": "object",
"customField_5": "object",
"customField_6": "object",
"customField_7": "object",
"customField_8": "object",
"customField_9": "object",
"customField_10": "object",
"customField_11": "object",
"customField_12": "object",
"customField_13": "object",
"customField_14": "object",
"customField_15": "object",
"customField_16": "object",
"customField_17": "object",
"customField_18": "object",
"customField_19": "object",
"customField_20": "object",
"customField_21": "object",
"customField_22": "object",
"customField_23": "object",
"customField_24": "object",
"customField_25": "object",
"customField_26": "object",
"customField_27": "object",
"customField_28": "object",
"customField_29": "object",
"customField_30": "object"
}
Jovix.Application.V1.Locations.LocationPost: object
- namedLocation: Jovix.Application.V1.GenericViews.IdPost
Example
{
"namedLocation": {
"id": "integer (int32)"
}
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.Materials.Views.MaterialIncludeView[]]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.Materials.Views.MaterialIncludeView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)",
"name": "string"
},
"catalogItem": {
"id": "integer (int32)",
"name": "string",
"centerOfGravity": "string",
"description": "string",
"notes": "string",
"size": "string",
"shortDescription": "string",
"specializedTrailer": "boolean",
"storageRequirement": "string",
"tagNumber": "string",
"volume": "string",
"length": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"width": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"height": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"weight": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"discipline": {
"id": "integer (int32)",
"name": "string"
},
"materialType": {
"id": "integer (int32)",
"name": "string"
},
"project": {
"id": "integer (int32)",
"name": "string"
},
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
},
"customFields": "object"
},
"job": {
"id": "integer (int32)",
"name": "string"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"quantity": "number (double)",
"inventoryType": {
"id": "integer (int32)",
"name": "string"
},
"location": {
"latitude": "number (double)",
"longitude": "number (double)",
"dateLocated": "string (date-time)",
"horizontalErrorMeters": "number (double)",
"namedLocation": {
"id": "integer (int32)",
"name": "string"
},
"yard": {
"id": "integer (int32)"
},
"zones": [
{}
]
}
}
]
}
Jovix.Application.V1.Materials.Views.MaterialIncludeView: object
- id: integer (int32)
- name: string
- project: Jovix.Application.V1.GenericViews.IdAndNameView
- catalogItem: Jovix.Application.V1.CatalogItems.Views.CatalogItemIncludeView
- job: Jovix.Application.V1.GenericViews.IdAndNameView
- status: Jovix.Application.V1.GenericViews.IdAndNameView
- quantity: number (double)
- inventoryType: Jovix.Application.V1.GenericViews.IdAndNameView
- location: Jovix.Application.V1.Locations.Views.LocationView
- area: Jovix.Application.V1.GenericViews.IdAndNameView
- system: Jovix.Application.V1.GenericViews.IdAndNameView
- building: Jovix.Application.V1.GenericViews.IdAndNameView
- barcode: string
- supplier: Jovix.Application.V1.GenericViews.IdAndNameView
- serialNumber: string
- tagNumber: string
- assetNumber: string
- heatNumber: string
- lotNumber: string
- shelfLifeExpiration: string (date-time)
- preventativeMaintenanceDueDate: string (date-time)
- notes: string
- flags: Jovix.Application.V1.Inventories.InventoryItemFlag
- customFields: object
Example
{
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)",
"name": "string"
},
"catalogItem": {
"id": "integer (int32)",
"name": "string",
"centerOfGravity": "string",
"description": "string",
"notes": "string",
"size": "string",
"shortDescription": "string",
"specializedTrailer": "boolean",
"storageRequirement": "string",
"tagNumber": "string",
"volume": "string",
"length": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"width": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"height": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"weight": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"discipline": {
"id": "integer (int32)",
"name": "string"
},
"materialType": {
"id": "integer (int32)",
"name": "string"
},
"project": {
"id": "integer (int32)",
"name": "string"
},
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
},
"customFields": "object"
},
"job": {
"id": "integer (int32)",
"name": "string"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"quantity": "number (double)",
"inventoryType": {
"id": "integer (int32)",
"name": "string"
},
"location": {
"latitude": "number (double)",
"longitude": "number (double)",
"dateLocated": "string (date-time)",
"horizontalErrorMeters": "number (double)",
"namedLocation": {
"id": "integer (int32)",
"name": "string"
},
"yard": {
"id": "integer (int32)"
},
"zones": [
{
"id": "integer (int32)"
}
]
},
"area": {
"id": "integer (int32)",
"name": "string"
}
}
Jovix.Application.V1.CatalogItems.Views.CatalogItemIncludeView: object
- id: integer (int32)
- name: string
- centerOfGravity: string
- description: string
- notes: string
- size: string
- shortDescription: string
- specializedTrailer: boolean
- storageRequirement: string
- tagNumber: string
- volume: string
- length: Jovix.Application.V1.UnitsOfMeasure.MeasurementView
- width: Jovix.Application.V1.UnitsOfMeasure.MeasurementView
- height: Jovix.Application.V1.UnitsOfMeasure.MeasurementView
- weight: Jovix.Application.V1.UnitsOfMeasure.MeasurementView
- discipline: Jovix.Application.V1.GenericViews.IdAndNameView
- materialType: Jovix.Application.V1.GenericViews.IdAndNameView
- project: Jovix.Application.V1.GenericViews.IdAndNameView
- unitOfMeasure: Jovix.Application.V1.GenericViews.IdAndNameView
- customFields: object
Example
{
"id": "integer (int32)",
"name": "string",
"centerOfGravity": "string",
"description": "string",
"notes": "string",
"size": "string",
"shortDescription": "string",
"specializedTrailer": "boolean",
"storageRequirement": "string",
"tagNumber": "string",
"volume": "string",
"length": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"width": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"height": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"weight": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"discipline": {
"id": "integer (int32)",
"name": "string"
},
"materialType": {
"id": "integer (int32)",
"name": "string"
},
"project": {
"id": "integer (int32)",
"name": "string"
},
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
},
"customFields": "object"
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.MaterialFlags.MaterialFlagLookupOption[]]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.MaterialFlags.MaterialFlagLookupOption
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"name": "string"
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.V1.MaterialFlags.MaterialFlagLookupOption: object
- name: string
Example
{
"name": "string"
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.MaterialFlags.MaterialFlag[]]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.MaterialFlags.MaterialFlag
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"flagCode": "string",
"abbreviation": "string",
"isMobileFlag": "boolean",
"isReceiptFlag": "boolean",
"isShippingUnitFlag": "boolean",
"hasTextField": "boolean",
"isActive": "boolean",
"isOsdFlag": "boolean",
"isMaterialFlag": "boolean",
"columnNumber": "integer (int32)"
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.V1.MaterialFlags.MaterialFlag: object
- id: integer (int32)
- flagCode: string
- abbreviation: string
- isMobileFlag: boolean
- isReceiptFlag: boolean
- isShippingUnitFlag: boolean
- hasTextField: boolean
- isActive: boolean
- isOsdFlag: boolean
- isMaterialFlag: boolean
- columnNumber: integer (int32)
Example
{
"id": "integer (int32)",
"flagCode": "string",
"abbreviation": "string",
"isMobileFlag": "boolean",
"isReceiptFlag": "boolean",
"isShippingUnitFlag": "boolean",
"hasTextField": "boolean",
"isActive": "boolean",
"isOsdFlag": "boolean",
"isMaterialFlag": "boolean",
"columnNumber": "integer (int32)"
}
Jovix.Application.Response.ResponseContentForSingle[Jovix.Application.V1.LabelTemplate.Views.LabelTemplateView]: object
- include: string
- data: Jovix.Application.V1.LabelTemplate.Views.LabelTemplateView
Example
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"templateType": {
"id": "integer (int32)",
"name": "string"
},
"isDefault": "boolean",
"isActive": "boolean",
"labelHeight": "number (double)",
"labelWidth": "number (double)",
"barcodePosition": "string",
"barcode": "string",
"fields": [
{
"order": "integer (int32)",
"caption": "string",
"hideBlank": "boolean",
"numberOfLines": "integer (int32)",
"fontSize": "integer (int32)",
"value": "string"
}
]
}
}
Jovix.Application.V1.LabelTemplate.Views.LabelTemplateView: object
- id: integer (int32)
- name: string
- templateType: Jovix.Application.V1.GenericViews.IdAndNameView
- isDefault: boolean
- isActive: boolean
- labelHeight: number (double)
- labelWidth: number (double)
- barcodePosition: string
- barcode: string
- fields: Jovix.Application.V1.LabelTemplate.Views.LabelTemplateFieldConfigurationView
Example
{
"id": "integer (int32)",
"name": "string",
"templateType": {
"id": "integer (int32)",
"name": "string"
},
"isDefault": "boolean",
"isActive": "boolean",
"labelHeight": "number (double)",
"labelWidth": "number (double)",
"barcodePosition": "string",
"barcode": "string",
"fields": [
{
"order": "integer (int32)",
"caption": "string",
"hideBlank": "boolean",
"numberOfLines": "integer (int32)",
"fontSize": "integer (int32)",
"value": "string"
}
]
}
Jovix.Application.V1.LabelTemplate.Views.LabelTemplateFieldConfigurationView: object
- order: integer (int32)
- caption: string
- hideBlank: boolean
- numberOfLines: integer (int32)
- fontSize: integer (int32)
- value: string
Example
{
"order": "integer (int32)",
"caption": "string",
"hideBlank": "boolean",
"numberOfLines": "integer (int32)",
"fontSize": "integer (int32)",
"value": "string"
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.LabelTemplate.Views.LabelTemplateView[]]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.LabelTemplate.Views.LabelTemplateView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"templateType": {
"id": "integer (int32)",
"name": "string"
},
"isDefault": "boolean",
"isActive": "boolean",
"labelHeight": "number (double)",
"labelWidth": "number (double)",
"barcodePosition": "string",
"barcode": "string",
"fields": [
{
"order": "integer (int32)",
"caption": "string",
"hideBlank": "boolean",
"numberOfLines": "integer (int32)",
"fontSize": "integer (int32)",
"value": "string"
}
]
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.Inventories.Views.MaterialView]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.Inventories.Views.MaterialView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"catalogItem": {
"id": "integer (int32)",
"name": "string",
"centerOfGravity": "string",
"description": "string",
"notes": "string",
"size": "string",
"shortDescription": "string",
"specializedTrailer": "boolean",
"tagNumber": "string",
"volume": "string",
"length": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"width": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"height": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"weight": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"discipline": {
"id": "integer (int32)",
"name": "string"
},
"materialType": {
"id": "integer (int32)",
"name": "string"
},
"project": {
"id": "integer (int32)",
"name": "string"
},
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
},
"customField_1": "string",
"customField_2": "string",
"customField_3": "string",
"customField_4": "string",
"customField_5": "string",
"customField_6": "string",
"customField_7": "string",
"customField_8": "string",
"customField_9": "string",
"customField_10": "string",
"customField_11": "string",
"customField_12": "string",
"customField_13": "string",
"customField_14": "string",
"customField_15": "string",
"customField_16": "string",
"customField_17": "string",
"customField_18": "string",
"customField_19": "string",
"customField_20": "string",
"customField_21": "string",
"customField_22": "string",
"customField_23": "string",
"customField_24": "string",
"customField_25": "string",
"customField_26": "string",
"customField_27": "string",
"customField_28": "string",
"customField_29": "string",
"customField_30": "string"
},
"job": {
"id": "integer (int32)"
}
}
}
Jovix.Application.V1.Inventories.Views.MaterialView: object
- id: integer (int32)
- name: string
- project: Jovix.Application.V1.Projects.ProjectView
- catalogItem: Jovix.Application.V1.CatalogItems.Views.CatalogItemView
- job: Jovix.Application.V1.Jobs.Views.JobView
- status: Jovix.Application.V1.Statuses.Views.StatusView
- quantity: number (double)
- inventoryType: Jovix.Application.V1.InventoryType.Views.InventoryTypeView
- location: Jovix.Application.V1.Locations.Views.LocationView
- area: Jovix.Application.V1.GenericViews.IdView
- system: Jovix.Application.V1.GenericViews.IdView
- building: Jovix.Application.V1.GenericViews.IdView
- barcode: string
- supplier: Jovix.Application.V1.Suppliers.Views.SupplierView
- serialNumber: string
- tagNumber: string
- assetNumber: string
- heatNumber: string
- lotNumber: string
- shelfLifeExpiration: string (date-time)
- preventativeMaintenanceDueDate: string (date-time)
- notes: string
- flags: Jovix.Application.V1.Inventories.InventoryItemFlag
- cF_1: string
- cF_2: string
- cF_3: string
- cF_4: string
- cF_5: string
- cF_6: string
- cF_7: string
- cF_8: string
- cF_9: string
- cF_10: string
- cF_11: string
- cF_12: string
- cF_13: string
- cF_14: string
- cF_15: string
- cF_16: string
- cF_17: string
- cF_18: string
- cF_19: string
- cF_20: string
- cF_21: string
- cF_22: string
- cF_23: string
- cF_24: string
- cF_25: string
- cF_26: string
- cF_27: string
- cF_28: string
- cF_29: string
- cF_30: string
- cF_Lookup1: string (uuid)
- cF_Lookup2: string (uuid)
- cF_Lookup3: string (uuid)
- cF_Lookup4: string (uuid)
- cF_Lookup5: string (uuid)
Example
{
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"catalogItem": {
"id": "integer (int32)",
"name": "string",
"centerOfGravity": "string",
"description": "string",
"notes": "string",
"size": "string",
"shortDescription": "string",
"specializedTrailer": "boolean",
"tagNumber": "string",
"volume": "string",
"length": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"width": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"height": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"weight": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"discipline": {
"id": "integer (int32)",
"name": "string"
},
"materialType": {
"id": "integer (int32)",
"name": "string"
},
"project": {
"id": "integer (int32)",
"name": "string"
},
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
},
"customField_1": "string",
"customField_2": "string",
"customField_3": "string",
"customField_4": "string",
"customField_5": "string",
"customField_6": "string",
"customField_7": "string",
"customField_8": "string",
"customField_9": "string",
"customField_10": "string",
"customField_11": "string",
"customField_12": "string",
"customField_13": "string",
"customField_14": "string",
"customField_15": "string",
"customField_16": "string",
"customField_17": "string",
"customField_18": "string",
"customField_19": "string",
"customField_20": "string",
"customField_21": "string",
"customField_22": "string",
"customField_23": "string",
"customField_24": "string",
"customField_25": "string",
"customField_26": "string",
"customField_27": "string",
"customField_28": "string",
"customField_29": "string",
"customField_30": "string"
},
"job": {
"id": "integer (int32)",
"name": "string"
},
"status": {
"id": "integer (int32)",
"name": "string"
}
}
Jovix.Application.V1.Projects.ProjectView: object
- id: integer (int32)
Example
{
"id": "integer (int32)"
}
Jovix.Application.V1.Statuses.Views.StatusView: object
- id: integer (int32)
- name: string
Example
{
"id": "integer (int32)",
"name": "string"
}
Jovix.Application.V1.InventoryType.Views.InventoryTypeView: object
- id: integer (int32)
Example
{
"id": "integer (int32)"
}
Jovix.Application.V1.Suppliers.Views.SupplierView: object
- id: integer (int32)
- name: string
- code: string
- project: Jovix.Application.V1.GenericViews.IdView
- addresses: Jovix.Application.V1.Addresses.AddressResourceView
Example
{
"id": "integer (int32)",
"name": "string",
"code": "string",
"project": {
"id": "integer (int32)"
},
"addresses": [
{
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
}
]
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.Inventories.InventoryItem]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.Inventories.InventoryItem
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"inventoryItemKey": "string",
"jobInfoId": "integer (int32)",
"instanceNumber": "integer (int32)",
"inventoryTypeNumber": "integer (int32)",
"itemTypeNumber": "integer (int32)",
"barcode": "string",
"catalogId": "integer (int32)",
"statusId": "integer (int32)",
"quantity": "number (double)",
"namedLocationId": "integer (int32)",
"notes": "string",
"serialNumber": "string",
"assetNumber": "string",
"heatNumber": "string",
"lotNumber": "string",
"tagNumber": "string",
"latitude": "number (double)",
"longitude": "number (double)",
"horizontalErrorMeters": "number (double)",
"dateLocated": "string (date-time)",
"cF_1": "string",
"cF_2": "string",
"cF_3": "string",
"cF_4": "string",
"cF_5": "string",
"cF_6": "string",
"cF_7": "string",
"cF_8": "string",
"cF_9": "string",
"cF_10": "string",
"cF_11": "string",
"cF_12": "string",
"cF_13": "string",
"cF_14": "string",
"cF_15": "string",
"cF_16": "string",
"cF_17": "string",
"cF_18": "string",
"cF_19": "string",
"cF_20": "string",
"cF_21": "string",
"cF_22": "string",
"cF_23": "string",
"cF_24": "string",
"cF_25": "string",
"cF_26": "string",
"cF_27": "string",
"cF_28": "string",
"cF_29": "string",
"cF_30": "string",
"cF_Lookup1": "string",
"cF_Lookup2": "string",
"cF_Lookup3": "string",
"cF_Lookup4": "string",
"cF_Lookup5": "string",
"job": {
"id": "integer (int32)",
"name": "string"
},
"catalogItem": {
"id": "integer (int32)",
"name": "string",
"shortDescription": "string",
"description": "string",
"project": {
"id": "00000000-0000-0000-0000-000000000000"
},
"materialType": {
"id": "integer (int32)"
},
"discipline": {
"id": "integer (int32)"
},
"unitOfMeasure": {
"id": "00000000-0000-0000-0000-000000000000"
},
"lengthUnitOfMeasureID": "00000000-0000-0000-0000-000000000000",
"widthUnitOfMeasureID": "00000000-0000-0000-0000-000000000000",
"heightUnitOfMeasureID": "00000000-0000-0000-0000-000000000000",
"weightUnitOfMeasureID": "00000000-0000-0000-0000-000000000000",
"volume": "string",
"centerOfGravity": "string",
"asmeClassification": "string",
"htsClassification": "string",
"htsDescription": "string",
"hazardousMaterialsClassification": "string",
"hazardousMaterialsDescription": "string",
"storageRequirement": "string",
"safetyClassification": "string",
"handlingInstructions": "string",
"isAssetNumberRequired": "boolean"
}
}
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.Barcodes.BarcodeDescriptor]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.Barcodes.BarcodeDescriptor
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": {
"entityType": "string",
"barcodeVersion": "integer (int32)",
"barcodeValue": "string"
},
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.V1.Barcodes.BarcodeDescriptor: object
- entityType: string
- barcodeVersion: integer (int32)
- barcodeValue: string
Example
{
"entityType": "string",
"barcodeVersion": "integer (int32)",
"barcodeValue": "string"
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.Locations.NamedLocation]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.Locations.NamedLocation
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"facility": {
"id": "integer (int32)",
"name": "string",
"site": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
},
"job": {
"id": "integer (int32)",
"name": "string"
}
}
},
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.Response.ResponseContentForSingle[Jovix.Application.V1.Locations.Views.NamedLocationResourceView]: object
- include: string
- data: Jovix.Application.V1.Locations.Views.NamedLocationResourceView
Example
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"facility": {
"id": "integer (int32)"
},
"barcode": "string"
}
}
Jovix.Application.V1.Locations.Views.NamedLocationResourceView: object
- id: integer (int32)
- name: string
- facility: Jovix.Application.V1.GenericViews.IdView
- barcode: string
Example
{
"id": "integer (int32)",
"name": "string",
"facility": {
"id": "integer (int32)"
},
"barcode": "string"
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.Locations.NamedLocation[]]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.Locations.NamedLocation
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"facility": {
"id": "integer (int32)",
"name": "string",
"site": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
},
"job": {
"id": "integer (int32)",
"name": "string"
}
}
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.V1.Users.Permissions.Permissions: object
- materialsPermissions: Jovix.Application.V1.Users.Permissions.MaterialsPermissions
Example
{
"materialsPermissions": {
"addAttachments": "boolean",
"editStatus": "boolean",
"modify": "boolean",
"view": "boolean"
}
}
Jovix.Application.V1.Users.Permissions.MaterialsPermissions: object
- addAttachments: boolean
- editStatus: boolean
- modify: boolean
- view: boolean
Example
{
"addAttachments": "boolean",
"editStatus": "boolean",
"modify": "boolean",
"view": "boolean"
}
Jovix.Application.Response.ResponseContentForSingle[Jovix.Application.V1.PickLists.Views.PickListIncludeView]: object
- include: string
- data: Jovix.Application.V1.PickLists.Views.PickListIncludeView
Example
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"description": "string",
"job": {
"id": "integer (int32)",
"name": "string",
"description": "string",
"abbreviation": "string",
"isActive": "boolean",
"project": {
"id": "integer (int32)"
}
},
"site": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"datePickRequested": "string (date-time)",
"datePickStarted": "string (date-time)",
"datePickFinished": "string (date-time)",
"stagedLocation": "string",
"assignedTo": {
"id": "integer (int32)",
"name": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"internalId": "string",
"company": "string",
"isSupplierUser": "boolean",
"isLocked": "boolean",
"isMobileUser": "boolean",
"phone": "string",
"email": "string"
},
"pickedBy": {
"id": "integer (int32)",
"name": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"internalId": "string",
"company": "string",
"isSupplierUser": "boolean",
"isLocked": "boolean",
"isMobileUser": "boolean",
"phone": "string",
"email": "string"
},
"customFields": "object"
}
}
Jovix.Application.V1.PickLists.Views.PickListIncludeView: object
- id: integer (int32)
- name: string
- description: string
- job: Jovix.Application.V1.Jobs.Views.JobIncludeView
- site: Jovix.Application.V1.Sites.Views.SiteIncludeView
- status: Jovix.Application.V1.Statuses.Views.StatusView
- datePickRequested: string (date-time)
- datePickStarted: string (date-time)
- datePickFinished: string (date-time)
- stagedLocation: string
- assignedTo: Jovix.Application.V1.Users.Views.UserIncludeView
- pickedBy: Jovix.Application.V1.Users.Views.UserIncludeView
- customFields: object
Example
{
"id": "integer (int32)",
"name": "string",
"description": "string",
"job": {
"id": "integer (int32)",
"name": "string",
"description": "string",
"abbreviation": "string",
"isActive": "boolean",
"project": {
"id": "integer (int32)"
}
},
"site": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"datePickRequested": "string (date-time)",
"datePickStarted": "string (date-time)",
"datePickFinished": "string (date-time)",
"stagedLocation": "string",
"assignedTo": {
"id": "integer (int32)",
"name": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"internalId": "string",
"company": "string",
"isSupplierUser": "boolean",
"isLocked": "boolean",
"isMobileUser": "boolean",
"phone": "string",
"email": "string"
},
"pickedBy": {
"id": "integer (int32)",
"name": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"internalId": "string",
"company": "string",
"isSupplierUser": "boolean",
"isLocked": "boolean",
"isMobileUser": "boolean",
"phone": "string",
"email": "string"
},
"customFields": "object"
}
Jovix.Application.V1.Jobs.Views.JobIncludeView: object
- id: integer (int32)
- name: string
- description: string
- abbreviation: string
- isActive: boolean
- project: Jovix.Application.V1.GenericViews.IdView
Example
{
"id": "integer (int32)",
"name": "string",
"description": "string",
"abbreviation": "string",
"isActive": "boolean",
"project": {
"id": "integer (int32)"
}
}
Jovix.Application.V1.Sites.Views.SiteIncludeView: object
- id: integer (int32)
- name: string
- project: Jovix.Application.V1.GenericViews.IdView
- address: Jovix.Application.V1.Addresses.AddressResourceView
- isToLocation: boolean
- isFromLocation: boolean
- isWorkOrDeliverySite: boolean
Example
{
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
}
Jovix.Application.V1.Users.Views.UserIncludeView: object
- id: integer (int32)
- name: string
- firstName: string
- middleName: string
- lastName: string
- internalId: string
- company: string
- isSupplierUser: boolean
- isLocked: boolean
- isMobileUser: boolean
- phone: string
- email: string
Example
{
"id": "integer (int32)",
"name": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"internalId": "string",
"company": "string",
"isSupplierUser": "boolean",
"isLocked": "boolean",
"isMobileUser": "boolean",
"phone": "string",
"email": "string"
}
Jovix.Application.Response.ResponseContentForSingle[Jovix.Application.V1.PickLists.Views.PickListResourceView]: object
- include: string
- data: Jovix.Application.V1.PickLists.Views.PickListResourceView
Example
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"description": "string",
"stagedLocation": "string",
"job": {
"id": "integer (int32)",
"name": "string"
},
"site": {
"id": "integer (int32)"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"datePickStarted": "string (date-time)",
"datePickRequested": "string (date-time)",
"datePickFinished": "string (date-time)"
}
}
Jovix.Application.V1.PickLists.Views.PickListResourceView: object
- id: integer (int32)
- name: string
- description: string
- stagedLocation: string
- job: Jovix.Application.V1.GenericViews.IdAndNameView
- site: Jovix.Application.V1.GenericViews.IdView
- status: Jovix.Application.V1.GenericViews.IdAndNameView
- datePickStarted: string (date-time)
- datePickRequested: string (date-time)
- datePickFinished: string (date-time)
Example
{
"id": "integer (int32)",
"name": "string",
"description": "string",
"stagedLocation": "string",
"job": {
"id": "integer (int32)",
"name": "string"
},
"site": {
"id": "integer (int32)"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"datePickStarted": "string (date-time)",
"datePickRequested": "string (date-time)",
"datePickFinished": "string (date-time)"
}
Jovix.Application.V1.PickLists.Views.PickListPostView: object
- name: string
- description: string
- job: Jovix.Application.V1.GenericViews.IdPost
- site: Jovix.Application.V1.GenericViews.IdPost
Example
{
"name": "string",
"description": "string",
"job": {
"id": "integer (int32)"
},
"site": {
"id": "integer (int32)"
}
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.PickLists.Views.PickListIncludeView[]]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.PickLists.Views.PickListIncludeView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"description": "string",
"job": {
"id": "integer (int32)",
"name": "string",
"description": "string",
"abbreviation": "string",
"isActive": "boolean",
"project": {
"id": "integer (int32)"
}
},
"site": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"datePickRequested": "string (date-time)",
"datePickStarted": "string (date-time)",
"datePickFinished": "string (date-time)",
"stagedLocation": "string",
"assignedTo": {
"id": "integer (int32)",
"name": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"internalId": "string",
"company": "string",
"isSupplierUser": "boolean",
"isLocked": "boolean",
"isMobileUser": "boolean",
"phone": "string",
"email": "string"
},
"pickedBy": {
"id": "integer (int32)",
"name": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"internalId": "string",
"company": "string",
"isSupplierUser": "boolean",
"isLocked": "boolean",
"isMobileUser": "boolean",
"phone": "string",
"email": "string"
},
"customFields": "object"
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.Response.ResponseContentForSingle[Jovix.Application.V1.PickListItems.Views.PickListItemResourceView]: object
- include: string
- data: Jovix.Application.V1.PickListItems.Views.PickListItemResourceView
Example
{
"include": "string",
"data": {
"id": "integer (int32)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"pickQuantity": "number (double)",
"catalogItem": {
"id": "integer (int32)"
},
"pickList": {
"id": "integer (int32)"
},
"material": {
"id": "integer (int32)"
}
}
}
Jovix.Application.V1.PickListItems.Views.PickListItemResourceView: object
- id: integer (int32)
- lineNumber: integer (int32)
- subLineNumber: integer (int32)
- pickQuantity: number (double)
- catalogItem: Jovix.Application.V1.GenericViews.IdView
- pickList: Jovix.Application.V1.GenericViews.IdView
- material: Jovix.Application.V1.GenericViews.IdView
Example
{
"id": "integer (int32)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"pickQuantity": "number (double)",
"catalogItem": {
"id": "integer (int32)"
},
"pickList": {
"id": "integer (int32)"
},
"material": {
"id": "integer (int32)"
}
}
Jovix.Application.V1.PickListItems.Views.PickListItemPost: object
- pickList: Jovix.Application.V1.GenericViews.IdPost
- catalogItem: Jovix.Application.V1.GenericViews.IdPost
- material: Jovix.Application.V1.GenericViews.IdPost
- pickQuantity: number (double)
Example
{
"pickList": {
"id": "integer (int32)"
},
"catalogItem": {
"id": "integer (int32)"
},
"material": {
"id": "integer (int32)"
},
"pickQuantity": "number (double)"
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.PickListItems.Views.PickListItemIncludeView[]]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.PickListItems.Views.PickListItemIncludeView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"pickQuantity": "number (double)",
"catalogItem": {
"id": "integer (int32)",
"name": "string",
"centerOfGravity": "string",
"description": "string",
"notes": "string",
"size": "string",
"shortDescription": "string",
"specializedTrailer": "boolean",
"storageRequirement": "string",
"tagNumber": "string",
"volume": "string",
"length": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"width": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"height": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"weight": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"discipline": {
"id": "integer (int32)",
"name": "string"
},
"materialType": {
"id": "integer (int32)",
"name": "string"
},
"project": {
"id": "integer (int32)",
"name": "string"
},
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
},
"customFields": "object"
},
"pickList": {
"id": "integer (int32)",
"name": "string",
"description": "string",
"job": {
"id": "integer (int32)",
"name": "string",
"description": "string",
"abbreviation": "string",
"isActive": "boolean",
"project": {
"id": "integer (int32)"
}
},
"site": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string"
}
}
}
}
]
}
Jovix.Application.V1.PickListItems.Views.PickListItemIncludeView: object
- id: integer (int32)
- lineNumber: integer (int32)
- subLineNumber: integer (int32)
- pickQuantity: number (double)
- catalogItem: Jovix.Application.V1.CatalogItems.Views.CatalogItemIncludeFullView
- pickList: Jovix.Application.V1.PickLists.Views.PickListIncludeView
- material: Jovix.Application.V1.Materials.Views.MaterialIncludeView
- withdrawalRequestItem: Jovix.Application.V1.WithdrawalRequestItems.Views.WithdrawalRequestItemIncludeView
- pickedQuantity: number (double)
- remainingQuantity: number (double)
- stagedLocation: string
- customFields: object
Example
{
"id": "integer (int32)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"pickQuantity": "number (double)",
"catalogItem": {
"id": "integer (int32)",
"name": "string",
"centerOfGravity": "string",
"description": "string",
"notes": "string",
"size": "string",
"shortDescription": "string",
"specializedTrailer": "boolean",
"storageRequirement": "string",
"tagNumber": "string",
"volume": "string",
"length": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"width": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"height": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"weight": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"discipline": {
"id": "integer (int32)",
"name": "string"
},
"materialType": {
"id": "integer (int32)",
"name": "string"
},
"project": {
"id": "integer (int32)",
"name": "string"
},
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
},
"customFields": "object"
},
"pickList": {
"id": "integer (int32)",
"name": "string",
"description": "string",
"job": {
"id": "integer (int32)",
"name": "string",
"description": "string",
"abbreviation": "string",
"isActive": "boolean",
"project": {
"id": "integer (int32)"
}
},
"site": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean"
}
}
}
Jovix.Application.V1.CatalogItems.Views.CatalogItemIncludeFullView: object
- id: integer (int32)
- name: string
- centerOfGravity: string
- description: string
- notes: string
- size: string
- shortDescription: string
- specializedTrailer: boolean
- storageRequirement: string
- tagNumber: string
- volume: string
- length: Jovix.Application.V1.UnitsOfMeasure.MeasurementView
- width: Jovix.Application.V1.UnitsOfMeasure.MeasurementView
- height: Jovix.Application.V1.UnitsOfMeasure.MeasurementView
- weight: Jovix.Application.V1.UnitsOfMeasure.MeasurementView
- discipline: Jovix.Application.V1.GenericViews.IdAndNameView
- materialType: Jovix.Application.V1.GenericViews.IdAndNameView
- project: Jovix.Application.V1.GenericViews.IdAndNameView
- unitOfMeasure: Jovix.Application.V1.GenericViews.IdAndNameView
- customFields: object
Example
{
"id": "integer (int32)",
"name": "string",
"centerOfGravity": "string",
"description": "string",
"notes": "string",
"size": "string",
"shortDescription": "string",
"specializedTrailer": "boolean",
"storageRequirement": "string",
"tagNumber": "string",
"volume": "string",
"length": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"width": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"height": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"weight": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"discipline": {
"id": "integer (int32)",
"name": "string"
},
"materialType": {
"id": "integer (int32)",
"name": "string"
},
"project": {
"id": "integer (int32)",
"name": "string"
},
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
},
"customFields": "object"
}
Jovix.Application.V1.WithdrawalRequestItems.Views.WithdrawalRequestItemIncludeView: object
- id: integer (int32)
- withdrawalRequest: Jovix.Application.V1.WithdrawalRequests.Views.WithdrawalRequestIncludeView
- workPackageItem: Jovix.Application.V1.WorkPackageItems.Views.WorkPackageItemIncludeView
- catalogItem: Jovix.Application.V1.CatalogItems.Views.CatalogItemIncludeView
- material: Jovix.Application.V1.GenericViews.IdView
- requestedQuantity: number (double)
- lineNumber: integer (int32)
- subLineNumber: integer (int32)
- isReserved: boolean
- customField_1: string
- customField_2: string
- customField_3: string
- customField_4: string
- customField_5: string
- customField_6: string
- customField_7: string
- customField_8: string
- customField_9: string
- customField_10: string
- customField_11: string
- customField_12: string
- customField_13: string
- customField_14: string
- customField_15: string
- customField_16: string
- customField_17: string
- customField_18: string
- customField_19: string
- customField_20: string
- customField_21: string
- customField_22: string
- customField_23: string
- customField_24: string
- customField_25: string
- customField_26: string
- customField_27: string
- customField_28: string
- customField_29: string
- customField_30: string
Example
{
"id": "integer (int32)",
"withdrawalRequest": {
"id": "integer (int32)",
"name": "string",
"notes": "string",
"description": "string",
"deliverByDate": "string (date-time)",
"requiredAtSiteDate": "string (date-time)",
"requestedOnDate": "string (date-time)",
"status": {
"id": "integer (int32)",
"name": "string"
},
"deliverySite": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
},
"pickSite": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
},
"job": {
"id": "integer (int32)",
"name": "string",
"description": "string",
"abbreviation": "string",
"isActive": "boolean",
"project": {
"id": "integer (int32)"
}
},
"customField_1": "string",
"customField_2": "string",
"customField_3": "string",
"customField_4": "string",
"customField_5": "string",
"customField_6": "string",
"customField_7": "string",
"customField_8": "string",
"customField_9": "string",
"customField_10": "string",
"customField_11": "string",
"customField_12": "string",
"customField_13": "string",
"customField_14": "string",
"customField_15": "string",
"customField_16": "string",
"customField_17": "string",
"customField_18": "string",
"customField_19": "string",
"customField_20": "string",
"customField_21": "string",
"customField_22": "string",
"customField_23": "string",
"customField_24": "string",
"customField_25": "string",
"customField_26": "string",
"customField_27": "string"
}
}
Jovix.Application.V1.WithdrawalRequests.Views.WithdrawalRequestIncludeView: object
- id: integer (int32)
- name: string
- notes: string
- description: string
- deliverByDate: string (date-time)
- requiredAtSiteDate: string (date-time)
- requestedOnDate: string (date-time)
- status: Jovix.Application.V1.GenericViews.IdAndNameView
- deliverySite: Jovix.Application.V1.Sites.Views.SiteIncludeView
- pickSite: Jovix.Application.V1.Sites.Views.SiteIncludeView
- job: Jovix.Application.V1.Jobs.Views.JobIncludeView
- customField_1: string
- customField_2: string
- customField_3: string
- customField_4: string
- customField_5: string
- customField_6: string
- customField_7: string
- customField_8: string
- customField_9: string
- customField_10: string
- customField_11: string
- customField_12: string
- customField_13: string
- customField_14: string
- customField_15: string
- customField_16: string
- customField_17: string
- customField_18: string
- customField_19: string
- customField_20: string
- customField_21: string
- customField_22: string
- customField_23: string
- customField_24: string
- customField_25: string
- customField_26: string
- customField_27: string
- customField_28: string
- customField_29: string
- customField_30: string
Example
{
"id": "integer (int32)",
"name": "string",
"notes": "string",
"description": "string",
"deliverByDate": "string (date-time)",
"requiredAtSiteDate": "string (date-time)",
"requestedOnDate": "string (date-time)",
"status": {
"id": "integer (int32)",
"name": "string"
},
"deliverySite": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
},
"pickSite": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
},
"job": {
"id": "integer (int32)",
"name": "string",
"description": "string",
"abbreviation": "string",
"isActive": "boolean",
"project": {
"id": "integer (int32)"
}
},
"customField_1": "string",
"customField_2": "string",
"customField_3": "string",
"customField_4": "string",
"customField_5": "string",
"customField_6": "string",
"customField_7": "string",
"customField_8": "string",
"customField_9": "string",
"customField_10": "string",
"customField_11": "string",
"customField_12": "string",
"customField_13": "string",
"customField_14": "string",
"customField_15": "string",
"customField_16": "string",
"customField_17": "string",
"customField_18": "string",
"customField_19": "string",
"customField_20": "string",
"customField_21": "string",
"customField_22": "string",
"customField_23": "string",
"customField_24": "string",
"customField_25": "string",
"customField_26": "string",
"customField_27": "string",
"customField_28": "string",
"customField_29": "string",
"customField_30": "string"
}
Jovix.Application.V1.WorkPackageItems.Views.WorkPackageItemIncludeView: object
- id: integer (int32)
- quantity: number (double)
- lineNumber: integer (int32)
- subLineNumber: integer (int32)
- catalogItem: Jovix.Application.V1.GenericViews.IdView
- workPackage: Jovix.Application.V1.GenericViews.IdView
Example
{
"id": "integer (int32)",
"quantity": "number (double)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"catalogItem": {
"id": "integer (int32)"
},
"workPackage": {
"id": "integer (int32)"
}
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.PurchaseOrders.Views.PurchaseOrderView]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.PurchaseOrders.Views.PurchaseOrderView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"job": {
"id": "integer (int32)",
"name": "string"
},
"supplier": {
"id": "integer (int32)",
"name": "string"
},
"dateSubmitted": "string (date-time)",
"dateFinalized": "string (date-time)",
"status": {
"id": "integer (int32)"
},
"targetDeliveryDate": "string (date-time)",
"targetShipDate": "string (date-time)",
"notes": "string"
},
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.V1.PurchaseOrders.Views.PurchaseOrderView: object
- id: integer (int32)
- name: string
- job: Jovix.Application.V1.GenericViews.IdAndNameView
- supplier: Jovix.Application.V1.GenericViews.IdAndNameView
- dateSubmitted: string (date-time)
- dateFinalized: string (date-time)
- status: Jovix.Application.V1.GenericViews.IdView
- targetDeliveryDate: string (date-time)
- targetShipDate: string (date-time)
- notes: string
Example
{
"id": "integer (int32)",
"name": "string",
"job": {
"id": "integer (int32)",
"name": "string"
},
"supplier": {
"id": "integer (int32)",
"name": "string"
},
"dateSubmitted": "string (date-time)",
"dateFinalized": "string (date-time)",
"status": {
"id": "integer (int32)"
},
"targetDeliveryDate": "string (date-time)",
"targetShipDate": "string (date-time)",
"notes": "string"
}
Jovix.Application.Serialization.Patch[Jovix.Application.V1.PurchaseOrders.Patch.PurchaseOrderPatch]:
Example
{
"dateFinalized": "string (date-time)",
"targetDeliveryDate": "string (date-time)",
"targetShipDate": "string (date-time)",
"notes": "string"
}
Jovix.Application.V1.PurchaseOrders.Patch.PurchaseOrderPatch: object
- dateFinalized: string (date-time)
- targetDeliveryDate: string (date-time)
- targetShipDate: string (date-time)
- notes: string
Example
{
"dateFinalized": "string (date-time)",
"targetDeliveryDate": "string (date-time)",
"targetShipDate": "string (date-time)",
"notes": "string"
}
Jovix.Application.Response.ResponseContentForSingle[Jovix.Application.V1.PurchaseOrders.Views.PurchaseOrderView]: object
- include: string
- data: Jovix.Application.V1.PurchaseOrders.Views.PurchaseOrderView
Example
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"job": {
"id": "integer (int32)",
"name": "string"
},
"supplier": {
"id": "integer (int32)",
"name": "string"
},
"dateSubmitted": "string (date-time)",
"dateFinalized": "string (date-time)",
"status": {
"id": "integer (int32)"
},
"targetDeliveryDate": "string (date-time)",
"targetShipDate": "string (date-time)",
"notes": "string"
}
}
Jovix.Application.V1.PurchaseOrders.Views.PurchaseOrderPost: object
- name: string (up to 100 chars)
- job: Jovix.Application.V1.GenericViews.IdPost
- supplier: Jovix.Application.V1.GenericViews.IdPost
- dateSubmitted: string (date-time)
- dateFinalized: string (date-time)
- targetDeliveryDate: string (date-time)
- targetShipDate: string (date-time)
- notes: string (up to 1000 chars)
Example
{
"name": "string",
"job": {
"id": "integer (int32)"
},
"supplier": {
"id": "integer (int32)"
},
"dateSubmitted": "string (date-time)",
"dateFinalized": "string (date-time)",
"targetDeliveryDate": "string (date-time)",
"targetShipDate": "string (date-time)",
"notes": "string"
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.PurchaseOrders.Views.PurchaseOrderView[]]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.PurchaseOrders.Views.PurchaseOrderView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"job": {
"id": "integer (int32)",
"name": "string"
},
"supplier": {
"id": "integer (int32)",
"name": "string"
},
"dateSubmitted": "string (date-time)",
"dateFinalized": "string (date-time)",
"status": {
"id": "integer (int32)"
},
"targetDeliveryDate": "string (date-time)",
"targetShipDate": "string (date-time)",
"notes": "string"
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.Response.ResponseContentForSingle[Jovix.Application.V1.PurchaseOrderDeliveryLines.Views.PurchaseOrderDeliveryLineView]: object
- include: string
- data: Jovix.Application.V1.PurchaseOrderDeliveryLines.Views.PurchaseOrderDeliveryLineView
Example
{
"include": "string",
"data": {
"id": "integer (int32)",
"quantity": "number (double)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"srn": "string",
"catalogItem": {
"id": "integer (int32)",
"name": "string",
"centerOfGravity": "string",
"description": "string",
"notes": "string",
"size": "string",
"shortDescription": "string",
"specializedTrailer": "boolean",
"tagNumber": "string",
"volume": "string",
"length": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"width": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"height": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"weight": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"discipline": {
"id": "integer (int32)",
"name": "string"
},
"materialType": {
"id": "integer (int32)",
"name": "string"
},
"project": {
"id": "integer (int32)",
"name": "string"
},
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
},
"customField_1": "string",
"customField_2": "string",
"customField_3": "string",
"customField_4": "string",
"customField_5": "string",
"customField_6": "string",
"customField_7": "string",
"customField_8": "string",
"customField_9": "string",
"customField_10": "string",
"customField_11": "string",
"customField_12": "string",
"customField_13": "string",
"customField_14": "string",
"customField_15": "string",
"customField_16": "string",
"customField_17": "string",
"customField_18": "string",
"customField_19": "string",
"customField_20": "string",
"customField_21": "string",
"customField_22": "string",
"customField_23": "string",
"customField_24": "string",
"customField_25": "string",
"customField_26": "string",
"customField_27": "string",
"customField_28": "string",
"customField_29": "string",
"customField_30": "string"
},
"purchaseOrderLineItem": {
"id": "integer (int32)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)"
}
}
}
Jovix.Application.V1.PurchaseOrderDeliveryLines.Views.PurchaseOrderDeliveryLineView: object
- id: integer (int32)
- quantity: number (double)
- lineNumber: integer (int32)
- subLineNumber: integer (int32)
- srn: string
- catalogItem: Jovix.Application.V1.CatalogItems.Views.CatalogItemView
- purchaseOrderLineItem: Jovix.Application.V1.PurchaseOrderItems.Views.PurchaseOrderItemView
- materialStage: Jovix.Application.V1.MaterialStage.Views.MaterialStageView
Example
{
"id": "integer (int32)",
"quantity": "number (double)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"srn": "string",
"catalogItem": {
"id": "integer (int32)",
"name": "string",
"centerOfGravity": "string",
"description": "string",
"notes": "string",
"size": "string",
"shortDescription": "string",
"specializedTrailer": "boolean",
"tagNumber": "string",
"volume": "string",
"length": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"width": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"height": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"weight": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"discipline": {
"id": "integer (int32)",
"name": "string"
},
"materialType": {
"id": "integer (int32)",
"name": "string"
},
"project": {
"id": "integer (int32)",
"name": "string"
},
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
},
"customField_1": "string",
"customField_2": "string",
"customField_3": "string",
"customField_4": "string",
"customField_5": "string",
"customField_6": "string",
"customField_7": "string",
"customField_8": "string",
"customField_9": "string",
"customField_10": "string",
"customField_11": "string",
"customField_12": "string",
"customField_13": "string",
"customField_14": "string",
"customField_15": "string",
"customField_16": "string",
"customField_17": "string",
"customField_18": "string",
"customField_19": "string",
"customField_20": "string",
"customField_21": "string",
"customField_22": "string",
"customField_23": "string",
"customField_24": "string",
"customField_25": "string",
"customField_26": "string",
"customField_27": "string",
"customField_28": "string",
"customField_29": "string",
"customField_30": "string"
},
"purchaseOrderLineItem": {
"id": "integer (int32)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"purchaseOrder": {
"id": "integer (int32)"
}
}
}
Jovix.Application.V1.PurchaseOrderItems.Views.PurchaseOrderItemView: object
- id: integer (int32)
- lineNumber: integer (int32)
- subLineNumber: integer (int32)
- purchaseOrder: Jovix.Application.V1.GenericViews.IdAndNameView
- catalogItem: Jovix.Application.V1.GenericViews.IdAndNameView
- acceptableOverage: number (double)
- acceptableShortage: number (double)
Example
{
"id": "integer (int32)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"purchaseOrder": {
"id": "integer (int32)",
"name": "string"
},
"catalogItem": {
"id": "integer (int32)",
"name": "string"
},
"acceptableOverage": "number (double)",
"acceptableShortage": "number (double)"
}
Jovix.Application.V1.MaterialStage.Views.MaterialStageView: object
- barcode: string
- rfidTag: string
- inventoryTypeId: integer (int32)
Example
{
"barcode": "string",
"rfidTag": "string",
"inventoryTypeId": "integer (int32)"
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.PurchaseOrderDeliveryLines.Views.PurchaseOrderDeliveryLineView]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.PurchaseOrderDeliveryLines.Views.PurchaseOrderDeliveryLineView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": {
"id": "integer (int32)",
"quantity": "number (double)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"srn": "string",
"catalogItem": {
"id": "integer (int32)",
"name": "string",
"centerOfGravity": "string",
"description": "string",
"notes": "string",
"size": "string",
"shortDescription": "string",
"specializedTrailer": "boolean",
"tagNumber": "string",
"volume": "string",
"length": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"width": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"height": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"weight": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"discipline": {
"id": "integer (int32)",
"name": "string"
},
"materialType": {
"id": "integer (int32)",
"name": "string"
},
"project": {
"id": "integer (int32)",
"name": "string"
},
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
},
"customField_1": "string",
"customField_2": "string",
"customField_3": "string",
"customField_4": "string",
"customField_5": "string",
"customField_6": "string",
"customField_7": "string",
"customField_8": "string",
"customField_9": "string",
"customField_10": "string",
"customField_11": "string",
"customField_12": "string",
"customField_13": "string",
"customField_14": "string",
"customField_15": "string",
"customField_16": "string",
"customField_17": "string",
"customField_18": "string",
"customField_19": "string",
"customField_20": "string",
"customField_21": "string",
"customField_22": "string",
"customField_23": "string",
"customField_24": "string",
"customField_25": "string",
"customField_26": "string",
"customField_27": "string",
"customField_28": "string",
"customField_29": "string",
"customField_30": "string"
},
"purchaseOrderLineItem": {
"id": "integer (int32)"
}
}
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.PurchaseOrderDeliveryLines.PurchaseOrderDeliveryLineBarcodeView]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.PurchaseOrderDeliveryLines.PurchaseOrderDeliveryLineBarcodeView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": {
"value": "string"
},
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.V1.PurchaseOrderDeliveryLines.PurchaseOrderDeliveryLineBarcodeView: object
- value: string
Example
{
"value": "string"
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.PurchaseOrderDeliveryLines.Views.PurchaseOrderDeliveryLineView[]]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.PurchaseOrderDeliveryLines.Views.PurchaseOrderDeliveryLineView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"quantity": "number (double)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"srn": "string",
"catalogItem": {
"id": "integer (int32)",
"name": "string",
"centerOfGravity": "string",
"description": "string",
"notes": "string",
"size": "string",
"shortDescription": "string",
"specializedTrailer": "boolean",
"tagNumber": "string",
"volume": "string",
"length": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"width": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"height": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"weight": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"discipline": {
"id": "integer (int32)",
"name": "string"
},
"materialType": {
"id": "integer (int32)",
"name": "string"
},
"project": {
"id": "integer (int32)",
"name": "string"
},
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
},
"customField_1": "string",
"customField_2": "string",
"customField_3": "string",
"customField_4": "string",
"customField_5": "string",
"customField_6": "string",
"customField_7": "string",
"customField_8": "string",
"customField_9": "string",
"customField_10": "string",
"customField_11": "string",
"customField_12": "string",
"customField_13": "string",
"customField_14": "string",
"customField_15": "string",
"customField_16": "string",
"customField_17": "string",
"customField_18": "string",
"customField_19": "string",
"customField_20": "string",
"customField_21": "string",
"customField_22": "string",
"customField_23": "string",
"customField_24": "string",
"customField_25": "string",
"customField_26": "string",
"customField_27": "string",
"customField_28": "string",
"customField_29": "string",
"customField_30": "string"
},
"purchaseOrderLineItem": {}
}
]
}
Jovix.Application.V1.PurchaseOrderItems.Views.PurchaseOrderItemPost: object
- purchaseOrder: Jovix.Application.V1.GenericViews.IdView
- catalogItem: Jovix.Application.V1.GenericViews.IdView
- acceptableOverage: number (double)
- acceptableShortage: number (double)
- lineNumber: integer (int32)
- subLineNumber: integer (int32)
Example
{
"purchaseOrder": {
"id": "integer (int32)"
},
"catalogItem": {
"id": "integer (int32)"
},
"acceptableOverage": "number (double)",
"acceptableShortage": "number (double)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)"
}
Jovix.Application.Response.ResponseContentForSingle[Jovix.Application.V1.PurchaseOrderItems.Views.PurchaseOrderItemView]: object
- include: string
- data: Jovix.Application.V1.PurchaseOrderItems.Views.PurchaseOrderItemView
Example
{
"include": "string",
"data": {
"id": "integer (int32)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"purchaseOrder": {
"id": "integer (int32)",
"name": "string"
},
"catalogItem": {
"id": "integer (int32)",
"name": "string"
},
"acceptableOverage": "number (double)",
"acceptableShortage": "number (double)"
}
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.PurchaseOrderItems.Views.PurchaseOrderItemView[]]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.PurchaseOrderItems.Views.PurchaseOrderItemView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"purchaseOrder": {
"id": "integer (int32)",
"name": "string"
},
"catalogItem": {
"id": "integer (int32)",
"name": "string"
},
"acceptableOverage": "number (double)",
"acceptableShortage": "number (double)"
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.PurchaseOrderItems.Views.PurchaseOrderItemView]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.PurchaseOrderItems.Views.PurchaseOrderItemView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": {
"id": "integer (int32)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"purchaseOrder": {
"id": "integer (int32)",
"name": "string"
},
"catalogItem": {
"id": "integer (int32)",
"name": "string"
},
"acceptableOverage": "number (double)",
"acceptableShortage": "number (double)"
},
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.Response.ResponseContentForSingle[Jovix.Application.V1.Receipts.Views.ReceiptResourceView]: object
- include: string
- data: Jovix.Application.V1.Receipts.Views.ReceiptResourceView
Example
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"receiptType": "integer (int32)",
"status": {
"id": "integer (int32)"
},
"shipment": {
"id": "integer (int32)"
},
"purchaseOrder": {
"id": "integer (int32)"
},
"dateStarted": "string (date-time)",
"dateComplete": "string (date-time)",
"osdItemCount": "integer (int32)",
"notes": "string"
}
}
Jovix.Application.V1.Receipts.Views.ReceiptResourceView: object
- id: integer (int32)
- name: string
- receiptType: integer (int32)
- status: Jovix.Application.V1.GenericViews.IdView
- shipment: Jovix.Application.V1.GenericViews.IdView
- purchaseOrder: Jovix.Application.V1.GenericViews.IdView
- dateStarted: string (date-time)
- dateComplete: string (date-time)
- osdItemCount: integer (int32)
- notes: string
Example
{
"id": "integer (int32)",
"name": "string",
"receiptType": "integer (int32)",
"status": {
"id": "integer (int32)"
},
"shipment": {
"id": "integer (int32)"
},
"purchaseOrder": {
"id": "integer (int32)"
},
"dateStarted": "string (date-time)",
"dateComplete": "string (date-time)",
"osdItemCount": "integer (int32)",
"notes": "string"
}
Jovix.Application.V1.Receipts.Views.ReceiptPost: object
- name: string
- shipment: Jovix.Application.V1.GenericViews.IdPost
- dateStarted: string (date-time)
- notes: string
Example
{
"name": "string",
"shipment": {
"id": "integer (int32)"
},
"dateStarted": "string (date-time)",
"notes": "string"
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.Receipts.Views.ReceiptResourceView[]]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.Receipts.Views.ReceiptResourceView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"receiptType": "integer (int32)",
"status": {
"id": "integer (int32)"
},
"shipment": {
"id": "integer (int32)"
},
"purchaseOrder": {
"id": "integer (int32)"
},
"dateStarted": "string (date-time)",
"dateComplete": "string (date-time)",
"osdItemCount": "integer (int32)",
"notes": "string"
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.Response.ResponseContentForSingle[Jovix.Application.V1.ReceiptItems.Views.ReceiptItemResourceView]: object
- include: string
- data: Jovix.Application.V1.ReceiptItems.Views.ReceiptItemResourceView
Example
{
"include": "string",
"data": {
"id": "integer (int32)",
"receipt": {
"id": "integer (int32)"
},
"lineNumber": "integer (int32)",
"shipmentItem": {
"id": "integer (int32)"
},
"shippingUnit": {
"id": "integer (int32)"
},
"material": {
"id": "integer (int32)"
},
"receivedQuantity": "number (double)",
"flags": [
{
"name": "string",
"description": "string"
}
]
}
}
Jovix.Application.V1.ReceiptItems.Views.ReceiptItemResourceView: object
- id: integer (int32)
- receipt: Jovix.Application.V1.GenericViews.IdView
- lineNumber: integer (int32)
- shipmentItem: Jovix.Application.V1.GenericViews.IdView
- shippingUnit: Jovix.Application.V1.GenericViews.IdView
- material: Jovix.Application.V1.GenericViews.IdView
- receivedQuantity: number (double)
- flags: Jovix.Application.V1.MaterialFlags.Views.MaterialFlagCompactView
Example
{
"id": "integer (int32)",
"receipt": {
"id": "integer (int32)"
},
"lineNumber": "integer (int32)",
"shipmentItem": {
"id": "integer (int32)"
},
"shippingUnit": {
"id": "integer (int32)"
},
"material": {
"id": "integer (int32)"
},
"receivedQuantity": "number (double)",
"flags": [
{
"name": "string",
"description": "string"
}
]
}
Jovix.Application.Response.ResponseContentForSingle[Jovix.Application.V1.ReceiptItems.Views.ReceiptItemModifiedView]: object
- include: string
- data: Jovix.Application.V1.ReceiptItems.Views.ReceiptItemModifiedView
Example
{
"include": "string",
"data": {
"id": "integer (int32)",
"receipt": {
"id": "integer (int32)"
},
"lineNumber": "integer (int32)",
"shipmentItem": {
"id": "integer (int32)"
},
"shippingUnit": {
"id": "integer (int32)"
},
"material": {
"id": "integer (int32)"
},
"location": {
"latitude": "number (double)",
"longitude": "number (double)",
"dateLocated": "string (date-time)",
"horizontalErrorMeters": "number (double)",
"namedLocation": {
"id": "integer (int32)",
"name": "string"
},
"yard": {
"id": "integer (int32)"
},
"zones": [
{
"id": "integer (int32)"
}
]
},
"receivedQuantity": "number (double)",
"flags": [
{
"name": "string",
"description": "string"
}
]
}
}
Jovix.Application.V1.ReceiptItems.Views.ReceiptItemModifiedView: object
- id: integer (int32)
- receipt: Jovix.Application.V1.GenericViews.IdView
- lineNumber: integer (int32)
- shipmentItem: Jovix.Application.V1.GenericViews.IdView
- shippingUnit: Jovix.Application.V1.GenericViews.IdView
- material: Jovix.Application.V1.GenericViews.IdView
- location: Jovix.Application.V1.Locations.Views.LocationView
- receivedQuantity: number (double)
- flags: Jovix.Application.V1.MaterialFlags.Views.MaterialFlagCompactView
Example
{
"id": "integer (int32)",
"receipt": {
"id": "integer (int32)"
},
"lineNumber": "integer (int32)",
"shipmentItem": {
"id": "integer (int32)"
},
"shippingUnit": {
"id": "integer (int32)"
},
"material": {
"id": "integer (int32)"
},
"location": {
"latitude": "number (double)",
"longitude": "number (double)",
"dateLocated": "string (date-time)",
"horizontalErrorMeters": "number (double)",
"namedLocation": {
"id": "integer (int32)",
"name": "string"
},
"yard": {
"id": "integer (int32)"
},
"zones": [
{
"id": "integer (int32)"
}
]
},
"receivedQuantity": "number (double)",
"flags": [
{
"name": "string",
"description": "string"
}
]
}
Jovix.Application.V1.ReceiptItems.Views.ReceiptItemPost: object
- receipt: Jovix.Application.V1.GenericViews.IdView
- shipmentItem: Jovix.Application.V1.GenericViews.IdView
- receivedQuantity: number (double)
- location: Jovix.Application.V1.Locations.Views.LocationView
- shippingUnit: Jovix.Application.V1.GenericViews.IdView
- material: Jovix.Application.V1.GenericViews.IdView
- flags: Jovix.Application.V1.MaterialFlags.Views.MaterialFlagCompactView
Example
{
"receipt": {
"id": "integer (int32)"
},
"shipmentItem": {
"id": "integer (int32)"
},
"receivedQuantity": "number (double)",
"location": {
"latitude": "number (double)",
"longitude": "number (double)",
"dateLocated": "string (date-time)",
"horizontalErrorMeters": "number (double)",
"namedLocation": {
"id": "integer (int32)",
"name": "string"
},
"yard": {
"id": "integer (int32)"
},
"zones": [
{
"id": "integer (int32)"
}
]
},
"shippingUnit": {
"id": "integer (int32)"
},
"material": {
"id": "integer (int32)"
},
"flags": [
{
"name": "string",
"description": "string"
}
]
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.ReceiptItems.Views.ReceiptItemResourceView[]]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.ReceiptItems.Views.ReceiptItemResourceView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"receipt": {
"id": "integer (int32)"
},
"lineNumber": "integer (int32)",
"shipmentItem": {
"id": "integer (int32)"
},
"shippingUnit": {
"id": "integer (int32)"
},
"material": {
"id": "integer (int32)"
},
"receivedQuantity": "number (double)",
"flags": [
{
"name": "string",
"description": "string"
}
]
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.ScheduleActivities.Views.ScheduleActivityView]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.ScheduleActivities.Views.ScheduleActivityView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"activityType": "string",
"project": {
"id": "integer (int32)"
},
"job": {
"id": "integer (int32)",
"name": "string"
},
"externalId": "string",
"externalProjectId": "string",
"externalProjectName": "string",
"workBreakdownStructureId": "integer (int32)",
"workBreakdownStructureName": "string",
"startDate": "string (date-time)",
"finishDate": "string (date-time)",
"isActualStartDate": "boolean",
"isActualFinishDate": "boolean",
"totalFloat": "integer (int32)",
"freeFloat": "integer (int32)",
"activityCode1": "string",
"activityCode2": "string",
"activityCode3": "string",
"activityCode4": "string",
"activityCode5": "string"
},
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.V1.ScheduleActivities.Views.ScheduleActivityView: object
- id: integer (int32)
- name: string
- activityType: string
- project: Jovix.Application.V1.Projects.ProjectView
- job: Jovix.Application.V1.Jobs.Views.JobView
- externalId: string
- externalProjectId: string
- externalProjectName: string
- workBreakdownStructureId: integer (int32)
- workBreakdownStructureName: string
- startDate: string (date-time)
- finishDate: string (date-time)
- isActualStartDate: boolean
- isActualFinishDate: boolean
- totalFloat: integer (int32)
- freeFloat: integer (int32)
- activityCode1: string
- activityCode2: string
- activityCode3: string
- activityCode4: string
- activityCode5: string
Example
{
"id": "integer (int32)",
"name": "string",
"activityType": "string",
"project": {
"id": "integer (int32)"
},
"job": {
"id": "integer (int32)",
"name": "string"
},
"externalId": "string",
"externalProjectId": "string",
"externalProjectName": "string",
"workBreakdownStructureId": "integer (int32)",
"workBreakdownStructureName": "string",
"startDate": "string (date-time)",
"finishDate": "string (date-time)",
"isActualStartDate": "boolean",
"isActualFinishDate": "boolean",
"totalFloat": "integer (int32)",
"freeFloat": "integer (int32)",
"activityCode1": "string",
"activityCode2": "string",
"activityCode3": "string",
"activityCode4": "string",
"activityCode5": "string"
}
Jovix.Application.Response.ResponseContentForSingle[Jovix.Application.V1.ScheduleActivities.Views.ScheduleActivityView]: object
- include: string
- data: Jovix.Application.V1.ScheduleActivities.Views.ScheduleActivityView
Example
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"activityType": "string",
"project": {
"id": "integer (int32)"
},
"job": {
"id": "integer (int32)",
"name": "string"
},
"externalId": "string",
"externalProjectId": "string",
"externalProjectName": "string",
"workBreakdownStructureId": "integer (int32)",
"workBreakdownStructureName": "string",
"startDate": "string (date-time)",
"finishDate": "string (date-time)",
"isActualStartDate": "boolean",
"isActualFinishDate": "boolean",
"totalFloat": "integer (int32)",
"freeFloat": "integer (int32)",
"activityCode1": "string",
"activityCode2": "string",
"activityCode3": "string",
"activityCode4": "string",
"activityCode5": "string"
}
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.ScheduleActivities.Views.ScheduleActivityPostResponse]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.ScheduleActivities.Views.ScheduleActivityPostResponse
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": {
"id": "integer (int32)"
},
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.V1.ScheduleActivities.Views.ScheduleActivityPostResponse: object
- id: integer (int32)
Example
{
"id": "integer (int32)"
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.ScheduleActivities.Views.ScheduleActivityView[]]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.ScheduleActivities.Views.ScheduleActivityView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"activityType": "string",
"project": {
"id": "integer (int32)"
},
"job": {
"id": "integer (int32)",
"name": "string"
},
"externalId": "string",
"externalProjectId": "string",
"externalProjectName": "string",
"workBreakdownStructureId": "integer (int32)",
"workBreakdownStructureName": "string",
"startDate": "string (date-time)",
"finishDate": "string (date-time)",
"isActualStartDate": "boolean",
"isActualFinishDate": "boolean",
"totalFloat": "integer (int32)",
"freeFloat": "integer (int32)",
"activityCode1": "string",
"activityCode2": "string",
"activityCode3": "string",
"activityCode4": "string",
"activityCode5": "string"
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.Response.ResponseContentForSingle[Jovix.Application.V1.Shipments.Views.ShipmentView]: object
- include: string
- data: Jovix.Application.V1.Shipments.Views.ShipmentView
Example
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"job": {
"id": "integer (int32)",
"name": "string"
},
"purchaseOrder": {
"id": "integer (int32)",
"name": "string"
},
"supplier": {
"id": "integer (int32)",
"name": "string"
},
"toSite": {
"id": "integer (int32)",
"name": "string"
},
"fromSite": {
"id": "integer (int32)",
"name": "string"
},
"isTransfer": "boolean",
"billOfLading": "string",
"vehicleNumber": "string",
"grossWeight": "string",
"packingListNumber": "string",
"release": {
"dateApproved": "string (date-time)"
},
"arrival": {
"date": "string (date-time)",
"dateConfirmed": "string (date-time)",
"confirmationNotes": "string"
},
"departure": {
"date": "string (date-time)",
"dateConfirmed": "string (date-time)",
"confirmationNotes": "string"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"dateModified": "string (date-time)"
}
}
Jovix.Application.V1.Shipments.Views.ShipmentView: object
- id: integer (int32)
- name: string
- job: Jovix.Application.V1.GenericViews.IdAndNameView
- purchaseOrder: Jovix.Application.V1.GenericViews.IdAndNameView
- supplier: Jovix.Application.V1.GenericViews.IdAndNameView
- toSite: Jovix.Application.V1.GenericViews.IdAndNameView
- fromSite: Jovix.Application.V1.GenericViews.IdAndNameView
- isTransfer: boolean
- billOfLading: string
- vehicleNumber: string
- grossWeight: string
- packingListNumber: string
- release: Jovix.Application.V1.Shipments.Views.ReleaseView
- arrival: Jovix.Application.V1.Shipments.Views.DateConfirmationView
- departure: Jovix.Application.V1.Shipments.Views.DateConfirmationView
- status: Jovix.Application.V1.GenericViews.IdAndNameView
- dateModified: string (date-time)
Example
{
"id": "integer (int32)",
"name": "string",
"job": {
"id": "integer (int32)",
"name": "string"
},
"purchaseOrder": {
"id": "integer (int32)",
"name": "string"
},
"supplier": {
"id": "integer (int32)",
"name": "string"
},
"toSite": {
"id": "integer (int32)",
"name": "string"
},
"fromSite": {
"id": "integer (int32)",
"name": "string"
},
"isTransfer": "boolean",
"billOfLading": "string",
"vehicleNumber": "string",
"grossWeight": "string",
"packingListNumber": "string",
"release": {
"dateApproved": "string (date-time)"
},
"arrival": {
"date": "string (date-time)",
"dateConfirmed": "string (date-time)",
"confirmationNotes": "string"
},
"departure": {
"date": "string (date-time)",
"dateConfirmed": "string (date-time)",
"confirmationNotes": "string"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"dateModified": "string (date-time)"
}
Jovix.Application.V1.Shipments.Views.ReleaseView: object
- dateApproved: string (date-time)
Example
{
"dateApproved": "string (date-time)"
}
Jovix.Application.V1.Shipments.Views.DateConfirmationView: object
- date: string (date-time)
- dateConfirmed: string (date-time)
- confirmationNotes: string
Example
{
"date": "string (date-time)",
"dateConfirmed": "string (date-time)",
"confirmationNotes": "string"
}
Jovix.Application.V1.Shipments.ShipmentPost: object
- name: string (up to 150 chars)
- job: Jovix.Application.V1.GenericViews.IdPost
- purchaseOrder: Jovix.Application.V1.GenericViews.IdPost
- supplier: Jovix.Application.V1.GenericViews.IdPost
- fromSite: Jovix.Application.V1.GenericViews.IdPost
- toSite: Jovix.Application.V1.GenericViews.IdPost
- isTransfer: boolean
- billOfLading: string (up to 150 chars)
- vehicleNumber: string (up to 150 chars)
- grossWeight: string (up to 150 chars)
- packingListNumber: string (up to 150 chars)
- departure: Jovix.Application.V1.Shipments.Views.DateConfirmationView
- arrival: Jovix.Application.V1.Shipments.Views.DateConfirmationView
Example
{
"name": "string",
"job": {
"id": "integer (int32)"
},
"purchaseOrder": {
"id": "integer (int32)"
},
"supplier": {
"id": "integer (int32)"
},
"fromSite": {
"id": "integer (int32)"
},
"toSite": {
"id": "integer (int32)"
},
"isTransfer": "boolean",
"billOfLading": "string",
"vehicleNumber": "string",
"grossWeight": "string",
"packingListNumber": "string",
"departure": {
"date": "string (date-time)",
"dateConfirmed": "string (date-time)",
"confirmationNotes": "string"
},
"arrival": {
"date": "string (date-time)",
"dateConfirmed": "string (date-time)",
"confirmationNotes": "string"
}
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.Shipments.Views.ShipmentView[]]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.Shipments.Views.ShipmentView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"job": {
"id": "integer (int32)",
"name": "string"
},
"purchaseOrder": {
"id": "integer (int32)",
"name": "string"
},
"supplier": {
"id": "integer (int32)",
"name": "string"
},
"toSite": {
"id": "integer (int32)",
"name": "string"
},
"fromSite": {
"id": "integer (int32)",
"name": "string"
},
"isTransfer": "boolean",
"billOfLading": "string",
"vehicleNumber": "string",
"grossWeight": "string",
"packingListNumber": "string",
"release": {
"dateApproved": "string (date-time)"
},
"arrival": {
"date": "string (date-time)",
"dateConfirmed": "string (date-time)",
"confirmationNotes": "string"
},
"departure": {
"date": "string (date-time)",
"dateConfirmed": "string (date-time)",
"confirmationNotes": "string"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"dateModified": "string (date-time)"
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.Response.ResponseContentForSingle[Jovix.Application.V1.ShipmentItems.Views.ShipmentItemResourceView]: object
- include: string
- data: Jovix.Application.V1.ShipmentItems.Views.ShipmentItemResourceView
Example
{
"include": "string",
"data": {
"id": "integer (int32)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"catalogItem": {
"id": "integer (int32)"
},
"shippingUnit": {
"id": "integer (int32)"
},
"shipment": {
"id": "integer (int32)"
},
"purchaseOrderDeliveryLine": {
"id": "integer (int32)"
},
"material": {
"id": "integer (int32)"
},
"materialStage": {
"barcode": "string",
"rfidTag": "string",
"inventoryTypeId": "integer (int32)"
},
"quantityExpected": "number (double)",
"packingListQuantity": "number (double)",
"dateConfirmedShipped": "string (date-time)",
"dateConfirmedArrived": "string (date-time)",
"dateModified": "string (date-time)"
}
}
Jovix.Application.V1.ShipmentItems.Views.ShipmentItemResourceView: object
- id: integer (int32)
- lineNumber: integer (int32)
- subLineNumber: integer (int32)
- catalogItem: Jovix.Application.V1.GenericViews.IdView
- shippingUnit: Jovix.Application.V1.GenericViews.IdView
- shipment: Jovix.Application.V1.GenericViews.IdView
- purchaseOrderDeliveryLine: Jovix.Application.V1.GenericViews.IdView
- material: Jovix.Application.V1.GenericViews.IdView
- materialStage: Jovix.Application.V1.MaterialStage.Views.MaterialStageView
- quantityExpected: number (double)
- packingListQuantity: number (double)
- dateConfirmedShipped: string (date-time)
- dateConfirmedArrived: string (date-time)
- dateModified: string (date-time)
Example
{
"id": "integer (int32)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"catalogItem": {
"id": "integer (int32)"
},
"shippingUnit": {
"id": "integer (int32)"
},
"shipment": {
"id": "integer (int32)"
},
"purchaseOrderDeliveryLine": {
"id": "integer (int32)"
},
"material": {
"id": "integer (int32)"
},
"materialStage": {
"barcode": "string",
"rfidTag": "string",
"inventoryTypeId": "integer (int32)"
},
"quantityExpected": "number (double)",
"packingListQuantity": "number (double)",
"dateConfirmedShipped": "string (date-time)",
"dateConfirmedArrived": "string (date-time)",
"dateModified": "string (date-time)"
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.Projections.ShipmentItem.ShipmentItemIncludeView[]]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.Projections.ShipmentItem.ShipmentItemIncludeView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"catalogItem": {
"id": "integer (int32)",
"name": "string",
"centerOfGravity": "string",
"description": "string",
"notes": "string",
"size": "string",
"shortDescription": "string",
"specializedTrailer": "boolean",
"storageRequirement": "string",
"tagNumber": "string",
"volume": "string",
"length": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"width": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"height": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"weight": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"discipline": {
"id": "integer (int32)",
"name": "string"
},
"materialType": {
"id": "integer (int32)",
"name": "string"
},
"project": {
"id": "integer (int32)",
"name": "string"
},
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
},
"customFields": "object"
},
"purchaseOrderDeliveryLine": {
"id": "integer (int32)"
},
"material": {
"id": "integer (int32)"
},
"shippingUnit": {
"id": "integer (int32)"
},
"shipment": {
"id": "integer (int32)"
},
"materialStage": {
"barcode": "string",
"rfidTag": "string",
"inventoryTypeId": "integer (int32)"
},
"quantityExpected": "number (double)",
"packingListQuantity": "number (double)",
"dateConfirmedShipped": "string (date-time)",
"dateConfirmedArrived": "string (date-time)",
"dateModified": "string (date-time)"
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.V1.Projections.ShipmentItem.ShipmentItemIncludeView: object
- id: integer (int32)
- lineNumber: integer (int32)
- subLineNumber: integer (int32)
- catalogItem: Jovix.Application.V1.CatalogItems.Views.CatalogItemIncludeView
- purchaseOrderDeliveryLine: Jovix.Application.V1.GenericViews.IdView
- material: Jovix.Application.V1.GenericViews.IdView
- shippingUnit: Jovix.Application.V1.GenericViews.IdView
- shipment: Jovix.Application.V1.GenericViews.IdView
- materialStage: Jovix.Application.V1.MaterialStage.Views.MaterialStageView
- quantityExpected: number (double)
- packingListQuantity: number (double)
- dateConfirmedShipped: string (date-time)
- dateConfirmedArrived: string (date-time)
- dateModified: string (date-time)
Example
{
"id": "integer (int32)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"catalogItem": {
"id": "integer (int32)",
"name": "string",
"centerOfGravity": "string",
"description": "string",
"notes": "string",
"size": "string",
"shortDescription": "string",
"specializedTrailer": "boolean",
"storageRequirement": "string",
"tagNumber": "string",
"volume": "string",
"length": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"width": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"height": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"weight": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"discipline": {
"id": "integer (int32)",
"name": "string"
},
"materialType": {
"id": "integer (int32)",
"name": "string"
},
"project": {
"id": "integer (int32)",
"name": "string"
},
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
},
"customFields": "object"
},
"purchaseOrderDeliveryLine": {
"id": "integer (int32)"
},
"material": {
"id": "integer (int32)"
},
"shippingUnit": {
"id": "integer (int32)"
},
"shipment": {
"id": "integer (int32)"
},
"materialStage": {
"barcode": "string",
"rfidTag": "string",
"inventoryTypeId": "integer (int32)"
},
"quantityExpected": "number (double)",
"packingListQuantity": "number (double)",
"dateConfirmedShipped": "string (date-time)",
"dateConfirmedArrived": "string (date-time)",
"dateModified": "string (date-time)"
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.ShipmentReleaseNotices.Views.ShipmentReleaseNoticeView[]]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.ShipmentReleaseNotices.Views.ShipmentReleaseNoticeView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"name": "string"
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.V1.ShipmentReleaseNotices.Views.ShipmentReleaseNoticeView: object
- name: string
Example
{
"name": "string"
}
Jovix.Application.V1.ShippingUnits.Views.ShippingUnitView: object
- id: integer (int32)
- name: string
- barcode: string
- rfidTags: string[]
- shippingUnitType: Jovix.Application.V1.GenericViews.IdView
- parentShippingUnit: Jovix.Application.V1.GenericViews.IdView
- status: Jovix.Application.V1.GenericViews.IdAndNameView
- job: Jovix.Application.V1.GenericViews.IdAndNameView
- supplier: Jovix.Application.V1.GenericViews.IdAndNameView
- purchaseOrder: Jovix.Application.V1.GenericViews.IdAndNameView
- shipment: Jovix.Application.V1.GenericViews.IdView
- location: Jovix.Application.V1.Locations.Views.LocationView
- specializedTrailer: boolean
- flags: Jovix.Application.V1.Inventories.InventoryItemFlag
Example
{
"id": "integer (int32)",
"name": "string",
"barcode": "string",
"rfidTags": [
"string"
],
"shippingUnitType": {
"id": "integer (int32)"
},
"parentShippingUnit": {
"id": "integer (int32)"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"job": {
"id": "integer (int32)",
"name": "string"
},
"supplier": {
"id": "integer (int32)",
"name": "string"
},
"purchaseOrder": {
"id": "integer (int32)",
"name": "string"
},
"shipment": {
"id": "integer (int32)"
},
"location": {
"latitude": "number (double)",
"longitude": "number (double)",
"dateLocated": "string (date-time)",
"horizontalErrorMeters": "number (double)",
"namedLocation": {
"id": "integer (int32)",
"name": "string"
},
"yard": {
"id": "integer (int32)"
},
"zones": [
{
"id": "integer (int32)"
}
]
},
"specializedTrailer": "boolean",
"flags": [
{
"name": "string",
"description": "string"
}
]
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.ShippingUnits.Views.ShippingUnitView]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.ShippingUnits.Views.ShippingUnitView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"barcode": "string",
"rfidTags": [
"string"
],
"shippingUnitType": {
"id": "integer (int32)"
},
"parentShippingUnit": {
"id": "integer (int32)"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"job": {
"id": "integer (int32)",
"name": "string"
},
"supplier": {
"id": "integer (int32)",
"name": "string"
},
"purchaseOrder": {
"id": "integer (int32)",
"name": "string"
},
"shipment": {
"id": "integer (int32)"
},
"location": {
"latitude": "number (double)",
"longitude": "number (double)",
"dateLocated": "string (date-time)",
"horizontalErrorMeters": "number (double)",
"namedLocation": {
"id": "integer (int32)",
"name": "string"
},
"yard": {
"id": "integer (int32)"
},
"zones": [
{
"id": "integer (int32)"
}
]
},
"specializedTrailer": "boolean",
"flags": [
{
"name": "string",
"description": "string"
}
]
},
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.Projections.ShippingUnit.ShippingUnitIncludeView[]]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.Projections.ShippingUnit.ShippingUnitIncludeView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"barcode": "string",
"shippingUnitType": {
"id": "integer (int32)",
"name": "string"
},
"parentShippingUnit": {
"id": "integer (int32)",
"name": "string"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"job": {
"id": "integer (int32)",
"name": "string",
"description": "string",
"abbreviation": "string",
"isActive": "boolean",
"project": {
"id": "integer (int32)"
}
},
"supplier": {
"id": "integer (int32)",
"name": "string"
},
"purchaseOrder": {
"id": "integer (int32)",
"name": "string"
},
"shipment": {
"id": "integer (int32)",
"name": "string"
},
"location": {
"latitude": "number (double)",
"longitude": "number (double)",
"dateLocated": "string (date-time)",
"horizontalErrorMeters": "number (double)",
"namedLocation": {
"id": "integer (int32)",
"name": "string"
},
"yard": {
"id": "integer (int32)"
},
"zones": [
{
"id": "integer (int32)"
}
]
},
"specializedTrailer": "boolean",
"dateCreated": "string (date-time)",
"createdByUser": {
"id": "integer (int32)",
"name": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"internalId": "string",
"company": "string",
"isSupplierUser": "boolean",
"isLocked": "boolean",
"isMobileUser": "boolean",
"phone": "string",
"email": "string"
},
"dateModified": "string (date-time)",
"modifiedByUser": {
"id": "integer (int32)",
"name": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"internalId": "string",
"company": "string",
"isSupplierUser": "boolean",
"isLocked": "boolean",
"isMobileUser": "boolean",
"phone": "string",
"email": "string"
},
"length": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
}
}
]
}
Jovix.Application.V1.Projections.ShippingUnit.ShippingUnitIncludeView: object
- id: integer (int32)
- name: string
- barcode: string
- shippingUnitType: Jovix.Application.V1.GenericViews.IdAndNameView
- parentShippingUnit: Jovix.Application.V1.GenericViews.IdAndNameView
- status: Jovix.Application.V1.GenericViews.IdAndNameView
- job: Jovix.Application.V1.Jobs.Views.JobIncludeView
- supplier: Jovix.Application.V1.GenericViews.IdAndNameView
- purchaseOrder: Jovix.Application.V1.GenericViews.IdAndNameView
- shipment: Jovix.Application.V1.GenericViews.IdAndNameView
- location: Jovix.Application.V1.Locations.Views.LocationView
- specializedTrailer: boolean
- dateCreated: string (date-time)
- createdByUser: Jovix.Application.V1.Users.Views.UserIncludeView
- dateModified: string (date-time)
- modifiedByUser: Jovix.Application.V1.Users.Views.UserIncludeView
- length: Jovix.Application.V1.UnitsOfMeasure.MeasurementView
- width: Jovix.Application.V1.UnitsOfMeasure.MeasurementView
- height: Jovix.Application.V1.UnitsOfMeasure.MeasurementView
- weight: Jovix.Application.V1.UnitsOfMeasure.MeasurementView
- volume: string
- rfidTags: string[]
- flags: Jovix.Application.V1.Inventories.InventoryItemFlag
Example
{
"id": "integer (int32)",
"name": "string",
"barcode": "string",
"shippingUnitType": {
"id": "integer (int32)",
"name": "string"
},
"parentShippingUnit": {
"id": "integer (int32)",
"name": "string"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"job": {
"id": "integer (int32)",
"name": "string",
"description": "string",
"abbreviation": "string",
"isActive": "boolean",
"project": {
"id": "integer (int32)"
}
},
"supplier": {
"id": "integer (int32)",
"name": "string"
},
"purchaseOrder": {
"id": "integer (int32)",
"name": "string"
},
"shipment": {
"id": "integer (int32)",
"name": "string"
},
"location": {
"latitude": "number (double)",
"longitude": "number (double)",
"dateLocated": "string (date-time)",
"horizontalErrorMeters": "number (double)",
"namedLocation": {
"id": "integer (int32)",
"name": "string"
},
"yard": {
"id": "integer (int32)"
},
"zones": [
{
"id": "integer (int32)"
}
]
},
"specializedTrailer": "boolean",
"dateCreated": "string (date-time)",
"createdByUser": {
"id": "integer (int32)",
"name": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"internalId": "string",
"company": "string",
"isSupplierUser": "boolean",
"isLocked": "boolean",
"isMobileUser": "boolean",
"phone": "string",
"email": "string"
},
"dateModified": "string (date-time)",
"modifiedByUser": {
"id": "integer (int32)",
"name": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"internalId": "string",
"company": "string",
"isSupplierUser": "boolean",
"isLocked": "boolean",
"isMobileUser": "boolean",
"phone": "string",
"email": "string"
},
"length": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"width": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
}
}
Jovix.Application.Response.ResponseContentForSingle[Jovix.Application.V1.Projections.ShippingUnit.ShippingUnitIncludeView]: object
- include: string
- data: Jovix.Application.V1.Projections.ShippingUnit.ShippingUnitIncludeView
Example
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"barcode": "string",
"shippingUnitType": {
"id": "integer (int32)",
"name": "string"
},
"parentShippingUnit": {
"id": "integer (int32)",
"name": "string"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"job": {
"id": "integer (int32)",
"name": "string",
"description": "string",
"abbreviation": "string",
"isActive": "boolean",
"project": {
"id": "integer (int32)"
}
},
"supplier": {
"id": "integer (int32)",
"name": "string"
},
"purchaseOrder": {
"id": "integer (int32)",
"name": "string"
},
"shipment": {
"id": "integer (int32)",
"name": "string"
},
"location": {
"latitude": "number (double)",
"longitude": "number (double)",
"dateLocated": "string (date-time)",
"horizontalErrorMeters": "number (double)",
"namedLocation": {
"id": "integer (int32)",
"name": "string"
},
"yard": {
"id": "integer (int32)"
},
"zones": [
{
"id": "integer (int32)"
}
]
},
"specializedTrailer": "boolean",
"dateCreated": "string (date-time)",
"createdByUser": {
"id": "integer (int32)",
"name": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"internalId": "string",
"company": "string",
"isSupplierUser": "boolean",
"isLocked": "boolean",
"isMobileUser": "boolean",
"phone": "string",
"email": "string"
},
"dateModified": "string (date-time)",
"modifiedByUser": {
"id": "integer (int32)",
"name": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"internalId": "string",
"company": "string",
"isSupplierUser": "boolean",
"isLocked": "boolean",
"isMobileUser": "boolean",
"phone": "string",
"email": "string"
},
"length": {
"value": "number (double)",
"unitOfMeasure": {
"id": "integer (int32)",
"name": "string"
}
},
"width": {
"value": "number (double)"
}
}
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.ShippingUnitTypes.Views.ShippingUnitTypeResponseView[]]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.ShippingUnitTypes.Views.ShippingUnitTypeResponseView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"isDefault": "boolean"
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.V1.ShippingUnitTypes.Views.ShippingUnitTypeResponseView: object
- id: integer (int32)
- name: string
- isDefault: boolean
Example
{
"id": "integer (int32)",
"name": "string",
"isDefault": "boolean"
}
Jovix.Application.Response.ResponseContentForSingle[Jovix.Application.V1.Sites.Views.SiteResourceView]: object
- include: string
- data: Jovix.Application.V1.Sites.Views.SiteResourceView
Example
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
}
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.Sites.Views.SiteResourceView[]]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.Sites.Views.SiteResourceView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.Statuses.Repositories.StatusResourceView]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.Statuses.Repositories.StatusResourceView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"isPicked": "boolean",
"isActive": "boolean",
"isIssuable": "boolean",
"isRequestable": "boolean",
"autoDisassociate": "boolean",
"autoReturnToStock": "boolean",
"autoEndPreventativeMaintenance": "boolean",
"showOnMap": "boolean"
},
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.V1.Statuses.Repositories.StatusResourceView: object
- id: integer (int32)
- name: string
- project: Jovix.Application.V1.GenericViews.IdView
- isPicked: boolean
- isActive: boolean
- isIssuable: boolean
- isRequestable: boolean
- autoDisassociate: boolean
- autoReturnToStock: boolean
- autoEndPreventativeMaintenance: boolean
- showOnMap: boolean
Example
{
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"isPicked": "boolean",
"isActive": "boolean",
"isIssuable": "boolean",
"isRequestable": "boolean",
"autoDisassociate": "boolean",
"autoReturnToStock": "boolean",
"autoEndPreventativeMaintenance": "boolean",
"showOnMap": "boolean"
}
Jovix.Application.Response.ResponseContentForSingle[Jovix.Application.V1.Statuses.Repositories.StatusResourceView]: object
- include: string
- data: Jovix.Application.V1.Statuses.Repositories.StatusResourceView
Example
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"isPicked": "boolean",
"isActive": "boolean",
"isIssuable": "boolean",
"isRequestable": "boolean",
"autoDisassociate": "boolean",
"autoReturnToStock": "boolean",
"autoEndPreventativeMaintenance": "boolean",
"showOnMap": "boolean"
}
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.Statuses.Repositories.StatusResourceView[]]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.Statuses.Repositories.StatusResourceView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"isPicked": "boolean",
"isActive": "boolean",
"isIssuable": "boolean",
"isRequestable": "boolean",
"autoDisassociate": "boolean",
"autoReturnToStock": "boolean",
"autoEndPreventativeMaintenance": "boolean",
"showOnMap": "boolean"
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.Response.ResponseContentForSingle[Jovix.Application.V1.Suppliers.Views.SupplierView]: object
- include: string
- data: Jovix.Application.V1.Suppliers.Views.SupplierView
Example
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"code": "string",
"project": {
"id": "integer (int32)"
},
"addresses": [
{
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
}
]
}
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.Suppliers.Views.SupplierView[]]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.Suppliers.Views.SupplierView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"code": "string",
"project": {
"id": "integer (int32)"
},
"addresses": [
{
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
}
]
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.V1.TagAssociations.NewTagAssociation: object
- inventoryItemId: integer (int32)
- shippingUnitId: integer (int32)
- rfid: string
Example
{
"inventoryItemId": "integer (int32)",
"shippingUnitId": "integer (int32)",
"rfid": "string"
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.TagAssociations.Views.TagAssociationView]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.TagAssociations.Views.TagAssociationView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": {
"id": "integer (int32)",
"rfid": "string"
},
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.V1.TagAssociations.Views.TagAssociationView: object
- id: integer (int32)
- rfid: string
Example
{
"id": "integer (int32)",
"rfid": "string"
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.TagAssociations.TagAssociation[]]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.TagAssociations.TagAssociation
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"inventoryItemId": "integer (int32)",
"rfidTagId": "integer (int32)",
"inventoryItemKey": "string",
"rfid": "string"
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.V1.TagAssociations.TagAssociation: object
- id: integer (int32)
- inventoryItemId: integer (int32)
- rfidTagId: integer (int32)
- inventoryItemKey: string
- rfid: string
Example
{
"id": "integer (int32)",
"inventoryItemId": "integer (int32)",
"rfidTagId": "integer (int32)",
"inventoryItemKey": "string",
"rfid": "string"
}
Jovix.Application.Security.TokenResponse: object
- accessToken: string
- refreshToken: string
Example
{
"accessToken": "string",
"refreshToken": "string"
}
Jovix.Application.Response.ResponseContentForSingle[Jovix.Application.V1.UnitsOfMeasure.Views.UnitOfMeasureView]: object
- include: string
- data: Jovix.Application.V1.UnitsOfMeasure.Views.UnitOfMeasureView
Example
{
"include": "string",
"data": {
"id": "integer (int32)",
"project": {
"id": "integer (int32)"
},
"name": "string",
"description": "string"
}
}
Jovix.Application.V1.UnitsOfMeasure.Views.UnitOfMeasureView: object
- id: integer (int32)
- project: Jovix.Application.V1.GenericViews.IdView
- name: string
- description: string
Example
{
"id": "integer (int32)",
"project": {
"id": "integer (int32)"
},
"name": "string",
"description": "string"
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.Users.UserView]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.Users.UserView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": {
"company": "string",
"email": "string",
"employee": {
"id": "integer (int32)"
},
"firstName": "string",
"id": "integer (int32)",
"internalId": "string",
"isActive": "boolean",
"isLocked": "boolean",
"isMobileUser": "boolean",
"isSuperUser": "boolean",
"isSupplierUser": "boolean",
"isSupportUser": "boolean",
"isUserManager": "boolean",
"lastName": "string",
"middleName": "string",
"name": "string",
"phoneNumber": "string",
"title": {
"name": "string"
}
},
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.V1.Users.UserView: object
- company: string
- email: string
- employee: Jovix.Application.V1.GenericViews.IdView
- firstName: string
- id: integer (int32)
- internalId: string
- isActive: boolean
- isLocked: boolean
- isMobileUser: boolean
- isSuperUser: boolean
- isSupplierUser: boolean
- isSupportUser: boolean
- isUserManager: boolean
- lastName: string
- middleName: string
- name: string
- phoneNumber: string
- title: Jovix.Application.V1.GenericViews.NameView
Example
{
"company": "string",
"email": "string",
"employee": {
"id": "integer (int32)"
},
"firstName": "string",
"id": "integer (int32)",
"internalId": "string",
"isActive": "boolean",
"isLocked": "boolean",
"isMobileUser": "boolean",
"isSuperUser": "boolean",
"isSupplierUser": "boolean",
"isSupportUser": "boolean",
"isUserManager": "boolean",
"lastName": "string",
"middleName": "string",
"name": "string",
"phoneNumber": "string",
"title": {
"name": "string"
}
}
Jovix.Application.Response.ResponseContentForSingle[Jovix.Application.V1.Users.Views.UserResourceView]: object
- include: string
- data: Jovix.Application.V1.Users.Views.UserResourceView
Example
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"internalId": "string",
"company": "string",
"isSupplierUser": "boolean",
"isLocked": "boolean",
"isMobileUser": "boolean",
"phone": "string",
"email": "string"
}
}
Jovix.Application.V1.Users.Views.UserResourceView: object
- id: integer (int32)
- name: string
- firstName: string
- middleName: string
- lastName: string
- internalId: string
- company: string
- isSupplierUser: boolean
- isLocked: boolean
- isMobileUser: boolean
- phone: string
- email: string
Example
{
"id": "integer (int32)",
"name": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"internalId": "string",
"company": "string",
"isSupplierUser": "boolean",
"isLocked": "boolean",
"isMobileUser": "boolean",
"phone": "string",
"email": "string"
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.Users.UserView[]]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.Users.UserView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"company": "string",
"email": "string",
"employee": {
"id": "integer (int32)"
},
"firstName": "string",
"id": "integer (int32)",
"internalId": "string",
"isActive": "boolean",
"isLocked": "boolean",
"isMobileUser": "boolean",
"isSuperUser": "boolean",
"isSupplierUser": "boolean",
"isSupportUser": "boolean",
"isUserManager": "boolean",
"lastName": "string",
"middleName": "string",
"name": "string",
"phoneNumber": "string",
"title": {
"name": "string"
}
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.V1.Version.VersionInfo: object
- api: string
- offlineTablet: string
- server: string
Example
{
"api": "string",
"offlineTablet": "string",
"server": "string"
}
Jovix.Application.Response.ResponseContentForSingle[Jovix.Application.V1.WithdrawalRequests.Views.WithdrawalRequestView]: object
- include: string
- data: Jovix.Application.V1.WithdrawalRequests.Views.WithdrawalRequestView
Example
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"notes": "string",
"description": "string",
"deliverByDate": "string (date-time)",
"requiredAtSiteDate": "string (date-time)",
"requestedOnDate": "string (date-time)",
"status": {
"id": "integer (int32)",
"name": "string"
},
"deliverySite": {
"id": "integer (int32)"
},
"pickSite": {
"id": "integer (int32)"
},
"job": {
"id": "integer (int32)"
},
"customField_1": "string",
"customField_2": "string",
"customField_3": "string",
"customField_4": "string",
"customField_5": "string",
"customField_6": "string",
"customField_7": "string",
"customField_8": "string",
"customField_9": "string",
"customField_10": "string",
"customField_11": "string",
"customField_12": "string",
"customField_13": "string",
"customField_14": "string",
"customField_15": "string",
"customField_16": "string",
"customField_17": "string",
"customField_18": "string",
"customField_19": "string",
"customField_20": "string",
"customField_21": "string",
"customField_22": "string",
"customField_23": "string",
"customField_24": "string",
"customField_25": "string",
"customField_26": "string",
"customField_27": "string",
"customField_28": "string",
"customField_29": "string",
"customField_30": "string"
}
}
Jovix.Application.V1.WithdrawalRequests.Views.WithdrawalRequestView: object
- id: integer (int32)
- name: string
- notes: string
- description: string
- deliverByDate: string (date-time)
- requiredAtSiteDate: string (date-time)
- requestedOnDate: string (date-time)
- status: Jovix.Application.V1.GenericViews.IdAndNameView
- deliverySite: Jovix.Application.V1.GenericViews.IdView
- pickSite: Jovix.Application.V1.GenericViews.IdView
- job: Jovix.Application.V1.GenericViews.IdView
- customField_1: string
- customField_2: string
- customField_3: string
- customField_4: string
- customField_5: string
- customField_6: string
- customField_7: string
- customField_8: string
- customField_9: string
- customField_10: string
- customField_11: string
- customField_12: string
- customField_13: string
- customField_14: string
- customField_15: string
- customField_16: string
- customField_17: string
- customField_18: string
- customField_19: string
- customField_20: string
- customField_21: string
- customField_22: string
- customField_23: string
- customField_24: string
- customField_25: string
- customField_26: string
- customField_27: string
- customField_28: string
- customField_29: string
- customField_30: string
Example
{
"id": "integer (int32)",
"name": "string",
"notes": "string",
"description": "string",
"deliverByDate": "string (date-time)",
"requiredAtSiteDate": "string (date-time)",
"requestedOnDate": "string (date-time)",
"status": {
"id": "integer (int32)",
"name": "string"
},
"deliverySite": {
"id": "integer (int32)"
},
"pickSite": {
"id": "integer (int32)"
},
"job": {
"id": "integer (int32)"
},
"customField_1": "string",
"customField_2": "string",
"customField_3": "string",
"customField_4": "string",
"customField_5": "string",
"customField_6": "string",
"customField_7": "string",
"customField_8": "string",
"customField_9": "string",
"customField_10": "string",
"customField_11": "string",
"customField_12": "string",
"customField_13": "string",
"customField_14": "string",
"customField_15": "string",
"customField_16": "string",
"customField_17": "string",
"customField_18": "string",
"customField_19": "string",
"customField_20": "string",
"customField_21": "string",
"customField_22": "string",
"customField_23": "string",
"customField_24": "string",
"customField_25": "string",
"customField_26": "string",
"customField_27": "string",
"customField_28": "string",
"customField_29": "string",
"customField_30": "string"
}
Jovix.Application.Serialization.Patch[Jovix.Application.V1.WithdrawalRequests.WithdrawalRequestPatch]:
Example
{
"name": "string",
"deliverySite": {
"id": "integer (int32)"
},
"pickSite": {
"id": "integer (int32)"
},
"deliverToEmployee": {
"id": "integer (int32)"
},
"assignedToUser": {
"id": "integer (int32)"
},
"deliverToZone": {
"id": "integer (int32)"
},
"deliverByDate": "string (date-time)",
"requestedOnDate": "string (date-time)",
"requiredAtSiteDate": "string (date-time)",
"description": "string",
"deliverToPhoneNumber": "string",
"notes": "string",
"customField_1": "object",
"customField_2": "object",
"customField_3": "object",
"customField_4": "object",
"customField_5": "object",
"customField_6": "object",
"customField_7": "object",
"customField_8": "object",
"customField_9": "object",
"customField_10": "object",
"customField_11": "object",
"customField_12": "object",
"customField_13": "object",
"customField_14": "object",
"customField_15": "object",
"customField_16": "object",
"customField_17": "object",
"customField_18": "object",
"customField_19": "object",
"customField_20": "object",
"customField_21": "object",
"customField_22": "object",
"customField_23": "object",
"customField_24": "object",
"customField_25": "object",
"customField_26": "object",
"customField_27": "object",
"customField_28": "object",
"customField_29": "object",
"customField_30": "object"
}
Jovix.Application.V1.WithdrawalRequests.WithdrawalRequestPatch: object
- name: string (up to 100 chars)
- deliverySite: Jovix.Application.V1.GenericViews.IdPost
- pickSite: Jovix.Application.V1.GenericViews.IdPost
- deliverToEmployee: Jovix.Application.V1.GenericViews.IdPost
- assignedToUser: Jovix.Application.V1.GenericViews.IdPost
- deliverToZone: Jovix.Application.V1.GenericViews.IdPost
- deliverByDate: string (date-time)
- requestedOnDate: string (date-time)
- requiredAtSiteDate: string (date-time)
- description: string (up to 500 chars)
- deliverToPhoneNumber: string (up to 50 chars)
- notes: string (up to 1000 chars)
- customField_1: object
- customField_2: object
- customField_3: object
- customField_4: object
- customField_5: object
- customField_6: object
- customField_7: object
- customField_8: object
- customField_9: object
- customField_10: object
- customField_11: object
- customField_12: object
- customField_13: object
- customField_14: object
- customField_15: object
- customField_16: object
- customField_17: object
- customField_18: object
- customField_19: object
- customField_20: object
- customField_21: object
- customField_22: object
- customField_23: object
- customField_24: object
- customField_25: object
- customField_26: object
- customField_27: object
- customField_28: object
- customField_29: object
- customField_30: object
Example
{
"name": "string",
"deliverySite": {
"id": "integer (int32)"
},
"pickSite": {
"id": "integer (int32)"
},
"deliverToEmployee": {
"id": "integer (int32)"
},
"assignedToUser": {
"id": "integer (int32)"
},
"deliverToZone": {
"id": "integer (int32)"
},
"deliverByDate": "string (date-time)",
"requestedOnDate": "string (date-time)",
"requiredAtSiteDate": "string (date-time)",
"description": "string",
"deliverToPhoneNumber": "string",
"notes": "string",
"customField_1": "object",
"customField_2": "object",
"customField_3": "object",
"customField_4": "object",
"customField_5": "object",
"customField_6": "object",
"customField_7": "object",
"customField_8": "object",
"customField_9": "object",
"customField_10": "object",
"customField_11": "object",
"customField_12": "object",
"customField_13": "object",
"customField_14": "object",
"customField_15": "object",
"customField_16": "object",
"customField_17": "object",
"customField_18": "object",
"customField_19": "object",
"customField_20": "object",
"customField_21": "object",
"customField_22": "object",
"customField_23": "object",
"customField_24": "object",
"customField_25": "object",
"customField_26": "object",
"customField_27": "object",
"customField_28": "object",
"customField_29": "object",
"customField_30": "object"
}
Jovix.Application.V1.WithdrawalRequests.Views.WithdrawalRequestPost: object
- name: string
- job: Jovix.Application.V1.GenericViews.IdView
- deliverySite: Jovix.Application.V1.GenericViews.IdView
- deliverByDate: string (date-time)
- requestedOnDate: string (date-time)
- description: string
- assignedToUser: Jovix.Application.V1.GenericViews.IdView
- pickSite: Jovix.Application.V1.GenericViews.IdView
- requiredAtSiteDate: string (date-time)
- deliverToEmployee: Jovix.Application.V1.GenericViews.IdView
- deliverToPhoneNumber: string
- deliverToZone: Jovix.Application.V1.GenericViews.IdView
- notes: string
- customField_1: object
- customField_2: object
- customField_3: object
- customField_4: object
- customField_5: object
- customField_6: object
- customField_7: object
- customField_8: object
- customField_9: object
- customField_10: object
- customField_11: object
- customField_12: object
- customField_13: object
- customField_14: object
- customField_15: object
- customField_16: object
- customField_17: object
- customField_18: object
- customField_19: object
- customField_20: object
- customField_21: object
- customField_22: object
- customField_23: object
- customField_24: object
- customField_25: object
- customField_26: object
- customField_27: object
- customField_28: object
- customField_29: object
- customField_30: object
Example
{
"name": "string",
"job": {
"id": "integer (int32)"
},
"deliverySite": {
"id": "integer (int32)"
},
"deliverByDate": "string (date-time)",
"requestedOnDate": "string (date-time)",
"description": "string",
"assignedToUser": {
"id": "integer (int32)"
},
"pickSite": {
"id": "integer (int32)"
},
"requiredAtSiteDate": "string (date-time)",
"deliverToEmployee": {
"id": "integer (int32)"
},
"deliverToPhoneNumber": "string",
"deliverToZone": {
"id": "integer (int32)"
},
"notes": "string",
"customField_1": "object",
"customField_2": "object",
"customField_3": "object",
"customField_4": "object",
"customField_5": "object",
"customField_6": "object",
"customField_7": "object",
"customField_8": "object",
"customField_9": "object",
"customField_10": "object",
"customField_11": "object",
"customField_12": "object",
"customField_13": "object",
"customField_14": "object",
"customField_15": "object",
"customField_16": "object",
"customField_17": "object",
"customField_18": "object",
"customField_19": "object",
"customField_20": "object",
"customField_21": "object",
"customField_22": "object",
"customField_23": "object",
"customField_24": "object",
"customField_25": "object",
"customField_26": "object",
"customField_27": "object",
"customField_28": "object",
"customField_29": "object",
"customField_30": "object"
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.WithdrawalRequests.Views.WithdrawalRequestIncludeView[]]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.WithdrawalRequests.Views.WithdrawalRequestIncludeView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"notes": "string",
"description": "string",
"deliverByDate": "string (date-time)",
"requiredAtSiteDate": "string (date-time)",
"requestedOnDate": "string (date-time)",
"status": {
"id": "integer (int32)",
"name": "string"
},
"deliverySite": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
},
"pickSite": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
},
"job": {
"id": "integer (int32)",
"name": "string",
"description": "string",
"abbreviation": "string",
"isActive": "boolean",
"project": {
"id": "integer (int32)"
}
},
"customField_1": "string",
"customField_2": "string",
"customField_3": "string",
"customField_4": "string",
"customField_5": "string",
"customField_6": "string",
"customField_7": "string",
"customField_8": "string",
"customField_9": "string",
"customField_10": "string",
"customField_11": "string",
"customField_12": "string",
"customField_13": "string",
"customField_14": "string",
"customField_15": "string",
"customField_16": "string",
"customField_17": "string",
"customField_18": "string",
"customField_19": "string",
"customField_20": "string",
"customField_21": "string",
"customField_22": "string",
"customField_23": "string",
"customField_24": "string"
}
]
}
Jovix.Application.Response.ResponseContentForSingle[Jovix.Application.V1.WithdrawalRequestItems.Views.WithdrawalRequestItemView]: object
- include: string
- data: Jovix.Application.V1.WithdrawalRequestItems.Views.WithdrawalRequestItemView
Example
{
"include": "string",
"data": {
"id": "integer (int32)",
"withdrawalRequest": {
"id": "integer (int32)"
},
"workPackageItem": {
"id": "integer (int32)"
},
"catalogItem": {
"id": "integer (int32)"
},
"material": {
"id": "integer (int32)"
},
"requestedQuantity": "number (double)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"isReserved": "boolean",
"customField_1": "string",
"customField_2": "string",
"customField_3": "string",
"customField_4": "string",
"customField_5": "string",
"customField_6": "string",
"customField_7": "string",
"customField_8": "string",
"customField_9": "string",
"customField_10": "string",
"customField_11": "string",
"customField_12": "string",
"customField_13": "string",
"customField_14": "string",
"customField_15": "string",
"customField_16": "string",
"customField_17": "string",
"customField_18": "string",
"customField_19": "string",
"customField_20": "string",
"customField_21": "string",
"customField_22": "string",
"customField_23": "string",
"customField_24": "string",
"customField_25": "string",
"customField_26": "string",
"customField_27": "string",
"customField_28": "string",
"customField_29": "string",
"customField_30": "string"
}
}
Jovix.Application.V1.WithdrawalRequestItems.Views.WithdrawalRequestItemView: object
- id: integer (int32)
- withdrawalRequest: Jovix.Application.V1.GenericViews.IdView
- workPackageItem: Jovix.Application.V1.GenericViews.IdView
- catalogItem: Jovix.Application.V1.GenericViews.IdView
- material: Jovix.Application.V1.GenericViews.IdView
- requestedQuantity: number (double)
- lineNumber: integer (int32)
- subLineNumber: integer (int32)
- isReserved: boolean
- customField_1: string
- customField_2: string
- customField_3: string
- customField_4: string
- customField_5: string
- customField_6: string
- customField_7: string
- customField_8: string
- customField_9: string
- customField_10: string
- customField_11: string
- customField_12: string
- customField_13: string
- customField_14: string
- customField_15: string
- customField_16: string
- customField_17: string
- customField_18: string
- customField_19: string
- customField_20: string
- customField_21: string
- customField_22: string
- customField_23: string
- customField_24: string
- customField_25: string
- customField_26: string
- customField_27: string
- customField_28: string
- customField_29: string
- customField_30: string
Example
{
"id": "integer (int32)",
"withdrawalRequest": {
"id": "integer (int32)"
},
"workPackageItem": {
"id": "integer (int32)"
},
"catalogItem": {
"id": "integer (int32)"
},
"material": {
"id": "integer (int32)"
},
"requestedQuantity": "number (double)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"isReserved": "boolean",
"customField_1": "string",
"customField_2": "string",
"customField_3": "string",
"customField_4": "string",
"customField_5": "string",
"customField_6": "string",
"customField_7": "string",
"customField_8": "string",
"customField_9": "string",
"customField_10": "string",
"customField_11": "string",
"customField_12": "string",
"customField_13": "string",
"customField_14": "string",
"customField_15": "string",
"customField_16": "string",
"customField_17": "string",
"customField_18": "string",
"customField_19": "string",
"customField_20": "string",
"customField_21": "string",
"customField_22": "string",
"customField_23": "string",
"customField_24": "string",
"customField_25": "string",
"customField_26": "string",
"customField_27": "string",
"customField_28": "string",
"customField_29": "string",
"customField_30": "string"
}
Jovix.Application.Serialization.Patch[Jovix.Application.V1.WithdrawalRequestItems.WithdrawalRequestItemPatch]:
Example
{
"requestedQuantity": "number (double)",
"isReserved": "boolean",
"customField_1": "object",
"customField_2": "object",
"customField_3": "object",
"customField_4": "object",
"customField_5": "object",
"customField_6": "object",
"customField_7": "object",
"customField_8": "object",
"customField_9": "object",
"customField_10": "object",
"customField_11": "object",
"customField_12": "object",
"customField_13": "object",
"customField_14": "object",
"customField_15": "object",
"customField_16": "object",
"customField_17": "object",
"customField_18": "object",
"customField_19": "object",
"customField_20": "object",
"customField_21": "object",
"customField_22": "object",
"customField_23": "object",
"customField_24": "object",
"customField_25": "object",
"customField_26": "object",
"customField_27": "object",
"customField_28": "object",
"customField_29": "object",
"customField_30": "object"
}
Jovix.Application.V1.WithdrawalRequestItems.WithdrawalRequestItemPatch: object
- requestedQuantity: number (double)
- isReserved: boolean
- customField_1: object
- customField_2: object
- customField_3: object
- customField_4: object
- customField_5: object
- customField_6: object
- customField_7: object
- customField_8: object
- customField_9: object
- customField_10: object
- customField_11: object
- customField_12: object
- customField_13: object
- customField_14: object
- customField_15: object
- customField_16: object
- customField_17: object
- customField_18: object
- customField_19: object
- customField_20: object
- customField_21: object
- customField_22: object
- customField_23: object
- customField_24: object
- customField_25: object
- customField_26: object
- customField_27: object
- customField_28: object
- customField_29: object
- customField_30: object
Example
{
"requestedQuantity": "number (double)",
"isReserved": "boolean",
"customField_1": "object",
"customField_2": "object",
"customField_3": "object",
"customField_4": "object",
"customField_5": "object",
"customField_6": "object",
"customField_7": "object",
"customField_8": "object",
"customField_9": "object",
"customField_10": "object",
"customField_11": "object",
"customField_12": "object",
"customField_13": "object",
"customField_14": "object",
"customField_15": "object",
"customField_16": "object",
"customField_17": "object",
"customField_18": "object",
"customField_19": "object",
"customField_20": "object",
"customField_21": "object",
"customField_22": "object",
"customField_23": "object",
"customField_24": "object",
"customField_25": "object",
"customField_26": "object",
"customField_27": "object",
"customField_28": "object",
"customField_29": "object",
"customField_30": "object"
}
Jovix.Application.Response.ResponseContentForSingle[Jovix.Application.V1.WithdrawalRequestItems.Views.WithdrawalRequestItemIncludeView]: object
- include: string
- data: Jovix.Application.V1.WithdrawalRequestItems.Views.WithdrawalRequestItemIncludeView
Example
{
"include": "string",
"data": {
"id": "integer (int32)",
"withdrawalRequest": {
"id": "integer (int32)",
"name": "string",
"notes": "string",
"description": "string",
"deliverByDate": "string (date-time)",
"requiredAtSiteDate": "string (date-time)",
"requestedOnDate": "string (date-time)",
"status": {
"id": "integer (int32)",
"name": "string"
},
"deliverySite": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
},
"pickSite": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
},
"job": {
"id": "integer (int32)",
"name": "string",
"description": "string",
"abbreviation": "string",
"isActive": "boolean",
"project": {
"id": "integer (int32)"
}
},
"customField_1": "string",
"customField_2": "string",
"customField_3": "string",
"customField_4": "string",
"customField_5": "string",
"customField_6": "string",
"customField_7": "string",
"customField_8": "string",
"customField_9": "string",
"customField_10": "string",
"customField_11": "string",
"customField_12": "string",
"customField_13": "string",
"customField_14": "string",
"customField_15": "string",
"customField_16": "string",
"customField_17": "string",
"customField_18": "string",
"customField_19": "string",
"customField_20": "string",
"customField_21": "string",
"customField_22": "string",
"customField_23": "string",
"customField_24": "string"
}
}
}
Jovix.Application.V1.WithdrawalRequestItems.Views.WithdrawalRequestItemPost: object
- withdrawalRequest: Jovix.Application.V1.GenericViews.IdView
- requestedQuantity: number (double)
- catalogItem: Jovix.Application.V1.GenericViews.IdView
- workPackageItem: Jovix.Application.V1.GenericViews.IdView
- isReserved: boolean
- customField_1: object
- customField_2: object
- customField_3: object
- customField_4: object
- customField_5: object
- customField_6: object
- customField_7: object
- customField_8: object
- customField_9: object
- customField_10: object
- customField_11: object
- customField_12: object
- customField_13: object
- customField_14: object
- customField_15: object
- customField_16: object
- customField_17: object
- customField_18: object
- customField_19: object
- customField_20: object
- customField_21: object
- customField_22: object
- customField_23: object
- customField_24: object
- customField_25: object
- customField_26: object
- customField_27: object
- customField_28: object
- customField_29: object
- customField_30: object
Example
{
"withdrawalRequest": {
"id": "integer (int32)"
},
"requestedQuantity": "number (double)",
"catalogItem": {
"id": "integer (int32)"
},
"workPackageItem": {
"id": "integer (int32)"
},
"isReserved": "boolean",
"customField_1": "object",
"customField_2": "object",
"customField_3": "object",
"customField_4": "object",
"customField_5": "object",
"customField_6": "object",
"customField_7": "object",
"customField_8": "object",
"customField_9": "object",
"customField_10": "object",
"customField_11": "object",
"customField_12": "object",
"customField_13": "object",
"customField_14": "object",
"customField_15": "object",
"customField_16": "object",
"customField_17": "object",
"customField_18": "object",
"customField_19": "object",
"customField_20": "object",
"customField_21": "object",
"customField_22": "object",
"customField_23": "object",
"customField_24": "object",
"customField_25": "object",
"customField_26": "object",
"customField_27": "object",
"customField_28": "object",
"customField_29": "object",
"customField_30": "object"
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.WithdrawalRequestItems.Views.WithdrawalRequestItemIncludeView[]]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.WithdrawalRequestItems.Views.WithdrawalRequestItemIncludeView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"withdrawalRequest": {
"id": "integer (int32)",
"name": "string",
"notes": "string",
"description": "string",
"deliverByDate": "string (date-time)",
"requiredAtSiteDate": "string (date-time)",
"requestedOnDate": "string (date-time)",
"status": {
"id": "integer (int32)",
"name": "string"
},
"deliverySite": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
},
"pickSite": {
"id": "integer (int32)",
"name": "string",
"project": {
"id": "integer (int32)"
},
"address": {
"name": "string",
"description": "string",
"contact": "string",
"phone1": "string",
"phone2": "string",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"email": "string"
},
"isToLocation": "boolean",
"isFromLocation": "boolean",
"isWorkOrDeliverySite": "boolean"
},
"job": {
"id": "integer (int32)",
"name": "string",
"description": "string",
"abbreviation": "string",
"isActive": "boolean",
"project": {
"id": "integer (int32)"
}
},
"customField_1": "string",
"customField_2": "string",
"customField_3": "string",
"customField_4": "string",
"customField_5": "string",
"customField_6": "string",
"customField_7": "string",
"customField_8": "string",
"customField_9": "string",
"customField_10": "string",
"customField_11": "string",
"customField_12": "string",
"customField_13": "string",
"customField_14": "string",
"customField_15": "string",
"customField_16": "string",
"customField_17": "string",
"customField_18": "string",
"customField_19": "string",
"customField_20": "string",
"customField_21": "string"
}
}
]
}
Jovix.Application.Response.ResponseContentForSingle[Jovix.Application.V1.WorkPackages.Views.WorkPackageView]: object
- include: string
- data: Jovix.Application.V1.WorkPackages.Views.WorkPackageView
Example
{
"include": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"description": "string",
"job": {
"id": "integer (int32)"
},
"workSite": {
"id": "integer (int32)"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"costCode": "string",
"system": {
"id": "integer (int32)"
},
"area": {
"id": "integer (int32)"
},
"building": {
"id": "integer (int32)"
},
"discipline": {
"id": "integer (int32)"
},
"plannedStartDate": "string (date-time)",
"requiredAtSiteDate": "string (date-time)",
"plannedFinishDate": "string (date-time)",
"estimatedManHours": "number (double)",
"notes": "string"
}
}
Jovix.Application.V1.WorkPackages.Views.WorkPackageView: object
- id: integer (int32)
- name: string
- description: string
- job: Jovix.Application.V1.GenericViews.IdView
- workSite: Jovix.Application.V1.GenericViews.IdView
- status: Jovix.Application.V1.GenericViews.IdAndNameView
- costCode: string
- system: Jovix.Application.V1.GenericViews.IdView
- area: Jovix.Application.V1.GenericViews.IdView
- building: Jovix.Application.V1.GenericViews.IdView
- discipline: Jovix.Application.V1.GenericViews.IdView
- plannedStartDate: string (date-time)
- requiredAtSiteDate: string (date-time)
- plannedFinishDate: string (date-time)
- estimatedManHours: number (double)
- notes: string
Example
{
"id": "integer (int32)",
"name": "string",
"description": "string",
"job": {
"id": "integer (int32)"
},
"workSite": {
"id": "integer (int32)"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"costCode": "string",
"system": {
"id": "integer (int32)"
},
"area": {
"id": "integer (int32)"
},
"building": {
"id": "integer (int32)"
},
"discipline": {
"id": "integer (int32)"
},
"plannedStartDate": "string (date-time)",
"requiredAtSiteDate": "string (date-time)",
"plannedFinishDate": "string (date-time)",
"estimatedManHours": "number (double)",
"notes": "string"
}
Jovix.Application.V1.WorkPackages.WorkPackagePost: object
- name: string (up to 150 chars)
- job: Jovix.Application.V1.GenericViews.IdPost
- workSite: Jovix.Application.V1.GenericViews.IdPost
- costCode: string (up to 150 chars)
- system: Jovix.Application.V1.GenericViews.IdPost
- area: Jovix.Application.V1.GenericViews.IdPost
- building: Jovix.Application.V1.GenericViews.IdPost
- discipline: Jovix.Application.V1.GenericViews.IdPost
- plannedStartDate: string (date-time)
- plannedFinishDate: string (date-time)
- requiredAtSiteDate: string (date-time)
- estimatedManHours: number (double)
- notes: string (up to 1000 chars)
- description: string (up to 255 chars)
Example
{
"name": "string",
"job": {
"id": "integer (int32)"
},
"workSite": {
"id": "integer (int32)"
},
"costCode": "string",
"system": {
"id": "integer (int32)"
},
"area": {
"id": "integer (int32)"
},
"building": {
"id": "integer (int32)"
},
"discipline": {
"id": "integer (int32)"
},
"plannedStartDate": "string (date-time)",
"plannedFinishDate": "string (date-time)",
"requiredAtSiteDate": "string (date-time)",
"estimatedManHours": "number (double)",
"notes": "string",
"description": "string"
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.WorkPackages.Views.WorkPackageView[]]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.WorkPackages.Views.WorkPackageView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"description": "string",
"job": {
"id": "integer (int32)"
},
"workSite": {
"id": "integer (int32)"
},
"status": {
"id": "integer (int32)",
"name": "string"
},
"costCode": "string",
"system": {
"id": "integer (int32)"
},
"area": {
"id": "integer (int32)"
},
"building": {
"id": "integer (int32)"
},
"discipline": {
"id": "integer (int32)"
},
"plannedStartDate": "string (date-time)",
"requiredAtSiteDate": "string (date-time)",
"plannedFinishDate": "string (date-time)",
"estimatedManHours": "number (double)",
"notes": "string"
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.Response.ResponseContentForSingle[Jovix.Application.V1.WorkPackageItems.Views.WorkPackageItemView]: object
- include: string
- data: Jovix.Application.V1.WorkPackageItems.Views.WorkPackageItemView
Example
{
"include": "string",
"data": {
"id": "integer (int32)",
"quantity": "number (double)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"catalogItem": {
"id": "integer (int32)"
},
"workPackage": {
"id": "integer (int32)"
}
}
}
Jovix.Application.V1.WorkPackageItems.Views.WorkPackageItemView: object
- id: integer (int32)
- quantity: number (double)
- lineNumber: integer (int32)
- subLineNumber: integer (int32)
- catalogItem: Jovix.Application.V1.GenericViews.IdView
- workPackage: Jovix.Application.V1.GenericViews.IdView
Example
{
"id": "integer (int32)",
"quantity": "number (double)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"catalogItem": {
"id": "integer (int32)"
},
"workPackage": {
"id": "integer (int32)"
}
}
Jovix.Application.Serialization.Patch[Jovix.Application.V1.WorkPackageItems.WorkPackageItemPatch]:
Example
{
"quantity": "number (double)",
"drawingItem": {
"id": "integer (int32)"
}
}
Jovix.Application.V1.WorkPackageItems.WorkPackageItemPatch: object
- quantity: number (double) x ≥ 0
- drawingItem: Jovix.Application.V1.GenericViews.IdPost
Example
{
"quantity": "number (double)",
"drawingItem": {
"id": "integer (int32)"
}
}
Jovix.Application.V1.WorkPackageItems.Views.WorkPackageItemCreateView: object
- quantity: number (double) x ≥ 0
- catalogItem: Jovix.Application.V1.GenericViews.IdView
- workPackage: Jovix.Application.V1.GenericViews.IdView
Example
{
"quantity": "number (double)",
"catalogItem": {
"id": "integer (int32)"
},
"workPackage": {
"id": "integer (int32)"
}
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.WorkPackageItems.Views.WorkPackageItemView[]]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.WorkPackageItems.Views.WorkPackageItemView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"quantity": "number (double)",
"lineNumber": "integer (int32)",
"subLineNumber": "integer (int32)",
"catalogItem": {
"id": "integer (int32)"
},
"workPackage": {
"id": "integer (int32)"
}
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.Yards.Views.YardResponseView]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.Yards.Views.YardResponseView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": {
"id": "integer (int32)",
"isActive": "boolean",
"job": {
"id": "integer (int32)",
"name": "string"
},
"name": "string",
"positionTop": "number (double)",
"positionLeft": "number (double)",
"positionRight": "number (double)",
"positionBottom": "number (double)",
"site": {
"id": "integer (int32)",
"name": "string"
}
},
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.V1.Yards.Views.YardResponseView: object
- id: integer (int32)
- isActive: boolean
- job: Jovix.Application.V1.Jobs.Views.JobView
- name: string
- positionTop: number (double)
- positionLeft: number (double)
- positionRight: number (double)
- positionBottom: number (double)
- site: Jovix.Application.V1.GenericViews.IdAndNameView
Example
{
"id": "integer (int32)",
"isActive": "boolean",
"job": {
"id": "integer (int32)",
"name": "string"
},
"name": "string",
"positionTop": "number (double)",
"positionLeft": "number (double)",
"positionRight": "number (double)",
"positionBottom": "number (double)",
"site": {
"id": "integer (int32)",
"name": "string"
}
}
Jovix.Application.Response.ResponseContent[System.String]: object
- include: string
- expand: string
- fieldSets: string
- data: string
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": "string",
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.Yards.Views.YardResponseView[]]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.Yards.Views.YardResponseView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"isActive": "boolean",
"job": {
"id": "integer (int32)",
"name": "string"
},
"name": "string",
"positionTop": "number (double)",
"positionLeft": "number (double)",
"positionRight": "number (double)",
"positionBottom": "number (double)",
"site": {
"id": "integer (int32)",
"name": "string"
}
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.Zones.Views.ZoneResponseView]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.Zones.Views.ZoneResponseView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": {
"id": "integer (int32)",
"name": "string",
"yard": {
"id": "integer (int32)"
}
},
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}
Jovix.Application.V1.Zones.Views.ZoneResponseView: object
- id: integer (int32)
- name: string
- yard: Jovix.Application.V1.Yards.Views.YardView
Example
{
"id": "integer (int32)",
"name": "string",
"yard": {
"id": "integer (int32)"
}
}
Jovix.Application.V1.Yards.Views.YardView: object
- id: integer (int32)
Example
{
"id": "integer (int32)"
}
Jovix.Application.Response.ResponseContent[Jovix.Application.V1.Zones.Views.ZoneResponseView[]]: object
- include: string
- expand: string
- fieldSets: string
- data: Jovix.Application.V1.Zones.Views.ZoneResponseView
- links: Jovix.Application.Response.PageLinks
- totalCount: integer (int32)
Example
{
"include": "string",
"expand": "string",
"fieldSets": "string",
"data": [
{
"id": "integer (int32)",
"name": "string",
"yard": {
"id": "integer (int32)"
}
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"previous": "string"
},
"totalCount": "integer (int32)"
}