承認API (/approvals)
承認APIを使用して、文書の承認を作成、更新、または検索します。 これには、却下・保留・承認などの操作を行うための専用エンドポイントや、申請者、明細アイテム、出荷の詳細などの申請書の詳細も含まれます。
データファイルソースAPIにアクセスするためのURL:
https ://<instance>/api/approvals/<approval id>詳細については、統合のベストプラクティスを参照してください。 リモート承認の実装の詳細については、APIを介したリモート承認を参照してください。
アクション
| 動詞 | パス | アクション | Description |
|---|---|---|---|
| PUT | /api/approvals /: id/approve | 承認 | 承認時に承認アクションを実行 |
| PUT | /api/approvals /: id/hold | hold | 承認に対して保留アクションを実行 |
| GET | /api/approvals | インデックス | 承認を検索 |
| PUT | /api/approvals /: id/reject | reject | 承認に対して却下アクションを実行 |
| GET | /api/approvals /: id | 表示 | 承認を表示 |
| PUT | /api/approvals /: id | 更新 | 承認を更新 |
Elements
承認APIで使用できる要素は次のとおりです。
| フィールド名 | フィールドの説明 | 必須 | 一意？ | 許容値 | 入力 | 出力 | Type |
|---|---|---|---|---|---|---|---|
| approvable-id | 承認された文書ID | yes | 整数 | ||||
| approvable-type | 承認された文書タイプ(申請書、発注書など) | yes | string(255) | ||||
| approval-chain-id | この承認がある承認チェーンのID | yes | 整数 | ||||
| approval-date | 承認が行われた日付 | yes | datetime | ||||
| approved-by | 承認を行ったユーザー名 | yes | ユーザー | ||||
| approver | approver | yes | ユーザー、承認グループ | ||||
| approver-id | 承認を行ったユーザーID | yes | 整数 | ||||
| approver-type | 承認者の役割 | yes | string(255) | ||||
| 作成日時 | CoupaがYYY-MM-DDTHH:MM:SS+HH:MMZの形式で自動的に作成します | yes | datetime | ||||
| created-by | 作成したユーザー | yes | ユーザー | ||||
| delegate | delegate | yes | ユーザー、承認グループ | ||||
| delegate-id | 承認を行った代理人ID (該当する場合) | yes | 整数 | ||||
| delegates | 代理 | yes | 代理承認 | ||||
| holdable | 承認を保留するかどうか | yes | boolean | ||||
| ID | Coupaの一意の識別子 | yes | 整数 | ||||
| メモ | 承認または却下の理由 | yes | テキスト | ||||
| position | この承認が発生した承認チェーン内のポジション | yes | 整数 | ||||
| reasons | 理由 | yes | Approval Reason | ||||
| ステータス | 承認のステータス(承認済み、エスカレーション済み、却下済みなど) | yes | string(50) | ||||
| タイプ | 承認の発生方法 (上書き承認、承認チェーン承認など) | yes | string(255) | ||||
| updated-at | CoupaがYYY-MM-DDTHH:MM:SS+HH:MMZの形式で自動的に作成します | yes | datetime | ||||
| updated-by | 更新したユーザー | yes | ユーザー |
例
この例では、IDが12622の単一の承認を検索しています。 以下のURLに対してGETリクエストを実行しました。
https ://<instance url>/api/approvals/12622承認GETレスポンス
<?xml version="1.0" encoding="UTF-8"?> <approval> <id type="integer">12622</id> <created-at type="datetime">2012 -02 -15 T 14:56:22 - 08:00</created-at> <updated-at type="datetime">2012 -04 -23 T 11:49:25 - 07:00</updated-at> <position type="integer">1</position> <approval-chain-id nil="true" /> <status>承認済み</status> <approval-date type="datetime">2012 -02 -15 T 14: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 (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_gatherer</login> <email>do_not_reply_metrics@coupa.com</email> <employee-number nil="true" /> <firstname>Coupa</firstname> <lastname>Metrics</lastname> <salesforce-id nil="true" /> </updated-by> </approval>承認または却下
以下はCoupa APIを使って承認に対してアクションを実行する方法の説明です。
承認中
/api/approvals/{id}/approve
却下中
/api/approvals/{id}/reject
理由の追加
どちらの場合も、アクションを有効にするには、承認が保留中(まだ承認または却下されていない)である必要があります。 また、XMLリクエストを介して、却下の「理由」を直接提供することも可能です。 たとえば、ID 12612による承認を拒否し、「連携によって拒否された」理由を提供するには、次のリクエストを使用します。
Https ://{instance url}/api/approvals/12612/reject? reason = Rejected%20by%20Integration成功した要求は
HTTP 200応答を返します。 レスポンスの本文には作成された申請書が含まれます。 リクエストが失敗すると、次が返されます:HTTP 400不正な要求