REST API Services for Oracle CPQ

Synchronize Data Table Rows

post

/rest/v16/adminCustom{tableName}/actions/synchronize

This endpoint is used to create, update, or delete data table rows.

Request

Supported Media Types

application/json

Path Parameters

tableName(required): string

Root Schema : schema

Type: object

Show Source

items: array items

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

Nested Schema : items

Type: array

Show Source

Array of: object syncRowRequest

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

Nested Schema : syncRowRequest

Type: object

Show Source

_sync_action: string

Title: Synchronization Action

The synchronization action for the row (create, update, or delete)
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."
        },
        "_sync_action":{
            "type":"string",
            "description":"The synchronization action for the row (create, update, or delete)",
            "title":"Synchronization Action"
        }
    }
}

Response

Supported Media Types

application/json

400 Response

Bad request. Invalid Payload

404 Response

Requested resource(s) not found

500 Response

Unexpected error

Default Response

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 synchronize data table rows by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.

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

Request Body Sample

{
  "documents": {
    "items": [{
        "StatusID": 20,
        "StatusLabel": "DELIVERED",
        "StatusOSC_t": "ZCA_COMPLETE",
        "StatusOSC_l": "WON",
        "HistoricalStatus": "ZCA_WIN",
        "DMStatus": "WON",
        "_sync_action": "update"
      }, {
        "StatusID": 21,
        "StatusLabel": "QUOTED",
        "StatusOSC_t": "ZCA_IN_PROGRESS",
        "StatusOSC_l": "OPEN",
        "HistoricalStatus": "ZCA_IN_PROGRESS",
        "DMStatus": "",
        "_sync_action": "create"
      }, {
        "StatusID": 15,
        "_sync_action": "delete"
      }
    ]
  }
}

Response Body Sample

{
  "documents": {
    "items": [{
        "id": 41365481,
        "StatusID": 20,
        "StatusLabel": "DELIVERED",
        "StatusOSC_t": "ZCA_COMPLETE",
        "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/41365481"
          }
        ],
      }, {
        "id": 41366930,
        "StatusID": 21,
        "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/41366930"
          }
        ],
      }
    ],
    "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"
      }
    ]
  }
}