Jump to

• Request
• Response

Cancel Task

patch

/rest/v16/tasks/{taskId}

This endpoint cancels the specified task. This endpoint replaces the '/tasks/{taskId}/actions/cancel' endpoint, which was deprecated in Oracle CPQ 20B.

Request

Path Parameters

• taskId(required): string
  The Task ID

Body ()

Root Schema : Task Cancel Request Details

Type: object

Title: Task Cancel Request Details

Task Cancel Request Details

Show Source

• status(required): string
  Title: Cancellation Request

  Allowed Values: [ "Cancellation Requested" ]

{
    "required":[
        "status"
    ],
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"",
            "title":"Cancellation Request",
            "enum":[
                "Cancellation Requested"
            ]
        }
    },
    "title":"Task Cancel Request Details",
    "description":"Task Cancel Request Details"
}

Back to Top

Response

200 Response

The request was accepted.

Body ()

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

404 Response

The task doesn't exist or is not accessible for current user.

409 Response

The task cannot be cancelled. For example, a completed task cannot be cancelled.

Back to Top