メインコンテンツにスキップ
ドキュメント
ドキュメント
Adaptive Planning
importGroups

importGroups

カテゴリ
メタデータの変更
説明
Workday のコア システムまたは外部システムで作成したユーザー グループをインポートします。成功した場合、この API はインポートしたグループの詳細を返します。この API を使用して、Adaptive Planning のユーザー インターフェイスで作成されたユーザー グループを更新することはできません。
起動に必要な権限
"グローバル ユーザー グループの管理" 権限
リクエストに応じてパラメータが必要
認証情報
このメソッドのリクエストには、呼び出し元のユーザーを識別し、認証するための認証情報タグが含まれています。ユーザー グループをインポートするには
、"グローバル ユーザー グループの管理
"
 権限が必要です。

リクエストのフォーマット

<?xml version='1.0' encoding='UTF-8'?>
<call method="importGroups" callerName="a string that identifies your client application"
dataSource="WORKDAY/EXTERNAL" mode="REPLACE_ALL/UPDATE" userIdentifier="userName/userGUID/wid">
  <credentials login="sampleuser@company.com" password="my_pwd" />
    <groups>
        <group
          externalID="userGroup_ID_1"
          name="new user group"
           >
          <users>
              <user userGUID="B9ADBCB81AA2F9BAE040307F02092C2E"
                  userName="user1"
                  wid="A9ADBCB81AA2F9BAE040307F02092C2E" />
              <user userGUID="B9ADBCB81AA2F9BAE040307F02092C2F"
                   userName="user3"
                   wid="A9ADBCB81AA2F9BAE040307F02092C2F" />
          </users>
        </group>
     </groups>
</call>

クエリー属性

名前
説明
必須
dataSource
ユーザー グループ データのソースは以下のとおりです。
  • WORKDAYユーザー グループ データのソースは Workday です。 これらのグループは Adaptive Planning 内で編集できません。
  • 外部:ユーザー グループ データのソースが、Workday 以外の他のシステムにある場合。
管理者は "一般設定" ページで、外部のデータ ソースを持つグループの編集を有効にできます。その後、Adaptive Planning ユーザー インターフェイスを使用してこれらのグループを更新できます。参照 参考: 一般設定。
あり
モード
API 呼び出しのモード:
  • REPLANCE_ALLこのモードでは、Adaptive Planning インスタンス内のすべてのユーザー グループが、ペイロードで指定したユーザー グループに置き換えられます。
  • 更新。このモードでは、ペイロードで指定したユーザー グループのみが更新されます。
あり
userIdentifier
ユーザー グループで指定されたユーザーの識別子:
  • userName.指定したユーザーのユーザー名。
  • userGUID指定したユーザーのグローバル ユーザー ID。
  • wid.指定したユーザーの Workday ID。
あり
認証情報要素
タグ名
認証情報
説明
すべての API 呼び出しには、API を呼び出したユーザーを識別するための単一の認証情報要素が含まれている必要があります。その後、このユーザーとして API コールが実行されます。システム内のアクションの履歴や変更履歴は、このユーザーがアクションを実行したことを示します。そのため、ユーザーは API 呼び出しを成功させるためにはアクションを実行するために必要な権限を持っている必要があります。
要素の特性
特性名
必須？
値
例
ログイン
あり
API メソッドを呼び出すユーザーのサインイン名。このユーザーは、メソッドを呼び出すために必要な権限を持っている必要があります。
sampleuser@company.com
password
あり
API メソッドを呼び出すユーザーのパスワード。
my_password
ロケール
なし
受信する数値と日付の解釈に使用するロケールを指定します。また、出力番号と日付の形式を設定する (適切な千単位の区切り文字、期間名、日付の形式設定を使用)。このロケールは、応答内のシステム メッセージを表示する言語も指定します。指定しない場合は、en_US (米国英語) が使用されます。
fr_FR
instanceCode
なし
認証情報で指定されたユーザーが Adaptive Planning の複数のインスタンスにアクセスできる場合、この属性によって、ユーザーがデフォルト インスタンス以外のインスタンスにアクセスしようとしていることを指定できます。指定しない場合、ユーザーのデフォルトのインスタンスが使用されます。使用可能なインスタンス コードを決定するには、exportInstances API を使用します。
MYINSTANCE1
エレメントの内容
なし
グループ要素
タグ名
グループ
説明
作成または更新する一連のユーザー グループを指定します。
要素の特性
特性名
必須？
値
例
externalID
あり
ユーザー グループの外部 ID。
user_group_1
名前
あり
ユーザー グループの名前。
セキュリティ管理者
エレメントの内容
ユーザー要素
ユーザー要素
タグ名
ユーザー
説明
ユーザー グループに追加するユーザー (複数可) を指定します。
要素の特性
特性名
必須？
値
例
userGUID
Y (API 呼び出し元によって指定されたユーザー ID が userGUID である場合)
ユーザーのグローバル ID。
B9ADBCB81AA2F9BAE040307F02092C2
userName
Y (API 呼び出し元によって指定されたユーザー ID が userName の場合)
ユーザーのユーザー名。
updateMail@company.com
wid
Y (API 呼び出し元で指定されたユーザー ID が wid の場合)
ユーザーの Workday ID。
A9ADBCB81AA2F9BAE040307F02092C2E
エレメントの内容
無効なユーザー (無効な userGUID/userName/wid) の場合、特定の無効なユーザーはスキップされ、残りの有効なユーザーのグループに対してリクエストが処理されます。ただし、次の <ユーザー> 要素に関連するシナリオでは、グループ全体がペイロードで却下されます。
  1. ユーザー ID がありません:
    • <user/>
    • <user userName=""/>
    • <user userName/userGUID/wid=" "/>
    エラー メッセージユーザー ID がありません。すべてのユーザーについて有効な userName/userGUID/wid を指定してください。
  2. WID の形式が無効です:
    • WID の長さが 32 文字を超えています。
    エラー メッセージ: すべてのユーザーについて有効な userWID を指定してください。
  3. userGUID は有効な形式ではありません:
    • userGUID の長さが 32 文字を超えています。
    • userGUID は英数字ではありません。
    エラー メッセージ: すべてのユーザーについて有効な userGUID を指定してください。

回答フォーマット

<?xml version="1.0" encoding="UTF-8"?>
<response success="true">
  <output>
      <result>
          <imported_groups>
              <group success="true" externalID="ID_1" id="33" name="New Group 1" />
          </imported_groups>
      </result>
  </output>
</response>
回答エレメント
タグ名
response
要素の特性
特性名
必須？
値
例
成功
あり
真偽のいずれか。API 呼び出しが成功したかどうかを示します。呼び出しが成功した場合でも、その応答に警告メッセージが含まれる場合があります。
真
エレメントの内容
作成呼び出しと更新呼び出しのどちらを行ったかに応じて、created_usergroup または update_usergroup ステータス要素を持つ単一の結果要素。
imported_groups element
タグ名
imported_groups
特性名
必須？
値
例
グループ成功
あり
返されるステータス (真または偽)。
"true"
message
あり
ステータス メッセージ。
ユーザー グループ新しいユーザー グループが作成されました。
ユーザー メンバーシップのクリアでペイロードは部分的に実行されました。再試行して問題が解決しない場合は、サポートまでご連絡ください。
エレメントの内容
なし。