Dela via

Job Scheduler - Run On Demand Item Job

Tjänst:
Core
API-version:
v1

Kör postjobbinstansen på begäran.

Anmärkning

URL:en för det här API:et har uppdaterats för att inkludera jobbtypen som en del av sökvägen och ersätter den tidigare användningen av en frågeparameter. För bakåtkompatibilitet stöds fortfarande anrop med frågeparametern.

Obligatoriska delegerade omfång

För objekt-API:er använder du följande omfångstyper:

  • Allmänt omfång: Item.Execute.All
  • Specifikt omfång: itemType. Execute.All (till exempel: Notebook.Execute.All)

Mer information om omfång finns i artikeln om omfång.

Microsoft Entra identiteter som stöds

Det här API:et stöder Microsoft identiteter som anges i det här avsnittet.

Identitet Stöd
Användare Ja
Tjänsthuvudnamn och hanterade identiteter Ja

Gränssnitt

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/jobs/{jobType}/instances

URI-parametrar

Name I Obligatorisk Typ Description
itemId
 path True

string (uuid)

Objekt-ID:t.
jobType
 path True

string

Jobbtyp
workspaceId
 path True

string (uuid)

Arbetsyte-ID.

Begärandetext

Name Typ Description
executionData

object

Körningsdata för ett jobb på begäran. Det här är fasta statiska data som definieras av den specifika objektjobbtypen.
parameters

Parameter[]

Parameterlistan för ett jobb på begäran. Det här är användardefinierade indata per körning som skräddarsyr det här anropet. Obs! Den här egenskapen stöds inte i stort sett. Om API:et returnerar ett fel med errorCode FeatureNotAvailable och errorMessage Parameter is not allowed for this item type or this item job typeparametersstöds inte egenskapen för den angivna objekttypen eller objektjobbtypen.

Svar

Name Typ Description
202 Accepted

Begäran accepterad, jobbkörning pågår.

Headers:

Platsstring – URL:en till jobbinstansresursen.

Försök igen efterinteger – Antalet sekunder som klienten ska vänta innan jobbstatusen avsöks för första gången. Klienter måste använda det här värdet för att avgöra när jobbstatusen ska kontrolleras och bör vänta minst så här många sekunder innan den första statussökningen.
429 Too Many Requests

ErrorResponse

Gränsen för tjänstfrekvens överskreds. Servern returnerar ett Retry-After huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas.

Sidhuvuden

Retry-After: integer
Other Status Codes

ErrorResponse

Vanliga felkoder:

  • InsufficientPrivileges – anroparen har inte tillräcklig behörighet för att köra jobbinstansen.

  • InvalidJobType – Den begärda jobbtypen är ogiltig.

  • TooManyRequestsForJobs – anroparen begär för många jobbbegäranden på begäran.

  • ItemNotFound – Det gick inte att hitta det begärda objekt-ID:t.

Exempel

Run item job instance with no request body example
Run item job instance with request body containing both executionData and parameters example
Run item job instance with request body containing executionData example
Run item job instance with request body containing parameters example

Run item job instance with no request body example

Exempelbegäran

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

Exempelsvar

Statuskod:
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 both executionData and parameters example

Exempelbegäran

POST https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/items/dddddddd-9999-0000-1111-eeeeeeeeeeee/jobs/Execute/instances

{
  "executionData": {
    "executeOption": "ApplyChangesIfNeeded"
  },
  "parameters": [
    {
      "name": "Threshold",
      "value": "start",
      "type": "Automatic"
    },
    {
      "name": "OrderKey",
      "value": 25,
      "type": "Automatic"
    }
  ]
}

Exempelsvar

Statuskod:
202 
Location: https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/items/dddddddd-9999-0000-1111-eeeeeeeeeeee/jobs/instances?jobType=Execute
Retry-After: 60

Run item job instance with request body containing executionData example

Exempelbegäran

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

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

Exempelsvar

Statuskod:
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 parameters example

Exempelbegäran

POST https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/items/dddddddd-9999-0000-1111-eeeeeeeeeeee/jobs/Execute/instances

{
  "parameters": [
    {
      "name": "param1",
      "value": "value1",
      "type": "Text"
    },
    {
      "name": "param2",
      "value": true,
      "type": "Boolean"
    },
    {
      "name": "param3",
      "value": 123,
      "type": "Number"
    }
  ]
}

Exempelsvar

Statuskod:
202 
Location: https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/items/dddddddd-9999-0000-1111-eeeeeeeeeeee/jobs/instances?jobType=Execute
Retry-After: 60

Definitioner

Name Description
ErrorRelatedResource

Det felrelaterade resursinformationsobjektet.
ErrorResponse

Felsvaret.
ErrorResponseDetails

Information om felsvar.
ItemJobParameterType

En sträng som representerar parameterns typ. Ytterligare typer kan läggas till över tid.
Parameter

En objektjobbparameter.
RunOnDemandItemJobRequest

Kör jobbinstansnyttolasten för objekt på begäran

ErrorRelatedResource

Objekt

Det felrelaterade resursinformationsobjektet.

Name Typ Description
resourceId

string

Det resurs-ID som ingår i felet.
resourceType

string

Typen av resurs som är inblandad i felet.

ErrorResponse

Objekt

Felsvaret.

Name Typ Description
errorCode

string

En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message

string

En mänsklig läsbar representation av felet.
moreDetails

ErrorResponseDetails[]

Lista över ytterligare felinformation.
relatedResource

ErrorRelatedResource

Felrelaterad resursinformation.
requestId

string (uuid)

ID för den begäran som är associerad med felet.

ErrorResponseDetails

Objekt

Information om felsvar.

Name Typ Description
errorCode

string

En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message

string

En mänsklig läsbar representation av felet.
relatedResource

ErrorRelatedResource

Felrelaterad resursinformation.

ItemJobParameterType

Uppräkning

En sträng som representerar parameterns typ. Ytterligare typer kan läggas till över tid.

Värde Description
VariableReference

Parametertypen är en variabelreferens.
Integer

Parametertypen är ett heltal.
Number

Parametertypen är ett tal. Den accepterar både heltals- och flyttalsvärden.
Text

Parametertypen är en text.
Boolean

Parametertypen är boolesk.
DateTime

Parametertypen är en datetime i UTC med formatet YYYY-MM-DDTHH:mm:ssZ.
Guid

Parametertypen är en strängrepresentation av ett GUID med formatet 00000000-0000-0000-0000-0000000000000. Se https://dotnet.territoriali.olinfo.it/dotnet/api/system.guid.tostring formateringsinformation och använd standardformatet: "D".
Automatic

Parametertypen bestäms automatiskt. Obs! Den här typen kanske inte stöds för alla objektjobbtyper.

Parameter

Objekt

En objektjobbparameter.

Name Typ Description
name

string

Parameternamnet, som anges av anroparen, måste vara unikt (skiftlägesokänslig kontroll) och inte längre än 256 tecken.
type

ItemJobParameterType

Parametertypen.
value

object

Parametervärdet baserat på parametertypen.

RunOnDemandItemJobRequest

Objekt

Kör jobbinstansnyttolasten för objekt på begäran

Name Typ Description
executionData

object

Körningsdata för ett jobb på begäran. Det här är fasta statiska data som definieras av den specifika objektjobbtypen.
parameters

Parameter[]

Parameterlistan för ett jobb på begäran. Det här är användardefinierade indata per körning som skräddarsyr det här anropet. Obs! Den här egenskapen stöds inte i stort sett. Om API:et returnerar ett fel med errorCode FeatureNotAvailable och errorMessage Parameter is not allowed for this item type or this item job typeparametersstöds inte egenskapen för den angivna objekttypen eller objektjobbtypen.