Items - Get Data Agent Definition

Service:: DataAgent

API Version:: v1

Returns the specified DataAgent public definition.
This API supports long running operations (LRO).

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

Permissions

The caller must have read and write permissions for the DataAgent.

Required Delegated Scopes

Item.ReadWrite.All

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity	Support
User	Yes
Service principal and Managed identities	Yes

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataAgents/{dataAgentId}/getDefinition

With optional parameters:

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

URI Parameters

Name	In	Required	Type	Description
dataAgentId	path	True	string (uuid)	The DataAgent ID.
workspaceId	path	True	string (uuid)	The workspace ID.
format	query		string	The format of the data agent public definition.

Responses

Name	Type	Description
200 OK	DataAgentDefinitionResponse	Request completed successfully.
202 Accepted		Request accepted. Retrieving the definition is in progress. Headers Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests. Headers Retry-After: integer
Other Status Codes	ErrorResponse	Common error codes: OperationNotSupportedForItem - Operation not supported for requested item.

Examples

Get a DataAgent public definition example

Sample request

HTTP

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

Sample response

Status code:: 200

{
  "definition": {
    "parts": [
      {
        "path": "DataAgentV1.json",
        "payload": "ew0KICAiZXhlY3V0YW..OWRmNDhhY2ZmZTgifQ",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "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
DataAgentDefinitionResponse	DataAgent public definition response.
DataAgentPublicDefinition	DataAgent public definition object. Refer to this article for more details on the structure of the DataAgent definition.
DataAgentPublicDefinitionPart	DataAgent definition part object.
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.

DataAgentDefinitionResponse

Object

DataAgent public definition response.

Name	Type	Description
definition	DataAgentPublicDefinition	DataAgent public definition object. Refer to this article for more details on the structure of the DataAgent definition.

DataAgentPublicDefinition

Object

DataAgent public definition object. Refer to this article for more details on the structure of the DataAgent definition.

Name	Type	Description
format	string	The format of the data agent definition.
parts	DataAgentPublicDefinitionPart[]	A list of definition parts.

DataAgentPublicDefinitionPart

Object

DataAgent definition part object.

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

ErrorRelatedResource

Object

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

Object

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.
isRetriable	boolean	When true, the request can be retried. Use the `Retry-After` response header to determine the delay, if available.
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 (uuid)	ID of the request associated with the error.

ErrorResponseDetails

Object

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

Enumeration

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

Value	Description
InlineBase64	Inline Base 64.