REST API Services for CPQ Cloud

Get Data Table Record

get

/rest/v7/custom{DataTable}/{id}

Returns the deployed data of a CPQ Cloud Data Table record.

Request

Path Parameters

DataTable: string

The name of the CPQ Cloud Data Table (first character must be capitalized).
id: integer

The Data Table record identifier.

Query Parameters

expand(optional): string

Allows expansion of relationships.
fields(optional): string

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

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

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

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

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

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

Response

Default Response

Root Schema : Data Table Record

Type: object

Title: Data Table Record

Show Source

customDataTableColumn(optional): 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 colum.
id(optional): integer

Title: id

The Data Table record identifier.
links(optional): 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 colum.",
            "type":"string"
        },
        "links":{
            "title":"Links",
            "description":"Link to Data Table record.",
            "type":"string"
        }
    }
}

Examples

The following example shows how to search a data table record 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/v7/customStatus/36950351

Response Body Sample

{
  "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/v7/customStatus/36950351"
    }
  ]
}