Table of Contents

What's New

GET /Modules/WM/ProposedWorkOrders/Batches

Get a collection of Proposed Work Order resources.

DELETE /Modules/WM/ProposedWorkOrders/Batches/{id}

Delete an existing Proposed Work Order resource.

DELETE /Modules/WM/ProposedWorkOrders/Batches/Batch

Delete a collection of existing Proposed Work Order resources.

DELETE /Modules/WM/ProposedWorkOrders/Batches/All

Delete All Proposed Work Order Batches.

GET /Modules/WM/WorkOrders/Lookups/LookupWorkOrderPhone1Type

Lookup the Phone Number Type for the Work Order.

GET /Modules/WM/WorkOrders/Lookups/LookupWorkOrderPhone2Type

Lookup the Phone Number Type for the Work Order.

GET /Modules/WM/WorkRequests/{id}

Get a Work Request resource.

PATCH /Modules/WM/WorkRequests/{id}

Update an existing Work Request resource.

GET /Modules/WM/WorkRequests

Get a collection of Work Request resources.

POST /Modules/WM/WorkRequests

Create a new Work Request resource.

GET /Modules/WM/WorkRequests/Lookups/LookupWorkRequestAsset

Lookup the Asset for the Work Request.

GET /Modules/WM/WorkRequests/Lookups/LookupWorkRequestChangePermissionTree

Lookup the permission set for changing the Work Request.

GET /Modules/WM/WorkRequests/Lookups/LookupWorkRequestFailedComponent

Lookup the Asset Component for the Work Request.

GET /Modules/WM/WorkRequests/Lookups/LookupWorkRequestInsertPermissionTree

Lookup the permission set for creating the Work Request.

GET /Modules/WM/WorkRequests/Lookups/LookupWorkRequestPhone1Type

Lookup the Phone Number Type for the Work Request.

GET /Modules/WM/WorkRequests/Lookups/LookupWorkRequestPhone2Type

Lookup the Phone Number Type for the Work Request.

GET /Modules/WM/WorkRequests/Lookups/LookupWorkRequestResponsibleSection

Lookup the Section for the Work Request.

GET /Modules/WM/WorkRequests/Lookups/LookupWorkRequestResponsibleStaffMember

Lookup up the Staff Member for the Work Request

GET /Modules/WM/WorkRequests/Lookups/LookupWorkRequestSite

Lookup the Site for the Work Request.

GET /Modules/WM/WorkRequests/Lookups/LookupWorkRequestStatus

Lookup the Work Request Status for the Work Request.

GET /Modules/WM/WorkRequests/Lookups/LookupWorkRequestWorkOrderAsset

Lookup the Asset for the Work Request.

GET /Modules/WM/WorkRequests/Lookups/LookupWorkRequestWorkOrderCostCentre

Lookup the Cost Centre for the Work Request.

GET /Modules/WM/WorkRequests/Lookups/LookupWorkRequestWorkOrderFailedComponent

Lookup the Regular Asset Component for the Work Request.

GET /Modules/WM/WorkRequests/Lookups/LookupWorkRequestWorkOrderGeneralLedger

Lookup the General Ledger for the Work Request.

GET /Modules/WM/WorkRequests/Lookups/LookupWorkRequestWorkOrder

Lookup the Work Order for the Work Request.

GET /Modules/WM/WorkRequests/Lookups/LookupWorkRequestWorkOrderSection

Lookup the Section for the Work Request.

GET /Modules/WM/WorkRequests/Lookups/LookupWorkRequestWorkOrderSite

Lookup the Site for the Work Request.

GET /Modules/WM/WorkRequests/Lookups/LookupWorkRequestWorkOrderStaffMember

Lookup the Resource for the Work Request.

GET /Modules/WM/WorkRequests/Lookups/LookupWorkRequestWorkOrderTrade

Lookup the Trade for the Work Request.

GET /Modules/WM/WorkRequests/Lookups/LookupWorkRequestWorkOrderTypeOfWork

Lookup the Type of Work for the Work Request.

GET /Modules/WM/WorkRequests/Batch/{ids}

Get a collection of Work Request resources for the set of id's.

POST /Modules/WM/WorkRequests/Batch

Create a new collection of Work Request resources.

PATCH /Modules/WM/WorkRequests/Batch

Update a collection of existing Work Request resources.

PATCH /Modules/WM/WorkRequests/{id}/PermissionTree

Change the PermissionTree for an existing Work Request resource.

POST /Modules/WM/WorkRequests/CreateWorkOrder

Create Work Order for Work Requests.

POST /Modules/WM/WorkRequests/LinkWorkOrder

Link work order.

POST /Modules/WM/WorkRequests/Status/Batch

Change the status for a collection of Work Request resources

POST /Modules/WM/WorkRequests/Status

Change the status for the Work Request resource

PATCH /Modules/WM/WorkRequests/Batch/PermissionTree

Change the PermissionTree status for a collection of existing Work Request resources.

GET /Modules/WM/WorkRequests/Attributes/{id}

Get a Work Request Attribute resource.

DELETE /Modules/WM/WorkRequests/Attributes/{id}

Delete an existing Work Request Attribute resource.

PATCH /Modules/WM/WorkRequests/Attributes/{id}

Update an existing Work Request Attribute resource.

GET /Modules/WM/WorkRequests/{workRequestId}/Attributes

Get a collection of Work Request Attribute resources for the Work Request.

GET /Modules/WM/WorkRequests/Attributes

Get a collection of Work Request Attribute resources.

POST /Modules/WM/WorkRequests/Attributes

Create a new Work Request Attribute resource.

GET /Modules/WM/WorkRequests/Attributes/Lookups/LookupWorkRequestAttributeAllowedValue

Lookup the Attribute Allowed Value for the Work Request Attribute.

GET /Modules/WM/WorkRequests/Attributes/Lookups/LookupWorkRequestAttribute

Work Request Attribute

GET /Modules/WM/WorkRequests/Attributes/Lookups/LookupWorkRequestAttributeChangePermissionTree

Lookup the permission set for changing the Work Request Attribute.

GET /Modules/WM/WorkRequests/Attributes/Lookups/LookupWorkRequestAttributeInsertPermissionTree

Lookup the permission set for creating the Work Request Attribute.

GET /Modules/WM/WorkRequests/Attributes/Lookups/LookupWorkRequestAttributeWorkRequest

Lookup the Work Request Attribute for the Work Request Attribute.

GET /Modules/WM/WorkRequests/Attributes/Batch/{ids}

Get a collection of Work Request Attribute resources for the set of id's.

POST /Modules/WM/WorkRequests/Attributes/Batch

Create a new collection of Work Request Attribute resources.

DELETE /Modules/WM/WorkRequests/Attributes/Batch

Delete a collection of existing Work Request Attribute resources.

PATCH /Modules/WM/WorkRequests/Attributes/Batch

Update a collection of existing Work Request Attribute resources.

PATCH /Modules/WM/WorkRequests/Attributes/{id}/Active

Change the IsActive status for an existing Work Request Attribute resource.

PATCH /Modules/WM/WorkRequests/Attributes/{id}/PermissionTree

Change the PermissionTree for an existing Work Request Attribute resource.

PATCH /Modules/WM/WorkRequests/Attributes/Batch/PermissionTree

Change the PermissionTree status for a collection of existing Work Request Attribute resources.

PATCH /Modules/WM/WorkRequests/Attributes/Batch/Active

Change the IsActive status for a collection of existing Work Request Attribute resources.

GET /Modules/WM/WorkRequestStatuses/{id}

Get a Work Request Status resource.

DELETE /Modules/WM/WorkRequestStatuses/{id}

Delete an existing Work Request Status resource.

PATCH /Modules/WM/WorkRequestStatuses/{id}

Update an existing Work Request Status resource.

GET /Modules/WM/WorkRequestStatuses

Get a collection of Work Request Status resources.

POST /Modules/WM/WorkRequestStatuses

Create a new Work Request Status resource.

GET /Modules/WM/WorkRequestStatuses/Lookups/LookupWorkRequestStatusChangePermissionTree

Lookup the permission set for changing the Work Request Status.

GET /Modules/WM/WorkRequestStatuses/Lookups/LookupWorkRequestStatusInsertPermissionTree

Lookup the permission set for creating the Work Request Status.

GET /Modules/WM/WorkRequestStatuses/Batch/{ids}

Get a collection of Work Request Status resources for the set of id's.

POST /Modules/WM/WorkRequestStatuses/Batch

Create a new collection of Work Request Status resources.

DELETE /Modules/WM/WorkRequestStatuses/Batch

Delete a collection of existing Work Request Status resources.

PATCH /Modules/WM/WorkRequestStatuses/Batch

Update a collection of existing Work Request Status resources.

PATCH /Modules/WM/WorkRequestStatuses/{id}/Active

Change the IsActive status for an existing Work Request Status resource.

PATCH /Modules/WM/WorkRequestStatuses/{id}/PermissionTree

Change the PermissionTree for an existing Work Request Status resource.

PATCH /Modules/WM/WorkRequestStatuses/Batch/Active

Change the IsActive status for a collection of existing Work Request Status resources.

PATCH /Modules/WM/WorkRequestStatuses/Batch/PermissionTree

Change the PermissionTree status for a collection of existing Work Request Status resources.

GET /Modules/WM/WorkRequests/StatusChangeHistory/{id}

Get a Work Request Status Change History resource.

GET /Modules/WM/WorkRequests/StatusChangeHistory

Get a collection of Work Request Status Change History resources.

GET /Modules/WM/WorkRequests/{workRequestId}/StatusChangeHistory

Get a collection of Work Request Status Change History resources for the Work Request.

GET /Modules/WM/WorkRequests/StatusChangeHistory/Batch/{ids}

Get a collection of Work Request Status Change History resources for the set of id's.

What's Changed

GET /Modules/WM/DueTasks/{id}
Return Type:

Changed response : 200 OK

Success response - body contains Due Task

  • Changed content type : application/vnd.onkey.entity+json

    • Changed property properties (object)

      • Added property outOfBoundsTask (boolean)
GET /Modules/WM/DueTasks
Return Type:

Changed response : 200 OK

Success response - body contains pageable Due Task collection

  • Changed content type : application/vnd.onkey.entitycollectionpage+json

    • Changed property items (array)

      Pageable collection of entities

      Changed items (object):

      • Changed property properties (object)

        • Added property outOfBoundsTask (boolean)
GET /Modules/WM/DueTasks/Batch/{ids}
Return Type:

Changed response : 200 OK

Success response - body contains Due Task collection

  • Changed content type : application/vnd.onkey.entitycollection+json

    • Changed property items (array)

      Collection of Due Task entities

      Changed items (object):

      • Changed property properties (object)

        • Added property outOfBoundsTask (boolean)
GET /Modules/WM/WorkOrders/{id}
Return Type:

Changed response : 200 OK

Success response - body contains Work Order

  • Changed content type : application/vnd.onkey.entity+json

    • Changed property properties (object)

      • Added property autoCalculateEstimatedDowntime (boolean)

      • Added property autoCalculateEstimatedDuration (boolean)

      • Added property phone1 (string)

      • Added property phone2 (string)

      • Added property phone1TypeId (integer)

      • Added property phone1TypeCode (string)

      • Added property phone1TypeDescription (string)

      • Added property phone2TypeId (integer)

      • Added property phone2TypeCode (string)

      • Added property phone2TypeDescription (string)

      • Deleted property phone (string)

GET /Modules/WM/WorkOrders
Return Type:

Changed response : 200 OK

Success response - body contains pageable Work Order collection

  • Changed content type : application/vnd.onkey.entitycollectionpage+json

    • Changed property items (array)

      Pageable collection of entities

      Changed items (object):

      • Changed property properties (object)

        • Added property phone1 (string)

        • Added property phone1TypeId (integer)

        • Added property phone1TypeCode (string)

        • Added property phone1TypeDescription (string)

        • Added property phone2 (string)

        • Added property phone2TypeId (integer)

        • Added property phone2TypeCode (string)

        • Added property phone2TypeDescription (string)

        • Deleted property phone (string)

POST /Modules/WM/WorkOrders
Request:

Changed content type : application/vnd.onkey.entity+json

  • Changed property properties (object)

    • Added property autoCalculateEstimatedDowntime (boolean)

    • Added property autoCalculateEstimatedDuration (boolean)

    • Added property phone1 (string)

    • Added property phone2 (string)

    • Added property phone1TypeId (integer)

    • Added property phone2TypeId (integer)

    • Deleted property phone (string)

GET /Modules/WM/WorkOrders/Batch/{ids}
Return Type:

Changed response : 200 OK

Success response - body contains Work Order collection

  • Changed content type : application/vnd.onkey.entitycollection+json

    • Changed property items (array)

      Collection of Work Order entities

      Changed items (object):

      • Changed property properties (object)

        • Added property autoCalculateEstimatedDowntime (boolean)

        • Added property autoCalculateEstimatedDuration (boolean)

        • Added property phone1 (string)

        • Added property phone2 (string)

        • Added property phone1TypeId (integer)

        • Added property phone1TypeCode (string)

        • Added property phone1TypeDescription (string)

        • Added property phone2TypeId (integer)

        • Added property phone2TypeCode (string)

        • Added property phone2TypeDescription (string)

        • Deleted property phone (string)

POST /Modules/WM/WorkOrders/Batch
Request:

Changed content type : application/vnd.onkey.entitycollection+json

Changed items (object):

  • Changed property properties (object)

    • Added property autoCalculateEstimatedDowntime (boolean)

    • Added property autoCalculateEstimatedDuration (boolean)

    • Added property phone1 (string)

    • Added property phone2 (string)

    • Added property phone1TypeId (integer)

    • Added property phone2TypeId (integer)

    • Deleted property phone (string)