REST API Services for Oracle CPQ

Get Data Table Row

get

/rest/v16/adminCustom{tableName}/{rowId}

This endpoint returns the specified data table row.

Request

Path Parameters

rowId(required): integer
tableName(required): string

Response

Supported Media Types

application/json

404 Response

Requested resource(s) not found

500 Response

Unexpected error

Default Response

Root Schema : rowResponse

Type: object

Show Source

_state: object state

Title: state

row state
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."
        },
        "_state":{
            "$ref":"#/definitions/_state"
        }
    }
}

Nested Schema : state

Type: object

Title: state

row state

Show Source

errors: array errors

{
    "type":"object",
    "properties":{
        "errors":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "title":{
                        "type":"string",
                        "description":"error title",
                        "title":"title"
                    },
                    "field":{
                        "type":"string",
                        "description":"error field",
                        "title":"field"
                    }
                }
            }
        }
    },
    "title":"state",
    "description":"row state"
}

Nested Schema : errors

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "title":{
                "type":"string",
                "description":"error title",
                "title":"title"
            },
            "field":{
                "type":"string",
                "description":"error field",
                "title":"field"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

field: string

Title: field

error field
title: string

Title: title

error title

{
    "type":"object",
    "properties":{
        "title":{
            "type":"string",
            "description":"error title",
            "title":"title"
        },
        "field":{
            "type":"string",
            "description":"error field",
            "title":"field"
        }
    }
}

Examples

The following examples show how to retrieve the specified data table row 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/36735109

Response Body Sample

{
  "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"
    }
  ]
}