メインコンテンツまでスキップ

 

 

Coupa Japanese

Approvals API(/approvals)

このページは機械翻訳を使用して翻訳されています。


承認APIを使用して、ドキュメントの承認を作成、更新、または照会します。これには、アクションを実行する特定のエンドポイント(却下/保留/承認)と、申請者、品目、発送の詳細などの申請の詳細が含まれます。

承認のAPIにアクセスするためのURLは次のとおりです。https://<instance>/api/approvals/<approval id>

参照してください 統合ナレッジ記事 詳細は統合のベストプラクティスを。

アクション

動詞 パス アクション 説明
置く /api/approvals/:id/approve 承認 承認に対して承認アクションを実行する
投稿 /api/approvals 作成 承認を作成
置く /api/approvals/:id/hold 保留 承認に対して保留アクションを実行
GET /api/approvals インデックス クエリ承認
置く /api/approvals/:id/reject 却下 承認に対して却下アクションを実行
GET /api/approvals/:id 表示 承認を表示
置く /api/approvals/:id 更新 承認を更新

要素

これらは、承認APIに利用可能な要素です

フィールド名 フィールドの説明 必須 一意ですか? 許容値 アウト タイプ
Approvable_ID 承認された文書ID         はい 整数
Approvable_Type 承認された文書タイプ(請求書、発注書など)         はい 文字列(255)
approval-chain-id この承認がある承認チェーンのID         はい 整数
approval-date 承認が行われた日付         はい 日時
承認者 承認を行ったユーザーの名前         はい ユーザー
approver approver         はい ユーザー、承認グループ
created-at 「YYYY-MM-DDTHH:MM:SS+HH:MMZ」の形式で、Coupaによって自動的に作成されます         はい 日時
created_by 作成したユーザー         はい ユーザー
delegate delegate         はい ユーザー、承認グループ
委任ID 承認を行った代理人のID(該当する場合)         はい 整数
代理人 代理         はい 代理承認
保持可能 承認を保持するかどうか         はい ブール値
id Coupaの一意の識別子         はい 整数
注: 承認または却下の理由         はい テキスト
Position この承認が行われた承認チェーン内のポジション         はい 整数
理由 理由         はい 承認理由
status 承認のステータス(承認済み、エスカレーション済み、却下済みなど)         はい 文字列(50)
type どのような承認が行われたか(承認を無効にする、承認チェーンの承認など)         はい 文字列(255)
updated-at 「YYYY-MM-DDTHH:MM:SS+HH:MMZ」の形式で、Coupaによって自動的に作成されます         はい 日時
updated_by 更新したユーザー         はい ユーザー

 

この例では、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-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リクエストから拒否の「理由」を直接入力することもできます。たとえば、idが12612の承認を却下し、 "統合によって却下"の理由を提供するには、次のリクエストを使用します。

PUT https://{instance url}/api/approvals/12612/reject?reason=Rejected%20by%20Integration

成功したリクエストは HTTP 200 Responseを返します。返答の本文には、作成された申請書が含まれます。失敗したリクエストは HTTP 400 Bad Requestを返します。応答の本文には、XML形式の検証エラーが含まれます。

  • この記事は役に立ちましたか?