exportDimensions

Adaptive Planning

最新情報 (Workday 2025R2)

最終更新: 2024-03-08

exportDimensions

この API はユーザーのみをサポートします概念: アクセスルール API v22 以上

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

このメソッドのリクエストには、呼び出し元のユーザーを識別して認証するための認証情報タグのみが含まれています。検証されると、このメソッドはすべてのメンバー値を含むシステムのカスタム属性一式を示す XML ドキュメントを返します。このメソッドは、バージョン、時間、科目などの必要なシステム属性を一切返しません。これらの属性はそれぞれ独自のメタデータ API コールで参照可能です。属性内のメンバーの値は、子を含む親メンバーとともにツリー形式で返されます。

属性 ID は、次の方法で見つけることができます。

exportDimensions

dimensionIDs 要素のないリクエストです。これにより、すべての属性とその ID のリストが作成されます。回答を確認して、必要な属性 ID を見つけます。属性 ID は、

Adaptive Planning

Web ユーザーインターフェイス

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


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportDimensions" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd"/>
<include versionName="Budget 2004" dimensionIDs="1,2,4,5" dimensionValues="true"/>
</call>

認証情報要素
タグ名		認証情報
説明		すべての API 呼び出しには、API を呼び出したユーザーを識別するための単一の認証情報要素が含まれている必要があります。その後、この API 呼び出しはこのユーザーとして実行されます (システムの監査証跡やアクション履歴は、このユーザーがアクションを実行したことを示します)。そのため、API 呼び出しが成功:
要素の特性
特性名	必須？	値	例
ログイン	あり	API メソッドを呼び出すユーザーのログイン名。このユーザーは、メソッドを呼び出すために必要な権限を持っている必要があります	sampleuser@company.com
password	あり	API メソッドを呼び出すユーザーのパスワード。	my_password
ロケール	なし	入力される数値と日付の解釈、および出力する数値と日付の形式設定 (適切な千単位の区切り文字、月名、日付の形式設定を使用) に使用されるロケールを指定します。ロケールは、応答内のシステムメッセージを表示する言語を指定するためにも使用されます。指定しない場合は、en_US (米国英語) が使用されます。	fr_FR
instanceCode	なし	認証情報で指定されたユーザーがの複数のインスタンスにアクセスできる場合、 Adaptive Planning 、この属性は、ユーザーがデフォルトのインスタンス以外のインスタンスにアクセスしようとしていることを指定するのに使用できます。指定しない場合、ユーザーのデフォルトのインスタンスが使用されます。使用可能なインスタンスコードを決定するには、exportInstances API を使用します。	MYINSTANCE1
エレメントの内容
(なし)

要素を含める
タグ名		含める
説明		「属性値」情報のどの側面を回答に含めるか、または回答に含めるか、または回答から除外するかを示すフラグのセットを表します。この要素は任意です。存在しない場合、versionName/versionID のデフォルト値は空白 (またはすべてのバージョン) になります。
要素の特性
特性名	必須？	値	例
versionName API v18 で更新済	なし	リクエストされたバージョン名では使用できない属性値を回答で除外するかどうかを示します。要素またはその特性が存在しない場合のデフォルトでは、すべての属性と値を返します。バージョン名を指定した場合、指定したバージョンで使用できない属性値は返されません。指定したバージョン名が見つからない場合、この API はエラーを返します。versionName 特性と versionID 特性の両方が渡された場合、versionID は無視されます。 <?xml version='1.0' コード化='UTF-8'?> <responsecess="true"> <output> <dimensions> <dimension id="6" name=" Department" shortName="" autoCreate=" 0" listDimension="0" liveSorted="0" useOnLevels="1" SeqNo="35"> <dimensionValue id="7" name="Engr" description="Engineering" shortName=""> <dimensionValue id=" 52" name="QA" description="Quality Assurance" shortName="" /> <dimensionValue id="53" name="DEV" description="開発" shortName="" /><dimensionValue> <dimension> <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" liveSorted="0" useOnLevels="0" SeqNo="21"> <dimensionValue id="32" name ="Graduate" description="Graduatedegree" shortName=""> <attributes> <attributes attributeId="21" name="Education Type" valueId="197" value="Tech1" /> <attributes> <dimensionValue > <dimensionValue id="33" name="Masters" description="修士号" shortName=""> <attributes> <attribute attributeId="21" name="Education Type" valueId="196" value="Management" /> <attribu) ses> <dimensionValue> <dimensionValue id="34" name="Phtml" description="PWD" shortName="" /> <dimension> <dimensions> <output> <response> バージョンを指定した場合、ユーザーがそのバージョンへのアクセス権を持っている場合にのみ、呼び出しが成功します。	2004 年予算
versionID API v17 でサポート + API v18 で更新	なし	パラメータとしてバージョン ID 番号を取ることを除き、versionName (上記) と同じ。リクエストされたバージョンで使用できない属性値を回答で除外するかどうかを示します。要素またはその特性が存在しない場合のデフォルトでは、すべての属性と値を返します。バージョン ID が指定されている場合、指定されたバージョンで使用できない属性値は返されません。指定されたバージョン ID が見つからない場合、この API はエラーを返します。versionName 特性と versionID 特性の両方が渡された場合、versionID は無視されます。バージョンを指定した場合、ユーザーがそのバージョンへのアクセス権を持っている場合にのみ、呼び出しが成功します。	3
dimensionIDs API v17 以上でサポート	なし	API 応答に表示される ID のリスト。これは属性をフィルタリングしますが、属性値はフィルタリングしません。	"1,2,3,14"
特性	なし	回答に各フラット属性の回答に特性を含める必要があるかどうかを示します。	false
inaccessibleValues API v18 以上でサポート	なし	現在のユーザーがアクセスできない値を回答に含めるかどうかを示します。デフォルトは false です。"モデリング" または "すべての組織にインポート" の権限を持つユーザーのみが、このオプションを true に設定できます。	1
dimensionValues API v22+ でサポート	なし	回答に各属性の属性値を含めるかどうかを示します。デフォルト値は true です。false に設定した場合、フィルタされた属性のみを返し、属性値は返しません。dimensionValues が include 要素に含まれていない場合は、すべての属性とその値を返します。 include 要素がリクエストに含まれていない場合は、すべての属性とその値が返されます。	false
displayNameEnabled 表示名を有効にしたインスタンスの API v30 以上でのみ使用できます。	なし	displayNameEnabled=true は、exportDimensions がの表示名プロパティを考慮する必要があることを示します code , displayNameType 、および description インスタンスで "表示名の有効化" がオンの場合。 displayNameEnabled=false は、インスタンスで "表示名の有効化" がオンになっている場合でも、exportDimensions API が v30 前の API 契約に従う必要があることを示します。exportDimensions API は表示名プロパティを無視します code , displayNameType および description 。 displayNameEnabled のデフォルト値は "false" です。	真
エレメントの内容
(なし)

回答フォーマット

<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
   <output>
       <dimensions>
           <dimension id="6" name="Department" shortName="" autoCreate="0" listDimension="0" keepSorted="0" useOnLevels="1" seqNo="35">
               <dimensionValue id="7" name="Engr" description="Engineering" shortName=""/>
               <dimensionValue id="52" name="QA" description="Quality Assurance" shortName=""/>
               <dimensionValue id="53" name="Dev" description="Development" shortName=""/>
           </dimension>
           <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0" seqNo="21">
               <dimensionValue id="32" name="Graduate" description="Graduate degree" shortName="">
                   <attributes>
                       <attribute attributeId="21" name="Education Type" valueId="197" value="Tech1" />
                   </attributes>
               </dimensionValue>
               <dimensionValue id="33" name="Masters" description="Masters degree" shortName="">
                   <attributes>
                       <attribute attributeId="21" name="Education Type" valueId="196" value="Management" />
                   </attributes>
               </dimensionValue>
               <dimensionValue id="34" name="Phd" description="Phd" shortName=""/>
           </dimension>
           <dimension id="16" name="Geography" shortName="" autoCreate="0" listDimension="0" keepSorted="0" useOnLevels="0" seqNo="14" property1="Latitude" property2="Longitude">
               <dimensionValue id="521" name="United States" description="USA" shortName="">
                   <dimensionValue id="555" name="Alabama" description="1" shortName="">
                       <dimensionValue id="579" name="205" description="1" shortName="">
                           <dimensionValue id="4718" name="35004" description="1" shortName="">
                               <properties>
                                   <property name="Latitude" value="33.606" />
                                   <property name="Longitude" value="-86.502" />
                               </properties>
                           </dimensionValue>
                           <dimensionValue id="4719" name="35005" description="" shortName="">
                               <properties>
                                   <property name="Latitude" value="33.593" />
                                   <property name="Longitude" value="-86.96" />
                               </properties>
                           </dimensionValue>
                           <dimensionValue id="5073" name="35006" description="" shortName="" />
                           <dimensionValue id="5074" name="35007" description="" shortName="" />
                       </dimensionValue>
                   </dimensionValue>
                   <properties>
                       <property name="Latitude" value="37.0902" />
                       <property name="Longitude" value="95.7129" />
                   </properties>
               </dimensionValue>
           </dimension>
       </dimensions>
   </output>
</response>

属性は名前別に並べられます。

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

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

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

属性要素
タグ名		属性
説明		exportDimensions API コールへの応答で返される単一のカスタム属性を示します。
要素の特性
特性名	必須？	値	例
ID	あり	属性の内部システム ID 番号。これは、exportDimensionFamilies などの、他の API コールで属性を識別するために使用できます。	16
名前	あり	レポートおよびシートに表示される属性の名前。	顧客
code API v39+ でのみ使用できます。	なし	レポートおよびシートに表示される属性の名前。API v39 以上でのみ表示されます。	顧客
displayNameType 表示名を有効にしたインスタンスの API v30 以上でのみ使用できます。	なし	選択した内部表現。"属性の管理" ページの値の表示名の形式。名前コード NAME_CODE CODE_NAME	名前
shortName	なし	属性の管理で入力された属性の短縮名 (存在する場合)。	cust。
autoCreate	あり	選択した属性に "データのインポートにより自動的に属性値を作成する" フィールドが設定されている場合は 1、それ以外の場合は 0。	0
listDimension	あり	選択した属性がリスト属性の場合は 1、それ以外の場合は 0。	1
keepSorted	あり	選択した属性がソート状態で維持される場合は 1、それ以外の場合は 0。	1
useOnLevels	あり	選択した属性を組織で使用できる場合は 1、それ以外の場合は 0。	1
連番 API v17 で追加されましたが、将来の使用のために予約されています。
説明表示名を有効にしたインスタンスの API v30 以上でのみ使用できます。	なし	属性の管理で入力された説明。
エレメントの内容
0 個以上の dimensionValue 要素。個々の囲まれた dimensionValue 要素は、属性のルート属性値、つまり親の値を持たない値を表します。

dimensionValue 要素
タグ名		dimensionValue
説明		exportDimensions API コールへの応答で返されるカスタム属性の単一メンバー値を表します。
要素の特性
特性名	必須？	値	例
ID	あり	属性のこのメンバー値の内部システム ID 番号。	34
code 表示名を有効にしたインスタンスの API v30 以上でのみ使用できます。	なし	"属性の管理" で入力された属性のメンバー値のコード (存在する場合)。	会社
名前	あり	レポートに表示され、数式で使用される属性のメンバー値のラベル。	会社
displayName 表示名を有効にしたインスタンスの API v30 以上でのみ使用できます。	なし	displayNameType から派生したメンバー値の表示名。	会社
shortName	なし	属性の管理で入力された属性値の短縮名 (存在する場合)	A
説明	なし	属性管理で入力された属性値の説明 (存在する場合)	法人
エレメントの内容
0 以上の任意の dimensionValue 要素囲まれた各 dimensionValue 要素はこの属性値の「子属性値」を表し、そのメンバーは暗黙的にこの値にロールアップされます。 1 つのオプションのプロパティ要素。

プロパティ要素
タグ名		プロパティ
説明		プロパティ要素を含む任意の要素。
要素の特性
特性名	必須？	値	例
(なし)
エレメントの内容
最大 5 つのプロパティ要素。

プロパティ要素
タグ名		プロパティ
説明		カスタムプロパティを指定します。プロパティ要素値には数字のみが含まれます。
要素の特性
特性名	必須？	値	例
名前	あり	プロパティの名前。	緯度
値	なし	プロパティの値。	33.6015
エレメントの内容
(なし)

特性要素
タグ名		特性
説明		1 つまたは複数の属性特性要素のコンテナです。
要素の特性
特性名	必須？	値	例
(なし)
エレメントの内容
1 つ以上の特性要素

特性要素
タグ名		特性
説明		1 つの属性特性要素のコンテナです。
要素の特性
特性名	必須？	値	例
attributeID	あり	システムによって生成された属性特性の ID。	20
名前	あり	属性特性の名前。	学歴タイプ
valueID	あり	システムによって生成された属性特性値の一意の ID。	170
値有効な表示名設定がオンの場合、API v34 でサポートされます。	あり	属性特性の値。	Tech1
valueCode 表示名が有効になっているインスタンスの API v32 および API v33 でのみ使用できます。 API v34 ではサポートされていません。	なし	この特性の特性値コード。 API v32 および API v33 では、valueCode が意味を持つのは次の場合のみです。インスタンスの "表示名" 設定がオンになっています。 displayNameEnabled=1	Tech1
valueName 表示名が有効になっているインスタンスの API v32 および API v33 でのみ使用できます。 API v34 ではサポートされていません。	なし	この特性の特性値名。 API v32 および API v33 では、valueName が意味を持つのは、以下の場合のみです。インスタンスの "表示名" 設定がオンになっています。 displayNameEnabled=1	Tech1
valueDisplayName 表示名を有効にするインスタンスの API v32 以上でのみ使用できます。	あり	API v32 以降では、valueDisplayName が意味を持つのは、以下の場合に限られます。インスタンスの "表示名" 設定がオンになっています。 displayNameEnabled=1	Tech1
エレメントの内容
(なし)

この情報はお役に立ちましたか？

対応が必要な問題は何ですか？正確である聞きたいことの答えが得れらた見つけやすいわかりやすいタスクを完了する助けになる詳細まで網羅されている

対応が必要な問題は何ですか？正確でない聞きたいことの答えが得れられない見つけにくいわかりにくいタスクを完了する助けにならない不完全であるか情報が十分でない

どのようなタスクに取り組んでいるか教えてください。このコンテンツを改善するためにどのような情報が追加されると良いですか？ほかにご意見はありましたら細かいことでも良いのでお知らせください。

氏名

メールアドレス

Workdayは、お客様のフィードバックに回答する際にお客様の氏名と電子メールアドレスを使用します。お客様の情報は、当社のプライバシーステートメントに従って処理されます。

フィードバックありがとうございました