GET

Lister les flux de travail

Récupérer tous les flux de travail configurés avec leurs statuts et paramètres associés.

Point de terminaison

Requête HTTP

GET /v1/workflows

Authentification

Ce point de terminaison nécessite une clé API valide avec la permission canViewStatuses . La clé API doit être passée dans l'en-tête X-API-Key .

En-tête requis

X-API-Key: ucos_live_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Réponse

Retourne un objet JSON avec la liste des flux de travail:

200 OK - Réponse de succès

{
  "success": true,
  "data": {
    "workflows": [
      {
        "id": "string",
        "name": "string",
        "description": null,
        "color": "string",
        "order": 0,
        "statuses": [
          {
            "id": "string",
            "name": "string",
            "public_name": null,
            "use_public_name": true,
            "display_name": "string",
            "color": "string",
            "order": 0,
            "is_independent": true,
            "is_addon": true
          }
        ],
        "status_count": 0
      }
    ],
    "workflows_enabled": true,
    "enforce_workflow_order": true,
    "summary": {
      "total": 0,
      "total_statuses": 0
    }
  }
}

Champs de réponse

Objet de réponse racine

Champ	Type	Description
`success`	boolean	Toujours true pour une réponse réussie.
`data`	object	Charge utile du point de terminaison. Ses champs sont détaillés dans les tableaux ci-dessous.
`workflows`	array	Tableau d'objets de flux de travail
`workflows_enabled`	boolean	Indique si le mode multi-flux de travail est actif
`enforce_workflow_order`	boolean	Indique si l'application de l'ordre des flux de travail est active. Lorsque vrai, les commandes doivent progresser à travers les flux de travail en séquence et ne peuvent pas reculer.
`summary`	object	Informations récapitulatives incluant les totaux

Champs d'objet de flux de travail

Champ	Type	Description
`id`	string	Identifiant unique du flux de travail
`name`	string	Nom d'affichage du flux de travail
`description`	string \| null	Description optionnelle de l'objectif du flux de travail
`color`	string	Code couleur hexadécimal pour l'affichage
`order`	number	Position d'affichage (croissant)
`statuses`	array	Tableau d'objets de statut assignés à ce flux de travail (triés par ordre croissant)
`status_count`	number	Nombre de statuts dans ce flux de travail

Champs d'objet de statut (dans le flux de travail)

Champ	Type	Description
`id`	string	UUID du statut
`name`	string	Nom interne du statut
`public_name`	string \| null	Nom orienté client
`use_public_name`	boolean	Indique si le nom public doit être utilisé pour les clients
`display_name`	string	Nom d'affichage calculé (public_name si use_public_name est vrai, sinon name)
`color`	string	Code couleur hexadécimal du statut
`order`	number	Ordre d'affichage dans le flux de travail
`is_independent`	boolean	Indique si le statut peut être utilisé indépendamment du flux de travail
`is_addon`	boolean	Indique si ce statut est un statut complémentaire

Objet récapitulatif

Champ	Type	Description
`total`	number	Nombre total de flux de travail
`total_statuses`	number	Nombre total de statuts dans tous les flux de travail

Exemples

Requête de base

Requête cURL

curl -X GET "https://api.ultimate-custom-order-status.apps.msmtech.ca/api/v1/workflows" \
  -H "X-API-Key: ucos_live_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
  -H "X-API-Version: 1.4"

Limitation de débit

Ce point de terminaison est soumis à des limites de débit par minute et par jour en fonction de votre clé API. Les informations de limite de débit sont renvoyées dans les en-têtes de réponse:

X-RateLimit-Limit-Minute: Nombre maximum de requêtes par minute
X-RateLimit-Remaining-Minute: Requêtes restantes dans la minute en cours
X-RateLimit-Reset-Minute: Horodatage Unix de réinitialisation de la fenêtre minute
X-RateLimit-Limit-Day: Nombre maximum de requêtes par jour
X-RateLimit-Remaining-Day: Requêtes restantes dans le jour en cours
X-RateLimit-Reset-Day: Horodatage Unix de réinitialisation de la fenêtre jour
Retry-After: Secondes à attendre avant de réessayer (en cas de limitation)

Réponses d'erreur

401 Non autorisé

Clé API manquante ou invalide

401 Non autorisé

{
  "success": false,
  "error": "Missing API key. Include it in the X-API-Key header"
}

403 Interdit

La clé API manque de permissions requises

403 Interdit

{
  "success": false,
  "error": "Insufficient permissions. Required: canViewStatuses"
}

500 Erreur interne du serveur

Une erreur du serveur s'est produite

500 Erreur interne du serveur

{
  "success": false,
  "error": "Internal server error",
  "details": {
    "message": "An unexpected error occurred"
  }
}