Job Scheduler - Cancel Item Job Instance

Service:

Core

API Version:

v1

Note

This API is in preview.

Cancel an item's job instance.

Required Delegated Scopes

For item APIs use these scope types:

• Generic scope: Item.Execute.All
• Specific scope: itemType.Execute.All (for example: Notebook.Execute.All)

for more information about scopes, see scopes article.

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/jobs/instances/{jobInstanceId}/cancel

URI Parameters

Name	In	Required	Type	Description
itemId	path	True	string uuid	The item ID.
jobInstanceId	path	True	string uuid	The job instance ID.
workspaceId	path	True	string uuid	The workspace ID.

Responses

Name	Type	Description
202 Accepted		Request accepted, canceling a job is in progress. Headers Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Common error codes: InsufficientPrivileges - The caller does not have sufficient permissions to cancel job instance ItemNotFound - Requested item id not found JobAlreadyCompleted - Requested cancellation can not take be processed as job instance run has completed

Examples

Cancel item job instance example

Sample Request

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/cfafbeb1-8037-4d0c-896e-a46fb27ff229/jobs/instances/5b218778-e7a5-4d73-8187-f10824047715/cancel

Sample Response

Status code:

202

Location: https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/cfafbeb1-8037-4d0c-896e-a46fb27ff229/jobs/instances/5b218778-e7a5-4d73-8187-f10824047715
Retry-After: 60

Definitions

Name	Description
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.

ErrorRelatedResource

The error related resource details object.

Name	Type	Description
resourceId	string	The resource ID that's involved in the error.
resourceType	string	The type of the resource that's involved in the error.

ErrorResponse

The error response.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
moreDetails	ErrorResponseDetails[]	List of additional error details.
relatedResource	ErrorRelatedResource	The error related resource details.
requestId	string	ID of the request associated with the error.

ErrorResponseDetails

The error response details.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
relatedResource	ErrorRelatedResource	The error related resource details.