メインコンテンツにスキップ
ドキュメント
ドキュメント
Adaptive Planning
最終更新: 2024-03-08
exportUsers

exportUsers

カテゴリ
Metadata retrieval
説明
インスタンス内のすべてのユーザーの完全なリストのメタデータを返します。
起動に必要な権限
ユーザー管理
リクエストに応じてパラメータが必要
認証情報
このメソッドのリクエストには、呼び出し元のユーザーを識別して認証するための認証情報タグのみが含まれています。検証されると、このメソッドはインスタンス内で定義された全ユーザー セットを示す XML ドキュメントを返します。

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


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportUsers" callerName="a string that identifies your client application">
 <credentials login="sampleuser@company.com" password="my_pwd"/>
</call>
認証情報要素
タグ名
認証情報
説明
すべての API 呼び出しには、API を呼び出したユーザーを識別するための単一の認証情報要素が含まれている必要があります。その後、この API 呼び出しはこのユーザーとして実行されます (システムの監査証跡やアクション履歴は、このユーザーがアクションを実行したことを示します)。そのため、API 呼び出しが成功:
要素の特性
特性名
必須？
値
例
ログイン
あり
API メソッドを呼び出すユーザーのログイン名。このユーザーは、メソッドを呼び出すために必要な権限を持っている必要があります。
sampleuser@company.com
password
あり
API メソッドを呼び出すユーザーのパスワード。
my_password
ロケール
なし
入力される数値と日付の解釈、および出力する数値と日付の形式設定 (適切な千単位の区切り文字、月名、日付の形式設定を使用) に使用されるロケールを指定します。ロケールは、応答内のシステム メッセージを表示する言語を指定するためにも使用されます。指定しない場合は、en_US (米国英語) が使用されます。
fr_FR
instanceCode
なし
認証情報で指定されたユーザーが の複数のインスタンスにアクセスできる場合、
Adaptive Planning
、この属性は、ユーザーがデフォルトのインスタンス以外のインスタンスにアクセスしようとしていることを指定するのに使用できます。指定しない場合、ユーザーのデフォルトのインスタンスが使用されます。使用可能なインスタンス コードを決定するには、exportInstances API を使用します。
MYINSTANCE1
エレメントの内容
(なし)
要素を含める
API v17 以前で使用できます。
API v18+ では使用できません。
タグ名
含める
説明
ユーザーの情報のどの側面を回答に含めるか、または回答から除外するかを示すフラグのセットを表します。この要素は任意です。存在しない場合のデフォルト値は、ownLevels では true、hiddenVersions では false になります。
要素の特性
特性名
必須？
値
例
グループ
API v23+ で使用できます。
なし
単語「true」または「false」のいずれか。応答内の user 要素に groupIds 特性が含まれるかどうかを示します。True の場合、応答の groupIds には、ユーザーが所属するすべてのグループのカンマ区切りリストが含まれます。特性が存在しない場合、またはその値が true または False 以外の場合は、デフォルト値の False が使用されます。
真
ownedLevels
API v17 以前で使用できます。
API v18+ では使用できません。
なし
単語「true」または「false」のいずれか。応答内の user 要素にownLevels 特性を含めるか、含めないかを示します。特性が存在しない場合、またはその値が true または False 以外の場合は、デフォルト値の true が使用されます。
真
hiddenVersions
API v17 以前で使用できます。
API v18+ では使用できません。
なし
単語「true」または「false」のいずれか。応答内の user 要素に、hiddenVersions 特性を含めるか否かを示します。特性が存在しない場合、またはその値が true または False 以外の場合は、デフォルト値の False が使用されます。
false
エレメントの内容
(なし)

回答フォーマット 


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
<output>
   <users seqNo="55">
     <user id="19" guid="B9ADBCB81AA2F9BAE040307F02092C2E" login="analytica@fakecompany.com" email="analytica@fakecompany.com"
           name="Anna Analyzer" permissionSetId="3" timeZone="US/Pacific"/>
     <user id="123" guid="AAFF5218D55ABB9234660001BEC117A9" login="randomuser@fakecompany.com" email="randomuser@fakecompany.com"
           name="J. Random User" permissionSetId="2" timeZone="US/Pacific"/>
   </users>
</output>
</response>
回答エレメント
タグ名
response
要素の特性
特性名
必須？
値
例
成功
あり
真偽のいずれか。API 呼び出しが成功したかどうかを示します。呼び出しが成功した場合でも、応答に警告メッセージが含まれる場合があります。
真
廃止
なし
レスポンス タグに存在し、true に設定されている場合、この属性は呼び出しているメソッドまたは API のバージョンが廃止されており、正式に廃止されたことを示します。現時点では機能し続けていますが、まもなく機能が停止する可能性があります。通常、この属性は存在しません。
false
エレメントの内容
単一の任意のメッセージ要素と、厳密に 1 つの必須の出力要素。
出力要素
タグ名
出力
要素の特性
(なし)
エレメントの内容
単一の科目要素この出力ラベンダーはすべての API 応答の標準であり、成功した API 呼び出しの有効な出力を囲みます。
ユーザー要素
タグ名
ユーザー
説明
1 つ以上のユーザー要素のコンテナです。
要素の特性
特性名
必須？
値
例
連番
API v17 で追加されましたが、将来の使用のために予約されています。
エレメントの内容
1 つ以上のユーザー要素
ユーザー要素
タグ名
ユーザー
説明
exportUsers API 呼び出しの応答で返される単一のユーザーを表します。
要素の特性
特性名
必須？
値
例
ID
あり
ユーザーの内部システム ID 番号。
19
ガイド
あり
ユーザーのグローバルに一意の識別子。この識別子は、将来ログインまたは名前が変更されても変更されることはありません。
B9ADBCB81AA2F9BAE040307F02092C2E
ログイン
あり
このユーザーのログイン情報。
analytica@fakecompany.com
E メール
あり
このユーザーの E メール アドレス。ユーザーが有効な E メール アドレスを設定していない場合、空白になることがあります。
analytica@fakecompany.com
名前
あり
このユーザーの名前。
Anna アナライザー
ポジション
API v39 以上で使用可能
なし
ユーザーのポジション
"CEO"
permissionSetId
API v25 以上で使用可能
API v36+ では使用できません。
あり
このユーザーに割り当てられた権限セットの内部システム ID。exportPermissionSetsも参照してください。
permissionSetIds
API v36 以上で使用可能
あり
このユーザーに割り当てられた権限セットの内部システム ID。exportPermissionSetsも参照してください。
roleId
API v25 以前で使用可能です。
API v25+ では使用できません
あり
このユーザーに割り当てられたロールの内部システム ID。「exportRoles」も参照してください。
3
ownedLevels
API v18 では使用できません。
あり
この属性が含まれるのは、リクエストの認証情報に含まれるユーザーが組織ツリー全体に対する組織管理権限を持っており、ownLevels を含めるべきであることがリクエストで示されている場合に限られます。含まれている場合、この特性の値は、このユーザーが直接アクセスを許可されている組織の内部システム ID のカンマ区切りリストです。ユーザーは、ここにリストされている組織のすべての子組織にもアクセスできるようになります。
5,10,13
hiddenVersions
API v18 では使用できません。
N (説明を参照)
この属性が含まれるのは、リクエストの認証情報に含まれるユーザーがバージョン管理権限を持っており、リクエストで「hiddenVersions」を含めるよう指定されている場合のみです。含まれている場合、この特性の値は、このユーザーには表示されない (ただし、その親が存在しないか非表示でない) バージョンまたはバージョン フォルダの内部システム ID のカンマ区切りリストです。また、ユーザーは、ここにリストされているバージョンの子バージョンを表示できません。
121
alternateEmail
API v39 以上で使用可能
なし
このユーザーの代替 E メール アドレス。
"abc@greenco.com"
samlFedId
API v39 以上で使用可能
なし
このユーザーの SAMLFedulation ID。
"1234"
timeZone
あり
ユーザーのタイムゾーン。
米国/太平洋地域
ホームページ
API v39 以上で使用可能
なし
ユーザーのホームページ。
"Welcome"
国
API v39 以上で使用可能
なし
ユーザーの国コード (英 2 文字コード)。
"US"
usState
API v39 以上で使用可能
なし
ユーザーの状態コード (国は米国である必要があります)。
"CA"
エリア
API v39 以上で使用可能
なし
ユーザーのエリア ID
"111"
perspectiveName
API v39 以上で使用可能
なし
ユーザーのエリアのエリア名
"テスト エリア"
ダッシュボード
API v39 以上で使用可能
なし
ユーザーのダッシュボード ID - ダッシュボード ID を設定するにはエリア ID が必要です。エリア ID が指定され、ダッシュボード ID が指定されていない場合、ダッシュボード ID はヌルに設定されます。
"222"
dashboardName
API v39 以上で使用可能
なし
ユーザーのダッシュボードのダッシュボード名。
"ダッシュボードのテスト"
netsuiteLogin
API v39 以上で使用可能
なし
NetSuite ログイン
"abc@netsuite.com"
salesforceLogin
API v39 以上で使用可能
なし
Salesforce ログイン
"abc@salesforce.com"
createdDate
API v39 以上で使用可能
なし
ユーザーが作成された日時のタイムスタンプ
"2023-08-15 08:02:16.0"
lastLogin
API v39 以上で使用可能
なし
ユーザーが最後にログインした日時のタイムスタンプ
"2023-11-13 22:22:39.0"
failedAttempts
API v39 以上で使用可能
なし
このユーザーが失敗したログイン試行の回数 (連続)。
"0"
ロック済
API v39 以上で使用可能
なし
ユーザーがロックされているかどうか/(ログイン失敗回数が多すぎるため) ログインできないか。
"false"
エレメントの内容
1 つのサブスクリプション エレメント
サブスクリプション エレメント
タグ名
- サブスクリプション
説明
ユーザーの E メール配信設定を示します。
要素の特性
特性名
必須？
値
例
登録なし
あり
ユーザーがすべてのサブスクリプションからオプトアウトしたことを知らせる設定1 は、ユーザーがすべてのサブスクリプションからオプトアウトしていることを意味します。
0
systemAlertsAndUpdates
あり
システム アラートと、ユーザーがオプトアウトしたサブスクリプションの更新に対する設定。1 はユーザーがオプトインしていることを、0 はオプトアウトしていることを意味します。
1
customerNewsLetter
あり
ユーザーがオプトしたカスタマー ニュース レターの配信先の設定。1 はユーザーがオプトインしていることを、0 はオプトアウトしていることを意味します。
1
localEvents
あり
ユーザーがオプトしたローカル イベントのサブスクリプションの設定。1 はユーザーがオプトインしていることを、0 はオプトアウトしていることを意味します。
1
educationTraining
あり
ユーザーによってオプトインされた教育および研修イベントのサブスクリプションの設定。1 はユーザーがオプトインしていることを、0 はオプトアウトしていることを意味します。
1
customerWebinars
あり
ユーザーがオプトしたカスタマー Web セミナー イベントのサブスクリプションの設定。1 はユーザーがオプトインしていることを、0 はオプトアウトしていることを意味します。
1
newProductsAndEnhancements
あり
ユーザーがオプトインした新製品や機能強化の通知の設定を行います。1 はユーザーがオプトインしていることを、0 はオプトアウトしていることを意味します。
1
partnerNewsLetter
あり
ユーザーがオプトしたパートナー ニュースレター サブスクリプションの設定。1 はユーザーがオプトインしていることを、0 はオプトアウトしていることを意味します。
1
partnerWebinars
あり
ユーザーによってオプトされたパートナーの Web セミナー イベントのサブスクリプションの設定。1 はユーザーがオプトインしていることを、0 はオプトアウトしていることを意味します。
1
userGroups
あり
ユーザーがオプトインしたユーザー グループ イベント通知の設定。1 はユーザーがオプトインしていることを、0 はオプトアウトしていることを意味します。
1
サーベイ
あり
ユーザーがオプトしたサーベイを受信するための設定。1 はユーザーがオプトインしていることを、0 はオプトアウトしていることを意味します。
0
エレメントの内容
なし