添付ファイルAPI

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

アクション

ほとんどのCoupaリソースでは、リソースに関するコメントと、コアリソースの両方に添付ファイルを追加できます。 詳しくは、コメント APIをご覧ください。

添付ファイルAPIでは以下のアクションが可能です。

動詞パスアクション説明
POST/api/contracts/:contract_id/attachments作成添付ファイルを作成
POST/api/invoices/:invoice_id/attachments作成添付ファイルを作成
POST/api/expense_reports/:expense_report_id/attachments作成添付ファイルを作成
POST/api/purchase_orders/:purchase_order_id/attachments作成添付ファイルを作成
POST/api/users/:user_id/attachments作成添付ファイルを作成
POST/api/requisitions/:requisition_id/attachments作成添付ファイルを作成
GET/api/contracts/:contract_id/attachmentsインデックス添付書類を検索
GET/api/inventory_transactions/:id/attachments/:id表示添付ファイルを表示
GET/api/invoices/:invoice_id/attachmentsインデックス添付書類を検索
GET/api/expense_reports/:expense_report_id/attachmentsインデックス添付書類を検索
GET/api/purchase_orders/:purchase_order_id/attachmentsインデックス添付書類を検索
GET/api/users/:user_id/attachmentsインデックス添付書類を検索
GET/api/requisitions/:requisition_id/attachmentsインデックス添付書類を検索
GET/api/contracts/:contract_id/attachments/:id表示添付ファイルを表示
GET/api/invoices/:invoice_id/attachments/:id表示添付ファイルを表示
GET/api/expense_reports/:expense_report_id/attachments/:id表示添付ファイルを表示
GET/api/purchase_orders/:purchase_order_id/attachments/:id表示添付ファイルを表示
GET/api/users/:user_id/attachments/:id表示添付ファイルを表示
GET/api/requisitions/:requisition_id/attachments/:id表示添付ファイルを表示
GET/api/attachments/:attachment_id表示添付書類IDに基づいて添付書類を表示します。
注:

添付ファイルが関連付けられているオブジェクトを明示的に定義するには、 attachable_type パラメーターを含めることができます。 たとえば、 /api/attachments /: id? attachable_type = Contract へのGET呼び出しでは、契約に関連付けられた添付ファイルが返されます。

PATCH/api/contracts/:contract_id/attachments/:id更新API経由では添付ファイルを更新できません
PUT/api/contracts/:contract_id/attachments/:id更新API経由では添付ファイルを更新できません
PATCH/api/invoices/:invoice_id/attachments/:id更新API経由では添付ファイルを更新できません
PUT/api/invoices/:invoice_id/attachments/:id更新API経由では添付ファイルを更新できません
PATCH/api/expense_reports/:expense_report_id/attachments/:id更新API経由では添付ファイルを更新できません
PUT/api/expense_reports/:expense_report_id/attachments/:id更新API経由では添付ファイルを更新できません
PATCH/api/purchase_orders/:purchase_order_id/attachments/:id更新API経由では添付ファイルを更新できません
PUT/api/purchase_orders/:purchase_order_id/attachments/:id更新API経由では添付ファイルを更新できません
PATCH/api/users/:user_id/attachments/:id更新API経由では添付ファイルを更新できません
PUT/api/users/:user_id/attachments/:id更新API経由では添付ファイルを更新できません
PATCH/api/requisitions/:requisition_id/attachments/:id更新API経由では添付ファイルを更新できません
PUT/api/requisitions/:requisition_id/attachments/:id更新API経由では添付ファイルを更新できません
DELETE/api/requisitions/:requisition_id/attachments/:iddelete申請書ヘッダーから添付ファイルを削除する(発注などの他の文書タイプにも機能します)
DELETE/api/requisition_lines/:requisition_line_id/attachments/:iddelete申請書明細から添付ファイルを削除する(発注などの他の文書タイプにも機能します)
DELETE/api/attachments/:attachment_iddelete添付ファイルを削除
POST

/api/quote_requests/:quote_request_id/attachments

作成イベントに添付ファイルを追加します。
DELETE/api/quote_requests/:quote_request_id/attachments/:id削除イベントに関連付けられた添付ファイルを削除します。
GET/api/quote_requests/:quote_request_id/attachmentsインデックスイベントに関連付けられた添付ファイルを取得します。
POST/api/quote_request_lines/:quote_request_line_id/attachments作成イベント明細に添付ファイルを追加します。
DELETE/api/quote_request_lines/:quote_request_line_id/attachments/:id削除イベント明細に関連付けられた添付ファイルを削除します。
GET/api/quote_request_lines/:quote_request_line_id/attachmentsインデックスイベント明細に関連付けられた添付ファイルを取得します。
POST/api/quote_request_attachments/:quote_request_attachment_id/attachments作成イベントの詳細セクションに添付ファイルを追加します。
DELETE/api/quote_request_attachments/:quote_request_attachment_id/attachments/:id削除イベントの詳細セクションの添付ファイルを削除します。
GET/api/quote_request_attachments/:quote_request_attachment_id/attachmentsインデックスイベントの詳細セクションの添付ファイルを取得します。

Elements

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

要素Description必須フィールド？一意？許容値Api_Inフィールド？Api_Outフィールド？データタイプ
作成日時CoupaがYYY-MM-DDTHH:MM:SS+HH:MMZの形式で自動的に作成しますyes
datetime
file-url添付ファイルのURLyes
yes
文字列
IDCoupaの一意の識別子yes
yes
整数
目的目的yes
yes
string(40)
linked-to特定の機能へのリンクyes
string(255)
テキストテキストyes
テキスト
typetypeyes
yes
yes
string(255)
updated-atCoupaがYYY-MM-DDTHH:MM:SS+HH:MMZの形式で自動的に作成しますyes
datetime
URLURLyes
string(255)

契約の添付ファイルを作成

メソッド

POST /api/requisitions /: id/attachments

cURLリクエスト例
curl -X POST \ https://<INSTANCE>/api/requisitions/12345/attachments \ -H "Accept: application/xml" \ -H "content-type: multipart/form-data" \ -H "x-coupa-api-key: <API KEY>" \ -F "attachment[file]=@/Users/IntegrationAdmin/Contracts/Standard_Terms_Conditions.pdf" \ -F "attachment[type]=file" -F "attachment[intent]=Supplier"

ソーシングイベントの詳細セクションに添付ファイルを追加します

メソッド
POST /api/quote_request_attachments/10058/attachments
リクエストパラメーター
リクエストパラメーターを次の値に設定します。
  • 添付ファイル[ファイル]:添付ファイルをアップロード
  • 添付[タイプ]:ファイル
  • attachment[intent]: Supplier
  • 添付[linked_to]: quote_request_attachment
cURLリクエスト例
curl --location 'https://<your-instance>.com/api/quote_request_attachments/10058/attachments ' \ --header 'Accept: application/xml' \ --header 'Accept: application/json' \ --header 'Authorization: ••••••' \ --form 'attachment[file]=@"/file-path.png"' \ --form 'attachment[type]="file"' \ --form 'attachment[intent]="Supplier"' \ --form 'attachment[linked_to]="quote_request_attachment"'

ソーシングイベントに関連付けられた添付ファイルを取得

メソッド
GET /api/quote_requests/10153/attachments/4712295
cURLリクエスト例
curl --location 'https://<your-instance>.com/api/quote_requests/10153/attachments/4712295' \ --header 'Accept: application/xml' \ --header 'Accept: application/json' \ --header 'Authorization: ••••••' \ --header 'Cookie: _mkra_ctxt=c7e24ee9dd42c97a2bbfd26a2215079d12490dcfb828c19c332fdef146268332--200'

ソーシングイベントに関連付けられた添付ファイルを作成

メソッド
POST /api/quote_requests/10153/attachments/4712295
リクエストパラメーター
イベント利用規約セクションの添付ファイルの場合、 linked_to to attachment_to_suppliersを設定します。 イベント利用規約セクションの添付ファイルの場合は、 linked_to to event_termsを設定します。
{" type ":" text "," text ":" Event info attachment text "," linked_to ":" attachment_to_suppliers ",// For attachments under event info "intent ":" Supplier "}
cURLリクエスト例
curl --location 'https://<your-instance>.com/api/quote_requests/10153/attachments/4712295' \ --header 'Accept: application/xml' \ --header 'Accept: application/json' \ --header 'Authorization: ••••••' \ --header 'Cookie: _mkra_ctxt=c7e24ee9dd42c97a2bbfd26a2215079d12490dcfb828c19c332fdef146268332--200'