patch /ondemand/requests/{requestId}

Updates the status of the specified request. Currently, the only supported operation is updating the status field to "aborted".

Aborts an existing On-Demand request. The request is removed from the queue and stopped if it is running. Request status is set to "aborted".

Path parameters

requestId (required)
The request ID.

Request body

status (required)
OnDemandRequestStatusPatch The status patch.

Return type

OnDemandRequestStatusResponse

Example data

Content-Type: application/json

{ "data" : { "reportType" : "Excel", "requestType" : "report", "created" : "2000-01-23T04:56:07.000+00:00", "id" : "00000000-0000-0000-0000-000000000000", "title" : "title", "outputFormat" : "pdf", "status" : "queued" } }

Responses

200
Success. Details about the patched On-Demand request are returned.

400
The ID of the request is malformed or the patch body is malformed. Currently, only patching the status to "aborted" is supported.

403
The user is not authorized to abort the On-Demand request.

404
The request does not exist or has expired.

409
Unable to change request status