承認API (/ approvals)
承認APIを使用して、ドキュメントの承認を作成、更新、またはクエリします。
承認APIを使用して、ドキュメントの承認を作成、更新、またはクエリします。これには、アクション(却下/保留/承認)を実行するための特定のエンドポイントと、依頼者、ラインアイテム、配送の詳細などの依頼の詳細が含まれます。
承認APIにアクセスするためのURLは次のとおりです: https ://<instance>/api/approvals/<approval id>
詳細については、統合のベストプラクティスを参照してください。リモート承認の実装の詳細については、「API経由のリモート承認」を参照してください。
アクション
動詞 | パス | アクション | 説明 |
---|---|---|---|
プット | /api/approvals /: id/approve |
承認 | 承認に対して承認アクションを実行する |
プット | /api/approvals /: id/hold |
保留 | 承認に対して保留アクションを実行する |
取得 | /api/approvals |
index | 承認を問い合わせ |
プット | /api/approvals /: id/reject |
却下 | 承認に対して却下アクションを実行する |
取得 | /api/approvals /: id |
表示 | 承認を表示 |
プット | /api/approvals /: id |
update | 承認リクエストを更新 |
要素
承認APIで使用できる要素は次のとおりです。
フィールド名 | フィールドの説明 | 申請済み | 一意ですか? | 許容値 | In | アウト | タイプ |
---|---|---|---|---|---|---|---|
approvable - id | 承認されたドキュメントID | はい | 整数 | ||||
approvable - type | 承認された書類の種類(申請書、発注書など) | はい | string (255) | ||||
approval - chain - id | この承認がある承認チェーンのID | はい | 整数 | ||||
approval - date | 承認が行われた日付 | はい | 日時 | ||||
approved - by | 承認を行ったユーザー名 | はい | ユーザー | ||||
承認者 | 承認者 | はい | ユーザー、承認グループ | ||||
approver - id | 承認を行ったユーザーID | はい | 整数 | ||||
approver - type | 承認者の役割 | はい | string (255) | ||||
created - at | CoupaがYYY - MM - DDTHH: MM: SS + HH: MMZの形式で自動的に作成しました | はい | 日時 | ||||
created - by | 作成したユーザー | はい | ユーザー | ||||
代理 | 代理 | はい | ユーザー、承認グループ | ||||
delegate - id | 承認を行った代理人ID (該当する場合) | はい | 整数 | ||||
代理人 | 代理 | はい | 代理の承認 | ||||
holdable | 承認を保留するかどうか | はい | boolean | ||||
iD | Coupaの一意の識別子 | はい | 整数 | ||||
メモ | 承認または却下の理由 | はい | テキスト | ||||
ポジション | この承認が発生した承認チェーン内のポジション | はい | 整数 | ||||
reasons | 理由 | はい | 承認理由 | ||||
ステータス | 承認ステータス(承認済み、エスカレート済み、却下済みなど) | はい | string (50) | ||||
タイプ | 承認がどのように行われたか(承認を上書き、承認チェーン承認など) | はい | string (255) | ||||
updated - at | CoupaがYYY - MM - DDTHH: MM: SS + HH: MMZの形式で自動的に作成しました | はい | 日時 | ||||
更新者: | 更新したユーザー | はい | ユーザー |
例
この例では、IDが12622の単一の承認を照会しました。URLへのアクセスを行いました。
https :/// api<instance url>/approvals/12622
承認は応答を取得します
<?xml version="1.0" encoding="UTF-8"?>
<approval>
<id type="integer">12622</id>
2012 <created-at type="datetime">-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>
2012 <approval-date type="datetime">-02 -15 T 14:56:59 - 08:00</approval-date>
<note />
<type>ManagementHierarchyApproval</type>
請求<approvable-type>ヘッダー</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>ピエール</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>ボブ(購買・調達部長)</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>指標</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 % 20 by % 20 Integration
要求が成功すると、HTTP 200応答が返されます
。レスポンスの本文には、作成された申請書が含まれます。要求が失敗すると、HTTP 400 Bad Requestが返されます
。応答の本文には、XML形式の検証エラーが含まれます。