Approbations API (/approbations)
Utilisez l'API Approbations pour créer, mettre à jour ou demander l'approbation d'un document.
Utilisez l'API Approbations pour créer, mettre à jour ou demander l'approbation d'un document. Cela inclut les points de terminaison spécifiques pour prendre des mesures (rejeter/mettre en attente/approuver) ainsi que les détails de la demande tels que le demandeur, les articles et les détails d'expédition.
L'URL pour accéder à l'API des approbations est : https ://<instance>/api/approvals/<approval id>
Voir les meilleures pratiques d'intégration pour plus d'informations. Pour en savoir plus sur la mise en œuvre des approbations à distance, voir Approbations à distance via API.
Actions
| Verbe | Chemin d'accès | Action | Description |
|---|---|---|---|
| METTRE | /api/approbations/:id/approuver |
approuver | Effectuer l'action Approuver sur une approbation |
| METTRE | /api/approvals/:id/hold |
retenir | Effectuer une action de mise en attente sur une approbation |
| OBTENIR | /API/approbations |
index | Approbations de la requête |
| METTRE | /api/approvals/:id/reject |
rejeter | Effectuer une action Rejeter sur une approbation |
| OBTENIR | /api/approvals/:id |
afficher | Afficher l'approbation |
| METTRE | /api/approvals/:id |
mettre à jour | Actualiser l'approbation |
Éléments
Ce sont les éléments disponibles pour l'API Approbations
| Nom de champ | Description du champ | Dem. | Unique ? | Valeurs admissibles | Dans | Sortie | Type |
|---|---|---|---|---|---|---|---|
| approvable-id | L'identifiant du document qui a été approuvé | oui | nombre entier | ||||
| approvable-type | Le type de document approuvé (demande, bon de commande, etc.) | oui | string(255) | ||||
| id-chaîne-approbation | ID de la chaîne d'approbation cette approbation est située dans | oui | nombre entier | ||||
| date-approbation | La date à laquelle l'approbation a eu lieu | oui | datetime | ||||
| approuvé par | Le nom d'utilisateur qui a donné l'approbation | oui | Utilisateur | ||||
| approbateur | approbateur | oui | Utilisateur, groupe d'approbation | ||||
| approbateur-id | L'ID de l'utilisateur qui a fait l'approbation | oui | nombre entier | ||||
| type d'approbateur | Le rôle de l'approbateur | oui | string(255) | ||||
| created-at | Créé automatiquement par Coupa au format AAAA-MM-JJFHH :MM :SS+HH :MMZ | oui | datetime | ||||
| créé par | Utilisateur qui a créé | oui | Utilisateur | ||||
| délégué | délégué : | oui | Utilisateur, groupe d'approbation | ||||
| delegate-id | L'ID du délégué qui a fait l'approbation (s'il y a lieu) | oui | nombre entier | ||||
| délégués | Délégués | oui | Déléguer l'approbation | ||||
| tenable | Tenir l'approbation ou non | oui | boolean | ||||
| id | Identifiant unique Coupa | oui | nombre entier | ||||
| note | Motif d'approbation ou de rejet | oui | texte | ||||
| position | La position dans la chaîne d'approbation cette approbation s'est produite | oui | nombre entier | ||||
| motifs | Motifs | oui | Motif de l'approbation | ||||
| statut | État de l'approbation (approuvée, transmise, rejetée, etc.) | oui | string(50) | ||||
| type | Comment l'approbation s'est produite (remplacer l'approbation, l'approbation de la chaîne d'approbation, etc.) | oui | string(255) | ||||
| mis-à-jour à | Créé automatiquement par Coupa au format AAAA-MM-JJFHH :MM :SS+HH :MMZ | oui | datetime | ||||
| mis à jour par | Utilisateur ayant réalisé la mise à jour | oui | Utilisateur |
Exemple
Dans cet exemple, nous avons demandé une seule approbation avec un ID de 12622. Nous avons accédé À l'URL :
https ://<instance url>/api/approbations/12622
Les approbations OBTIENNENT UNE RÉPONSE
<?xml version="1.0" encoding="UTF-8"?>
<approval>
<id type="integer">12622</id>
<created-at type="datetime">15/02/2012T14:56:22-08:00</created-at>
<updated-at type="datetime">23/04/2012T11:49:25-07:00</updated-at>
<position type="integer">1</position>
<approval-chain-id nil="true" />
<status>approuvé</status>
<approval-date type="datetime">15/02/2012T14:56:59-08:00</approval-date>
<note />
<type>ManagementHierarchyApproval</type>
<approvable-type>RequisitionHeader</approvable-type>
<approvable-id type="integer">2696</approvable-id>
<approver>
<id type="integer">3</id>
<login>vpierre</login>
<email>upgrade+vp@coupa.com</email>
<employee-number />
<firstname>Victor (directeur financier)</firstname>
<lastname>Pierre</lastname>
<salesforce-id nil="true" />
</approver>
<created-by>
<id type="integer">9</id>
<login>bjenkins</login>
<email>upgrade+bj@coupa.com</email>
<employee-number />
<firstname>Bob (VP Approvisionnement)</firstname>
<lastname>Jenkins</lastname>
<salesforce-id nil="true" />
</created-by>
<updated-by>
<id type="integer">17</id>
<login>coupa_metrics_gatherer</login>
<email>do_not_reply_metrics@coupa.com</email>
<employee-number nil="true" />
<firstname>Coupa</firstname>
<lastname>Indicateurs</lastname>
<salesforce-id nil="true" />
</updated-by>
</approval>Approbation ou rejet en cours
Ce qui suit décrit comment vous pouvez utiliser l'API Coupa pour effectuer des actions sur les approbations.
Approbation en cours
/api/approbations/{id}/approuver
Rejet en cours
/api/approbations/{id}/rejet
Motif de l'ajout
Dans les deux cas, une approbation doit être en attente (et non déjà approuvée ou rejetée) pour que l'action soit valide. Il est également possible de fournir un « Raison » pour le rejet via la requête XML directement. Par exemple, pour rejeter une approbation par l'ID de 12612 et fournir une raison de « Rejeté par l'intégration », vous devez utiliser la demande suivante :
METTRE https ://{instance url}/api/approvals/12612/reject ?reason=Rejected%20by%20Integration
Les demandes réussies renverront une réponse HTTP 200. Le corps de la réponse inclura la demande créée. Les demandes infructueuses renverront HTTP 400 Bad Request. Le corps de la réponse comprendra des erreurs de validation formatées en XML.