Jump to

• Request
• Response
• Examples

Cancel Data Extract Task

post

/rest/v16/extract/cancel/{taskId}

Use this endpoint to cancel the data extract task if not complete.

Request

Path Parameters

• taskId(required): string
  Data Extract Task Identifier

Back to Top

Response

Supported Media Types

• application/json

Default Response

Returns data extract task status

Body ()

Root Schema : extractData_TaskStatusResponse

Type: object

Show Source

• endTime: string
  Title: End Time

  Extract end time
• startTime: string
  Title: Start Time

  Extract start time
• taskId: string
  Title: Task Identifier

  Task Id
• taskStatus: string
  Title: Task Status

  Submit Task Message
• totalRows: string
  Title: Total Rows

  Total number of rows extracted

{
    "type":"object",
    "properties":{
        "taskId":{
            "type":"string",
            "description":"Task Id",
            "title":"Task Identifier"
        },
        "taskStatus":{
            "type":"string",
            "description":"Submit Task Message",
            "title":"Task Status"
        },
        "startTime":{
            "type":"string",
            "description":"Extract start time",
            "title":"Start Time"
        },
        "endTime":{
            "type":"string",
            "description":"Extract end time",
            "title":"End Time"
        },
        "totalRows":{
            "type":"string",
            "description":"Total number of rows extracted",
            "title":"Total Rows"
        }
    }
}

Back to Top

Examples

The following example shows how to cancel the data extract task if not complete 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/extract/cancel/{taskId}

Response Body

{
  "taskId": 3023103675,
  "taskStatus": "Cancellation Requested",
  "startTime": "2023-03-23 15:00:37.0"
}

Back to Top