REST API Services for Oracle CPQ

Get List of Tasks

get

/rest/v16/tasks

This endpoint returns a list of tasks which are specified using the query parameters listed below.

Request

Query Parameters

q(required): string

The '?q={category:{$in:[ ]}}' query parameter is required. The following category values are supported: 13, 17, 26, 51, and/or 52. '13' returns data table import tasks, '17' returns data table deploy tasks, '26' returns data table export tasks, '51' returns migration package import tasks, and '52' returns migration package export tasks

Response

Supported Media Types

application/json

Default Response

The response contains the tasks for the queried categories that are accessible for the current user.

Root Schema : task-collection

Type: object

Show Source

items: array Tasks List

Title: Tasks List

List of accessible Tasks
links: object Reference Links

Title: Reference Links

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

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of accessible Tasks",
            "title":"Tasks List",
            "items":{
                "$ref":"#/definitions/task"
            }
        },
        "links":{
            "$ref":"#/definitions/links"
        }
    }
}

Nested Schema : Tasks List

Type: array

Title: Tasks List

List of accessible Tasks

Show Source

Array of: object task

{
    "type":"array",
    "description":"List of accessible Tasks",
    "title":"Tasks List",
    "items":{
        "$ref":"#/definitions/task"
    }
}

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

Nested Schema : task

Type: object

Show Source

category: object category
dateAdded: string

Title: Date created

Task creation date
dateModified: string

Title: Date Last Modified

The date of the last task modification
detailStatus: object Detail Status

Title: Detail Status

Detail Status for entities associated with this task
executionTime: string

Title: Execution time

The time the task was executed
files: array File list

Title: File list

List of files associated with this task
id: integer

Title: Task ID

The task ID
links: object Reference Links

Title: Reference Links

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

Title: Task name

The task name
result: string

Title: Task result

The task result
status: string

Title: Status of task

Task status

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"The task ID",
            "title":"Task ID"
        },
        "name":{
            "type":"string",
            "description":"The task name",
            "title":"Task name"
        },
        "executionTime":{
            "type":"string",
            "description":"The time the task was executed",
            "title":"Execution time"
        },
        "category":{
            "type":"object",
            "properties":{
                "lookupCode":{
                    "type":"string",
                    "title":"Category identifier"
                },
                "displayValue":{
                    "type":"string",
                    "title":"Category display type"
                }
            }
        },
        "result":{
            "type":"string",
            "description":"The task result",
            "title":"Task result"
        },
        "status":{
            "type":"string",
            "description":"Task status",
            "title":"Status of task"
        },
        "detailStatus":{
            "type":"object",
            "description":"Detail Status for entities associated with this task",
            "title":"Detail Status",
            "properties":{
                "message":{
                    "type":"string",
                    "title":"High level message for task."
                },
                "items":{
                    "type":"array",
                    "description":"Statuses for all the entities",
                    "title":"Entities Statuses",
                    "items":{
                        "$ref":"#/definitions/entityStatus"
                    }
                }
            }
        },
        "dateModified":{
            "type":"string",
            "description":"The date of the last task modification",
            "title":"Date Last Modified"
        },
        "dateAdded":{
            "type":"string",
            "description":"Task creation date",
            "title":"Date created"
        },
        "files":{
            "type":"array",
            "description":"List of files associated with this task",
            "title":"File list",
            "items":{
                "$ref":"#/definitions/file"
            }
        },
        "links":{
            "$ref":"#/definitions/links"
        }
    }
}

Nested Schema : category

Type: object

Show Source

displayValue: string

Title: Category display type
lookupCode: string

Title: Category identifier

{
    "type":"object",
    "properties":{
        "lookupCode":{
            "type":"string",
            "title":"Category identifier"
        },
        "displayValue":{
            "type":"string",
            "title":"Category display type"
        }
    }
}

Nested Schema : Detail Status

Type: object

Title: Detail Status

Detail Status for entities associated with this task

Show Source

items: array Entities Statuses

Title: Entities Statuses

Statuses for all the entities
message: string

Title: High level message for task.

{
    "type":"object",
    "description":"Detail Status for entities associated with this task",
    "title":"Detail Status",
    "properties":{
        "message":{
            "type":"string",
            "title":"High level message for task."
        },
        "items":{
            "type":"array",
            "description":"Statuses for all the entities",
            "title":"Entities Statuses",
            "items":{
                "$ref":"#/definitions/entityStatus"
            }
        }
    }
}

Nested Schema : File list

Type: array

Title: File list

List of files associated with this task

Show Source

Array of: object file

{
    "type":"array",
    "description":"List of files associated with this task",
    "title":"File list",
    "items":{
        "$ref":"#/definitions/file"
    }
}

Nested Schema : Entities Statuses

Type: array

Title: Entities Statuses

Statuses for all the entities

Show Source

Array of: object Entity Status

Title: Entity Status

Entity Status

{
    "type":"array",
    "description":"Statuses for all the entities",
    "title":"Entities Statuses",
    "items":{
        "$ref":"#/definitions/entityStatus"
    }
}

Nested Schema : Entity Status

Type: object

Title: Entity Status

Entity Status

Show Source

entity: string

Title: Entity Display Name

Entity Display Name
status: string

Title: Entity Status

Entity Status
summary: array Summary

Title: Summary

Summary of message and type for entity

{
    "type":"object",
    "properties":{
        "entity":{
            "type":"string",
            "description":"Entity Display Name",
            "title":"Entity Display Name"
        },
        "status":{
            "type":"string",
            "description":"Entity Status",
            "title":"Entity Status"
        },
        "summary":{
            "type":"array",
            "description":"Summary of message and type for entity",
            "title":"Summary",
            "items":{
                "$ref":"#/definitions/summaryDetails"
            }
        }
    },
    "title":"Entity Status",
    "description":"Entity Status"
}

Nested Schema : Summary

Type: array

Title: Summary

Summary of message and type for entity

Show Source

Array of: object Summary Details

Title: Summary Details

Summary Details

{
    "type":"array",
    "description":"Summary of message and type for entity",
    "title":"Summary",
    "items":{
        "$ref":"#/definitions/summaryDetails"
    }
}

Nested Schema : Summary Details

Type: object

Title: Summary Details

Summary Details

Show Source

level: string

Title: Message Level

Message Level
messages: array Messages

Title: Messages

Messages

{
    "type":"object",
    "properties":{
        "level":{
            "type":"string",
            "description":"Message Level",
            "title":"Message Level"
        },
        "messages":{
            "type":"array",
            "description":"Messages",
            "title":"Messages",
            "items":{
                "$ref":"#/definitions/message"
            }
        }
    },
    "title":"Summary Details",
    "description":"Summary Details"
}

Nested Schema : Messages

Type: array

Title: Messages

Messages

Show Source

Array of: string

Title: Message

Message

{
    "type":"array",
    "description":"Messages",
    "title":"Messages",
    "items":{
        "$ref":"#/definitions/message"
    }
}

Nested Schema : file

Type: object

Show Source

name: string

Title: File name
type: string

Title: File type

File can be of type plain text, csv etc

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "title":"File name"
        },
        "type":{
            "type":"string",
            "description":"File can be of type plain text, csv etc",
            "title":"File type"
        }
    }
}

Examples

Get List of Data Table Tasks

The following example shows how to get a list of data table status log tasks 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 "Accept: application/json"
https://sitename.oracle.com/rest/v16/tasks/?q={category:{$in:[13,17,26]}}

Response Body Sample

{
  "items": [{
      "id": 41365772,
      "dateModified": "10/18/2019 1:19 PM",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/tasks/41365772"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/tasks"
        }
      ],
      "name": "Rack_Domain",
      "category": {
        "lookupCode": "13",
        "displayValue": "Data Table Upload"
      },
      "status": "Completed",
      "result": "4118171",
      "executionTime": "10/18/2019 1:19 PM",
      "dateAdded": "10/18/2019 1:19 PM"
    }, {
      "id": 41365771,
      "dateModified": "10/18/2019 1:18 PM",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/tasks/41365771"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/tasks"
        }
      ],
      "name": "Rack_Domain Export",
      "category": {
        "lookupCode": "26",
        "displayValue": "Data Table Export"
      },
      "status": "Completed",
      "result": "datatable_1571422724473",
      "executionTime": "10/18/2019 1:18 PM",
      "dateAdded": "10/18/2019 1:18 PM"
    }, {
      "id": 41365769,
      "dateModified": "10/18/2019 1:18 PM",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/tasks/41365769"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/tasks"
        }
      ],
      "name": "Rack_Domain",
      "category": {
        "lookupCode": "17",
        "displayValue": "Data Table Deploy"
      },
      "status": "Completed",
      "executionTime": "10/18/2019 1:18 PM",
      "dateAdded": "10/18/2019 1:18 PM"
    }
  ],
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v16/tasks"
    }
  ]
}

Get List of Migration Package Tasks

The following example shows how to get a list of migration package tasks 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 "Accept: application/json"
https://sitename.oracle.com/rest/v16/tasks/?q={category:{$in:[51,52]}}

Response Body Sample

{
  "items": [{
      "id": 41372699,
      "dateModified": "04/15/2020 4:02 PM",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/tasks/41372699"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/tasks"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/tasks/41372699/files"
        }
      ],
      "name": "Migration REST Import",
      "category": {
        "lookupCode": "51",
        "displayValue": "Migration Package Import"
      },
      "status": "Completed",
      "detailStatus": {
        "message": "Task is completed successfully.",
        "items": [{
            "entity": "Util Library",
            "status": "Successful"
          }, {
            "entity": "Package",
            "status": "Successful"
          }
        ]
      },
      "executionTime": "04/15/2020 4:00 PM",
      "dateAdded": "04/15/2020 4:00 PM"
    }, {
      "id": 41372640,
      "dateModified": "04/15/2020 3:45 PM",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/tasks/41372640"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/tasks"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.comtasks/41372640/files"
        }
      ],
      "name": "Migration REST Export",
      "category": {
        "lookupCode": "52",
        "displayValue": "Migration Package Export"
      },
      "status": "Completed",
      "result": "MigrationPackage_2",
      "executionTime": "04/15/2020 3:33 PM",
      "dateAdded": "04/15/2020 3:33 PM"
    }
  ],
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/tasks"
    }
  ]
}