Retrieve PCI Masters By Code
  • 27 Feb 2025
  • 2 Minutes to read
  • Dark
    Light

Retrieve PCI Masters By Code

  • Dark
    Light

Article summary

Get
/cm-rest-api/rest/1/cmmast

Query Standards

Finder

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

  • Select By Company Job CM Code
  • Select By Company Job
  • Select By Workflow
  • By UUID

Select By Company Job CM Code

Recommended finder parameters. Refer to Query Parameters for example.

ParameterDescriptionSample
companyCodeCompany Code001
cmCodeCM CodeEXT0001
jobCodeJob Code01JOB
typeCodeType CodeEXT

Select By Company Job

This is an optional finder for querying PCI Masters by Company Code,Job Code, Type Code.

ParameterDescriptionSample
companyCodeCompany Code001
jobCodeJob Code01JOB
typeCodeType CodeEXT

Select By Workflow

This is an optional finder for querying PCI Masters by Workflow Status, Type Code and Audit Date.

ParameterDescriptionSample
workflowStatusWorkflow StatusCOMPLETE
typeCodeType CodeEXT
auditDateCreate or Update Date Time Filter2015-01-01

By UUID

This is an optional finder for querying a specific PCI Master by row ID.

ParameterDescriptionSample
/VUUIDThe VUuid attribute is the Unique row ID/cm-rest-api/rest/1/cmmast/DC6549E57F0B7B3FE05316821FACEE2E
Security
HTTP
Type basic

Basic authentication

Query parameters
finder
string
ExampleselectByCompJobCMCode; companyCode=001, cmCode=EXT0001, jobCode=01JOB, typeCode=EXT
limit
integer
Example500
offset
integer
Example0
totalResults
boolean
ExampleTrue
orderBy
string
ExampleCmmVUuid:desc
Responses
200

OK

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

Successful Response - Finder - selectByCompJobCMCode

{
  "items": [
    {
      "CmmActionCode": null,
      "CmmAllowance": "N",
      "CmmAprvFlag": "Y",
      "CmmAutoCalcMarkupFlag": "N",
      "CmmBchNum": null,
      "CmmBiditemFlag": null,
      "CmmBillCatCode": null,
      "CmmBillCode": null,
      "CmmBillMethCode": "D",
      "CmmBillName": null,
      "CmmBillPhsCode": null,
      "CmmBillRevisAmt": null,
      "CmmCalcProjAmtMethod": "A",
      "CmmChgSentToOwnerDate": null,
      "CmmChgSignedByOwnerDate": null,
      "CmmClassCode": "E",
      "CmmClvValueCode1": null,
      "CmmClvValueCode2": null,
      "CmmClvValueCode3": null,
      "CmmClvValueCode4": null,
      "CmmClvValueCode5": null,
      "CmmClvValueCode6": null,
      "CmmCode": "EXT0001",
      "CmmCompCode": "001",
      "CmmCtrlJobCode": "ALL",
      "CmmCycleNum": null,
      "CmmDueToOwnerDate": "2022-04-08T03:57:12Z",
      "CmmEffectiveEndDate": null,
      "CmmEffectiveStartDate": null,
      "CmmFundsourceCode": null,
      "CmmGlobalUpdateDate": "2023-01-31T19:07:37Z",
      "CmmImpactDays": 100,
      "CmmInvCode": null,
      "CmmIuCreateDate": "2022-04-08T03:58:11Z",
      "CmmIuUpdateDate": "2023-01-31T19:07:37Z",
      "CmmJobCode": "01JOB",
      "CmmLumpsumFlag": null,
      "CmmName": "RYAN LAW",
      "CmmOrigCmmCode": null,
      "CmmOrigOwnerAllowanceAmt": null,
      "CmmOwnerAllowanceAmt": null,
      "CmmOwnerChgCode": null,
      "CmmPendFlag": "A",
      "CmmPmFlag": "Y",
      "CmmPmObjectCode": null,
      "CmmPostContrFlag": "N",
      "CmmPostDate": null,
      "CmmPostDateDummy": null,
      "CmmPostingFlag": "UNPOSTED",
      "CmmPrepostStatCode": "APPROVED",
      "CmmPropIssuedToOwnerDate": null,
      "CmmPropSignedByOwnerDate": null,
      "CmmReasonText": null,
      "CmmRefCmmCode": null,
      "CmmRefDate": "2022-04-07",
      "CmmRfqDueDate": null,
      "CmmRfqLimitAmt": null,
      "CmmRfqProceedFlag": null,
      "CmmScopeDesc": "this is my description of this PCI",
      "CmmSourceText": null,
      "CmmSrcId": null,
      "CmmStatCode": null,
      "CmmStatCodeUpdateDate": "2022-04-08T03:59:31Z",
      "CmmTypeCode": "EXT",
      "CmmUpdPcComplFlag": "Y",
      "CmmUpdProjAmtFlag": "Y",
      "CmmUser": "EXTRACKER",
      "CmmVUuid": "DC1D414C60B307EAE05316821FACEA9A",
      "CmmWorkflowStatus": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/cm-rest-api/rest/1/cmmast/DC1D414C60B307EAE05316821FACEA9A",
          "name": "cmmast",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/cm-rest-api/rest/1/cmmast/DC1D414C60B307EAE05316821FACEA9A",
          "name": "cmmast",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 1,
  "hasMore": false,
  "limit": 50,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/cm-rest-api/rest/1/cmmast",
      "name": "cmmast",
      "kind": "collection"
    }
  ]
}
example-1

Successful Response - Finder - selectByCompJob

{
  "items": [
    {
      "CmmActionCode": null,
      "CmmAllowance": "N",
      "CmmAprvFlag": "Y",
      "CmmAutoCalcMarkupFlag": "N",
      "CmmBchNum": null,
      "CmmBiditemFlag": null,
      "CmmBillCatCode": null,
      "CmmBillCode": null,
      "CmmBillMethCode": "D",
      "CmmBillName": null,
      "CmmBillPhsCode": null,
      "CmmBillRevisAmt": null,
      "CmmCalcProjAmtMethod": "A",
      "CmmChgSentToOwnerDate": null,
      "CmmChgSignedByOwnerDate": null,
      "CmmClassCode": "E",
      "CmmClvValueCode1": null,
      "CmmClvValueCode2": null,
      "CmmClvValueCode3": null,
      "CmmClvValueCode4": null,
      "CmmClvValueCode5": null,
      "CmmClvValueCode6": null,
      "CmmCode": "EXT0001",
      "CmmCompCode": "001",
      "CmmCtrlJobCode": "ALL",
      "CmmCycleNum": null,
      "CmmDueToOwnerDate": "2022-04-08T03:57:12Z",
      "CmmEffectiveEndDate": null,
      "CmmEffectiveStartDate": null,
      "CmmFundsourceCode": null,
      "CmmGlobalUpdateDate": "2023-01-31T19:07:37Z",
      "CmmImpactDays": 100,
      "CmmInvCode": null,
      "CmmIuCreateDate": "2022-04-08T03:58:11Z",
      "CmmIuUpdateDate": "2023-01-31T19:07:37Z",
      "CmmJobCode": "01JOB",
      "CmmLumpsumFlag": null,
      "CmmName": "RYAN LAW",
      "CmmOrigCmmCode": null,
      "CmmOrigOwnerAllowanceAmt": null,
      "CmmOwnerAllowanceAmt": null,
      "CmmOwnerChgCode": null,
      "CmmPendFlag": "A",
      "CmmPmFlag": "Y",
      "CmmPmObjectCode": null,
      "CmmPostContrFlag": "N",
      "CmmPostDate": null,
      "CmmPostDateDummy": null,
      "CmmPostingFlag": "UNPOSTED",
      "CmmPrepostStatCode": "APPROVED",
      "CmmPropIssuedToOwnerDate": null,
      "CmmPropSignedByOwnerDate": null,
      "CmmReasonText": null,
      "CmmRefCmmCode": null,
      "CmmRefDate": "2022-04-07",
      "CmmRfqDueDate": null,
      "CmmRfqLimitAmt": null,
      "CmmRfqProceedFlag": null,
      "CmmScopeDesc": "this is my description of this PCI",
      "CmmSourceText": null,
      "CmmSrcId": null,
      "CmmStatCode": null,
      "CmmStatCodeUpdateDate": "2022-04-08T03:59:31Z",
      "CmmTypeCode": "EXT",
      "CmmUpdPcComplFlag": "Y",
      "CmmUpdProjAmtFlag": "Y",
      "CmmUser": "EXTRACKER",
      "CmmVUuid": "DC1D414C60B307EAE05316821FACEA9A",
      "CmmWorkflowStatus": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/cm-rest-api/rest/1/cmmast/DC1D414C60B307EAE05316821FACEA9A",
          "name": "cmmast",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/cm-rest-api/rest/1/cmmast/DC1D414C60B307EAE05316821FACEA9A",
          "name": "cmmast",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 1,
  "hasMore": false,
  "limit": 50,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/cm-rest-api/rest/1/cmmast",
      "name": "cmmast",
      "kind": "collection"
    }
  ]
}
object