REST API Services for Oracle CPQ

Deploy Data Tables

post

/rest/v19/datatables/actions/deploy

This endpoint is used to deploy the specified data tables.

Request

Supported Media Types

application/json

Root Schema : dataTable-deployRequest

Type: object

Show Source

autoPullFKTables: boolean

Title: Deploy dependent tables

Deploy dependent tables, if they are not selected for deployment
selections(required): array Table Names List

Title: Table Names List

Table name list of Datatables to be deployed.

{
    "required":[
        "selections"
    ],
    "type":"object",
    "properties":{
        "selections":{
            "type":"array",
            "description":"Table name list of Datatables to be deployed.",
            "title":"Table Names List",
            "items":{
                "type":"string"
            }
        },
        "autoPullFKTables":{
            "type":"boolean",
            "description":"Deploy dependent tables, if they are not selected for deployment",
            "title":"Deploy dependent tables"
        }
    }
}

Nested Schema : Table Names List

Type: array

Title: Table Names List

Table name list of Datatables to be deployed.

Show Source

Array of: string

{
    "type":"array",
    "description":"Table name list of Datatables to be deployed.",
    "title":"Table Names List",
    "items":{
        "type":"string"
    }
}

Response

Supported Media Types

application/json

202 Response

Deploy task details

Root Schema : Task details

Type: object

Title: Task details

Task details

Show Source

links: array Links

Title: Links

Links to the related objects.
taskId: integer

Title: Task Id

The status log task Id.

{
    "type":"object",
    "properties":{
        "taskId":{
            "type":"integer",
            "description":"The status log task Id.",
            "title":"Task Id"
        },
        "links":{
            "type":"array",
            "description":"Links to the related objects.",
            "title":"Links",
            "items":{
                "$ref":"#/definitions/links"
            }
        }
    },
    "title":"Task details",
    "description":"Task details"
}

Nested Schema : Links

Type: array

Title: Links

Links to the related objects.

Show Source

Array of: object Reference Links

Title: Reference Links

Reference links for the Parent, Self, Children and Related as applicable

{
    "type":"array",
    "description":"Links to the related objects.",
    "title":"Links",
    "items":{
        "$ref":"#/definitions/links"
    }
}

Nested Schema : Reference Links

Type: object

Title: Reference Links

Reference links for the Parent, Self, Children and Related as applicable

Show Source

href: string

Title: href

URL to the related object
rel: string

Title: Link

Link relationship to the current object

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Link relationship to the current object",
            "title":"Link"
        },
        "href":{
            "type":"string",
            "description":"URL to the related object",
            "title":"href"
        }
    },
    "title":"Reference Links",
    "description":"Reference links for the Parent, Self, Children and Related as applicable"
}

Default Response

Examples

The following example shows how to deploy data tables by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X POST -H "Authorization: Bearer <token>" -H "Content-type: application/json" -H "Accept: application/json"
https://sitename.oracle.com/rest/v19/datatables/actions/deploy

Request Body Sample

{
  "selections": ["Racks", "Rack_Components"]
}

Response Body Sample

{
  "taskIds": [{
      "id": 41366783,
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v19/tasks/41366783"
        }
      ],
    }, {
      "id": 41366784,
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v19/tasks/41366784"
        }
      ],
    }
  ],
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v19/datatables/actions/deploy"
    }
  ]
}