REST API Services for Oracle CPQ

Get Deployed Data Table

get

/rest/v16/custom{DataTable}

Returns the deployed data of a CPQ data table.

Request

Path Parameters

DataTable(required): string

The name of the CPQ Data Table (first character must be capitalized).

Query Parameters

expand: string

Allows expansion of relationships.
fields: string

Restrict which fields shall be returned. The value is a comma delimited string and each token is a field name.
limit: integer

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

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

Specifies a comma-separated list of pairs to order the response by.
q: string

Allows to specify one or more filtering criteria. By default, no filtering is applied.
totalResults: boolean

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

Response

Default Response

Root Schema : DataTableRecord-collection

Type: object

Show Source

items: array items

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

Nested Schema : items

Type: array

Show Source

Array of: object Data Table Record

Title: Data Table Record

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

Nested Schema : Data Table Record

Type: object

Title: Data Table Record

Show Source

customDataTableColumn: string

Title: Custom data table columns

The custom columns and values for the specified data table. This field will be replicated for each data table column.
id: integer

Title: id

The data table record identifier.
links: string

Title: Links

Link to data table record.

{
    "title":"Data Table Record",
    "type":"object",
    "properties":{
        "id":{
            "title":"id",
            "description":"The data table record identifier.",
            "type":"integer"
        },
        "customDataTableColumn":{
            "title":"Custom data table columns",
            "description":"The custom columns and values for the specified data table. This field will be replicated for each data table column.",
            "type":"string"
        },
        "links":{
            "title":"Links",
            "description":"Link to data table record.",
            "type":"string"
        }
    }
}

Examples

The following example shows how to search data tables by submitting GET requests to the REST resource using cURL. For more information about cURL, see Use cURL.

Request all records from a Data Table

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

Response Body Sample

{
    "items": [{
      "id": 36950347,
      "historicalstatus": "ZCA_WIN",
      "statusosc_l": "WON",
      "statuslabel": "INVOICED",
      "statusosc_t": "ZCA_IN_PROGRESS",
      "statusid": 3,
      "dmstatus": "WON",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/customStatus/36950347"
        }
      ]
    }, {
      "id": 36950348,
      "historicalstatus": "ZCA_WIN",
      "statusosc_l": "WON",
      "statuslabel": "AWAIT_BILLING",
      "statusosc_t": "ZCA_IN_PROGRESS",
      "statusid": 4,
      "dmstatus": "WON",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/customStatus/36950348"
        }
      ]
    }, {
      "id": 36950349,
      "historicalstatus": "ZCA_WIN",
      "statusosc_l": "WON",
      "statuslabel": "BILLED",
      "statusosc_t": "ZCA_IN_PROGRESS",
      "statusid": 5,
      "dmstatus": "WON",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/customStatus/36950349"
        }
      ]
    }, {
      "id": 36950350,
      "historicalstatus": "ZCA_WIN",
      "statusosc_l": "WON",
      "statuslabel": "ORDERED",
      "statusosc_t": "ZCA_IN_PROGRESS",
      "statusid": 6,
      "dmstatus": "WON",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/customStatus/36950350"
        }
      ]
    }, {
      "id": 36950351,
      "historicalstatus": "ZCA_WIN",
      "statusosc_l": "WON",
      "statuslabel": "SCHEDULED",
      "statusosc_t": "ZCA_IN_PROGRESS",
      "statusid": 7,
      "dmstatus": "WON",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/customStatus/36950351"
        }
      ]
    }, {
      "id": 36950352,
      "historicalstatus": "ZCA_WIN",
      "statusosc_l": "WON",
      "statuslabel": "PICKED",
      "statusosc_t": "ZCA_IN_PROGRESS",
      "statusid": 8,
      "dmstatus": "WON",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/customStatus/36950352"
        }
      ]
    }, {
      "id": 36950353,
      "historicalstatus": "ZCA_WIN",
      "statusosc_l": "WON",
      "statuslabel": "MANUFACTURED",
      "statusosc_t": "ZCA_IN_PROGRESS",
      "statusid": 9,
      "dmstatus": "WON",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/customStatus/36950353"
        }
      ]
    }, {
      "id": 36950354,
      "historicalstatus": "ZCA_WIN",
      "statusosc_l": "WON",
      "statuslabel": "AWAIT_SHIP",
      "statusosc_t": "ZCA_IN_PROGRESS",
      "statusid": 10,
      "dmstatus": "WON",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/customStatus/36950354"
        }
      ]
    }, {
      "id": 36950355,
      "historicalstatus": "ZCA_WIN",
      "statusosc_l": "WON",
      "statuslabel": "SHIPPED",
      "statusosc_t": "ZCA_IN_PROGRESS",
      "statusid": 11,
      "dmstatus": "WON",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/customStatus/36950355"
        }
      ]
    }, {
      "id": 36950356,
      "historicalstatus": "ZCA_WIN",
      "statusosc_l": "WON",
      "statuslabel": "DELIVERED",
      "statusosc_t": "ZCA_IN_PROGRESS",
      "statusid": 12,
      "dmstatus": "WON",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/customStatus/36950356"
        }
      ]
    }, {
      "id": 36950357,
      "historicalstatus": "ZCA_WIN",
      "statusosc_l": "WON",
      "statuslabel": "ACTIVATED",
      "statusosc_t": "ZCA_IN_PROGRESS",
      "statusid": 13,
      "dmstatus": "WON",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/customStatus/36950357"
        }
      ]
    }, {
      "id": 36950358,
      "historicalstatus": "ZCA_LOST",
      "statusosc_l": "LOST",
      "statuslabel": "CANCELED",
      "statusosc_t": "ZCA_IN_PROGRESS",
      "statusid": 14,
      "dmstatus": "LOST",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/customStatus/36950358"
        }
      ]
    }, {
      "id": 36950345,
      "historicalstatus": "ZCA_IN_PROGRESS",
      "statusosc_l": "OPEN",
      "statuslabel": "CREATED",
      "statusosc_t": "ZCA_IN_PROGRESS",
      "statusid": 1,
      "dmstatus": null,
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/customStatus/36950345"
        }
      ]
    }, {
      "id": 36950346,
      "historicalstatus": "ZCA_IN_PROGRESS",
      "statusosc_l": "OPEN",
      "statuslabel": "QUOTED",
      "statusosc_t": "ZCA_IN_PROGRESS",
      "statusid": 2,
      "dmstatus": null,
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/customStatus/36950346"
        }
      ]
    }, {
      "id": 36950359,
      "historicalstatus": "ZCA_DELETED",
      "statusosc_l": "DELETED",
      "statuslabel": "DELETED",
      "statusosc_t": "ZCA_DELETED",
      "statusid": 15,
      "dmstatus": null,
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/customStatus/36950359"
        }
      ]
    }
  ],
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v16/customStatus"
    }
  ]
}

Request Data Table records matching a specific criteria

curl - X GET - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json" https://sitename.oracle.com/rest/v16/customStatus?q={dmstatus: 'WON'}

Response Body Sample

{
  "items": [{
      "id": 36950347,
      "historicalstatus": "ZCA_WIN",
      "statusosc_l": "WON",
      "statuslabel": "INVOICED",
      "statusosc_t": "ZCA_IN_PROGRESS",
      "statusid": 3,
      "dmstatus": "WON",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/customStatus/36950347"
        }
      ]
    }, {
      "id": 36950348,
      "historicalstatus": "ZCA_WIN",
      "statusosc_l": "WON",
      "statuslabel": "AWAIT_BILLING",
      "statusosc_t": "ZCA_IN_PROGRESS",
      "statusid": 4,
      "dmstatus": "WON",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/customStatus/36950348"
        }
      ]
    }, {
      "id": 36950349,
      "historicalstatus": "ZCA_WIN",
      "statusosc_l": "WON",
      "statuslabel": "BILLED",
      "statusosc_t": "ZCA_IN_PROGRESS",
      "statusid": 5,
      "dmstatus": "WON",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/customStatus/36950349"
        }
      ]
    }, {
      "id": 36950350,
      "historicalstatus": "ZCA_WIN",
      "statusosc_l": "WON",
      "statuslabel": "ORDERED",
      "statusosc_t": "ZCA_IN_PROGRESS",
      "statusid": 6,
      "dmstatus": "WON",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/customStatus/36950350"
        }
      ]
    }, {
      "id": 36950351,
      "historicalstatus": "ZCA_WIN",
      "statusosc_l": "WON",
      "statuslabel": "SCHEDULED",
      "statusosc_t": "ZCA_IN_PROGRESS",
      "statusid": 7,
      "dmstatus": "WON",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/customStatus/36950351"
        }
      ]
    }, {
      "id": 36950352,
      "historicalstatus": "ZCA_WIN",
      "statusosc_l": "WON",
      "statuslabel": "PICKED",
      "statusosc_t": "ZCA_IN_PROGRESS",
      "statusid": 8,
      "dmstatus": "WON",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/customStatus/36950352"
        }
      ]
    }, {
      "id": 36950353,
      "historicalstatus": "ZCA_WIN",
      "statusosc_l": "WON",
      "statuslabel": "MANUFACTURED",
      "statusosc_t": "ZCA_IN_PROGRESS",
      "statusid": 9,
      "dmstatus": "WON",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/customStatus/36950353"
        }
      ]
    }, {
      "id": 36950354,
      "historicalstatus": "ZCA_WIN",
      "statusosc_l": "WON",
      "statuslabel": "AWAIT_SHIP",
      "statusosc_t": "ZCA_IN_PROGRESS",
      "statusid": 10,
      "dmstatus": "WON",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/customStatus/36950354"
        }
      ]
    }, {
      "id": 36950355,
      "historicalstatus": "ZCA_WIN",
      "statusosc_l": "WON",
      "statuslabel": "SHIPPED",
      "statusosc_t": "ZCA_IN_PROGRESS",
      "statusid": 11,
      "dmstatus": "WON",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/customStatus/36950355"
        }
      ]
    }, {
      "id": 36950356,
      "historicalstatus": "ZCA_WIN",
      "statusosc_l": "WON",
      "statuslabel": "DELIVERED",
      "statusosc_t": "ZCA_IN_PROGRESS",
      "statusid": 12,
      "dmstatus": "WON",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/customStatus/36950356"
        }
      ]
    }, {
      "id": 36950357,
      "historicalstatus": "ZCA_WIN",
      "statusosc_l": "WON",
      "statuslabel": "ACTIVATED",
      "statusosc_t": "ZCA_IN_PROGRESS",
      "statusid": 13,
      "dmstatus": "WON",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/customStatus/36950357"
        }
      ]
    }
  ],
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v16/customStatus"
    }
  ]
}