| Type de modification | Description |
|---|---|
| Introduit dans la version 24.0 | API GetDocuments |
À propos de l’API GetDocuments
Lier une formule ou une expression pour arriver sur des pages Brouillon et Document à l’ouverture de l’élément correspondant. L’API Get documents retourne tous les documents avec une prise en charge limitée du filtre OData. Cela permet de filtrer les données en transmettant le filtre OData dans l’URL de l’API. Cette API utilise la méthode GET pour retourner tous les documents.
Lier une formule/expression
{baseUrl}/#/{appname}/winforms?procDefId=<procDefIdValue>&name=<name>&lid=<lid>&readOnly=<readOnly>&solutionId=<solutionId>&dataItemId=<dataItemId>&ftype=11&composerPkgId=<solutionId>&extcont=<extcont>&pid=<pid>&r=-1&v=<v>&type=documentSi le paramètre formView n’est pas passé, un nouveau paramètre (type) doit être ajouté avec la valeur attribuée en fonction du type de lien.
Corps de la requête et de la réponse
L’API renvoie tous les brouillons avec une prise en charge limitée du filtre OData avec le format de réponse suivant.
Demander les contrats de données
Paramètres de requête| Nom | Description | Type |
| composerPkgId | Id de package Composer (la même valeur que solutionId) | GUID |
| dataItemId | ID d’élément de données | GUID |
| extcont |
A un contenu externe Indique si un fichier externe a été ajouté au workflow. |
Booléen |
| ftype | Type de formulaire (valeur fixe : 11) | Entier |
| lid | ID de bibliothèque | GUID |
| name | Nom | Chaîne |
| pid | ID de processus | GUID |
| procDefId | ID de définition de processus | GUID |
| r | Référentiel (valeur fixe : -1) | Entier |
| readOnly | Chaîne en lecture seule | Booléen |
| solutionId | ID de solution | GUID |
| type | Type (valeur fixe : document) | Chaîne |
| v | Version Datafile | Entier |
Exemple de requête et de réponse
Exemples de requêtes avec filtres OData :
- Pour obtenir tous les documents
{{RoutePrefix}}/api/v1/Processextn/GetDocuments - Pour obtenir les documents avec un ProcessId spécifique
{{RoutePrefix}}/api/v1/Processextn/GetDocuments?$filter=pid eq 7e8b0239-c81e-4d9f-965c-fa8932c4fa2b - Pour obtenir les documents avec un ComposerPackageID spécifique
{{RoutePrefix}}/api/v1/Processextn/GetDocuments?$filter= composerPkgId eq 7e8b0239-c81e-4d9f-965c-fa8932c4fa2b - Pour obtenir les documents avec un DataItemId spécifique
{{RoutePrefix}}/api/v1/Processextn/GetDocuments?$filter= dataItemId eq 7e8b0239-c81e-4d9f-965c-fa8932c4fa2b - Pour obtenir tous les documents portant un nom spécifique
{{RoutePrefix}}/api/v1/Processextn/GetDocuments?$filter=name eq testDoc
[{"ErrorCode":"SOMETHING_WENT_WRONG_ADMIN","Message":"An error has occured on the server","errorPrameters":null}]