Items - Get Spark Job Definition Definition

Service:

SparkJobDefinition

API Version:

v1

Returns the specified spark job definition public definition.

This API supports long running operations (LRO).

When you get a spark job definition's public definition, the sensitivity label is not a part of the definition.

Permissions

The caller must have contributor or higher workspace role.

Required Delegated Scopes

SparkJobDefinition.ReadWrite.All or Item.ReadWrite.All

Limitations

This API is blocked for a spark job definition with an encrypted sensitivity label.

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/sparkJobDefinitions/{sparkJobDefinitionId}/getDefinition

With optional parameters:

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/sparkJobDefinitions/{sparkJobDefinitionId}/getDefinition?format={format}

URI Parameters

Name	In	Required	Type	Description
sparkJobDefinitionId	path	True	string uuid	The spark job definition ID.
workspaceId	path	True	string uuid	The workspace ID.
format	query		string	The format of the spark job definition public definition.

Responses

Name	Type	Description
200 OK	SparkJobDefinitionDefinitionResponse	Request completed successfully.
202 Accepted		Request accepted. Retrieving the definition is in progress. Headers Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Common error codes: OperationNotSupportedForItem - Operation not supported for requested item.

Examples

Get a spark job definition public definition example

Sample request

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/sparkJobDefinitions/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition

Sample response

Status code:

200

{
  "definition": {
    "parts": [
      {
        "path": "SparkJobDefinitionV1.json",
        "payload": "ew0KICAiZXhlY3V0YW..OWRmNDhhY2ZmZTgifQ",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Status code:

202

Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

Definitions

Name	Description
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.
PayloadType	The type of the definition part payload. Additional payload types may be added over time.
SparkJobDefinitionDefinitionResponse	Spark job definition public definition response.
SparkJobDefinitionPublicDefinition	Spark job definition public definition object. Refer to this article for more details on how to craft a spark job definition public definition.
SparkJobDefinitionPublicDefinitionPart	Spark job definition definition part object.

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.

PayloadType

The type of the definition part payload. Additional payload types may be added over time.

Name	Type	Description
InlineBase64	string	Inline Base 64.

SparkJobDefinitionDefinitionResponse

Spark job definition public definition response.

Name	Type	Description
definition	SparkJobDefinitionPublicDefinition	Spark job definition public definition object. Refer to this article for more details on how to craft a spark job definition public definition.

SparkJobDefinitionPublicDefinition

Spark job definition public definition object. Refer to this article for more details on how to craft a spark job definition public definition.

Name	Type	Description
format	string	The format of the item definition. Supported format: SparkJobDefinitionV1.
parts	SparkJobDefinitionPublicDefinitionPart[]	A list of definition parts.

SparkJobDefinitionPublicDefinitionPart

Spark job definition definition part object.

Name	Type	Description
path	string	The spark job definition public definition part path.
payload	string	The spark job definition public definition part payload.
payloadType	PayloadType	The payload type.