Items - Update Copy Job Definition

Service:

CopyJob

API-versie:

v1

Hiermee wordt de definitie voor de opgegeven CopyJob overschreven.
Deze API ondersteunt langlopende bewerkingen (LRO).

Het bijwerken van de definitie van de CopyJob heeft geen invloed op het vertrouwelijkheidslabel.

Machtigingen

De API-aanroeper moet inzender hebben of een hogere werkruimterol.

Vereiste gedelegeerde bereiken

CopyJob.ReadWrite.All of Item.ReadWrite.All

Door Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft -identiteiten vermeld in deze sectie.

Identiteit	Ondersteuning
Gebruiker	Ja
service-principal en beheerde identiteiten	Ja

gebruikersinterface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/copyJobs/{copyJobId}/updateDefinition

Met optionele parameters:

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/copyJobs/{copyJobId}/updateDefinition?updateMetadata={updateMetadata}

URI-parameters

Name	In	Vereist	Type	Description
copyJobId	path	True	string (uuid)	De CopyJob-id.
workspaceId	path	True	string (uuid)	De werkruimte-id.
updateMetadata	query		boolean	Als deze is ingesteld op true en het .platform-bestand wordt opgegeven als onderdeel van de definitie, worden de metagegevens van het item bijgewerkt met behulp van de metagegevens in het PLATFORM-bestand

Aanvraagbody

Name	Vereist	Type	Description
definition	True	CopyJobDefinition	CopyJob public definition object. Raadpleeg taakdefinitie kopiëren voor meer informatie over het maken van een openbare CopyJob-definitie.

Antwoorden

Name	Type	Description
200 OK		De aanvraag is voltooid.
202 Accepted		Aanvraag geaccepteerd. De definitie van de update wordt uitgevoerd. Kopteksten Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Veelvoorkomende foutcodes: OperationNotSupportedForItem - Bewerking wordt niet ondersteund voor aangevraagd item. CorruptedPayload: de opgegeven nettolading is beschadigd.

Voorbeelden

Update a CopyJob public definition example

Voorbeeldaanvraag

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/copyJobs/5b218778-e7a5-4d73-8187-f10824047715/updateDefinition?updateMetadata=True

{
  "definition": {
    "parts": [
      {
        "path": "copyjob-content.json",
        "payload": "ewogICJwcm9wZXJ0aWVzIjogewogICAgImpvYk1vZGUiOiAiQ0RDIgogIH0sCiAgImFjdGl2aXRpZXMiOiBbXQp9",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Voorbeeldrespons

Statuscode:

200

Statuscode:

202

Location: https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
Retry-After: 30

Definities

Name	Description
CopyJobDefinition	CopyJob public definition object. Raadpleeg taakdefinitie kopiëren voor meer informatie over het maken van een openbare CopyJob-definitie.
CopyJobDefinitionPart	CopyJob definition part object.
ErrorRelatedResource	Het foutgerelateerde resourcedetailsobject.
ErrorResponse	Het foutbericht.
ErrorResponseDetails	De details van het foutbericht.
PayloadType	Het type nettolading van het definitieonderdeel. Er kunnen in de loop van de tijd extra typen nettoladingen worden toegevoegd.
UpdateCopyJobDefinitionRequest	Werk de nettolading van de openbare definitie-aanvraag voor CopyJob bij.

CopyJobDefinition

Object

CopyJob public definition object. Raadpleeg taakdefinitie kopiëren voor meer informatie over het maken van een openbare CopyJob-definitie.

Name	Type	Description
format	string	De indeling van de itemdefinitie.
parts	CopyJobDefinitionPart[]	Een lijst met definitieonderdelen.

CopyJobDefinitionPart

Object

CopyJob definition part object.

Name	Type	Description
path	string	Het pad van het onderdeel CopyJob public definition.
payload	string	De nettolading van het openbare definitieonderdeel CopyJob.
payloadType	PayloadType	Het nettoladingstype.

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Name	Type	Description
resourceId	string	De resource-id die betrokken is bij de fout.
resourceType	string	Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

Het foutbericht.

Name	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message	string	Een leesbare weergave van de fout.
moreDetails	ErrorResponseDetails[]	Lijst met aanvullende foutdetails.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.
requestId	string	Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Name	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message	string	Een leesbare weergave van de fout.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.

PayloadType

Inventarisatie

Het type nettolading van het definitieonderdeel. Er kunnen in de loop van de tijd extra typen nettoladingen worden toegevoegd.

Waarde	Description
InlineBase64	Inline base 64.

UpdateCopyJobDefinitionRequest

Object

Werk de nettolading van de openbare definitie-aanvraag voor CopyJob bij.

Name	Type	Description
definition	CopyJobDefinition	CopyJob public definition object. Raadpleeg taakdefinitie kopiëren voor meer informatie over het maken van een openbare CopyJob-definitie.