関係を取得
最大50の関係のリストを取得します。 各関係には、組織、サプライヤー、内部マネージャー、外部マネージャーなどの関連オブジェクトが含まれます。
エンドポイント
エンドポイント |
|
メソッド | GET |
ヘッダー
ヘッダー | 議論 |
認証 | Bearerトークン |
承認 | application/jsonまたはapplication/xml |
パラメーター
パラメーター | データタイプ | 説明 |
limit | int | レスポンス内の最大アイテム数。 最大値: 50。 |
offset | int | 先頭からスキップするアイテム数。 既定: 0。 |
| order_by | 文字列 | 並べ替える列。 のcreatedAt と 個のmodifiedAt 要素でのみ使用できます。 |
| dir | 文字列 | ソートの方向利用可能なオプション： 昇順、 降順。 デフォルト： Asc。 のcreatedAt と 個のmodifiedAt 要素でのみ使用できます。 |
| entityId | guid | 関係の一意の識別子。 このパラメータでは[eq]演算子を使用してフィルタリング可能。 |
| 名前 | 文字列 | 関係名。 このパラメータでは[eq]、[contains]演算子を使用してフィルタリング可能。 |
| status | 文字列 | 関係のステータス。 このパラメータでは[eq]、[contains]演算子を使用してフィルタリング可能。 |
| createdAt | datetime | 次の形式の関係作成タイムスタンプ： YYY - MM - DDTHH: MM: SS.FFZ。 このパラメータでは[eq]、[lt]、[gt]演算子を使用してフィルタリング可能。 |
| modifiedAt | datetime | 最終更新日時(YYYY-MM-DDTHH:MM:SS.FFZ形式)。 このパラメータでは[eq]、[lt]、[gt]演算子を使用してフィルタリング可能。 |
| relationshipNumber | 文字列 | 関係番号。 このパラメータでは[eq]、[contains]演算子を使用してフィルタリング可能。 |
| startEffectiveDate | datetime | 発効日: YYY - MM - DDTHH: MM: SS.FFZ。 このパラメータでは[eq]、[lt]、[gt]演算子を使用してフィルタリング可能。 |
| classification | 文字列 | Classification. このパラメータでは[eq]、[contains]演算子を使用してフィルタリング可能。 |
| カテゴリー | 文字列 | カテゴリ. このパラメータでは[eq]、[contains]演算子を使用してフィルタリング可能。 |
| residualRisk | 小数 | 残留リスク。 このパラメータでは[eq]演算子を使用してフィルタリング可能。 |
| inherentRisk | 小数 | 固有リスク. このパラメータでは[eq]演算子を使用してフィルタリング可能。 |
| includeDeleted | boolean | 関係の返されたリストに削除された関係を含めるかどうかを指定します。 既定: False。 |
Elements
関係APIでは、次の要素を使用できます。
要素 | データタイプ | 利用可能なオプション | Description |
|---|---|---|---|
success | boolean | リクエストが成功したかどうか。 | |
totalCount | 整数 | すべてのページにわたってフィルター条件に一致する関係の総数。 注: totalCountがページサイズを超える場合は、limitとoffsetパラメーターを使用して追加のデータセットを取得してください。 | |
result | array | リレーションシップ結果の現在のページ。リクエストごとに最大50個のリレーションシップ（制限とオフセットによって決定）。 | |
errors | array | エラーオブジェクトの一覧。 通常、リクエストが成功した場合は空。 | |
entityId | 文字列 | システム内の関係を表す一意の永続的なGUID。 | |
名前 | 文字列 | 作成プロセス中にユーザーが提供した関係の名前。 | |
status | 文字列 | Relationship_Active Relationship_Expired Relationship_Inactive | 関係の現在の状態。 |
relationshipNumber | 数字 | システムによって自動的に生成される関係番号。 | |
startEffectiveDate | 文字列 | 履行の契約期間の開始日。 | |
createdAt | datetime | 関係が作成された日時。 | |
modifiedAt | datetime | 関係が最後に変更された日時。 | |
classification | 文字列 | 設定可能な値のリストから提供される分類値。 | |
カテゴリー | 文字列 | 関係のサービス分類。 | |
residualRisk | 小数 | 残留リスク。 | |
inherentRisk | 小数 | 固有リスク。 | |
| supplier | サプライヤー | テナントに属しているサプライヤーのリスト。 | |
| 交流 | 契約 | 関係にリンクされたエンゲージメントオブジェクト。 | |
| 親関係 | 親会社との関係 | 関係にリンクされた親関係オブジェクト。 | |
| organizations | 組織オブジェクトの配列 | 関係にリンクされた組織オブジェクト。 | |
| 内部マネージャー | 社内マネージャー | 関係にリンクされた内部マネージャーオブジェクト。 | |
| 外部マネージャー | 外部マネージャー | 関係にリンクされた外部マネージャーオブジェクト。 |
リレーションシップを取得する
- エンドポイント
GET
/api/relationships- cURLリクエスト例
curl --location 'https://<your-instance>. risk.coupadev.com/api/relationships' \--header 'Accept: application/json' \--header 'Content-Type: application/json' \--header 'Authorization: ••••••'- レスポンス例
{ "result": { "totalCount": 2, "relationships": [ { "entityId": "e14e044e-e847-47e4-a8e8-01f2e6341fbf", "name": "Relationship_Rest<API&Test2", "status": "Relationship_Active", "createdAt": "2025-07-28T11:50:16.213Z", "modifiedAt": "2025-07-28T11:50:16.213Z", "relationshipNumber": "R10071", "startEffectiveDate": "2025-07-28T04:00:00Z", "classification": "Commodity", "category": "Finance and Accounting", "residualRisk": 0.0, "inherentRisk": 0.0, "organizations": [ { "entityId": "7fcd72e3-6572-4a44-88c7-9a0fb2cd0661", "name": "3pm", "links": null } ], "supplier": { "entityId": "dfe010f7-55e3-4577-abad-cd9f8105dc25", "name": "HarshSupplier", "links": [ { "href": "api/suppliers", "rel": "retrieve-suppliers", "method": "GET" } ] }, "engagement": null, "parentRelationship": null, "internalManager": { "entityId": "8b3cbfb3-f345-42ec-a437-0201ccb7769f", "name": "Administrator, Risk Assess", "links": null }, "externalManager": { "entityId": "474cb696-2283-4078-984b-11e13becf89c", "name": "L, HarshSupplierManager", "links": null } }, { "entityId": "7f563cb3-162c-4145-a2ec-030134c8e4ba", "name": "AdminApNewRelWid1", "status": "Relationship_Active", "createdAt": "2025-02-10T13:14:24.327Z", "modifiedAt": "2025-06-27T06:32:13.8Z", "relationshipNumber": "R10020", "startEffectiveDate": "2025-02-10T05:00:00Z", "classification": "Class1", "category": "cat1", "residualRisk": 0.0, "inherentRisk": 0.0, "organizations": [ { "entityId": "bdf4fc3b-2ec4-4b1e-9fca-e71812036804", "name": "testorg1", "links": null }, { "entityId": "99ff3f27-fe10-4077-b2c9-b4c76055a319", "name": "DotnetOrg", "links": null }, { "entityId": "b4f7c860-78c9-4a37-8b00-2b8d36424c72", "name": "testorg2", "links": null } ], "supplier": { "entityId": "85c3d82b-b2bf-4c57-b6e9-9e0469fe83fd", "name": "IntApJZ132659Sup1", "links": [ { "href": "api/suppliers", "rel": "retrieve-suppliers", "method": "GET" } ] }, "engagement": null, "parentRelationship": null, "internalManager": { "entityId": "8b3cbfb3-f345-42ec-a437-0201ccb7769f", "name": "Administrator, Risk Assess", "links": null }, "externalManager": { "entityId": "a54c316c-f4c9-4647-ad03-690b66859503", "name": "IntApJZ132659Sup1, IntApJZ132659Sup1", "links": null } }, ] }, "errors": [], "success": true }
リレーションシップを取得し、IDで絞り込む
- エンドポイント
GET
/api/relationships?entityid[eq]=e14e044e-e847-47e4-a8e8-01f2e6341fbf- cURLリクエスト例
curl --location --globoff 'https://<your-instance>.risk.coupadev.com/api/relationships?entityid[eq]=e14e044e-e847-47e4-a8e8-01f2e6341fbf' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --header 'Authorization: ••••••'- レスポンス例
{ "result": { "totalCount": 1, "relationships": [ { "entityId": "e14e044e-e847-47e4-a8e8-01f2e6341fbf", "name": "Relationship_Rest<API&Test2", "status": "Relationship_Active", "createdAt": "2025-07-28T11:50:16.213Z", "modifiedAt": "2025-07-28T11:50:16.213Z", "relationshipNumber": "R10071", "startEffectiveDate": "2025-07-28T04:00:00Z", "classification": "Commodity", "category": "Finance and Accounting", "residualRisk": 0.0, "inherentRisk": 0.0, "organizations": [ { "entityId": "7fcd72e3-6572-4a44-88c7-9a0fb2cd0661", "name": "3pm", "links": null } ], "supplier": { "entityId": "dfe010f7-55e3-4577-abad-cd9f8105dc25", "name": "HarshSupplier", "links": [ { "href": "api/suppliers", "rel": "retrieve-suppliers", "method": "GET" } ] }, "engagement": null, "parentRelationship": null, "internalManager": { "entityId": "8b3cbfb3-f345-42ec-a437-0201ccb7769f", "name": "Administrator, Risk Assess", "links": null }, "externalManager": { "entityId": "474cb696-2283-4078-984b-11e13becf89c", "name": "L, HarshSupplierManager", "links": null } } ] }, "errors": [], "success": true }
関係を取得し、ステータス、作成日、名前で絞り込む
- エンドポイント
GET
/api/relationships?status[eq]=Relationship_Active&createdAt[lt]=2024-12-11T06:20:52.03Z&name[contains]=xyz- cURLリクエスト例
curl --location --globoff 'https:// <your-instance>.risk.coupadev.com/api/ relationships?status[eq] =Relationship_Active&createdAt[lt] =2024-12-11T06%3A20%3A52.03Z&name [contains]=xyz' \--header 'Accept: application/json' \--header 'Content-Type: application/json' \--header 'Authorization: ••••••'- レスポンス例
{ "result": { "totalCount": 1, "relationships": [ { "entityId": "3b3dbc0e-fb38-46b3-81c0-3a9514324888", "name": "xyz_New_engagement", "status": "Relationship_Active", "createdAt": "2024-12-09T06:39:01.093Z", "modifiedAt": "2025-05-26T09:17:30.05Z", "relationshipNumber": "R10000", "startEffectiveDate": "2024-09-29T18:30:00Z", "classification": "1101", "category": "1101", "residualRisk": 50.00, "inherentRisk": 0.0, "organizations": [ { "entityId": "fa0282c0-4768-406b-8495-f56d7420ecd9", "name": "org1", "links": null } ], "supplier": { "entityId": "e2c2ae5b-f548-47aa-8613-9afca685d5f5", "name": "Dell", "links": [ { "href": "api/suppliers", "rel": "retrieve-suppliers", "method": "GET" } ] }, "engagement": { "entityId": "4584be4e-2a29-4901-9546-7be64f7784e9", "name": "xyz_New_engagement", "links": null }, "parentRelationship": { "entityId": "386baed9-905b-4934-81d1-134b71adac64", "name": "Engagement 003", "links": [ { "href": "api/relationships", "rel": "retrieve-relationships", "method": "GET" } ] }, "internalManager": { "entityId": "999f973a-165a-4ee9-a46f-d44b09863504", "name": "Administrator, Risk Assess", "links": null }, "externalManager": { "entityId": "0c8e8fd0-cc10-4fbb-9732-94e14ea160a1", "name": "supplier user, Dell", "links": null } } ] }, "errors": [], "success": true }