何かお探しですか？製品プラットフォーム連携技術文書 Risk Assess連携 Risk Assess REST API 評価のGET

評価のGET

評価スコア、コメント、添付ファイルなど、Coupa Risk Assessテナントから評価データを取得します。

エンドポイント

エンドポイント	`/api/evaluations`
メソッド	GET

ヘッダー

ヘッダー	引数
認証	Bearerトークン
承認	application/jsonまたはapplication/xml

パラメーター

Table 1. クエリパラメーター
パラメーター	データタイプ	説明
limit	int	レスポンス内の最大アイテム数。最大値: 50。
offset	int	先頭からスキップするアイテム数。既定: 0。
entityId	guid	評価の一意の識別子。このパラメータでは[eq]演算子を使用してフィルタリング可能。
name	string	評価名。このパラメータでは[eq]、[contains]演算子を使用してフィルタリング可能。
status	string	評価のステータス。このパラメータでは[eq]、[contains]演算子を使用してフィルタリング可能。
createdAt	datetime	評価作成日時(YYYY-MM-DDTHH:MM:SS.FFZ形式)。このパラメータでは[eq]、[lt]、[gt]演算子を使用してフィルタリング可能。
modifiedAt	datetime	最終更新日時(YYYY-MM-DDTHH:MM:SS.FFZ形式)。このパラメータでは[eq]、[lt]、[gt]演算子を使用してフィルタリング可能。
includeDeleted	boolean	削除された評価を返されるリストに含めるか指定。既定: False。

要素

評価APIでは、次の要素を使用できます。

要素	データタイプ	利用可能なオプション	説明
success	boolean		リクエストが成功したかどうか。
totalCount	integer		フィルター条件に一致する評価の総数(全ページ合計) Note: totalCountがページサイズを超える場合は、limitとoffsetパラメーターを使用して追加のデータセットを取得してください。
result	array		リクエストごとの現在の評価結果のページ。1回のリクエストで最大50件(limitとoffsetにより決定)。
errors	array		エラーオブジェクトの一覧。通常、リクエストが成功した場合は空。
entityId	string		システム内で評価を一意に識別する恒久的なGUID。
name	string		システムによって自動的に生成される評価の名前。
status	string	PrgCancelled、PrgCollaborate、PrgCompleted、PrgExtApprInprocess、PrgExtApprPending、PrgExtEvalApproved、PrgExtEvalComplete、PrgExtEvalInprocess、PrgExtEvalPending、PrgIntApprInprocess、PrgIntApprPending、PrgIntEvalComplete、PrgIntEvalInprocess、PrgIntEvalPending、PrgCancelled	評価の現在の状態を示す列挙値。
finalScore	number	以下のFinalScoreおよびFinalRatingの値のセクションを参照してください。	KPIスコアや重み付けなどの設定に基づき算出された評価の最終スコア。値が-1の場合、評価は未完了(statusがPrgCompletedでない)を示します。
finalRating	string	以下のFinalScoreおよびFinalRatingの値のセクションを参照してください。	評価プログラム内で設定された範囲に基づき、finalScoreから導出された評価ラベル。評価の範囲が未設定、または評価が未完了の場合はnull。
createdAt	datetime		評価が作成された日時。
modifiedAt	datetime		評価が最後に変更された日時。
enrollment	登録		オブジェクトが評価対象として登録された際に記録された詳細情報。評価対象(サプライヤーやエンゲージメントなど)および評価に特化した設定(割当てられた評価者、承認者、その他関連データ)を含みます。
program	プログラム		この評価インスタンスの作成を管理する評価プログラムに関する詳細情報。評価プロセスの全体的なフレームワーク、規制、スコア設定、タイムラインが含まれます。
riskableObject	RiskableObject		評価を受けた評価可能・リスク対象のエンティティに関する詳細情報。サプライヤー、関係、エンゲージメントなど、さまざまなタイプのエンティティを表します。
organizations	組織オブジェクトの配列		評価プロセスに紐づく組織スコア蓄積オブジェクトを表します。蓄積オブジェクトは、組織レベルでの重要業績評価指標(KPI)のスコアを集計します。このオブジェクトは組織と呼ばれますが、値は組織自体ではなく、スコア蓄積レコードに関連しています。
comments	コメントオブジェクトの配列		評価者や承認者が評価全体レベルで提供したコメント。このオブジェクトには、組織、カテゴリー、KPIなどの下位レベルで行われたコメントは含まれていません。
attachments	添付ファイルオブジェクトの配列		評価者や承認者が評価全体レベルで添付したファイル。この配列には、組織、カテゴリー、KPIなどの下位レベルで追加された添付ファイルは含まれていません。

FinalScoreおよびFinalRatingの値

FinalScoreとFinalRatingは、評価が作成されたプログラムの種類に応じて異なる可能性があります。以下は設定可能な値の例です。

評価プログラムタイプ	FinalScoreの使用可能な値	FinalRatingの使用可能な値
エンタープライズコンプライアンス	0/100	PASS/FAIL
エンタープライズパフォーマンス	0～100の小数値	プログラム内で設定された範囲に基づく
エンタープライズリスク	0～100の小数値	プログラム内で設定された範囲に基づく
情報管理	-1	なし
ROBO	-1	なし
ROBOとして実行	-1	なし
不完全な評価	-1	なし

評価のGET

エンドポイント

GET/api/evaluations

cURLリクエスト例

curl --location 'https://<your-instance>.risk.com/api/evaluations' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••'

レスポンス例

{
    "result": {
        "totalCount": 1,
        "evaluations": [
            {
                "entityId": "70d4920d-4db3-4e15-a607-00139fae905a",
                "name": "Evaluation-RuleEqualsTodayProgram [AutoSupplier_20220218171430] - Quarterly - Period Start 29 Aug 23",
                "status": "PrgIntEvalPending",
                "createdAt": "2023-08-29T18:06:08.037Z",
                "modifiedAt": "2023-08-29T18:06:08.303Z",
                "finalScore": -1.0,
                "finalRating": null,
                "program": {
                    "entityId": "639f950f-9d2b-49d1-ae3f-840970f3a58a",
                    "name": "RuleEqualsTodayProgram",
                    "status": "Performance_Active",
                    "links": null
                },
                "enrollment": {
                    "entityId": "dc920003-f6cc-4c0d-bf9a-ccce277b8797",
                    "name": "AutoSupplier_20220218171430",
                    "links": null
                },
                "riskableObject": {
                    "entityId": "495e7410-cf2d-4346-91de-c1420f5b1de5",
                    "name": "AutoSupplier_20220218171430",
                    "objectName": "Hiperos.Models.Supplier",
                    "status": "General_Active",
                    "links": [
                        {
                            "href": "api/suppliers",
                            "rel": "retrieve-suppliers",
                            "method": "GET"
                        },
                        {
                            "href": "api/suppliers?entityId[eq]=495e7410-cf2d-4346-91de-c1420f5b1de5",
                            "rel": "_self",
                            "method": "GET"
                        }
                    ]
                },
                "organizations": [
                    {
                        "entityId": "a205cbdb-a575-49a1-9985-9457d6ebac73",
                        "name": "QAAutomation",
                        "links": null
                    }
                ],
                "comments": null,
                "attachments": null
            },
            {
                "entityId": "98dc3811-d2ea-492c-8318-001e972827b1",
                "name": "Evaluation-RuleEqualsTodayProgram [Auto_SyncAddress_20220330080032] - Quarterly - Period Start 29 Aug 23",
                "status": "PrgIntEvalPending",
                "createdAt": "2023-08-29T18:26:45.92Z",
                "modifiedAt": "2023-08-29T18:26:46.85Z",
                "finalScore": -1.0,
                "finalRating": null,
                "program": {
                    "entityId": "639f950f-9d2b-49d1-ae3f-840970f3a58a",
                    "name": "RuleEqualsTodayProgram",
                    "status": "Performance_Active",
                    "links": null
                },
                "enrollment": {
                    "entityId": "a10b710e-4432-4945-bddb-16e628527406",
                    "name": "Auto_SyncAddress_20220330080032",
                    "links": null
                },
                "riskableObject": {
                    "entityId": "242fa13c-224f-44ed-80d1-95d83ea31692",
                    "name": "Auto_SyncAddress_20220330080032",
                    "objectName": "Hiperos.Models.Supplier",
                    "status": "General_Active",
                    "links": [
                        {
                            "href": "api/suppliers",
                            "rel": "retrieve-suppliers",
                            "method": "GET"
                        },
                        {
                            "href": "api/suppliers?entityId[eq]=242fa13c-224f-44ed-80d1-95d83ea31692",
                            "rel": "_self",
                            "method": "GET"
                        }
                    ]
                },
                "organizations": [
                    {
                        "entityId": "9c9f45b8-1a5a-463e-8bc0-8d83edeee15c",
                        "name": "QAAutomation",
                        "links": null
                    }
                ],
                "comments": null,
                "attachments": null
            },
        ]
    },
    "errors": [],
    "success": true
}

このページに表示されている一部、または全ての内容は、機械翻訳によるものです。ご了承ください。