Cet article liste et présente l’ensemble des appels API disponibles.
💡 Astuce : Utiliser les touches Ctrl + F pour trouver un résultat sur cet article plus rapidement.
ExternalApiApplicabilityResource
Catégorie | Nom de l'appel API | Action sur l’IHM |
POST | /ext/api/1.5/label-applicabilities | Rechercher les comptes présents sur une organisation |
external-api-version-document-flow-resource
Catégorie | Nom de l'appel API | Action sur l’IHM |
PUT | /ext/api/1.5/version-document-flows/{id}/client-response-files | Lier une pièce jointe au retour client dans le circuit de validation externe |
PUT | /ext/api/1.5/version-document-flows/{id}/client-cover-pages | Lier une page de couverture signée par le client au retour client dans le circuit de validation externe |
POST | /ext/api/1.5/version-document-flows/{id}/visa | Renseigner le retour client sur l’onglet suivi d’un document en fonction de son uuidEntity |
POST | /ext/api/1.5/version-document-flows/{id}/bpe-validations | Mettre un document à l'état validé |
GET | /ext/api/1.5/version-document-flows | Rechercher les versions (c’est-à-dire les lignes dans l’onglet suivi d’un document) de plusieurs documents |
GET | /ext/api/1.5/version-document-flows/{id} | Rechercher une version (c’est-à-dire une ligne dans l’onglet suivi d’un document) d’un document, en fonction de l’uuidEntity de la version |
GET | /ext/api/1.5/version-document-flows/{id}/pdf | Exporter en PDF une version (c’est-à-dire une ligne dans l’onglet suivi d’un document) d’un document, en fonction de l’uuidEntity de la version |
GET | /ext/api/1.5/closure-folder-versions/{id}/download | Exporter le PDF du dossier de clôture d’un projet, en fonction de l'uuidEntity du dossier de clôture |
external-api-flow-resource
🚨 Note : Pour plus de détails sur la signification des termes utilisés sur l’API pour les flows, se référer à cette section.
Catégorie | Nom de l'appel API | Action sur l’IHM |
GET | /ext/api/1.5/flows | Rechercher un ou plusieurs flows en fonction de son nom, du projet, du statut de flow, du type de flow ou du n° chrono |
PUT | /ext/api/1.5/flows | Editer un flow |
POST | /ext/api/1.5/flows | Créer un flow |
POST | /ext/api/1.5/flows/bulk/create | Créer des flows en masse |
PATCH | /ext/api/1.5/flows/custom-attributes/bulk/update | Editer des attributs de flows en masse |
PATCH | /ext/api/1.5/flows/bulk/update | Editer des flows en masse (sauf les attributs) |
GET | /ext/api/1.5/flows/{id} | Rechercher un flow en fonction de son uuidentity |
external-api-storage-resource
Catégorie | Nom de l'appel API | Action sur l’IHM |
POST | /ext/api/1.5/storage/pdf-files/upload | Importer un fichier PDF afin de l’associer comme valeur d’attribut de type fichier |
GET | /ext/api/1.5/storage/pdf-files | Rechercher un fichier PDF en fonction de son nom ou de sa référence |
external-api-skill-resource
Catégorie | Nom de l'appel API | Action sur l’IHM |
POST | /ext/api/1.5/skills/bulk | Assigner des compétences à un utilisateur en masse |
external-api-form-resource
🚨 Note : Pour plus de détails sur la signification des termes utilisés sur l’API pour :
Les formulaires, se référer à cette section
Les réponses de formulaires, se référer à cette section
L’export de photos en fichier ZIP, se référer à cette section
Catégorie | Nom de l'appel API | Action sur l’IHM |
POST | /ext/api/1.5/responses/export-many | Rechercher des formulaires et les réponses à ces formulaires |
GET | /ext/api/1.5/forms | Rechercher des formulaires en fonction du statut ou de la nature (modèle ou générique) |
POST | /ext/api/1.5/forms | Rechercher des formulaires en fonction du nom ou de la date de dernière modification |
POST | /ext/api/1.5/forms/{uuidType}/responses | Rechercher les réponses à un même formulaire dans tous les projets |
GET | /ext/api/1.5/responses | Rechercher des réponses de formulaire |
GET | /ext/api/1.5/responses/{id}/zipped-images | Exporter les photos contenus dans des réponses de formulaires sous format .zip |
external-api-project-resource
🚨 Note : Pour plus de détails sur la signification des termes utilisés sur l’API pour les entités, se référer à cette section.
Catégorie | Nom de l'appel API | Action sur l’IHM |
GET | /ext/api/1.5/projects | Rechercher une entité |
POST | /ext/api/1.5/projects | Créer une entité |
GET | /ext/api/1.5/projects/{id} | Rechercher une entité en fonction de son uuidentity |
external-api-project-referential-flow-resource
Catégorie | Nom de l'appel API | Action sur l’IHM |
POST | /ext/api/1.5/project-referential-flows/{flowRef}/async-execute | Exécuter (de manière asynchrone) un flow référentiel dans le module référentiels d’un projet |
external-api-kpi-usage-resource
Catégorie | Nom de l'appel API | Action sur l’IHM |
POST | /ext/api/1.5/kpi-usage/preparation | Rechercher le nombre total de projets, de flows et de formulaires créés en préparant un sous-dossier référentiel |
POST | /ext/api/1.5/kpi-usage/office | Rechercher le nombre total de projets, de flows et de formulaires locaux |
POST | /ext/api/1.5/kpi-usage/global | Rechercher le nombre total de collaborateurs, d'entités, de flows, de formulaires, de réponses de formulaires et de signatures |
POST | /ext/api/1.5/kpi-usage/form | Rechercher le nombre total de formulaires et de réponses de formulaires |
POST | /ext/api/1.5/kpi-usage/flows | Rechercher le nombre total de flows actifs dans des projets |
POST | /ext/api/1.5/kpi-usage/field | Rechercher le nombre total de réponses de formulaire et de signatures |
POST | /ext/api/1.5/kpi-usage/audience | Rechercher le nombre total de collaborateurs |
💡 Astuce : Le terme “collaborateurs” désigne la somme des utilisateurs et des opérateurs.
external-api-kpi-progression-resource
Catégorie | Nom de l'appel API | Action sur l’IHM |
POST | /ext/api/1.5/kpi-progression/{projectUuidEntity}/signatures | Rechercher le pourcentage de réalisation des signatures d’un projet en fonction de son uuidEntity |
POST | /ext/api/1.5/kpi-progression/{projectUuidEntity}/flows | Rechercher le pourcentage de réalisation des flows d’un projet en fonction de son uuidEntity |
POST | /ext/api/1.5/kpi-progression/{projectUuidEntity}/documents | Rechercher le pourcentage de réalisation des documents d’un projet en fonction de son uuidEntity |
POST | /ext/api/1.5/kpi-progression/{projectUuidEntity}/blocs | Rechercher le pourcentage de réalisation des blocs (issus des flows) d’un projet en fonction de son uuidEntity |
external-api-step-resource
Catégorie | Nom de l'appel API | Action sur l’IHM |
POST | /ext/api/1.5/flows/{flowRef}/steps/{stepRef}/link-other-flow | Lier un flow générique à une étape de flow spécifique Lier un flow spécifique, générique ou intervention à une étape de flow chapeau |
POST | /ext/api/1.5/flows/{flowRef}/phases/{phaseRef}/add-steps | Créer des étapes dans une phase |
GET | /ext/api/1.5/flows/{flowRef}/phases/{phaseRef}/steps | Rechercher les étapes d’une phase |
external-api-phase-resource
Catégorie | Nom de l'appel API | Action sur l’IHM |
POST | /ext/api/1.5/flows/{flowRef}/add-phases | Créer des phases dans un flow |
GET | /ext/api/1.5/flows/{flowRef}/phases | Rechercher les phases (et optionnellement les étapes) d’un flow |
external-api-document-flow-resource
🚨 Note : Pour plus de détails sur la signification des termes utilisés sur l’API pour les documents de flow, se référer à cette section.
Catégorie | Nom de l'appel API | Action sur l’IHM |
GET | /ext/api/1.5/document-flows | Rechercher un document source flow |
POST | /ext/api/1.5/document-flows | Créer un document source flow |
PATCH | /ext/api/1.5/document-flows | Editer un document source flow |
GET | /ext/api/1.5/document-flows/{id} | Rechercher un document source flow en fonction de son uuidEntity |
GET | /ext/api/1.5/document-flows/{id}/last-versions | Rechercher la dernière version (c’est-à-dire la dernière ligne dans l’onglet suivi d’un document) d’un document, en fonction de l’uuidEntity de la version |
GET | /ext/api/1.5/document-flows/{id}/last-versions-pdf | Exporter en PDF la dernière version (c’est-à-dire la dernière ligne dans l’onglet suivi d’un document) d’un document, en fonction de l’uuidEntity de la version |
external-api-custom-attribute-resource
Catégorie | Nom de l'appel API | Action sur l’IHM |
GET | /ext/api/1.5/dictionary/custom-attributes | Rechercher des attributs |
external-api-auth-resource
Catégorie | Nom de l'appel API | Action sur l’IHM |
POST | /ext/api/1.5/authenticate | Permet de s’identifier sur la plateforme d’API |
external-api-user-resource
🚨 Note : Pour plus de détails sur la signification des termes utilisés sur l’API pour les utilisateurs, les opérateurs et / ou les profils tablettes, se référer à cette section.
Catégorie | Nom de l'appel API | Action sur l’IHM |
PATCH | /ext/api/1.5/users/bulk | Editer des utilisateurs, des opérateurs et / ou des profils tablettes en masse |
GET | /ext/api/1.5/users | Rechercher des utilisateurs, des opérateurs et / ou des profils tablettes |
external-api-rubric-resource
Catégorie | Nom de l'appel API | Action sur l’IHM |
GET | /ext/api/1.5/rubrics-response/{rubricUuidEntity}/tree | Rechercher l’arborescence d’une rubrique d’une réponse de formulaire |
GET | /ext/api/1.5/rubrics-form/{rubricUuidEntity}/tree | Rechercher l’arborescence d’une rubrique d’un formulaire |
GET | /ext/api/1.5/responses/{responseUuidEntity}/rubrics | Rechercher les options d’une rubrique d’une réponse de formulaire |
GET | /ext/api/1.5/forms/{formUuidEntity}/rubrics | Rechercher les options d’une rubrique d’un formulaire |
external-api-label-family-resource
🚨 Note : Pour plus de détails sur la signification des termes utilisés sur l’API pour les familles, se référer à cette section.
Catégorie | Nom de l'appel API | Action sur l’IHM |
GET | /ext/api/1.5/label-families | Rechercher une famille |
external-kpi-resource
Catégorie | Nom de l'appel API | Action sur l’IHM |
GET | /ext/api/1.5/kpi/users | Rechercher le nombre d’utilisateurs, d'opérateurs et / ou de profils tablettes |
GET | /ext/api/1.5/kpi/tablets | Rechercher le nombre de profils tablettes |
GET | /ext/api/1.5/kpi/projects | Rechercher le nombre d’entités |
GET | /ext/api/1.5/kpi/flows | Rechercher le nombre de flows |
external-api-job-resource
Catégorie | Nom de l'appel API | Action sur l’IHM |
GET | /ext/api/1.5/jobs/project-referential-flows/{jobRef}/status | Consulter le statut (to do, in progress ou done) du traitement de l’exécution du flow à partir de sa référence (lien en haut) |
GET | /ext/api/1.5/jobs/project-referential-flows/{jobRef}/created-flows | Rechercher la liste des flows créés suite à l’exécution |
external-api-custom-status-resource
Catégorie | Nom de l'appel API | Action sur l’IHM |
GET | /ext/api/1.5/dictionary/statuses | Rechercher les statuts |
external-api-client-resource
🚨 Note : Pour plus de détails sur la signification des termes utilisés sur l’API pour le carnet client, se référer à cette section.
Catégorie | Nom de l'appel API | Action sur l’IHM |
GET | /ext/api/1.5/clients | Rechercher un client depuis le carnet clients |