Retrieve Work Orders By Code
    • 04 Dec 2024
    • 6 Minutes to read
    • Dark
      Light

    Retrieve Work Orders By Code

    • Dark
      Light

    Article summary

    Get
    /prm-rest-api/rest/1/workorder

    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.

    ParameterDescriptionSample
    WorkOrderCodeWork Order CodeWO.00030
    CompCodeCompany Code001

    Select By Date

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

    ParameterDescriptionSample
    AuditDateCreate or Update Date Time Filter2015-06-01

    By UUID

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

    ParameterDescriptionSample
    /VUUIDThe VUuid attribute is the Unique row ID/prm-rest-api/rest/1/workorder/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

    OK

    Headers
    Content-Type
    string
    Exampleapplication/vnd.oracle.adf.resourcecollection+json
    example-0

    Successful Response - Finder - selectByDate

    {
      "items": [
        {
          "WoCompCode": "001",
          "WoCompName": "CMiC Construction Inc",
          "WoCode": "WO.18",
          "WoNumber": 18,
          "WoDescription": "Soil Removal",
          "WoType": "J",
          "WoCostingType": "T",
          "WoCostingTypeDesc": "Entered via transactions",
          "WoBillingType": "N",
          "WoBillingTypeDesc": "Not billed",
          "WoStatus": "C",
          "WoStatusDesc": "Closed",
          "WoShopWoFlag": null,
          "WoPriorityNumber": 3,
          "WoReceivedDateTime": "2015-10-30",
          "WoReceivedDate": "2015-10-30",
          "WoReceivedTime": "2024-12-04T12:00:00Z",
          "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": "2015-10-30T03:04:03Z",
          "WoModifiedBy": "ADWAIT",
          "WoDateModified": "2016-03-09T09:53:55Z",
          "WoTranType": "J",
          "WoCostCompCode": "001",
          "WoCostCompName": "CMiC Construction Inc",
          "WoCostDeptCode": "080",
          "WoCostDeptName": "Support Services",
          "WoVendorCode": null,
          "WoTitle": "Soil Removal",
          "WoDeptCode": "080",
          "WoCostJobCode": "WO.18",
          "WoCustCode": "KAISER",
          "WoCustName": "Kaiser Permanente",
          "WoBillAmt": null,
          "WoBillAmtFrmtd": null,
          "WoAppTypeCode": "CRM",
          "WoIssueId": null,
          "WoDmLocCode": null,
          "WoDmLocName": null,
          "WoJobBidFlag": "N",
          "WoProjCode": null,
          "WoProjName": null,
          "WoProjJobCode": null,
          "WoBillingRateTableCode": "WORKORDERS",
          "WoInvoiceFormat": "WO",
          "WoInvoiceFormatName": "Work Order Billing (Grp1 - Freeform)",
          "WoEntry2Flag": "N",
          "WoTax1Code": null,
          "WoTax2Code": null,
          "WoTax3Code": null,
          "WoFfPoNum": null,
          "WoAddrCode": null,
          "WoAddrTypeCode": null,
          "WoVUuid": "D21723A19CE45650E05316821FACB6B7",
          "WoIuCreateDate": "2015-10-30T03:04:03Z",
          "WoIuUpdateDate": "2016-03-09T09:53:55Z",
          "links": [
            {
              "rel": "self",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/prm-rest-api/rest/1/workorder/D21723A19CE45650E05316821FACB6B7",
              "name": "workorder",
              "kind": "item"
            },
            {
              "rel": "canonical",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/prm-rest-api/rest/1/workorder/D21723A19CE45650E05316821FACB6B7",
              "name": "workorder",
              "kind": "item"
            }
          ]
        },
        {
          "WoCompCode": "001",
          "WoCompName": "CMiC Construction Inc",
          "WoCode": "WO.20",
          "WoNumber": 20,
          "WoDescription": "Replace tiles in front lobby.",
          "WoType": "J",
          "WoCostingType": "T",
          "WoCostingTypeDesc": "Entered via transactions",
          "WoBillingType": "N",
          "WoBillingTypeDesc": "Not billed",
          "WoStatus": "C",
          "WoStatusDesc": "Closed",
          "WoShopWoFlag": null,
          "WoPriorityNumber": 3,
          "WoReceivedDateTime": "2015-11-09",
          "WoReceivedDate": "2015-11-09",
          "WoReceivedTime": "2024-12-04T12:00:00Z",
          "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": "BILL",
          "WoDateCreated": "2015-11-12T06:18:38Z",
          "WoModifiedBy": "ADWAIT",
          "WoDateModified": "2016-03-09T09:54:17Z",
          "WoTranType": "J",
          "WoCostCompCode": "001",
          "WoCostCompName": "CMiC Construction Inc",
          "WoCostDeptCode": "080",
          "WoCostDeptName": "Support Services",
          "WoVendorCode": null,
          "WoTitle": "Replace tiles in front lobby.",
          "WoDeptCode": "080",
          "WoCostJobCode": "WO.20",
          "WoCustCode": "KAISER",
          "WoCustName": "Kaiser Permanente",
          "WoBillAmt": null,
          "WoBillAmtFrmtd": null,
          "WoAppTypeCode": "CRM",
          "WoIssueId": null,
          "WoDmLocCode": null,
          "WoDmLocName": null,
          "WoJobBidFlag": "N",
          "WoProjCode": null,
          "WoProjName": null,
          "WoProjJobCode": null,
          "WoBillingRateTableCode": "WORKORDERS",
          "WoInvoiceFormat": "WO",
          "WoInvoiceFormatName": "Work Order Billing (Grp1 - Freeform)",
          "WoEntry2Flag": "N",
          "WoTax1Code": null,
          "WoTax2Code": null,
          "WoTax3Code": null,
          "WoFfPoNum": null,
          "WoAddrCode": null,
          "WoAddrTypeCode": null,
          "WoVUuid": "D21723A19CE55650E05316821FACB6B7",
          "WoIuCreateDate": "2015-11-12T06:18:38Z",
          "WoIuUpdateDate": "2016-03-09T09:54:17Z",
          "links": [
            {
              "rel": "self",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/prm-rest-api/rest/1/workorder/D21723A19CE55650E05316821FACB6B7",
              "name": "workorder",
              "kind": "item"
            },
            {
              "rel": "canonical",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/prm-rest-api/rest/1/workorder/D21723A19CE55650E05316821FACB6B7",
              "name": "workorder",
              "kind": "item"
            }
          ]
        },
        {
          "WoCompCode": "001",
          "WoCompName": "CMiC Construction Inc",
          "WoCode": "WO.00030",
          "WoNumber": 30,
          "WoDescription": "Safety Line Repair",
          "WoType": "J",
          "WoCostingType": "T",
          "WoCostingTypeDesc": "Entered via transactions",
          "WoBillingType": "N",
          "WoBillingTypeDesc": "Not billed",
          "WoStatus": "C",
          "WoStatusDesc": "Closed",
          "WoShopWoFlag": null,
          "WoPriorityNumber": 3,
          "WoReceivedDateTime": "2016-02-05",
          "WoReceivedDate": "2016-02-05",
          "WoReceivedTime": "2024-12-04T12:00:00Z",
          "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",
          "WoCostJobCode": "WO.00030",
          "WoCustCode": "KAISER",
          "WoCustName": "Kaiser Permanente",
          "WoBillAmt": null,
          "WoBillAmtFrmtd": null,
          "WoAppTypeCode": "CRM",
          "WoIssueId": null,
          "WoDmLocCode": null,
          "WoDmLocName": null,
          "WoJobBidFlag": "N",
          "WoProjCode": null,
          "WoProjName": null,
          "WoProjJobCode": null,
          "WoBillingRateTableCode": "WORKORDERS",
          "WoInvoiceFormat": "WO",
          "WoInvoiceFormatName": "Work Order Billing (Grp1 - Freeform)",
          "WoEntry2Flag": "N",
          "WoTax1Code": null,
          "WoTax2Code": null,
          "WoTax3Code": null,
          "WoFfPoNum": null,
          "WoAddrCode": null,
          "WoAddrTypeCode": null,
          "WoVUuid": "D21723A19CE95650E05316821FACB6B7",
          "WoIuCreateDate": "2016-02-05T04:04:39Z",
          "WoIuUpdateDate": "2017-01-30T07:15:03Z",
          "links": [
            {
              "rel": "self",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/prm-rest-api/rest/1/workorder/D21723A19CE95650E05316821FACB6B7",
              "name": "workorder",
              "kind": "item"
            },
            {
              "rel": "canonical",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/prm-rest-api/rest/1/workorder/D21723A19CE95650E05316821FACB6B7",
              "name": "workorder",
              "kind": "item"
            }
          ]
        },
        {
          "WoCompCode": "001",
          "WoCompName": "CMiC Construction Inc",
          "WoCode": "WO.00034",
          "WoNumber": 34,
          "WoDescription": "Fix Broken Window - Room 1A",
          "WoType": "J",
          "WoCostingType": "T",
          "WoCostingTypeDesc": "Entered via transactions",
          "WoBillingType": "N",
          "WoBillingTypeDesc": "Not billed",
          "WoStatus": "C",
          "WoStatusDesc": "Closed",
          "WoShopWoFlag": null,
          "WoPriorityNumber": 3,
          "WoReceivedDateTime": "2016-02-01",
          "WoReceivedDate": "2016-02-01",
          "WoReceivedTime": "2024-12-04T12:00:00Z",
          "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-25T02:15:26Z",
          "WoModifiedBy": "ADWAIT",
          "WoDateModified": "2017-01-30T07:15:03Z",
          "WoTranType": "J",
          "WoCostCompCode": "001",
          "WoCostCompName": "CMiC Construction Inc",
          "WoCostDeptCode": "080",
          "WoCostDeptName": "Support Services",
          "WoVendorCode": null,
          "WoTitle": "Fix Broken Window - Room 1A",
          "WoDeptCode": "080",
          "WoCostJobCode": "WO.00034",
          "WoCustCode": "KAISER",
          "WoCustName": "Kaiser Permanente",
          "WoBillAmt": null,
          "WoBillAmtFrmtd": null,
          "WoAppTypeCode": "CRM",
          "WoIssueId": null,
          "WoDmLocCode": null,
          "WoDmLocName": null,
          "WoJobBidFlag": "N",
          "WoProjCode": null,
          "WoProjName": null,
          "WoProjJobCode": null,
          "WoBillingRateTableCode": "WORKORDERS",
          "WoInvoiceFormat": "WO",
          "WoInvoiceFormatName": "Work Order Billing (Grp1 - Freeform)",
          "WoEntry2Flag": "N",
          "WoTax1Code": null,
          "WoTax2Code": null,
          "WoTax3Code": null,
          "WoFfPoNum": null,
          "WoAddrCode": null,
          "WoAddrTypeCode": null,
          "WoVUuid": "D21723A19CEB5650E05316821FACB6B7",
          "WoIuCreateDate": "2016-02-25T02:15:26Z",
          "WoIuUpdateDate": "2017-01-30T07:15:03Z",
          "links": [
            {
              "rel": "self",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/prm-rest-api/rest/1/workorder/D21723A19CEB5650E05316821FACB6B7",
              "name": "workorder",
              "kind": "item"
            },
            {
              "rel": "canonical",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/prm-rest-api/rest/1/workorder/D21723A19CEB5650E05316821FACB6B7",
              "name": "workorder",
              "kind": "item"
            }
          ]
        },
        {
          "WoCompCode": "001",
          "WoCompName": "CMiC Construction Inc",
          "WoCode": "WO.00036",
          "WoNumber": 36,
          "WoDescription": "Enviromental Dig",
          "WoType": "J",
          "WoCostingType": "T",
          "WoCostingTypeDesc": "Entered via transactions",
          "WoBillingType": "N",
          "WoBillingTypeDesc": "Not billed",
          "WoStatus": "C",
          "WoStatusDesc": "Closed",
          "WoShopWoFlag": null,
          "WoPriorityNumber": 3,
          "WoReceivedDateTime": "2016-02-29",
          "WoReceivedDate": "2016-02-29",
          "WoReceivedTime": "2024-12-04T12:00:00Z",
          "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-29T08:25:18Z",
          "WoModifiedBy": "ADWAIT",
          "WoDateModified": "2017-01-30T07:15:03Z",
          "WoTranType": "J",
          "WoCostCompCode": "001",
          "WoCostCompName": "CMiC Construction Inc",
          "WoCostDeptCode": "080",
          "WoCostDeptName": "Support Services",
          "WoVendorCode": null,
          "WoTitle": "Enviromental Dig",
          "WoDeptCode": "080",
          "WoCostJobCode": "WO.00036",
          "WoCustCode": "KAISER",
          "WoCustName": "Kaiser Permanente",
          "WoBillAmt": null,
          "WoBillAmtFrmtd": null,
          "WoAppTypeCode": "CRM",
          "WoIssueId": null,
          "WoDmLocCode": null,
          "WoDmLocName": null,
          "WoJobBidFlag": "N",
          "WoProjCode": null,
          "WoProjName": null,
          "WoProjJobCode": null,
          "WoBillingRateTableCode": "WORKORDERS",
          "WoInvoiceFormat": "WO",
          "WoInvoiceFormatName": "Work Order Billing (Grp1 - Freeform)",
          "WoEntry2Flag": "N",
          "WoTax1Code": null,
          "WoTax2Code": null,
          "WoTax3Code": null,
          "WoFfPoNum": null,
          "WoAddrCode": null,
          "WoAddrTypeCode": null,
          "WoVUuid": "D21723A19CEC5650E05316821FACB6B7",
          "WoIuCreateDate": "2016-02-29T08:25:18Z",
          "WoIuUpdateDate": "2017-01-30T07:15:03Z",
          "links": [
            {
              "rel": "self",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/prm-rest-api/rest/1/workorder/D21723A19CEC5650E05316821FACB6B7",
              "name": "workorder",
              "kind": "item"
            },
            {
              "rel": "canonical",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/prm-rest-api/rest/1/workorder/D21723A19CEC5650E05316821FACB6B7",
              "name": "workorder",
              "kind": "item"
            }
          ]
        }
      ],
      "count": 5,
      "hasMore": true,
      "limit": 5,
      "offset": 0,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/prm-rest-api/rest/1/workorder",
          "name": "workorder",
          "kind": "collection"
        }
      ]
    }
    example-1

    Successful Response - Finder - selectByCode

    {
      "items": [
        {
          "WoCompCode": "001",
          "WoCompName": "CMiC Construction Inc",
          "WoCode": "WO.00030",
          "WoNumber": 30,
          "WoDescription": "Safety Line Repair",
          "WoType": "J",
          "WoCostingType": "T",
          "WoCostingTypeDesc": "Entered via transactions",
          "WoBillingType": "N",
          "WoBillingTypeDesc": "Not billed",
          "WoStatus": "C",
          "WoStatusDesc": "Closed",
          "WoShopWoFlag": null,
          "WoPriorityNumber": 3,
          "WoReceivedDateTime": "2016-02-05",
          "WoReceivedDate": "2016-02-05",
          "WoReceivedTime": "2024-12-04T12:00:00Z",
          "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",
          "WoCostJobCode": "WO.00030",
          "WoCustCode": "KAISER",
          "WoCustName": "Kaiser Permanente",
          "WoBillAmt": null,
          "WoBillAmtFrmtd": null,
          "WoAppTypeCode": "CRM",
          "WoIssueId": null,
          "WoDmLocCode": null,
          "WoDmLocName": null,
          "WoJobBidFlag": "N",
          "WoProjCode": null,
          "WoProjName": null,
          "WoProjJobCode": null,
          "WoBillingRateTableCode": "WORKORDERS",
          "WoInvoiceFormat": "WO",
          "WoInvoiceFormatName": "Work Order Billing (Grp1 - Freeform)",
          "WoEntry2Flag": "N",
          "WoTax1Code": null,
          "WoTax2Code": null,
          "WoTax3Code": null,
          "WoFfPoNum": null,
          "WoAddrCode": null,
          "WoAddrTypeCode": null,
          "WoVUuid": "D21723A19CE95650E05316821FACB6B7",
          "WoIuCreateDate": "2016-02-05T04:04:39Z",
          "WoIuUpdateDate": "2017-01-30T07:15:03Z",
          "links": [
            {
              "rel": "self",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/prm-rest-api/rest/1/workorder/D21723A19CE95650E05316821FACB6B7",
              "name": "workorder",
              "kind": "item"
            },
            {
              "rel": "canonical",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/prm-rest-api/rest/1/workorder/D21723A19CE95650E05316821FACB6B7",
              "name": "workorder",
              "kind": "item"
            }
          ]
        }
      ],
      "count": 1,
      "hasMore": false,
      "limit": 5,
      "offset": 0,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/prm-rest-api/rest/1/workorder",
          "name": "workorder",
          "kind": "collection"
        }
      ]
    }
    object