REST API Services for Oracle CPQ

Get Data Table Data

get

/rest/v16/adminCustom{tableName}

This endpoint returns all rows for the specified data table.

Request

Path Parameters

tableName(required): string

Query Parameters

q: string

Query specifications can be used to search for specific data within the named data table.

Response

Supported Media Types

application/json

404 Response

Requested resource(s) not found

500 Response

Unexpected error

Default Response

Table row collection

Root Schema : rowCollection

Type: object

Show Source

count: integer

Title: Count

Specifies that the total count of records should be included in the response when doing pagination.
hasMore: boolean

Title: Has More

Returns true if more resources are available on the server than the subset returned in current page.
items: array items
limit: integer

Title: Limit

The requested page size, which limits the number of elements the collection should max return.
offset: integer

Title: Offset

The offset of the page. By default, offset is 0, which means first page will be returned.
totalResults: integer

Title: Total Results

Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"integer",
            "description":"The offset of the page. By default, offset is 0, which means first page will be returned.",
            "title":"Offset"
        },
        "count":{
            "type":"integer",
            "description":"Specifies that the total count of records should be included in the response when doing pagination.",
            "title":"Count"
        },
        "limit":{
            "type":"integer",
            "description":"The requested page size, which limits the number of elements the collection should max return.",
            "title":"Limit"
        },
        "hasMore":{
            "type":"boolean",
            "description":"Returns true if more resources are available on the server than the subset returned in current page.",
            "title":"Has More"
        },
        "totalResults":{
            "type":"integer",
            "description":"Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.",
            "title":"Total Results"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/rowRequest"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object rowRequest

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/rowRequest"
    }
}

Nested Schema : rowRequest

Type: object

Show Source

DataItems: string

Title: Data Table Row Data.

This object contains labels and values for each column in the data table.

{
    "type":"object",
    "properties":{
        "DataItems":{
            "type":"string",
            "title":"Data Table Row Data.",
            "description":"This object contains labels and values for each column in the data table."
        }
    }
}

Examples

The following examples show how to retrieve all rows for the specified data table by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl - X GET - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v16/adminCustomStatus

Response Body Sample

{
 {
  "limit": 1000,
  "offset": 0,
  "count": 8,
  "hasMore": false,
  "items": [{
      "id": 36735107,
      "StatusID": 1,
      "StatusLabel": "CREATED",
      "StatusOSC_t": "ZCA_IN_PROGRESS",
      "StatusOSC_l": "OPEN",
      "HistoricalStatus": "ZCA_IN_PROGRESS",
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/adminCustomStatus"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/adminCustomStatus/36735107"
        }
      ],
    }, {
      "id": 36735108,
      "StatusID": 2,
      "StatusLabel": "QUOTED",
      "StatusOSC_t": "ZCA_IN_PROGRESS",
      "StatusOSC_l": "OPEN",
      "HistoricalStatus": "ZCA_IN_PROGRESS",
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/adminCustomStatus"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/adminCustomStatus/36735108"
        }
      ],
    }, {
      "id": 36735109,
      "StatusID": 3,
      "StatusLabel": "INVOICED",
      "StatusOSC_t": "ZCA_IN_PROGRESS",
      "StatusOSC_l": "WON",
      "HistoricalStatus": "ZCA_WIN",
      "DMStatus": "WON",
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/adminCustomStatus"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/adminCustomStatus/36735109"
        }
      ],
    }, {
      "id": 36735110,
      "StatusID": 4,
      "StatusLabel": "AWAIT_BILLING",
      "StatusOSC_t": "ZCA_IN_PROGRESS",
      "StatusOSC_l": "WON",
      "HistoricalStatus": "ZCA_WIN",
      "DMStatus": "WON",
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/adminCustomStatus"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/adminCustomStatus/36735110"
        }
      ],
    }, {
      "id": 36735111,
      "StatusID": 5,
      "StatusLabel": "BILLED",
      "StatusOSC_t": "ZCA_IN_PROGRESS",
      "StatusOSC_l": "WON",
      "HistoricalStatus": "ZCA_WIN",
      "DMStatus": "WON",
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/adminCustomStatus"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/adminCustomStatus/36735111"
        }
      ],
    }, {
      "id": 36735112,
      "StatusID": 6,
      "StatusLabel": "ORDERED",
      "StatusOSC_t": "ZCA_IN_PROGRESS",
      "StatusOSC_l": "WON",
      "HistoricalStatus": "ZCA_WIN",
      "DMStatus": "WON",
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/adminCustomStatus"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/adminCustomStatus/36735112"
        }
      ],
    }, {
      "id": 36735113,
      "StatusID": 7,
      "StatusLabel": "SCHEDULED",
      "StatusOSC_t": "ZCA_IN_PROGRESS",
      "StatusOSC_l": "WON",
      "HistoricalStatus": "ZCA_WIN",
      "DMStatus": "WON",
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/adminCustomStatus"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/adminCustomStatus/36735113"
        }
      ],
    }, {
      "id": 36735114,
      "StatusID": 8,
      "StatusLabel": "PICKED",
      "StatusOSC_t": "ZCA_IN_PROGRESS",
      "StatusOSC_l": "WON",
      "HistoricalStatus": "ZCA_WIN",
      "DMStatus": "WON",
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/adminCustomStatus"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/adminCustomStatus/36735114"
        }
      ]
     }
    }
  ],
  "links": [{
      "rel": "canonical",
      "href": "https://sitename.oracle.com/rest/v16/adminCustomStatus"
    }, {
      "rel": "next",
      "href": "https://sitename.oracle.com/rest/v16/adminCustomStatus?offset=1000&limit=1000&totalResults=false"
    }, {
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v16/adminCustomStatus?offset=0&limit=1000&totalResults=false"
    }
  ]
}

Request Data Table records matching a specific criteria

The following query returns Status table records where the StatusLabel equals CREATED or PICKED.

curl - X GET - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v16/adminCustomStatus?q={$or:[{StatusLabel:'CREATED'},{ StatusLabel:'PICKED'}]}

Response Body Sample

 {
  "limit": 1000,
  "offset": 0,
  "count": 2,
  "hasMore": false,
  "items": [{
      "id": 36735107,
      "StatusID": 1,
      "StatusLabel": "CREATED",
      "StatusOSC_t": "ZCA_IN_PROGRESS",
      "StatusOSC_l": "OPEN",
      "HistoricalStatus": "ZCA_IN_PROGRESS",
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/adminCustomStatus"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/adminCustomStatus/36735107"
        }
      ],
    }, {
      "id": 36735114,
      "StatusID": 8,
      "StatusLabel": "PICKED",
      "StatusOSC_t": "ZCA_IN_PROGRESS",
      "StatusOSC_l": "WON",
      "HistoricalStatus": "ZCA_WIN",
      "DMStatus": "WON",
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/adminCustomStatus"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/adminCustomStatus/36735114"
        }
      ],
    }
  ],
  "links": [{
      "rel": "canonical",
      "href": "https://sitename.oracle.com/rest/v16/adminCustomStatus"
    }, {
      "rel": "next",
      "href": "https://sitename.oracle.com/rest/v16/adminCustomStatus?offset=1000&limit=1000&totalResults=false&q={$or:[{StatusLabel:'CREATED'},{ StatusLabel:'PICKED'}]}"
    }, {
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v16/adminCustomStatus?offset=0&limit=1000&totalResults=false&q={$or:[{StatusLabel:'CREATED'},{ StatusLabel:'PICKED'}]}"
    }
  ]
}