Récupérer le résultat

GET — Obtenir le JSON métier et les liens signés de ses pièces.

GET https://api.raydocs.com/workspaces/{WORKSPACE_ID}/workflows/{WORKFLOW_ID}/runs/{RUN_ID}/output

Récupérer le résultat final d’un traitement et télécharger directement ses fichiers avec les liens inclus. Utilisez le token API.

Avec les notifications, le même résultat métier est reçu dans output de l’enveloppe de transport. /output permet de le récupérer si le callback n’arrive pas. Le téléchargement ci-dessous s’applique aux deux modes de réception.

Paramètres du chemin

Paramètre	Type	Obligatoire	Description
`WORKSPACE_ID`	Identifiant	Oui	Espace de travail fourni par Raydocs.
`WORKFLOW_ID`	UUID	Oui	Workflow configuré pour votre intégration.
`RUN_ID`	UUID	Oui	Identifiant retourné lors de l’envoi des documents.

Exemple de requête

curl --fail-with-body "https://api.raydocs.com/workspaces/{WORKSPACE_ID}/workflows/{WORKFLOW_ID}/runs/{RUN_ID}/output" \
  -H "Authorization: Bearer {RAYDOCS_API_TOKEN}" \
  -H "Accept: application/json"

Réponse terminée — `200 OK`

Lorsque le traitement est completed, la réponse est directement le JSON métier du workflow, sans enveloppe output. Les fichiers temporaires accessibles référencés dans le résultat reçoivent automatiquement download_url et download_url_expires_at.

Extrait illustratif d’un résultat CDJ Connect, pas un lot complet :

{
  "dossiers": [{
    "pieces_jointes": [{
      "reference_piece": "DECISION-01",
      "nom": "Décision judiciaire",
      "chemin": "pieces/decision.pdf",
      "type": "PDF",
      "file_id": "5ef9bd1f-25d5-4ff2-a2c4-a31039aae174",
      "download_url": "https://api.raydocs.com/.../download?expires=...&signature=...",
      "download_url_expires_at": "2026-10-07T14:10:00.000000Z"
    }]
  }]
}

Champ	Description
`reference_piece`	Référence métier utilisée pour rattacher la pièce aux titres ou actes.
`chemin`	Destination locale de la pièce dans cette convention de transport.
`file_id`	Identifiant stable du fichier pour demander un nouveau lien.
`download_url`	Lien signé utilisable sans token API pendant dix minutes après génération.
`download_url_expires_at`	Date et heure d’expiration du lien.

Les champs de téléchargement relèvent de l’API Raydocs, distincte du standard CDJ Connect. Les originaux EML/MSG, Word, ZIP et les fichiers non classés peuvent être référencés dans extensions_prestataire.RAYDOCS.fichiers_sources[] et bénéficier des mêmes liens.

Télécharger directement les fichiers

Utilisez download_url telle quelle et suivez les redirections, sans en-tête Authorization. Il n’est pas nécessaire d’appeler /file avant chaque téléchargement.

# DOWNLOAD_URL : valeur download_url de la pièce
mkdir -p ./pieces
curl --fail --location "$DOWNLOAD_URL" --output ./pieces/decision.pdf

Validez le chemin reçu, enregistrez la pièce dans le répertoire de la demande et vérifiez son intégrité avant import.

Si le lien expire ou est absent

Appelez Obtenir un lien de téléchargement avec le même RUN_ID et le file_id de la pièce. Vous pouvez aussi relire /output pour obtenir de nouveaux liens générés automatiquement. Ne relancez pas le workflow pour renouveler un lien.

La génération des liens dépend de l’accès aux fichiers et de références exploitables. Une référence inaccessible ou invalide reste inchangée, sans empêcher le retour du reste du résultat. Si un objet définit déjà download_url ou download_url_expires_at, ses champs sont conservés et ne sont pas régénérés automatiquement.

La validité de dix minutes concerne le lien, pas la conservation du fichier. Un fichier supprimé ne peut pas être restauré en renouvelant son lien.

Traitement non terminé — `200 OK`

Aucun résultat partiel n’est retourné. Par exemple :

{
  "status": "running"
}

Poursuivez le suivi du statut.

Traitement échoué

Un traitement failed ne fournit pas de résultat métier. Une erreur publique peut être retournée :

{
  "status": "failed",
  "error": {
    "code": "UNSUPPORTED_ACT_TYPE",
    "message": "Type d'acte non supporté par ce workflow."
  }
}

Consultez les codes et la gestion des erreurs.