Job Scheduler - Run On Demand Item Job

Service:

Core

API Version:

v1

Run on-demand item 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?jobType={jobType}

URI Parameters

Name	In	Required	Type	Description
itemId	path	True	string uuid	The item ID.
workspaceId	path	True	string uuid	The workspace ID.
jobType	query	True	string	Job type

Request Body

Name	Type	Description
executionData	object	Payload for run on-demand job request. Needed only if the job type requires a payload.

Responses

Name	Type	Description
202 Accepted		Request accepted, job execution 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 run job instance. InvalidJobType - The requested job type is invalid. TooManyRequestsForJobs - The caller requests too many on-demand job requests. ItemNotFound - Requested item ID not found.

Examples

Run item job instance with no request body example

Run item job instance with request body containing executionData example

Run item job instance with no request body example

Sample request

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/jobs/instances?jobType=DefaultJob

Sample response

Status code:

202

Location: https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/jobs/instances/f2d65699-dd22-4889-980c-15226deb0e1b
Retry-After: 60

Run item job instance with request body containing executionData example

Sample request

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/jobs/instances?jobType=DefaultJob

{
  "executionData": {
    "tableName": "Table1",
    "optimizeSettings": {
      "vOrder": true
    }
  }
}

Sample response

Status code:

202

Location: https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/jobs/instances/f2d65699-dd22-4889-980c-15226deb0e1b
Retry-After: 60

Definitions

Name	Description
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.
RunOnDemandItemJobRequest	Run on demand item job instance payload

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.

RunOnDemandItemJobRequest

Run on demand item job instance payload

Name	Type	Description
executionData	object	Payload for run on-demand job request. Needed only if the job type requires a payload.