連携実行API
連携実行にアクセスするURLは https ://<instance>.coupahost.com/api/integration_runsです
詳細については、統合のベストプラクティスを参照してください。
アクション
連携実行APIでは以下の操作が可能です。
| 動詞 | パス | アクション | 説明 |
|---|---|---|---|
| POST | /api/integration_runs | 作成 | 保留中のステータスで連携実行を作成する |
| PUT | /api/integration_runs/:id/fail | fail | 連携実行ステータスを失敗に設定する |
| GET | /api/integration_runs | インデックス | 連携合実行を検索する |
| PUT | /api/integration_runs/:id/pause | pause | 連携実行ステータスを一時停止に設定する |
| PUT | /api/integration_runs/:id/pending | pending | 連携実行ステータスを処理待ちに設定する |
| PUT | /api/integration_runs/:id/run | run | 連携実行ステータスを実行中に設定する |
| GET | /api/integration_runs/:id | 表示 | 連携実行を表示する |
| PUT | /api/integration_runs/:id/success | success | 連携実行ステータスを成功に設定する |
| PATCH | /api/integration_runs/:id | 更新 | 連携実行を更新する |
| PUT | /api/integration_runs/:id | 更新 | 連携実行を更新する |
Elements
連携実行APIで使用できる要素は次のとおりです。
| 要素 | Description | Type | APIイン | APIアウト | Required | 長さ | 許容値 |
|---|---|---|---|---|---|---|---|
| 作成日時 | CoupaがYYY-MM-DDTHH:MM:SS+HH:MMZの形式で自動的に作成します | yes | datetime | ||||
| end-time | end_time | yes | yes | datetime | |||
| flow | flow | yes | yes | フロー | |||
| ID | Coupaの一意の識別子 | yes | 整数 | ||||
| integration | integration | yes | yes | yes | 連携 | ||
| integration | 標準 | boolean | なし | any | |||
| integrationError | 文書タイプ | string(255) | なし | OrderHeader, InventoryTransaction, InvoiceHeader, ExpenseReport, RequisitionHeader, Account, Supplier, User, Address, RemitToAddress, Contract, ExchangeRate, Invoice, Requisition, Payment, ApprovalChain, LookupValue, Item, SupplierInformation | |||
| integrationError | document_id | 整数 | なし | any | |||
| integrationError | document_status | 文字列 | なし | any | |||
| integrationError | document_revision | 整数 | なし | any | |||
| integration-errors | integration_errors | 文字列 | yes | IntegrationError | |||
| integrationError | 文書タイプ | string(255) | false | OrderHeader, InventoryTransaction, InvoiceHeader, ExpenseReport, RequisitionHeader, Account, Supplier, User, Address, RemitToAddress, Contract, ExchangeRate, Invoice, Requisition, Payment, ApprovalChain, LookupValue, Item, SupplierInformation | |||
| integrationError | document_id | 整数 | false | any | |||
| integrationError | document_status | 文字列 | false | any | |||
| integrationError | document_revision | 整数 | false | any | |||
| records-processed | records_processed | yes | yes | 整数 | |||
| start-time | start_time | yes | yes | datetime | |||
| ステータス | 取引ステータス | yes | 文字列 | ||||
| total-records | total_records | yes | yes | 整数 | |||
| updated-at | CoupaがYYY-MM-DDTHH:MM:SS+HH:MMZの形式で自動的に作成します | yes | datetime |