Jump to

• Request
• Response
• Examples

Get Deployed Data Table Record

get

/rest/v16/custom{DataTable}/{id}

Returns the deployed data of a CPQ data table record.

Request

Path Parameters

• DataTable(required): string
  The name of the CPQ Data Table (first character must be capitalized).
• id(required): integer
  The data table record identifier.

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.

Back to Top

Response

Default Response

Body ()

Root 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"
        }
    }
}

Back to Top

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

Back to Top