• 最終編集日時: 19 October 2021

添付ファイルAPI

添付ファイルAPIを使用して、Coupa参照オブジェクトとトランザクションオブジェクトの添付ファイルを管理します。

アクション

ほとんどのCoupaリソースでは、リソースのコメントとともにコアリソースの両方に添付ファイルを追加できます。詳細については、Comments APIを参照してください。 

Attachments APIを使用すると、以下の操作を行えるようになります。

動詞 パス アクション 説明
投稿 /api/contracts /: contract_id/attachments 作成 添付ファイルを作成
投稿 /api/invoices /: invoice_id/attachments 作成 添付を作成
投稿 /api/expense_reports /: expense_report_id/attachments 作成 添付を作成
投稿 /api/purchase_orders /: purchase_order_id/attachments 作成 添付ファイルを作成
投稿 /api/users /: user_id/attachments 作成 添付を作成
投稿 /api/requisitions /: requisition_id/attachments 作成 添付を作成
取得 /api/contracts /: contract_id/attachments index 添付書類の照会
取得 /api/inventory_transactions /: id/attachments /: id 表示 添付ファイルを表示
取得 /api/invoices /: invoice_id/attachments index 添付書類の照会
取得 /api/expense_reports /: expense_report_id/attachments index 添付書類の照会
取得 /api/purchase_orders /: purchase_order_id/attachments index 添付書類の照会
取得 /api/users /: user_id/attachments index 添付書類の照会
取得 /api/requisitions /: requisition_id/attachments index 添付書類の照会
取得 /api/contracts /: contract_id/attachments /: id 表示 添付を表示
取得 /api/invoices /: invoice_id/attachments /: id 表示 添付を表示
取得 /api/expense_reports /: expense_report_id/添付ファイル/: id 表示 添付ファイルを表示
取得 /api/purchase_orders /: purchase_order_id/attachments /: id 表示 添付ファイルを表示
取得 /api/users /: user_id/attachments /: id 表示 添付を表示
取得 /api/requisitions /: requisition_id/attachments /: id 表示 添付を表示
パッチ /api/contracts /: contract_id/attachments /: id update API経由で添付ファイルを更新することはできません
プット /api/contracts /: contract_id/attachments /: id 更新 API経由で添付ファイルを更新することはできません
パッチ /api/invoices /: invoice_id/attachments /: id 更新 API経由で添付ファイルを更新することはできません
プット /api/invoices /: invoice_id/attachments /: id update API経由で添付ファイルを更新することはできません
パッチ /api/expense_reports /: expense_report_id/添付ファイル/: id update API経由で添付ファイルを更新することはできません
プット /api/expense_reports /: expense_report_id/添付ファイル/: id 更新 API経由で添付ファイルを更新することはできません
パッチ /api/purchase_orders /: purchase_order_id/attachments /: id update API経由で添付ファイルを更新することはできません
プット /api/purchase_orders /: purchase_order_id/attachments /: id 更新 API経由で添付ファイルを更新することはできません
パッチ /api/users /: user_id/attachments /: id 更新 API経由で添付ファイルを更新することはできません
プット /api/users /: user_id/attachments /: id 更新 API経由で添付ファイルを更新することはできません
パッチ /api/requisitions /: requisition_id/attachments /: id update API経由で添付ファイルを更新することはできません
プット /api/requisitions /: requisition_id/attachments /: id 更新 API経由で添付ファイルを更新することはできません
削除 /api/requisitions /: requisition_id/attachments /: id     delete 申請書ヘッダーから添付ファイルを削除します(注文など、他の書類タイプでも機能します)
削除 /api/requisition_lines /: requisition_line_id/attachments /: id delete 申請書明細から添付ファイルを削除します(注文など、他の書類タイプでも機能します)

要素

次の要素は、添付ファイルAPIで使用できます。

要素 説明 必須フィールドですか? 一意ですか? 許容される値 Api_Inフィールド? Api_Outフィールド? データタイプ
created - at CoupaがYYY - MM - DDTHH: MM: SS + HH: MMZの形式で自動的に作成しました         はい 日時
file - url 添付ファイルへのURL       はい   string
iD Coupaの一意の識別子   はい     はい 整数
intent intent       はい はい string (40)
リンク先 特定の機能へのリンク       はい   string (255)
テキスト テキスト       はい   テキスト
type type はい     はい はい string (255)
updated - at CoupaがYYY - MM - DDTHH: MM: SS + HH: MMZの形式で自動的に作成しました         はい 日時
uRL uRL       はい   string (255)

 次の例の投稿は、契約12345のファイルStandard_Terms_Conditions.pdf添付ファイルを作成します。

curl - X POST\

  https :/// api<INSTANCE>/requisitions/12345/attachments\

  - H "Accept: application/xml "\

  - H "content - type: multipart/form - data "\

  - H "x - coupa - <API KEY>api - key :"\

  - F "添付ファイル[ファイル] = @/ Users/IntegrationAdmin/Contracts/Standard_Terms_Conditions.pdf "\

  - F "attachment [type] = file"

  - F "ATTACHMENT [INTENT ]= SUPPLIER"

関連アイテム


Coupa Core API

CoupaのRESTful APIは、お客様のデータをCoupaプラットフォームで読み取り、編集し、統合するための堅牢なアクセスを提供します。

APIの開始

Coupa APIの使用に関する一般情報、およびCSVの使用を検討するタイミング。

OAuth 2.0およびOIDCへの移行

Coupaは従来のAPIキーを廃止し、OAuth 2.0 / OIDCの使用を必要としています。R34以降、新しいAPIキーは発行されず、R35ではAPIキーはサポートされなくなります。

リソース

参照データ、トランザクションデータ、共有リソースなど、オブジェクトのタイプ別にAPIエンドポイントを整理しました。