Job Scheduler - List Item Job Instances

Référence

Service:: Core

Version d'API:: v1

Retourne une liste d’instances de travail pour l’élément spécifié.

Étendues déléguées requises

Pour les API d’élément, utilisez ces types d’étendue :

Étendue générique : Item.ReadWrite.All ou Item.Read.All
Étendue spécifique : itemType. ReadWrite.All ou itemType. Read.All (par exemple : Notebook.ReadWrite.All)

pour plus d’informations sur les étendues, consultez article sur les étendues.

Limites

La plupart des éléments ont une limite de 100 entités récemment terminées et il n’existe pas de limite pour les entités actives.

Identités prises en charge par Microsoft Entra

Cette API prend en charge les identités Microsoft répertoriées dans cette section.

Identité	Soutien
Utilisateur	Oui
Service principal et identités gérées	Oui

Interface

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

Avec des paramètres facultatifs:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/jobs/instances?continuationToken={continuationToken}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
itemId	path	True	string (uuid)	ID d’élément.
workspaceId	path	True	string (uuid)	Identifiant de l’espace de travail.
continuationToken	query		string	Jeton permettant de récupérer la page suivante des résultats.

Réponses

Nom	Type	Description
200 OK	ItemJobInstances	La demande s’est terminée avec succès.
Other Status Codes	ErrorResponse	Codes d’erreur courants : InsufficientPrivileges : l’appelant ne dispose pas des autorisations suffisantes pour accéder à l’élément. ItemNotFound - ID d’élément demandé introuvable.

Nom

Type

Description

200 OK

ItemJobInstances

La demande s’est terminée avec succès.

Other Status Codes

ErrorResponse

Codes d’erreur courants :

InsufficientPrivileges : l’appelant ne dispose pas des autorisations suffisantes pour accéder à l’élément.
ItemNotFound - ID d’élément demandé introuvable.

Exemples

List item job instances example

List item job instances with continuation example

List item job instances example

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "id": "f2d65699-dd22-4889-980c-15226deb0e1b",
      "itemId": "431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
      "jobType": "DefaultJob",
      "invokeType": "Manual",
      "status": "Completed",
      "rootActivityId": "8c2ee553-53a4-7edb-1042-0d8189a9e0ca",
      "startTimeUtc": "2024-06-22T06:35:00.7812154",
      "endTimeUtc": "2024-06-22T06:35:00.8033333",
      "failureReason": null
    },
    {
      "id": "c0c99aed-be56-4fe0-a6e5-6de5fe277f16",
      "itemId": "431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
      "jobType": "DefaultJob",
      "invokeType": "Manual",
      "status": "Completed",
      "rootActivityId": "c0c99aed-be56-4fe0-a6e5-6de5fe277f16",
      "startTimeUtc": "2024-06-22T06:35:00.7812154",
      "endTimeUtc": "2024-06-22T07:35:00.8033333",
      "failureReason": null
    }
  ]
}

List item job instances with continuation example

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "id": "f2d65699-dd22-4889-980c-15226deb0e1b",
      "itemId": "431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
      "jobType": "DefaultJob",
      "invokeType": "Manual",
      "status": "Completed",
      "rootActivityId": "8c2ee553-53a4-7edb-1042-0d8189a9e0ca",
      "startTimeUtc": "2024-06-22T06:35:00.7812154",
      "endTimeUtc": "2024-06-22T06:35:00.8033333",
      "failureReason": null
    },
    {
      "id": "c0c99aed-be56-4fe0-a6e5-6de5fe277f16",
      "itemId": "431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
      "jobType": "DefaultJob",
      "invokeType": "Manual",
      "status": "Completed",
      "rootActivityId": "c0c99aed-be56-4fe0-a6e5-6de5fe277f16",
      "startTimeUtc": "2024-06-22T06:35:00.7812154",
      "endTimeUtc": "2024-06-22T07:35:00.8033333",
      "failureReason": null
    }
  ],
  "continuationToken": "LDEsMTAwMDAwLDA%3D",
  "continuationUri": "https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/jobs/instances?continuationToken=LDEsMTAwMDAwLDA%3D"
}

Définitions

Nom	Description
ErrorRelatedResource	Objet de détails de ressource associé à l’erreur.
ErrorResponse	Réponse d’erreur.
ErrorResponseDetails	Détails de la réponse d’erreur.
InvokeType	Type d’appel du travail d’élément. Des invokeTypes supplémentaires peuvent être ajoutés au fil du temps.
ItemJobInstance	Objet représentant une instance de travail d’élément
ItemJobInstances
Status	État du travail d’élément. Des états supplémentaires peuvent être ajoutés au fil du temps.

ErrorRelatedResource

Object

Objet de détails de ressource associé à l’erreur.

Nom	Type	Description
resourceId	string	ID de ressource impliqué dans l’erreur.
resourceType	string	Type de la ressource impliquée dans l’erreur.

ErrorResponse

Object

Réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message	string	Représentation lisible humaine de l’erreur.
moreDetails	ErrorResponseDetails[]	Liste des détails d’erreur supplémentaires.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.
requestId	string	ID de la demande associée à l’erreur.

ErrorResponseDetails

Object

Détails de la réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message	string	Représentation lisible humaine de l’erreur.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.

InvokeType

Énumération

Type d’appel du travail d’élément. Des invokeTypes supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
Manual	Le travail est appelé manuellement
Scheduled	Le travail est planifié

ItemJobInstance

Object

Objet représentant une instance de travail d’élément

Nom	Type	Description
endTimeUtc	string	Heure de fin du travail au format UTC
failureReason	ErrorResponse	Réponse d’erreur lors de l’échec du travail
id	string (uuid)	ID de l’instance de travail
invokeType	InvokeType	Type d’appel du travail d’élément. Des invokeTypes supplémentaires peuvent être ajoutés au fil du temps.
itemId	string (uuid)	ID de l’élément
jobType	string	Type de poste
rootActivityId	string	ID d’activité racine pour suivre les demandes entre les services
startTimeUtc	string	Heure de début du travail au format UTC
status	Status	État du travail d’élément. Des états supplémentaires peuvent être ajoutés au fil du temps.

ItemJobInstances

Object

Nom	Type	Description
continuationToken	string	Jeton du lot du jeu de résultats suivant. S’il n’y a plus d’enregistrements, il est supprimé de la réponse.
continuationUri	string	URI du lot du jeu de résultats suivant. S’il n’y a plus d’enregistrements, il est supprimé de la réponse.
value	ItemJobInstance[]	Liste des instances de travail d’élément.

Status

Énumération

État du travail d’élément. Des états supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
Cancelled	Travail annulé
Completed	Travail terminé
Deduped	Une instance de travail du même type de travail est déjà en cours d’exécution et cette instance de travail est ignorée
Failed	Échec du travail
InProgress	Travail en cours
NotStarted	Travail non démarré

Partager via

Job Scheduler - List Item Job Instances

Étendues déléguées requises

Limites

Identités prises en charge par Microsoft Entra

Interface

Paramètres URI

Réponses

Exemples

List item job instances example

Exemple de requête

Exemple de réponse

List item job instances with continuation example

Exemple de requête

Exemple de réponse

Définitions

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

InvokeType

ItemJobInstance

ItemJobInstances

Status