Genehmigungs-API (/Genehmigungen)
Verwenden Sie die Genehmigungs-API, um die Genehmigung eines Dokuments zu erstellen, zu aktualisieren oder abzufragen.
Verwenden Sie die Genehmigungs-API, um die Genehmigung eines Dokuments zu erstellen, zu aktualisieren oder abzufragen. Dazu gehören bestimmte zu ergreifende Endpunkte (Ablehnen/Halten/Genehmigen) sowie Anforderungsdetails wie Anforderer, Einzelposten und Versanddetails.
Die URL für den Zugriff auf die Genehmigungs-API lautet: https://<instance>/api/approvals/<approval id>
Weitere Informationen finden Sie unter Integrations-Best Practices. Weitere Informationen zur Implementierung von Remote-Genehmigungen finden Sie unter Remote-Genehmigungen über API.
Aktionen
| Verb | Pfad | Aktion | Beschreibung |
|---|---|---|---|
| PUT | /api/approvals/:id/approve |
genehmigen | Genehmigungsaktion für eine Genehmigung durchführen |
| PUT | /api/approvals/:id/hold |
halten | Halteaktion für eine Genehmigung durchführen |
| ABFRAGEN | /api/approvals |
index | Genehmigungen abfragen |
| PUT | /api/approvals/:id/reject |
ablehnen | Ablehnungsaktion bei einer Genehmigung durchführen |
| ABFRAGEN | /api/approvals/:id |
anzeigen | Genehmigung anzeigen |
| PUT | /api/approvals/:id |
aktualisieren | Genehmigung aktualisieren |
Elemente
Dies sind die Elemente, die für die Genehmigungs-API verfügbar sind
| Feldname | Feldbeschreibung | Anf. | Eindeutig? | Zulässige Werte | In | Out | Typ |
|---|---|---|---|---|---|---|---|
| approvable-id | Die Dokument-ID, die genehmigt wurde | ja | ganze Zahl | ||||
| genehmigungsfähiger Typ | Die Dokumentart, die genehmigt wurde (Anforderung, Bestellung usw.) | ja | string(255) | ||||
| approval-chain-id | ID der Genehmigungskette, in der sich diese Genehmigung befindet | ja | ganze Zahl | ||||
| genehmigungsdatum | Das Datum, an dem die Genehmigung erteilt wurde | ja | datum/Uhrzeit | ||||
| genehmigt von | Der Benutzername, der die Genehmigung erteilt hat | ja | Benutzer | ||||
| genehmigende Stelle | genehmigende Stelle | ja | Benutzer, Genehmigungsgruppe | ||||
| genehmiger-ID | Die Benutzer-ID, die die Genehmigung erteilt hat | ja | ganze Zahl | ||||
| genehmiger-Typ | Die Rolle des Genehmigers | ja | string(255) | ||||
| created-at | Automatisch von Coupa erstellt im Format JJJJ-MM-TTTHH:MM:SS+HH:MMZ | ja | datum/Uhrzeit | ||||
| erstellt von | Benutzer der Erstellung | ja | Benutzer | ||||
| stellvertreter | stellvertreter | ja | Benutzer, Genehmigungsgruppe | ||||
| delegate-id | Die Stellvertreter-ID, die die Genehmigung erteilt hat (falls zutreffend). | ja | ganze Zahl | ||||
| stellvertreter | Stellvertreter | ja | Genehmigung durch Stellvertreter | ||||
| haltbar | Halten Sie die Genehmigung oder nicht | ja | boolean | ||||
| iD | Eindeutige Coupa-ID | ja | ganze Zahl | ||||
| hinweis | Grund für Genehmigung oder Ablehnung | ja | text | ||||
| position | Die Position in der Genehmigungskette, an der diese Genehmigung erfolgt ist | ja | ganze Zahl | ||||
| gründe | Gründe | ja | Genehmigungsgrund | ||||
| status | Ausschreibungsstatus (genehmigt, eskaliert, abgelehnt usw.) | ja | string(50) | ||||
| typ | Wie die Genehmigung erfolgte (Genehmigung überschreiben, Genehmigung der Genehmigungskette usw.) | ja | string(255) | ||||
| updated-at | Automatisch von Coupa erstellt im Format JJJJ-MM-TTTHH:MM:SS+HH:MMZ | ja | datum/Uhrzeit | ||||
| aktualisiert von | Benutzer der Aktualisierung | ja | Benutzer |
Beispiel
In diesem Beispiel haben wir nach einer einzigen Genehmigung mit der ID 12622 gefragt. Wir sind auf die URL GEKOMMEN:
https://<instance url>/api/approvals/12622
Genehmigungen ERHALTEN ANTWORT
<?xml version="1.0" encoding="UTF-8"?>
<approval>
<id type="integer">12622</id>
<created-at type="datetime">2012-02-15T14:56:22-08:00</created-at>
<updated-at type="datetime">2012-04-23T11:49:25-07:00</updated-at>
<position type="integer">1</position>
<approval-chain-id nil="true" />
<status>genehmigt</status>
<approval-date type="datetime">2012-02-15T14:56:59-08:00</approval-date>
<note />
<type>ManagementHierarchieGenehmigung</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 (CFO)</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 Procurement)</firstname>
<lastname>Jenkins</lastname>
<salesforce-id nil="true" />
</created-by>
<updated-by>
<id type="integer">17</id>
<login>coupa_metrics_collecter</login>
<email>do_not_reply_metrics@coupa.com</email>
<employee-number nil="true" />
<firstname>Coupa</firstname>
<lastname>Metriken</lastname>
<salesforce-id nil="true" />
</updated-by>
</approval>Wird genehmigt oder abgelehnt
Im Folgenden wird beschrieben, wie Sie die Coupa-API zum Ausführen von Aktionen für Genehmigungen verwenden können.
Wird genehmigt
/api/approvals/{id}/approve
Wird abgelehnt
/api/approvals/{id}/reject
Grund hinzufügen
In beiden Fällen muss eine Genehmigung ausstehend sein (und nicht bereits genehmigt oder abgelehnt), damit die Aktion gültig ist. Es ist auch möglich, einen „Grund“ für die Ablehnung direkt über die XML-Anfrage anzugeben. Verwenden Sie zum Beispiel die folgende Anfrage, um eine Genehmigung per ID von 12612 abzulehnen und einen Grund für "Abgelehnt durch Integration" anzugeben:
PUT https://{instance url}/api/approvals/12612/reject?reason=Rejected%20by%20Integration
Erfolgreiche Anfragen geben die HTTP-200-Antwort zurück. Der Text der Antwort enthält die erstellte Anforderung. Bei nicht erfolgreichen Anfragen wird http 400 Bad Request zurückgegeben. Der Text der Antwort enthält Validierungsfehler, die als XML formatiert sind.