Skip to main content

Points de terminaison de la tâche

Points de terminaison et paramètres de tâches

Récupérer les détails sur l'exécution des tâches

Récupérer les détails d'une tâche spécifique

Récupérer les messages d'une tâche spécifique

Annuler une tâche spécifique

Pour en savoir plus sur les relations d'objets et sur leur utilisation dans l'API, consultez la section Relations d'objets.

Pour plus d'informations sur les tâches, consultez la page d'aide Tâches : interface Administrateur.

Récupérer les détails de toutes les tâches

Pour récupérer les détails de toutes les tâches et leur état actuel, utilisez le point de terminaison GET {baseURL}/v3/jobs. Utilisez différents paramètres pour filtrer les tâches que vous souhaitez afficher.

Note

Seuls les Administrateurs peuvent utiliser ce point de terminaison.

Paramètres

  • sortField (chaîne) : facultatif. Triez les résultats selon les valeurs autorisées suivantes : CreateDate, AppName, CompletionDateTime, Priority, Status.

  • direction (chaîne) : facultatif. Triez par ordre croissant ou décroissant. Les valeurs autorisées sont : asc ou desc.

  • offset (chaîne) : facultatif. Saisissez le décalage pour la pagination.

  • limit (chaîne) : facultatif. Saisissez la limite pour la pagination.

  • priorities (chaîne) : facultatif. Pour filtrer par priorités de tâche, saisissez une ou plusieurs de ces valeurs : Basse, Moyenne, Élevée, Critique et Valeurs numériques.

  • statuses (chaîne) : facultatif. Pour filtrer par statut, saisissez une ou plusieurs de ces valeurs : En file d'attente, En cours d'initialisation, En cours d'exécution et Terminée.

  • users (chaîne) : facultatif. Pour filtrer par utilisateur, saisissez un userId valide. Filtre uniquement si allUsers = true.

  • allUsers (booléen) : facultatif. Pour inclure tous les utilisateurs, sélectionnez true.

  • workflowNames (chaîne) : facultatif. Pour filtrer par nom de workflow, saisissez un ou plusieurs workflowName.

  • completedBefore (chaîne) : facultatif. Renvoie les tâches terminées avant la date spécifiée. Les tâches terminées à la date donnée sont exclues. Le format requis est aaaa-MM-jj.

  • completedAfter (chaîne) : facultatif. Renvoie les tâches terminées après la date spécifiée. Les tâches terminées à la date donnée sont exclues. Le format requis est aaaa-MM-jj.

Exemple de demande : cURL

curl -X 'GET' \
  'http://localhost/webapi/v3/jobs' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere'

Exemple de réponse

  • 200 : OK

    {
  "data": [
    {
      "jobId": "68dd3292c97fddfcc003adcb",
      "status": "Completed",
      "workflowName": "Workflow1.yxmd",
      "workflowId": "68dd32922a719467662d27c7",
      "submittedBy": "Jane Doe",
      "startTime": "2025-10-01T13:54:26Z",
      "queueTime": "2025-10-01T13:54:26Z",
      "executionTime": "00:00:02",
      "priority": "6"
    },
    {
      "jobId": "68dd3336c97fddfcc003add2",
      "status": "Completed",
      "workflowName": "Workflow1",
      "workflowId": "68dd32922a719467662d27c7",
      "submittedBy": "Jane Doe",
      "startTime": "2025-10-01T13:57:10Z",
      "queueTime": "2025-10-01T13:57:10Z",
      "executionTime": "00:00:02",
      "priority": "Low"
    }
  ],
  "pagination": {
    "currentPage": 1,
    "pageSize": 50,
    "totalItems": 3,
    "totalPages": 1,
    "hasNextPage": false,
    "hasPreviousPage": false
  }
}

  • 401 : Non autorisé

Récupérer les détails d'une tâche spécifique

Pour récupérer des détails sur une tâche existante et son état actuel, utilisez le point de terminaison GET {baseURL}/v3/jobs/{jobId}. Utilisez différents paramètres pour filtrer les tâches que vous souhaitez afficher.

Note

Seuls les workflows d'application peuvent être utilisés.

Les utilisateurs peuvent voir les tâches exécutées par eux et les tâches exécutées selon des planifications partagées via Collections.

Paramètres

  • jobId (chaîne) : obligatoire. Saisissez l'ID de tâche pour lequel vous souhaitez afficher les détails.

  • includeMessages (booléen) : facultatif. Peut être laissé sans valeur. Vous pouvez choisir parmi les valeurs suivantes : « vrai » et « faux ». Si ce paramètre est défini sur « faux », un objet réduit est renvoyé. Lorsqu'elle n'est pas spécifiée, la valeur « vrai » est utilisée.

Exemple de demande : cURL

curl -X 'GET' \
  'http://localhost/webapi/v3/jobs/66ebd18d3d6200007e000d8c?includeMessages=true' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere'

Exemple de réponse

  • 200 : OK

    {
  "id": "string",
  "appId": "string",
  "createDateTime": "2024-09-19T10:02:54.589Z",
  "status": "string",
  "disposition": "string",
  "outputs": [
    {
      "id": "string",
      "availableFormats": [
        "string"
      ],
      "fileName": "string"
    }
  ],
  "messages": [
    {
      "status": 0,
      "text": "string",
      "toolId": 0
    }
  ],
  "priority": "Default",
  "workerTag": "string",
  "runWithE2": true
}

  • 401 : Non autorisé

  • 404 : NotFound

Récupérer les messages d'une tâche spécifique

Pour extraire tous les messages d'une tâche spécifique, utilisez le point de terminaison GET {baseURL}/v3/jobs/{jobId}/messages.

Note

Seuls les Administrateurs peuvent utiliser ce point de terminaison.

Paramètres

  • jobId (chaîne) : obligatoire. Saisissez l'ID de tâche pour lequel vous souhaitez afficher les messages.

Exemple de demande : cURL

curl -X 'GET' \
  'http://localhost/webapi/v3/jobs/66ebd18d3d6200007e000d8c/messages' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere'

Exemple de réponse

  • 200 : OK

    {
  "status": 0,
  "text": "string",
  "toolId": 0
}

  • 401 : Non autorisé

  • 404 : NotFound

Annuler une tâche spécifique

Pour annuler une tâche spécifique, utilisez le point de terminaison DELETE {baseURL}/v3/jobs/{jobId}. La tâche doit être à l'état « En file d'attente » ou « En cours d'exécution ».

Si vous annulez une tâche en cours d'exécution, elle est annulée. Si vous annulez une tâche en file d'attente, elle est supprimée.

Note

Les administrateurs peuvent annuler n'importe quelle tâche.

D'autres rôles peuvent annuler des tâches qu'ils ont créées, déclenchées ou planifiées. Cela inclut les tâches partagées avec eux par le biais de collections, même s'ils ne sont pas le propriétaire de la tâche.

Paramètres

  • jobId (chaîne) : obligatoire. Saisissez l'ID de tâche à supprimer.

Exemple de demande : cURL

curl -X 'DELETE' \
  'http://localhost/webapi/v3/jobs/678f97baa15300008c0039fc' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere'

Exemple de réponse

  • 200 : OK

    • Réponse lorsque vous annulez une tâche en cours d'exécution :

      {
  "message": "Cancelled Successfully."
}

    • Réponse lorsque vous annulez une tâche en file d'attente :

      {
  "message": "Deleted Successfully."
}

  • 400 : BadRequest

    • Réponse lorsque la tâche n'est pas à l'état « En file d'attente » ou « En cours d'exécution » :

      {
  "message": "This job is not in 'Queued' or 'Running' state."
}

    • Réponse lorsque l'utilisateur effectuant l'appel API n'est pas autorisé à annuler la tâche :

      {
  "message": "You do not have permission to cancel this job."
}

  • 401 : Non autorisé

  • 404 : NotFound

Relations d'objets

Si vous souhaitez obtenir des informations sur une tâche spécifique, vous aurez besoin d'un jobId. Pour obtenir ce jobId, utilisez le point de terminaison GET {baseURL}/v3/workflows/{workflowId}/jobs. Pour plus d'informations sur ce point de terminaison, consultez la page d'aide Points de terminaison du workflow.Points de terminaison du workflow

Demandes Postman

Pour en savoir plus sur les demandes Postman, consultez la page d'aide Comment utiliser Postman.

Dans cette section​: