API Catalog

Retrieve PRM Work Orders By Code

25 Sep 2024
6 Minutes to read

Print
Dark
Light

Retrieve PRM Work Orders By Code

Updated on 25 Sep 2024
6 Minutes to read

Print
Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/prm-rest-api/rest/1/prmworkorder

Query Standards

Finder

Following row finders are available for data filtering and optimizing request performance.

Select By Code
Select By Date
By UUID

Select By Code

Recommended finder parameters. Refer to Query Parameters for example.

Parameter	Description	Sample
workOrderCode	Work Order Code	WO.00030
compCode	Company Code	001

Select By Date

This is an optional finder for querying PRM Work Orders by Audit Date.

Parameter	Description	Sample
AuditDate	Create or Update Date Time Filter	2015-01-01

By UUID

This is an optional finder for querying a specific PRM Work Order by row ID.

Parameter	Description	Sample
/VUUID	The VUuid attribute is the Unique row ID	/prm-rest-api/rest/1/prmworkorder/D21723A19CE95650E05316821FACB6B7

Security

HTTP

Type basic

Basic authentication

Query parameters

finder

string

ExampleselectByCode;workOrderCode=WO.00030, compCode=001

limit

integer

Example500

offset

integer

Example0

totalResults

boolean

Exampletrue

orderBy

string

ExampleWoVUuid:desc

Responses

200

Headers

Content-Type

string

Exampleapplication/vnd.oracle.adf.resourcecollection+json

example-0

Successful Response - Finder - selectByCode

{
  "items": [
    {
      "WoCompCode": "001",
      "WoCompName": "CMiC Construction Inc",
      "WoCode": "WO.00030",
      "WoNumber": 30,
      "WoDescription": "Safety Line Repair",
      "WoType": "J",
      "WoCostingType": "T",
      "WoBillingType": "N",
      "WoStatus": "C",
      "WoShopWoFlag": null,
      "WoPriorityNumber": 3,
      "WoReceivedDateTime": "2016-02-05",
      "WoReqStartDateTime": null,
      "WoReqEndDateTime": null,
      "WoDispatchedDateTime": null,
      "WoStartDateTime": null,
      "WoCompletionDateTime": null,
      "WoComments": null,
      "WoClass1": null,
      "WoClass2": null,
      "WoClass3": null,
      "WoClass4": null,
      "WoNormalBillRate": null,
      "WoOtBillRate": null,
      "WoDotBillRate": null,
      "WoPrintCounter": 0,
      "WoMteamCode": null,
      "WoCreatedBy": "ADWAIT",
      "WoDateCreated": "2016-02-05T04:04:39Z",
      "WoModifiedBy": "ADWAIT",
      "WoDateModified": "2017-01-30T07:15:03Z",
      "WoTranType": "J",
      "WoCostCompCode": "001",
      "WoCostCompName": "CMiC Construction Inc",
      "WoCostDeptCode": "080",
      "WoCostDeptName": "Support Services",
      "WoVendorCode": null,
      "WoTitle": "Safety Line Repair",
      "WoDeptCode": "080",
      "WoDeptName": "Support Services",
      "WoCostJobCode": "WO.00030",
      "WoCostJobName": "Safety Line Repair",
      "WoCustCode": "KAISER",
      "WoCustName": "Kaiser Permanente",
      "WoBillAmt": null,
      "WoAppTypeCode": "CRM",
      "WoIssueId": null,
      "WoDmLocCode": null,
      "WoBillingRateTableCode": "WORKORDERS",
      "WoInvoiceFormat": "WO",
      "WoClvValueCode1": null,
      "WoClvValueCode2": null,
      "WoClvValueCode3": null,
      "WoClvValueCode4": null,
      "WoClvValueCode5": null,
      "WoClvValueCode6": null,
      "WoEntry2Flag": "N",
      "WoUserField1": "WO.00030",
      "WoReceivedTimeHh": "12",
      "WoReceivedTimeMi": "00",
      "WoReceivedTimeAmPm": "AM",
      "WoIuCreateDate": "2016-02-05T04:04:39Z",
      "WoIuCreateUser": "ADWAIT",
      "WoIuUpdateDate": "2017-01-30T07:15:03Z",
      "WoIuUpdateUser": "ADWAIT",
      "WoVUuid": "D21723A19CE95650E05316821FACB6B7",
      "WoEqpCode": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/prm-rest-api/rest/1/prmworkorder/D21723A19CE95650E05316821FACB6B7",
          "name": "prmworkorder",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/prm-rest-api/rest/1/prmworkorder/D21723A19CE95650E05316821FACB6B7",
          "name": "prmworkorder",
          "kind": "item"
        },
        {
          "rel": "child",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/prm-rest-api/rest/1/prmworkorder/D21723A19CE95650E05316821FACB6B7/child/PrmWorkItemViewObj",
          "name": "PrmWorkItemViewObj",
          "kind": "collection"
        }
      ]
    }
  ],
  "count": 1,
  "hasMore": false,
  "limit": 5,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/prm-rest-api/rest/1/prmworkorder",
      "name": "prmworkorder",
      "kind": "collection"
    }
  ]
}

example-1

Successful Response - Finder - selectByDate

{
  "items": [
    {
      "WoCompCode": "001",
      "WoCompName": "CMiC Construction Inc",
      "WoCode": "WOYY.0051",
      "WoNumber": 51,
      "WoDescription": "CMiC Maintenance Contract",
      "WoType": "J",
      "WoCostingType": "T",
      "WoBillingType": "N",
      "WoStatus": "S",
      "WoShopWoFlag": null,
      "WoPriorityNumber": 3,
      "WoReceivedDateTime": "2020-08-10",
      "WoReqStartDateTime": null,
      "WoReqEndDateTime": null,
      "WoDispatchedDateTime": null,
      "WoStartDateTime": null,
      "WoCompletionDateTime": null,
      "WoComments": null,
      "WoClass1": null,
      "WoClass2": null,
      "WoClass3": null,
      "WoClass4": null,
      "WoNormalBillRate": null,
      "WoOtBillRate": null,
      "WoDotBillRate": null,
      "WoPrintCounter": 0,
      "WoMteamCode": null,
      "WoCreatedBy": "CANDICE",
      "WoDateCreated": "2020-08-10T05:55:41Z",
      "WoModifiedBy": "CANDICE",
      "WoDateModified": "2020-08-10T05:55:41Z",
      "WoTranType": "J",
      "WoCostCompCode": "001",
      "WoCostCompName": "CMiC Construction Inc",
      "WoCostDeptCode": "00",
      "WoCostDeptName": "Company Level",
      "WoVendorCode": null,
      "WoTitle": "CMiC Maintenance",
      "WoDeptCode": "00",
      "WoDeptName": "Company Level",
      "WoCostJobCode": "WOYY.0051",
      "WoCostJobName": "CMiC Maintenance",
      "WoCustCode": "0588-11-01T12:00:00Z",
      "WoCustName": "Minto Group Ltd",
      "WoBillAmt": null,
      "WoAppTypeCode": "CRM",
      "WoIssueId": null,
      "WoDmLocCode": "CA",
      "WoBillingRateTableCode": "WORKORDERS",
      "WoInvoiceFormat": "WO",
      "WoClvValueCode1": null,
      "WoClvValueCode2": null,
      "WoClvValueCode3": null,
      "WoClvValueCode4": null,
      "WoClvValueCode5": null,
      "WoClvValueCode6": null,
      "WoEntry2Flag": "Y",
      "WoUserField1": "WOYY.0051",
      "WoReceivedTimeHh": "12",
      "WoReceivedTimeMi": "00",
      "WoReceivedTimeAmPm": "AM",
      "WoIuCreateDate": "2020-08-10T05:55:41Z",
      "WoIuCreateUser": "CANDICE",
      "WoIuUpdateDate": "2020-08-10T05:55:41Z",
      "WoIuUpdateUser": "CANDICE",
      "WoVUuid": "D21723A1A6CD5650E05316821FACB6B7",
      "WoEqpCode": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/prm-rest-api/rest/1/prmworkorder/D21723A1A6CD5650E05316821FACB6B7",
          "name": "prmworkorder",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/prm-rest-api/rest/1/prmworkorder/D21723A1A6CD5650E05316821FACB6B7",
          "name": "prmworkorder",
          "kind": "item"
        },
        {
          "rel": "child",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/prm-rest-api/rest/1/prmworkorder/D21723A1A6CD5650E05316821FACB6B7/child/PrmWorkItemViewObj",
          "name": "PrmWorkItemViewObj",
          "kind": "collection"
        }
      ]
    },
    {
      "WoCompCode": "001",
      "WoCompName": "CMiC Construction Inc",
      "WoCode": "WOYY.0053",
      "WoNumber": 53,
      "WoDescription": "CMiC Maintenance III",
      "WoType": "J",
      "WoCostingType": "T",
      "WoBillingType": "N",
      "WoStatus": "S",
      "WoShopWoFlag": null,
      "WoPriorityNumber": 3,
      "WoReceivedDateTime": "2020-08-11",
      "WoReqStartDateTime": null,
      "WoReqEndDateTime": null,
      "WoDispatchedDateTime": null,
      "WoStartDateTime": null,
      "WoCompletionDateTime": null,
      "WoComments": null,
      "WoClass1": null,
      "WoClass2": null,
      "WoClass3": null,
      "WoClass4": null,
      "WoNormalBillRate": null,
      "WoOtBillRate": null,
      "WoDotBillRate": null,
      "WoPrintCounter": 0,
      "WoMteamCode": null,
      "WoCreatedBy": "CANDICE",
      "WoDateCreated": "2020-08-11T03:58:48Z",
      "WoModifiedBy": "CANDICE",
      "WoDateModified": "2020-08-11T03:58:48Z",
      "WoTranType": "J",
      "WoCostCompCode": "001",
      "WoCostCompName": "CMiC Construction Inc",
      "WoCostDeptCode": "00",
      "WoCostDeptName": "Company Level",
      "WoVendorCode": null,
      "WoTitle": "CMiC Maintenance III",
      "WoDeptCode": "00",
      "WoDeptName": "Company Level",
      "WoCostJobCode": "WOYY.0053",
      "WoCostJobName": "CMiC Maintenance III",
      "WoCustCode": "0588-11-01T12:00:00Z",
      "WoCustName": "Minto Group Ltd",
      "WoBillAmt": null,
      "WoAppTypeCode": "CRM",
      "WoIssueId": null,
      "WoDmLocCode": "CA",
      "WoBillingRateTableCode": "WORKORDERS",
      "WoInvoiceFormat": "WO",
      "WoClvValueCode1": null,
      "WoClvValueCode2": null,
      "WoClvValueCode3": null,
      "WoClvValueCode4": null,
      "WoClvValueCode5": null,
      "WoClvValueCode6": null,
      "WoEntry2Flag": "Y",
      "WoUserField1": "WOYY.0053",
      "WoReceivedTimeHh": "12",
      "WoReceivedTimeMi": "00",
      "WoReceivedTimeAmPm": "AM",
      "WoIuCreateDate": "2020-08-11T03:58:48Z",
      "WoIuCreateUser": "CANDICE",
      "WoIuUpdateDate": "2020-08-11T03:58:48Z",
      "WoIuUpdateUser": "CANDICE",
      "WoVUuid": "D21723A1A7F25650E05316821FACB6B7",
      "WoEqpCode": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/prm-rest-api/rest/1/prmworkorder/D21723A1A7F25650E05316821FACB6B7",
          "name": "prmworkorder",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/prm-rest-api/rest/1/prmworkorder/D21723A1A7F25650E05316821FACB6B7",
          "name": "prmworkorder",
          "kind": "item"
        },
        {
          "rel": "child",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/prm-rest-api/rest/1/prmworkorder/D21723A1A7F25650E05316821FACB6B7/child/PrmWorkItemViewObj",
          "name": "PrmWorkItemViewObj",
          "kind": "collection"
        }
      ]
    },
    {
      "WoCompCode": "001",
      "WoCompName": "CMiC Construction Inc",
      "WoCode": "WO18.0049",
      "WoNumber": 49,
      "WoDescription": "AMSI TEST",
      "WoType": "J",
      "WoCostingType": "T",
      "WoBillingType": "N",
      "WoStatus": "S",
      "WoShopWoFlag": null,
      "WoPriorityNumber": 3,
      "WoReceivedDateTime": "2018-11-30",
      "WoReqStartDateTime": null,
      "WoReqEndDateTime": null,
      "WoDispatchedDateTime": null,
      "WoStartDateTime": null,
      "WoCompletionDateTime": null,
      "WoComments": null,
      "WoClass1": null,
      "WoClass2": null,
      "WoClass3": null,
      "WoClass4": null,
      "WoNormalBillRate": null,
      "WoOtBillRate": null,
      "WoDotBillRate": null,
      "WoPrintCounter": 0,
      "WoMteamCode": null,
      "WoCreatedBy": "MARKB",
      "WoDateCreated": "2018-11-30T03:59:39Z",
      "WoModifiedBy": "MARKB",
      "WoDateModified": "2018-11-30T04:03:47Z",
      "WoTranType": "J",
      "WoCostCompCode": "001",
      "WoCostCompName": "CMiC Construction Inc",
      "WoCostDeptCode": "00",
      "WoCostDeptName": "Company Level",
      "WoVendorCode": null,
      "WoTitle": "AMSI Test",
      "WoDeptCode": "00",
      "WoDeptName": "Company Level",
      "WoCostJobCode": "WO18.0049",
      "WoCostJobName": "AMSI Test",
      "WoCustCode": "0588-11-01T12:00:00Z",
      "WoCustName": "Minto Group Ltd",
      "WoBillAmt": null,
      "WoAppTypeCode": "CRM",
      "WoIssueId": null,
      "WoDmLocCode": null,
      "WoBillingRateTableCode": "WORKORDERS",
      "WoInvoiceFormat": "WO",
      "WoClvValueCode1": null,
      "WoClvValueCode2": null,
      "WoClvValueCode3": null,
      "WoClvValueCode4": null,
      "WoClvValueCode5": null,
      "WoClvValueCode6": null,
      "WoEntry2Flag": "Y",
      "WoUserField1": "WO18.0049",
      "WoReceivedTimeHh": "12",
      "WoReceivedTimeMi": "00",
      "WoReceivedTimeAmPm": "AM",
      "WoIuCreateDate": "2018-11-30T03:59:39Z",
      "WoIuCreateUser": "MARKB",
      "WoIuUpdateDate": "2018-11-30T04:03:47Z",
      "WoIuUpdateUser": "MARKB",
      "WoVUuid": "D21723A19D3F5650E05316821FACB6B7",
      "WoEqpCode": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/prm-rest-api/rest/1/prmworkorder/D21723A19D3F5650E05316821FACB6B7",
          "name": "prmworkorder",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/prm-rest-api/rest/1/prmworkorder/D21723A19D3F5650E05316821FACB6B7",
          "name": "prmworkorder",
          "kind": "item"
        },
        {
          "rel": "child",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/prm-rest-api/rest/1/prmworkorder/D21723A19D3F5650E05316821FACB6B7/child/PrmWorkItemViewObj",
          "name": "PrmWorkItemViewObj",
          "kind": "collection"
        }
      ]
    },
    {
      "WoCompCode": "001",
      "WoCompName": "CMiC Construction Inc",
      "WoCode": "WO18.0048",
      "WoNumber": 48,
      "WoDescription": "Test for AMSI",
      "WoType": "J",
      "WoCostingType": "T",
      "WoBillingType": "N",
      "WoStatus": "S",
      "WoShopWoFlag": null,
      "WoPriorityNumber": 3,
      "WoReceivedDateTime": "2018-11-30",
      "WoReqStartDateTime": null,
      "WoReqEndDateTime": null,
      "WoDispatchedDateTime": null,
      "WoStartDateTime": null,
      "WoCompletionDateTime": null,
      "WoComments": null,
      "WoClass1": null,
      "WoClass2": null,
      "WoClass3": null,
      "WoClass4": null,
      "WoNormalBillRate": null,
      "WoOtBillRate": null,
      "WoDotBillRate": null,
      "WoPrintCounter": 0,
      "WoMteamCode": null,
      "WoCreatedBy": "MARKB",
      "WoDateCreated": "2018-11-30T02:39:58Z",
      "WoModifiedBy": "MARKB",
      "WoDateModified": "2018-11-30T02:39:58Z",
      "WoTranType": "J",
      "WoCostCompCode": "001",
      "WoCostCompName": "CMiC Construction Inc",
      "WoCostDeptCode": "00",
      "WoCostDeptName": "Company Level",
      "WoVendorCode": null,
      "WoTitle": "Test for AMSI",
      "WoDeptCode": "00",
      "WoDeptName": "Company Level",
      "WoCostJobCode": "WO18.0048",
      "WoCostJobName": "Test for AMSI",
      "WoCustCode": "0588-11-01T12:00:00Z",
      "WoCustName": "Minto Group Ltd",
      "WoBillAmt": null,
      "WoAppTypeCode": "CRM",
      "WoIssueId": null,
      "WoDmLocCode": null,
      "WoBillingRateTableCode": "WORKORDERS",
      "WoInvoiceFormat": "WO",
      "WoClvValueCode1": null,
      "WoClvValueCode2": null,
      "WoClvValueCode3": null,
      "WoClvValueCode4": null,
      "WoClvValueCode5": null,
      "WoClvValueCode6": null,
      "WoEntry2Flag": "Y",
      "WoUserField1": "WO18.0048",
      "WoReceivedTimeHh": "12",
      "WoReceivedTimeMi": "00",
      "WoReceivedTimeAmPm": "AM",
      "WoIuCreateDate": "2018-11-30T02:39:58Z",
      "WoIuCreateUser": "MARKB",
      "WoIuUpdateDate": "2018-11-30T02:39:58Z",
      "WoIuUpdateUser": "MARKB",
      "WoVUuid": "D21723A19D495650E05316821FACB6B7",
      "WoEqpCode": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/prm-rest-api/rest/1/prmworkorder/D21723A19D495650E05316821FACB6B7",
          "name": "prmworkorder",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/prm-rest-api/rest/1/prmworkorder/D21723A19D495650E05316821FACB6B7",
          "name": "prmworkorder",
          "kind": "item"
        },
        {
          "rel": "child",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/prm-rest-api/rest/1/prmworkorder/D21723A19D495650E05316821FACB6B7/child/PrmWorkItemViewObj",
          "name": "PrmWorkItemViewObj",
          "kind": "collection"
        }
      ]
    },
    {
      "WoCompCode": "001",
      "WoCompName": "CMiC Construction Inc",
      "WoCode": "WO17.0045",
      "WoNumber": 45,
      "WoDescription": "work order maintenance",
      "WoType": "J",
      "WoCostingType": "T",
      "WoBillingType": "N",
      "WoStatus": "S",
      "WoShopWoFlag": null,
      "WoPriorityNumber": 3,
      "WoReceivedDateTime": "2017-07-10",
      "WoReqStartDateTime": null,
      "WoReqEndDateTime": null,
      "WoDispatchedDateTime": null,
      "WoStartDateTime": null,
      "WoCompletionDateTime": null,
      "WoComments": null,
      "WoClass1": null,
      "WoClass2": null,
      "WoClass3": null,
      "WoClass4": null,
      "WoNormalBillRate": null,
      "WoOtBillRate": null,
      "WoDotBillRate": null,
      "WoPrintCounter": 0,
      "WoMteamCode": null,
      "WoCreatedBy": "CANDICE",
      "WoDateCreated": "2017-07-10T08:36:00Z",
      "WoModifiedBy": "CANDICE",
      "WoDateModified": "2017-07-10T08:36:00Z",
      "WoTranType": "J",
      "WoCostCompCode": "001",
      "WoCostCompName": "CMiC Construction Inc",
      "WoCostDeptCode": "00",
      "WoCostDeptName": "Company Level",
      "WoVendorCode": null,
      "WoTitle": "wokr order 1",
      "WoDeptCode": "00",
      "WoDeptName": "Company Level",
      "WoCostJobCode": "WO17.0045",
      "WoCostJobName": "wokr order 1",
      "WoCustCode": "0588-11-01T12:00:00Z",
      "WoCustName": "Minto Group Ltd",
      "WoBillAmt": null,
      "WoAppTypeCode": "CRM",
      "WoIssueId": null,
      "WoDmLocCode": null,
      "WoBillingRateTableCode": "WORKORDERS",
      "WoInvoiceFormat": "WO",
      "WoClvValueCode1": null,
      "WoClvValueCode2": null,
      "WoClvValueCode3": null,
      "WoClvValueCode4": null,
      "WoClvValueCode5": null,
      "WoClvValueCode6": null,
      "WoEntry2Flag": "Y",
      "WoUserField1": "WO17.0045",
      "WoReceivedTimeHh": "12",
      "WoReceivedTimeMi": "00",
      "WoReceivedTimeAmPm": "AM",
      "WoIuCreateDate": "2017-07-10T08:36:00Z",
      "WoIuCreateUser": "CANDICE",
      "WoIuUpdateDate": "2017-07-10T08:36:00Z",
      "WoIuUpdateUser": "CANDICE",
      "WoVUuid": "D21723A19D8E5650E05316821FACB6B7",
      "WoEqpCode": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/prm-rest-api/rest/1/prmworkorder/D21723A19D8E5650E05316821FACB6B7",
          "name": "prmworkorder",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/prm-rest-api/rest/1/prmworkorder/D21723A19D8E5650E05316821FACB6B7",
          "name": "prmworkorder",
          "kind": "item"
        },
        {
          "rel": "child",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/prm-rest-api/rest/1/prmworkorder/D21723A19D8E5650E05316821FACB6B7/child/PrmWorkItemViewObj",
          "name": "PrmWorkItemViewObj",
          "kind": "collection"
        }
      ]
    }
  ],
  "count": 5,
  "hasMore": true,
  "limit": 5,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/prm-rest-api/rest/1/prmworkorder",
      "name": "prmworkorder",
      "kind": "collection"
    }
  ]
}

object

What's Next

Patch a PRM Work Order

Retrieve PRM Work Orders By Code

Query Standards

Finder

Select By Code

Select By Date

By UUID

What's Next

Contact Us