Approvals API(/approvals)
承認APIを使用して、ドキュメントの承認を作成、更新、または照会します。
承認APIを使用して、ドキュメントの承認を作成、更新、または照会します。これには、アクション(却下/保留/承認)を実行する特定のエンドポイントと、申請者、品目、発送詳細などの申請書の詳細が含まれます。
承認APIにアクセスするためのURLは次のとおりです。 https://<instance>/api/approvals/<approval id>
詳細については、 「インテグレーションのベストプラクティス 」を参照してください。
アクション
動詞 | パス | アクション | 説明 |
---|---|---|---|
プット | /api/approvals/:id/approve |
承認 | 承認に対して承認アクションを実行する |
プット | /api/approvals/:id/hold |
保留 | 承認に対して保留アクションを実行する |
取得 | /api/approvals |
インデックス | 承認を問い合わせ |
プット | /api/approvals/:id/reject |
却下 | 承認に対して却下アクションを実行する |
取得 | /api/approvals/:id |
表示 | 承認を表示 |
プット | /api/approvals/:id |
更新 | 承認の更新 |
要素
これらは承認APIで使用できる要素です
フィールド名 | フィールドの説明 | 必須 | 一意ですか? | 許容値 | で | 出力 | タイプ |
---|---|---|---|---|---|---|---|
承認可能ID | 承認された文書ID | はい | 整数 | ||||
承認可能タイプ | 承認された文書タイプ(請求書、発注書など) | はい | 文字列(255) | ||||
approval-chain-id | この承認がある承認チェーンのID | はい | 整数 | ||||
approval-date | 承認が行われた日付 | はい | 日時 | ||||
承認者 | 承認を行ったユーザーの名前 | はい | ユーザー | ||||
approver | approver | はい | ユーザー、承認グループ | ||||
created-at | 「YYYY-MM-DDTHH:MM:SS+HH:MMZ」の形式で、Coupaによって自動的に作成されます | はい | 日時 | ||||
作成者 | 作成したユーザー | はい | ユーザー | ||||
delegate | delegate | はい | ユーザー、承認グループ | ||||
代理人ID | 承認を行った代理人のID(該当する場合) | はい | 整数 | ||||
代理人 | 代理 | はい | 代理承認 | ||||
holdable | 承認を保留にするかどうか。 | はい | ブール値 | ||||
id | Coupaの一意の識別子 | はい | 整数 | ||||
メモ | 承認または却下の理由 | はい | テキスト | ||||
ポジション | この承認が行われた承認チェーン内のポジション | はい | 整数 | ||||
理由 | 理由 | はい | 承認理由 | ||||
status | 承認のステータス(承認済み、エスカレーション済み、却下済みなど) | はい | 文字列(50) | ||||
type | どのような承認が行われたか(承認を無効にする、承認チェーンの承認など) | はい | 文字列(255) | ||||
updated-at | 「YYYY-MM-DDTHH:MM:SS+HH:MMZ」の形式で、Coupaによって自動的に作成されます | はい | 日時 | ||||
更新者 | 更新したユーザー | はい | ユーザー |
例
この例では、IDが12622の承認を1件検索しました。URLにGETしました:
https://<instance url>/api/approvals/12622
承認の返答の取得
<?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>approved</status>
<approval-date type="datetime">2012-02-15T14: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リクエストを介して却下の「理由」を直接提供することもできます。たとえば、12612というIDで承認を却下し、「インテグレーションによって却下」という理由を入力するには、次のリクエストを使用します。
PUT https://{instance url}/api/approvals/12612/reject?reason=Rejected%20by%20Integration
成功したリクエストは返り HTTP 200 Response
ます。回答の本文には、作成された申請書が含まれます。失敗したリクエストは返 HTTP 400 Bad Request
される。応答の本文には、XMLとしてフォーマットされた検証エラーが含まれます。
このページに表示されている一部、または全ての内容は、機械翻訳によるものです。ご了承ください。