exportRoles

API v25+ ではサポートされていません。exportPermissionSetsを使用します。

カテゴリ	Metadata retrieval
説明	インスタンス内のすべてのロールを含む完全なリストのメタデータを返します。
起動に必要な権限	なし (インスタンスに対して有効な認証情報である必要があります)
リクエストに応じてパラメータが必要	認証情報

このメソッドのリクエストには、呼び出し元のユーザーを識別して認証するための認証情報タグのみが含まれています。検証されると、このメソッドはユーザーのインスタンス内で見つかったすべてのロールの完全なセットを示す XML ドキュメントを返します。

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


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportRoles" 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
エレメントの内容
(なし)

回答フォーマット


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
 <output>
   <roles>
     <role id="1" name="Standard" permissions="SHT,RPT,SCOREBOARD"/>
     <role id="2" name="Administrative" permissions="SHT,RPT,SCOREBOARD,SAL,MOD,IMP,EXP"/>
   </roles>
 </output>
</response>

ロールと権限は名前別に並べられます。

回答エレメント
タグ名		response
要素の特性
特性名	必須？	値	例
成功	あり	真偽のいずれか。API 呼び出しが成功したかどうかを示します。呼び出しが成功した場合でも、応答に警告メッセージが含まれる場合があります。	真
廃止	なし	レスポンスタグに存在し、true に設定されている場合、この属性は、呼び出しているメソッドまたは API のバージョンが廃止され、によって正式に廃止されたことを示します。 Adaptive Planning 。現時点では機能し続けていますが、まもなく機能が停止する可能性があります。通常、この属性は存在しません。	false
エレメントの内容
単一の任意のメッセージ要素と、厳密に 1 つの必須の出力要素。

出力要素
タグ名	出力
要素の特性
(なし)
エレメントの内容
単一の科目要素この出力ラベンダーはすべての API 応答の標準であり、成功した API 呼び出しの有効な出力を囲みます。

ロール要素
タグ名	ロール
説明	1 つ以上のロール要素のコンテナです。
要素の特性
(なし)
エレメントの内容
1 つ以上のロール要素

ロールエレメント
タグ名		ロール
説明		インスタンスで使用できる単一のロールを示します。
要素の特性
特性名	必須？	値	例
ID	あり	ロールの内部システム ID 番号。これは、exportUsers API コールでユーザーに割り当てられたロールを識別するために使用されます。	1
名前	あり	"ロール管理" で表示されるロールの名前。	標準
権限	あり	このロールに割り当てられる権限のコードのカンマ区切りリスト。コードは、シートアクセスを示す "SHT" やレポートアクセスを示す "RPT" などの内部省略形です。	STD,RPT,SCOREBOARD
エレメントの内容
(なし)