Items - Create Copy Job

Service:: CopyJob

API Version:: v1

Creates a CopyJob in the specified workspace.
This API supports long running operations (LRO).

To create CopyJob with a public definition, refer to CopyJob.

Permissions

The caller must have a contributor workspace role.

Required Delegated Scopes

CopyJob.ReadWrite.All or Item.ReadWrite.All

Limitations

To create a CopyJob the workspace must be on a supported Fabric capacity. For more information see: Microsoft Fabric license types.

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}/copyJobs

URI Parameters

Name	In	Required	Type	Description
workspaceId	path	True	string (uuid)	The workspace ID.

Request Body

Name	Required	Type	Description
displayName	True	string	The CopyJob display name. The display name must follow naming rules according to item type.
definition		CopyJobDefinition	The CopyJob public definition.
description		string	The CopyJob description. Maximum length is 256 characters.
folderId		string (uuid)	The folder ID. If not specified or null, the CopyJob is created with the workspace as its folder.

Responses

Name	Type	Description
201 Created	CopyJob	Successfully created
202 Accepted		Request accepted, CopyJob provisioning in progress. Headers Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Common error codes: InvalidItemType - Item type is invalid ItemDisplayNameAlreadyInUse - Item display name is already used. CorruptedPayload - The provided payload is corrupted.

Name

Type

Description

201 Created

CopyJob

Successfully created

202 Accepted

Request accepted, CopyJob provisioning in progress.

Headers

Location: string
x-ms-operation-id: string
Retry-After: integer

Other Status Codes

ErrorResponse

Common error codes:

InvalidItemType - Item type is invalid
ItemDisplayNameAlreadyInUse - Item display name is already used.
CorruptedPayload - The provided payload is corrupted.

Examples

Create a CopyJob example

Create a CopyJob with public definition example

Create a CopyJob example

Sample request

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/copyJobs

{
  "displayName": "CopyJob 1",
  "description": "A Copy job description."
}

Sample response

Status code:: 201

{
  "displayName": "CopyJob 1",
  "description": "A Copy job description.",
  "type": "CopyJob",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Status code:: 202

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Create a CopyJob with public definition example

Sample request

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/copyJobs

{
  "displayName": "CopyJob 1",
  "description": "A Copy job description.",
  "definition": {
    "parts": [
      {
        "path": "copyjob-content.json",
        "payload": "ewogICJwcm9wZXJ0aWVzIjogewogICAgImpvYk1vZGUiOiAiQmF0Y2giCiAgfSwKICAiYWN0aXZpdGllcyI6IFtdCn0=",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Sample response

Status code:: 201

{
  "displayName": "CopyJob 1",
  "description": "A Copy job description.",
  "type": "CopyJob",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Status code:: 202

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Definitions

Name	Description
CopyJob	A CopyJob object.
CopyJobDefinition	CopyJob public definition object. Refer to Copy job definition for more details on how to craft a CopyJob public definition.
CopyJobDefinitionPart	CopyJob definition part object.
CreateCopyJobRequest	Create CopyJob request payload.
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.
ItemTag	Represents a tag applied on an item.
ItemType	The type of the item. Additional item types may be added over time.
PayloadType	The type of the definition part payload. Additional payload types may be added over time.

CopyJob

Object

A CopyJob object.

Name	Type	Description
description	string	The item description.
displayName	string	The item display name.
folderId	string (uuid)	The folder ID.
id	string (uuid)	The item ID.
tags	ItemTag[]	List of applied tags.
type	ItemType	The item type.
workspaceId	string (uuid)	The workspace ID.

CopyJobDefinition

Object

CopyJob public definition object. Refer to Copy job definition for more details on how to craft a CopyJob public definition.

Name	Type	Description
format	string	The format of the item definition.
parts	CopyJobDefinitionPart[]	A list of definition parts.

CopyJobDefinitionPart

Object

CopyJob definition part object.

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

CreateCopyJobRequest

Object

Create CopyJob request payload.

Name	Type	Description
definition	CopyJobDefinition	The CopyJob public definition.
description	string	The CopyJob description. Maximum length is 256 characters.
displayName	string	The CopyJob display name. The display name must follow naming rules according to item type.
folderId	string (uuid)	The folder ID. If not specified or null, the CopyJob is created with the workspace as its folder.

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.
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

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.

ItemTag

Object

Represents a tag applied on an item.

Name	Type	Description
displayName	string	The name of the tag.
id	string (uuid)	The tag ID.

ItemType

Enumeration

The type of the item. Additional item types may be added over time.

Value	Description
Dashboard	PowerBI dashboard.
Report	PowerBI report.
SemanticModel	PowerBI semantic model.
PaginatedReport	PowerBI paginated report.
Datamart	PowerBI datamart.
Lakehouse	A lakehouse.
Eventhouse	An eventhouse.
Environment	An environment.
KQLDatabase	A KQL database.
KQLQueryset	A KQL queryset.
KQLDashboard	A KQL dashboard.
DataPipeline	A data pipeline.
Notebook	A notebook.
SparkJobDefinition	A spark job definition.
MLExperiment	A machine learning experiment.
MLModel	A machine learning model.
Warehouse	A warehouse.
Eventstream	An eventstream.
SQLEndpoint	An SQL endpoint.
MirroredWarehouse	A mirrored warehouse.
MirroredDatabase	A mirrored database.
Reflex	A Reflex.
GraphQLApi	An API for GraphQL item.
MountedDataFactory	A MountedDataFactory.
SQLDatabase	A SQLDatabase.
CopyJob	A Copy job.
VariableLibrary	A VariableLibrary.
Dataflow	A Dataflow.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	A Warehouse snapshot.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	A Digital Twin Builder Flow.
MirroredAzureDatabricksCatalog	A mirrored azure databricks catalog.

PayloadType

Enumeration

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

Value	Description
InlineBase64	Inline Base 64.

Share via

Items - Create Copy Job

Permissions

Required Delegated Scopes

Limitations

Microsoft Entra supported identities

Interface

URI Parameters

Request Body

Responses

Examples

Create a CopyJob example

Sample request

Sample response

Create a CopyJob with public definition example

Sample request

Sample response

Definitions

CopyJob

CopyJobDefinition

CopyJobDefinitionPart

CreateCopyJobRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

PayloadType