[en] Varicent Incentive Compensation Management Documentation

計算呼び出しサンプル

Varicent Incentive Compensation Management (ICM)APIを使用して、モデルで使用可能な計算のリスト化、計算の実行、フルモデル計算の実行など、計算に関連するアクションを実行します。

すべての計算をリスト化

この呼び出しを使用して、Varicent Incentive Compensation Management (ICM)で使用可能なすべての計算をリスト化します。

リクエスト

GET - api/v1/calculations

サンプル呼び出し
curl -X GET -H "Authorization: Bearer API_KEY" 
-H "Model: YOUR_CLIENT_MODEL” 
-H "Content-Type: application/json" 
https:// YOUR_ICM10_API_SERVER_ADDRESS/api/v1/calculations
サンプルレスポンス
[ {
    "parentBlockId": 2170,
    "calculationId": 732,
    "name": "YOUR_CALCULATION_NAME",
    "isFavourite": false
  }]
特定の計算を実行

この呼び出しを使用して、Varicent Incentive Compensation Management (ICM)モデルで1つの計算を実行します。

リクエスト

POST - api/v1/rpc/calculations/{id}

注記

idは、GET - api/v1/calculationsフィールドのcalculationId呼び出しレスポンスから取得できます。

サンプル呼び出し
curl -X POST -H "Authorization: Bearer API_KEY" 
-H "Model: YOUR_CLIENT_MODEL” 
-H "Content-Type: application/json"
https:// YOUR_ICM10_API_SERVER_ADDRESS/api/v1/calculations/{id}
サンプルレスポンス
{ 
  "completedactivities": "api/v1/completedactivities/22848", 
  "liveactivities": "api/v1/liveactivities/22848", 
  "completedcomputation":"api/v1/calculations/logs/completed/1891", 
  "livecomputation": "api/v1/calculations/logs/live/0"
}