Cancel an Operation

Requests the cancellation of a running Output Creation operation of a specific operation ID.

Request takes no content, and on success returns a response with no content.

Request

Method Type:	POST
URI:	/rest/serverengine/workflow/outputcreation/cancel/{operationId}
Content:	–
Content Type:	–
Add. Headers:	If server security settings are enabled, then one of the following: Authorization – Basic Authentication (Username and Password) credentials (Base64 encoded) auth_token – Authorization Token

Parameters

Path parameters

The following lists the path parameters accepted by this method:

Name	Required	Type	Default Value	Description
operationId	–	–	–	Operation ID of Output Creation operation

Response

Success

The following lists status codes indicative of a successful response:

Status Code	Content	Content-Type	Add. Headers	Description
204 No Content	–	–	–	Operation cancellation requested

Error

The following lists status codes indicative of a failed or error response:

Status Code	Content	Content-Type	Add. Headers	Description
401 Unauthorized	JSON Error specifying error message	application/json	WWW-Authenticate – BASIC (Basic Authentication credentials are accepted)	Server authentication has failed. Response when either: basic authentication credentials nor an authorization token have been specified in the request headers the basic authentication credentials or the authorization token specified in the request headers are invalid the authorization token specified in the request headers has now expired
403 Forbidden	JSON Error specifying error message	application/json	–	Server authentication has succeeded, but user authorization for this specific method has failed. Response when authentication of the credentials or the authorization token specified in the request headers has succeeded, but the user associated with the credentials or the authorization token specified has insufficient role assignment/privileges.
404 Not Found	JSON Error specifying error message	application/json	–	Operation not found in Server

Status Code

Content

Content-Type

Add. Headers

Description

401 Unauthorized

JSON Error specifying error message

application/json

WWW-Authenticate – BASIC (Basic Authentication credentials are accepted)

Server authentication has failed.

Response when either:

basic authentication credentials nor an authorization token have been specified in the request headers
the basic authentication credentials or the authorization token specified in the request headers are invalid
the authorization token specified in the request headers has now expired

403 Forbidden

JSON Error specifying error message

application/json

–

Server authentication has succeeded, but user authorization for this specific method has failed.

Response when authentication of the credentials or the authorization token specified in the request headers has succeeded, but the user associated with the credentials or the authorization token specified has insufficient role assignment/privileges.

404 Not Found

JSON Error specifying error message

application/json

–

Operation not found in Server