メインコンテンツにスキップ
ドキュメント
ドキュメント
Adaptive Planning
最終更新: 2023-06-23
インスタンス

インスタンス

URL エンドポイント

HTTPS://api.adaptiveplanning.com/api/rest/security/<version>/<tenant>/users/instances
バージョン: v1
カテゴリ
データの更新
説明
親子階層で Adaptive Planning マルチインスタンスを使用する場合は、インスタンスにユーザーを割り当てます。
起動に必要な権限
"管理アクセス" > "ユーザー"
マルチインスタンス ユーザー アクセス API を使用すると、ユーザーのインスタンス割当を取得および変更できます。

サポートされている HTTPS VERB:

HTTP Verb
単一リソース
回収リソース
説明
GET
サポートされていません
サポート済
デフォルトのインスタンス割当を含む、ユーザーのすべてのインスタンス割当を取得します。
PATCH
サポート済
サポートされていません
既存のユーザーのインスタンス割当に新しいインスタンスを追加します。
入力
サポート済
サポートされていません
ユーザーに割り当てられた既存のインスタンスを、リクエスト本文の指定されたデータで更新および置き換えます。

GET

リクエスト:
/users/instances:
ユーザーに割り当てられたインスタンスのコレクションを取得します。
デフォルトのインスタンス割当を含む、ユーザーのすべてのインスタンス割当を取得します。instanceCode でフィルタできます。ページングは、これらのクエリー パラメータがない場合、 limit または offset にデフォルト値を使用します。
リクエスト URI の例
HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/users/instances?offset=5&limit=5
リクエスト ヘッダーの例:
受諾言語: en
リクエスト本文の例
クエリー パラメータ
名前
説明
必須
instanceCode
インスタンスのユーザーのリストを取得するインスタンス コンテキストを定義するインスタンスの一意の識別子インスタンス コードが指定されていない場合は、API 呼び出し元のデフォルト インスタンスのすべてのユーザーが取得されます。
なし
limit
単一の回答に含まれるオブジェクトの最大数デフォルト値は 500 です。最大値は 500 です。
なし
offset
回答一覧の最初のユーザーを示す 0 から始まるインデックス。デフォルトは 0 です。
limit パラメータで offset を使用して、回答一覧のページングを制御します。
なし
回答例
200
有効な回答
回答例
 

{
"links": {
   "next": "https://api.adaptiveplanning.com/api/rest/security/v1/default/users/instances?offset=10&limit=5",
   "previous": "https://api.adaptiveplanning.com/api/rest/security/v1/default/users/instances?offset=0&limit=5"
},
"total": 26,
"users": [
   {
       "userGuid": "111SampleUserGuid",
       "userName": "sampleuser1@company.com",
       "wid" : "14400000000000000000000000000samplewid",
       "instances": [
           {
               "code": "sampleCompany",
               "default": true
           }
       ]
   },
   {
       "userGuid": "222SampleUserGuid",
       "userName": "sampleuser2@company.com",
       "wid" : "31100000000000000000000000000samplewid",
       "instances": [
           {
               "code": "sampleCompany",
               "default": true
           }
       ]
   },
   {
       "userGuid": "474C4F424F0000000000000001sampleGuid",
       "userName": "sampleuser3@company.com",
       "wid" : "34400000000000000000000000000samplewid",
       "instances": [
           {
               "code": "sampleCompany",
               "default": true
           }
       ]
   },
   {
       "userGuid": "111C4F424F0000000000000001sampleGuid",
       "userName": "sampleuser5@company.com",
       "wid" : "343400000000000000000000000000samplewid",
       "instances": [
           {
               "code": "sampleCompany",
               "default": true
           }
       ]
   },
   {
       "userGuid": "374C4F424F0000000000sampleGuid",
       "userName": "sampleuser4@company.com,
       ""wid" : "355000000000000000000000000samplewid",
       "instances": [
           {
               "code": "sampleCompany_Child1"
           },
           {
               "code": "sampleCompany_Child2"
           },
           {
               "code": "sampleCompany",
               "default": true
           }
       ]
   }
]
}

バッチ:

リクエスト:
users/instances?instanceCode={INSTANCECODE}:
既存のユーザーのインスタンス割当を部分的に更新します。
既存のユーザーのインスタンス割当に新しいインスタンスを追加します。インスタンスのデフォルトの特性を指定すると、ユーザーの現在のデフォルトのインスタンス割当が置き換えられます。
userIdentifier クエリー パラメータでユーザー ID を指定します。
リクエスト本文で、"userIdentifier" を指定します。
リクエスト URI の例
HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/users/instances?userIdentifier=userName
リクエスト本文の例
PATCH リクエスト本文の例
 

{
      "userName": "SampleUser1@SampleCompany.com",
      "instances": [
          {
              "code": "SampleCompany"
          },
          {
              "code": "SampleCompany_Child",
              "default": true
          }
      ]
  }
クエリー パラメータ
名前
説明
必須
instanceCode
既存のユーザーに追加するインスタンスと同じインスタンス階層で上位のインスタンス コード。子インスタンスを追加できるのは、上位の親インスタンスへのアクセス権を持つユーザーのみです。
なし
userIdentifier
userIdentifier は、Adaptive Planning の一意のユーザーを決定するために使用されます。可能な値: userName、wid、userGuid。
あり
リクエスト ヘッダー
コンテンツ タイプ
application/json
認証
基本ベースまたはトークンベース
ペイロード パラメータ
名前
説明
必須
wid
ユーザーの Workday ID。
なし
userName
ユーザーのユーザー名 (ログイン名)。
なし
userGuid
ユーザー作成時にシステムで割り当てられたグローバル一意ユーザー ID。
なし
インスタンス コード
ペイロードでユーザーに割り当てられる企業の instanceCode です。
あり
デフォルト
ペイロードでユーザーに割り当てられたデフォルト instanceCode です。
なし

入力:

リクエスト:
users/instances
:
ユーザーに割り当てられた既存のインスタンスの更新と置き換え
ユーザーに割り当てられた既存のインスタンスを、指定された userIdentifier で更新します。ユーザーに割り当てられたインスタンスを、リクエスト本文の指定されたデータに置き換えます。
  • インスタンス割当が、ユーザーに割り当てられた既存のインスタンスの一部ではない場合、そのインスタンスが追加されます。
  • インスタンス割当がリクエスト本文に含まれていない場合、そのインスタンスへのアクセス権が以前に存在していた場合は、そのインスタンスへのアクセス権が削除されます。
  • userIdentifier クエリー パラメータでユーザー ID を指定します。
  • 必要に応じて、instanceCode クエリー パラメータにインスタンス コードを指定します。
  • userIdentifier クエリー パラメータのユーザー ID。
  • リクエスト本文で、次の必須フィールドを指定します。<userIdentifier> (ユーザー名、WID または userGUID)。 <userIdentifier> は、userIdentifier クエリー パラメータで指定した値です。
  • インスタンスのデフォルト特性を指定すると、 はユーザーの現在のデフォルト インスタンスを置き換えます。
リクエスト URI の例
HTTPS://api.adaptiveinsights.com/api/rest/security/v{1}/{default}/users/instances?userIdentifier=userName
リクエスト本文の例
PUT リクエスト本文の例 

{
      "userName": "sampleUser@SampleCompanyParent.com",
      "instances": [
          {
              "code": "SampleCompanyParent"
          },
          {
              "code": "SampleCompanyChild",
              "default": true
          },
          {
              "code": "SampleCompanyGrandChild"
          }
      ]
  }
クエリー パラメータ
名前
説明
必須
instanceCode
既存のユーザーに追加するインスタンスと同じインスタンス階層で上位のインスタンス コード。子インスタンスを追加できるのは、上位の親インスタンスへのアクセス権を持つユーザーのみです。
なし
userIdentifier
userIdentifier は、Adaptive Planning の一意のユーザーを決定するために使用されます。可能な値: userName、wid、userGuid。
あり
リクエスト ヘッダー
コンテンツ タイプ
application/json
認証
基本ベースまたはトークンベース
ペイロード パラメータ
名前
説明
必須
wid
ユーザーの Workday ID。
なし
userName
ユーザーのユーザー名 (ログイン名)。
なし
userGuid
ユーザー作成時にシステムで割り当てられたグローバル一意ユーザー ID。
なし
インスタンス コード
ペイロードでユーザーに割り当てられる企業の instanceCode です。
あり
デフォルト
ペイロードでユーザーに割り当てられたデフォルト instanceCode です。
なし
回答
回答
サポートされるステータス コードのリスト:
200
正常に完了しました。
回答の例
200 件のPATCH 応答の例
 

{
"userName": "SampleUser@SampleComopany.com",
"instances": [
    {
        "code": "SampleCompany"
    },
    {
        "code": "SampleCompany_Child1",
        "default": true
    }
]
}
500
内部サーバー エラー
例: ユーザーが無効な場合。
500 の回答の例
 

{
 "status": {
     "errorMessage": "User with username user@samplecompany.com does not exists in company SampleCompany. "
 },
 "userName": "user@samplecompany.com"
}
例: 無効な instanceCode の場合
500 の回答の例
 

{
  "userName": "user@samplecompany.com",
  "instances": [
      {
          "status": {
              "errorMessage": "SampleOtherCompany not in SampleCompany network. API Caller: APICaller@samplecompany.com  not authorized to assign user: user@samplecompany.com to Instance: SampleOtherCompany "
          },
          "code": "SampleCompany",
          "default": true
      },
      {
          "code": "SAMPLECOMPANY_CHILD2"
      }
  ]
}
405
無効なリソースまたは操作
403
ユーザーに必要な権限が不足しています
404
リソースがありません。