WorkOrder

Returns all work orders.

For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens

Securitybearer
Request
query Parameters
businessUnitId
string <uuid>

Optionally filter the returned list of work orders by business unit

count
integer or null <int32>

The total number of records to return. Default: 100. Limit: 1000.

cursor
integer or null <int32>

The point at which to start pagination.

sortBy
string or null

"workOrderNumber" or "statusDate". Default: workOrderNumber.

sortOrder
string or null

"asc" or "desc". Default: asc.

equipmentCode
string or null

Filters work orders by equipment code.

status
Array of strings or null

Filters work orders by status.

isPreventiveMaintenance
boolean or null

Set to true to filter to PM work orders, false to filter to non-PM work orders, and null for all work orders.

includeNotes
boolean or null

If true, the returned ApiWorkOrderRead object will include a list of the work order's notes. Default is false.

Responses
200

Success

401

Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.

403

Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.

404

Endpoint Not Found. This response may occur if the on-premises E360 service does not exist or is not currently running.

get/api/v1/workOrders
Request samples 
Response samples 
application/json
{
  • "count": 2,
  • "prev": 318,
  • "next": 322,
  • "timestamp": 1590769189,
  • "data": [
    ]
}
Creates a Work Order.
For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens


Securitybearer 
Request 
query Parameters
businessUnitId
string or null <uuid> 
Optional. If not specified, will create the work order in the authenticated HCSS Apps user's business unit.


 
Request Body schema: 
jobId
string or null <uuid> 
The Id of the job (if any) to which the work order applies. May only specify equipment, job, or shop upon creation.


 
equipmentId
string or null <uuid> 
The Id of the equipment (if any) to which the work order applies. May only specify equipment, job, or shop upon creation.


 
shopId
string or null <uuid> 
The Id of the shop (if any) to which the work order applies. May only specify equipment, job, or shop upon creation.


 
description
string or null
The work order's problem description.


 
status
string or null
The current status of the work order.


 
priority
string or null
The current priority of the work order.


 
dueDate
string or null <date-time> 
The date, if specified, on which the work order is due.


 
Responses 
200
Success


401
Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.


403
Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.


404
Endpoint Not Found. This response may occur if the on-premises E360 service does not exist or is not currently running.


post/api/v1/workOrders
Request samples 
{
  • "equipmentId": "109381e4-da01-43df-83a9-c6a3f3291e3b",
  • "description": "Catalytic converter was stolen.",
  • "status": "Open",
  • "priority": "Normal",
  • "dueDate": "2022-01-15"
}
Response samples 
application/json
{
  • "id": "47827b28-008a-46f2-88e1-bf286df33842",
  • "businessUnitId": "f4997dc6-a4a0-4d6c-81eb-e15deba9d8a2",
  • "workOrderNumber": 320,
  • "tags": [
    ],
  • "notes": [
    ],
  • "statusDate": "2019-01-21T00:00:00",
  • "isPreventiveMaintenance": true,
  • "shopId": "109381e4-da01-43df-83a9-c6a3f3291e3b",
  • "description": "Clean the west half of the shop.",
  • "status": "Closed",
  • "priority": "High",
  • "dueDate": "2020-04-20"
}
Returns a single work order, based on its Id.
For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens


Securitybearer 
Request 
path Parameters
id
required
string <uuid> 
The Id of the work order to return.


 
Responses 
200
Success


401
Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.


403
Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.


404
Endpoint Not Found. This response may occur if the on-premises E360 service does not exist or is not currently running.


get/api/v1/workOrders/{id}
Request samples 
Response samples 
application/json
{
  • "id": "47827b28-008a-46f2-88e1-bf286df33842",
  • "businessUnitId": "f4997dc6-a4a0-4d6c-81eb-e15deba9d8a2",
  • "workOrderNumber": 320,
  • "tags": [
    ],
  • "notes": [
    ],
  • "statusDate": "2019-01-21T00:00:00",
  • "isPreventiveMaintenance": true,
  • "shopId": "109381e4-da01-43df-83a9-c6a3f3291e3b",
  • "description": "Clean the west half of the shop.",
  • "status": "Closed",
  • "priority": "High",
  • "dueDate": "2020-04-20"
}
Updates a work order by id.
For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens


Securitybearer 
Request 
path Parameters
id
required
string <uuid> 
The Id of the work order to update and return.


 
Request Body schema: 
The updated fields for the work order.


equipmentId
string or null <uuid> 
Equipment Id (can only be used for equipment type work orders)


 
equipmentJobId
string or null <uuid> 
Equipment Job Id (can only be used for equipment type work orders)


 
jobId
string or null <uuid> 
Job Id (can only be used for job type work orders)


 
shopId
string or null <uuid> 
Shop Id (can only be used for shop type work orders)


 
description
string or null
The work order description


 
statusId
string or null <uuid> 
Work order Status Id


 
priorityId
string or null <uuid> 
Work order Priority Id


 
Responses 
200
Success


401
Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.


403
Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.


404
Endpoint Not Found. This response may occur if the on-premises E360 service does not exist or is not currently running.


put/api/v1/workOrder/{id}
Request samples 
{
  • "equipmentJobId": "21bea700-39c4-45e6-bd24-cde7bd6997ae",
  • "statusID": "c2010820-9bc7-4ba4-9fb3-16ea072086ff"
}
Response samples 
application/json
{
  • "id": "47827b28-008a-46f2-88e1-bf286df33842",
  • "businessUnitId": "f4997dc6-a4a0-4d6c-81eb-e15deba9d8a2",
  • "workOrderNumber": 320,
  • "tags": [
    ],
  • "notes": [
    ],
  • "statusDate": "2019-01-21T00:00:00",
  • "isPreventiveMaintenance": true,
  • "shopId": "109381e4-da01-43df-83a9-c6a3f3291e3b",
  • "description": "Clean the west half of the shop.",
  • "status": "Closed",
  • "priority": "High",
  • "dueDate": "2020-04-20"
}
Creates a new work order note.
For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens


Securitybearer 
Request 
path Parameters
workOrderId
required
string <uuid> 
The work order id.


 
Request Body schema: 
note
string or null
The note.


 
Responses 
200
Success


401
Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.


403
Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.


404
Endpoint Not Found. This response may occur if the on-premises E360 service does not exist or is not currently running.


post/api/v1/workOrders/{workOrderId}/notes
Request samples 
{
  • "note": "All service recalls completed."
}
Response samples 
application/json
{
  • "id": "47827b28-008a-46f2-88e1-bf286df33842",
  • "createdBy": "John Collins",
  • "createdDate": "2020-04-20T00:00:00Z",
  • "modifiedBy": "Sam Johnson",
  • "modifiedDate": "2020-05-20T00:00:00Z",
  • "note": "All service recalls completed."
}