Récupérer une tâche par id

Récupère une tâche. Utile pour vérifier son statut.

GET https://{tenantDomain}/api/v2/jobs/{id}

Go

Go

package example

import (
    context "context"

    client "github.com/auth0/go-auth0/management/management/client"
    option "github.com/auth0/go-auth0/management/management/option"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    client.Jobs.Get(
        context.TODO(),
        "id",
    )
}

200

{
  "id": "job_0000000000000001",
  "status": "pending",
  "type": "users_import",
  "connection_id": "con_0000000000000001",
  "created_at": "<string>",
  "location": "<string>",
  "percentage_done": 123,
  "status_details": "<string>",
  "summary": {
    "failed": 0,
    "inserted": 0,
    "total": 0,
    "updated": 0
  },
  "time_left_seconds": 123
}

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Paramètres de chemin

id · string · requis

ID de la tâche.

Réponse

200

application/json

Tâche récupérée avec succès.

id · string · défaut: job_0000000000000001 · requis

ID de cette tâche.

status · string · défaut: pending · requis

Statut de cette tâche.

type · string · défaut: users_import · requis

Type de cette tâche.

connection_id · string · défaut: con_0000000000000001

connection_id de la connexion utilisée par cette tâche.

created_at · string

Date de création de cette tâche.

format · enum<string>

Format du fichier. Doit être json ou csv.

Options disponibles: json, csv

location · string

URL permettant de télécharger le résultat de cette tâche.

percentage_done · integer

Pourcentage d’avancement de cette tâche.

status_details · string

Détails du statut.

summary · object

Résumé de l’exécution de cette tâche.

Show child attributes

time_left_seconds · integer

Temps restant estimé avant la fin de cette tâche.