指定したモデルのすべてのモジュールの ID と名前を取得するには、この呼び出しを使用します。

これにより、特定のモジュールからビュー、ライン アイテム、又はデータを取得する前に、どのモジュールが存在するかを統合で特定できるようになります。

注記: この呼び出しを使用できるのはワークスペース管理者だけです。

メソッドとエンドポイント

GET

/models/{modelId}/modules

パラメーター

パラメーター詳細
{modelId}
  • 必須
  • タイプ: 文字列
  • 説明: モデルの ID
  • 例: 75A40874E6B64FA3AE074327899685

Curl のサンプル

curl -X GET 'https://api.anaplan.com/2/0/models/{modelId}/modules' \
-H 'Authorization:AnaplanAuthToken {anaplan_auth_token}' \
-H 'Accept: application/json'

レスポンス

レスポンス ヘッダー

Content-Type: application/json

レスポンス 200 の本文

{
  "meta": {
    "paging": {
      "currentPageSize":1,
      "offset":0,
      "totalSize":1
    },
    "schema": "https://api.anaplan.com/2/0/objects/module"
  },
  "status": {
    "code":200,
    "message":"Success"
  },
  "modules": [{
      "id":"102000000125",
      "name":"REV01 Price Book"
    },
    {
      "id":"102000000121",
      "name":"REV02 Volume Inputs"
    }]
}