メインコンテンツにスキップ
ドキュメント
ドキュメント
Adaptive Planning
最終更新: 2025-10-03
updateDimensions

updateDimensions

API v17 以上でサポート
の単一リクエスト呼び出しの場合
updateDimensions
 リクエストによる更新は、階層属性で最大 10,000、またはフラット属性で最大 40,000 と制限されています。これらの制限は、リクエスト内の新しい属性値の作成には適用されません。
カテゴリ
メタデータの変更
説明
既存の属性とその属性値のセットを更新します。複数の属性と複数の値は、1 回の呼び出しで更新できます。成功した場合、API は更新されたばかりの属性の詳細を返します。
起動に必要な権限
各属性のモデルおよび権限
リクエストに応じてパラメータが必要
認証情報
このメソッドのリクエストには、呼び出し元のユーザーを識別し、認証するための認証情報タグが含まれています。ユーザーには "モデル" が指定されている必要があります 概念: 権限セット および更新する属性を管理するために必要な権限
ベスト プラクティス: を呼び出す exportDimensions updateDimensions リクエストに必要な Planning 属性 ID を取得します。updateDimensions リクエストを送信する前に、他のユーザーが Planning UI や API を使用して Planning 属性に変更を加えていないことを確認します。
HTTP
説明
Method
Post
Content-Type
text/xml

curl の例


curl -H "Content-Type: text/xml" -d @C:/temp/updateDimVal.xml -X POST https://api.adaptiveplanning.com/api/v17
updateDimVal.xml contents

<?xml version='1.0' encoding='UTF-8'?>
<call method="updateDimensions" callerName="Steve C">
 <credentials login="sampleuser@company.com" password="my_password"/>
<dimensions>
   <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0">
     <dimensionValue id="32" name="Graduate" description="Modified Graduate degree" />
   </dimension>
</dimensions>
</call>

XML ファイルへの添付ファイルの挿入の例



curl -i -X POST -H "Content-Type: multipart/form-data" -F "request=<C:/temp/requestCreateNewDimVal.xml" -F "content=@C:/temp/createNewDimVal.xml" https://api.adaptiveplanning.com/api/v17
requestCreateNewDimVal.xml content


<?xml version='1.0' encoding='UTF-8'?>
<call method="updateDimensions" callerName="Steve C">
 <credentials login="sampleuser@company.com" password="my_password"/>
</call>
createNewDimVal.xml


<?xml version='1.0' encoding='UTF-8'?>
<dimensions>
  <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0">
    <dimensionValue id="" name="Graduate" description="Graduate degree" />
  </dimension>
</dimensions>
ペイロードが多い場合は、圧縮 XML ファイル (ZIP 形式) を計上できます。参照 メタデータの一括更新。

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


<?xml version='1.0' encoding='UTF-8'?>
<call method="updateDimensions" callerName="Steve C">
 <credentials login="sampleuser@company.com" password="my_password"/>
<dimensions>
   <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0">
     <dimensionValue id="32" name="Graduate" description="Graduate degree" shortName="" allVersions="0">
         <attribute name="Education Type" value="Tech1" />
         <version name="Budget 2017" available="1" />
     </dimensionValue>
     <dimensionValue id="33" name="Masters" description="Masters degree" shortName="" allVersions="0">
         <attribute name="Education Type" value="Management" />
         <version name="Budget 2017" available="1" />
     </dimensionValue>
     <dimensionValue id="34" name="Phd" description="Phd" shortName="" />
   </dimension>
   <dimension id="16" name="Geography" 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="33" shortName="">                            
             <properties>                                
               <property name="Latitude" value="33.6015" />                                
               <property name="Longitude" value="86.4895" />                            
             </properties>                        
           </dimensionValue>                        
           <dimensionValue id="4719" name="35005" description="" shortName="" />                    
         </dimensionValue>                    
         <properties>                        
           <property name="Latitude" value="" />                        
           <property name="Longitude" value="86.9023" />                    
         </properties>                
       </dimensionValue>            
     </dimensionValue>        
   </dimension>
</dimensions>
</call>
次の条件が updateDimensions に適用されます。
  • 属性と属性値はいずれも、内部 ID 番号によって更新対象として識別されます。
  • システム属性である通貨は、API で更新することはできません。
  • 新しい属性および属性値を作成するには、空白または欠落している ID プロパティを指定します。
    • 既存の属性内で、既存の (新規ではない) 属性値を新規属性値の下でシフトできます。これにより、新しい dimensionValue が作成され、既存の dimensionValue が子としてその下に移動します。
  • フラット属性用に作成されたすべての属性値は、デフォルトですべての計画バージョンに表示されます。公開先を指定するには、次のいずれかを使用して明示的に指定する必要があります。
    • 設定
      allVersions
       特性
      dimensionValue
       タグ
    • または子を提供することによって
      version
       下のタグ
      dimensionValue
       カスタム表示の提供
    updateDimensions は、計画バージョンのバージョン使用可否のみを更新します。allVersions=1 の場合でも、実績バージョンのバージョン使用可否を更新できません。

新しい属性値を作成するためのリクエスト形式

新しい属性値を作成するには、その親の ID を含めます。たとえば、新しい子の値を下に追加すると、
Engr
 次の値を持つ値
id 7
では、以下を使用できます。

<?xml version='1.0' encoding='UTF-8'?>
<call method="updateDimensions" callerName="Steve C">
 <credentials login="sampleuser@company.com" password="my_password"/>
 <dimensions>
   <dimension id="7">
     <dimensionValue id="" name="Documentation" description="docs" shortName="" >
       <properties>                                
         <property name="OwnerID" value="58371998"/>                                                            
       </properties>        
     </dimensionValue>
   </dimension>
 </dimensions>  
</call>
この方法では、値のことは何も変更されません
id 7
。"子" という名前の新しい子が作成されます。
Docs
 対象
id 7
。メンションされていない子はすべて、子リストの最後に移動します。これは新しい値の「親を設定する」ことと同じですが、その親を要素として含めることによって実現できます。

コードと名前を使用した新しい属性値を作成するためのリクエスト形式

新しい属性値を作成するには、その親の ID を含めます。たとえば、ID が 7 の Engr 値の下に新しい子の値を追加するには、以下を使用できます。
<?xml version="1.0" encoding="UTF-8"?>
<call method="updateDimensions" callerName="Steve C">
<credentials login="sampleuser@company.com" password="my_pwd" />
<dimensions displayNameEnabled="1">
   <dimension id="7">
      <dimensionValue id="" code ="Doc" name="Documentation" description="docs" shortName="">
         <properties>
            <property name="OwnerID" value="58371998" />      
         </properties>
      </dimensionValue>
   </dimension>
</dimensions>
</call>

入力形式 1: ペイロードにディメンション ツリー全体を含める

updateDimensions API は、変更を考慮することなく、呼び出し元が新しいツリー状態を提供したい場合に最適です。
updateDimensions API は属性構造の変更を把握し、変更された、または新しい属性/属性値のみを更新します。設定
dimensions
 要素には直接の子が 1 つのみ含まれます
dimension
 または
dimensionValue
 要素
<?xml version="1.0" encoding="UTF-8"?>
<call method="updateDimensions" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd" />
<dimensions>
   <dimension id="16" name="Geography" 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="33" shortName="">
                  <properties>
                     <property name="Latitude" value="33.6015" />
                     <property name="Longitude" value="86.4895" />
                  </properties>
               </dimensionValue>
               <dimensionValue id="4719" name="35005" description="" shortName="" />
            </dimensionValue>
            <properties>
               <property name="Latitude" value="" />
               <property name="Longitude" value="86.9023" />
            </properties>
         </dimensionValue>
      </dimensionValue>
   </dimension>
</dimensions>
</call>

入力形式 2: ペイロードにディメンション サブツリー構造を含める

この形式は、変更が属性ツリー構造の 1 つの部分のみに制限されるユース ケースをサポートします。
updateDimensions API は属性構造の変更を把握し、変更された、または新しい属性/属性値のみを更新します。設定
dimensions
 要素には直接の子が 1 つのみ含まれます
dimensionValue
 要素
たとえば、アラバマ州内の変更があるとします。
<?xml version="1.0" encoding="UTF-8"?>
<call method="updateDimensions" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd" />
<dimensions>
   <dimensionValue id="555" name="Alabama" description="1" shortName="">
      <dimensionValue id="579" name="205" description="1" shortName="">
         <dimensionValue id="4718" name="35004" description="33" shortName="">
            <properties>
               <property name="Latitude" value="33.6015" />
               <property name="Longitude" value="86.4895" />
            </properties>
         </dimensionValue>
         <dimensionValue id="4719" name="35005" description="" shortName="" />
      </dimensionValue>
   </dimensionValue>
</dimensions>
</call>
フラット属性の場合、親を指定する必要があります
dimension
 タグの下に
dimensions
 タグの後に 1 つまたは複数の属性値が続きます。
dimensions
 要素には直接の子が 1 つのみ含まれます
dimension
 要素
<?xml version="1.0" encoding="UTF-8"?>
<call method="updateDimensions" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd" />
<dimensions>
   <dimension id="16" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0">
      <dimensionValue id="521" name="Graduate" shortName="" description="Graduate degree" />
      <dimensionValue id="522" name="Masters" shortName="" description="Masters degree" />
   </dimension>
</dimensions>
</call>

入力形式 3: 単一属性値の更新

この形式は、変更が 1 つの属性値のみに制限されるユース ケースをサポートします。
設定
dimensions
 要素には直接の子が 1 つのみ含まれます
dimensionValue
 要素
単一の属性値を更新する場合のみ、入力形式 3 を使用します。入力形式 3 は、複数の属性値を更新するための好ましい形式ではありません。この形式で新しい属性/属性値を作成することはできません。新しい属性/属性値を追加するには、入力形式 2 を使用します。
<?xml version="1.0" encoding="UTF-8"?>
<call method="updateDimensions" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd" />
<dimensions>
   <dimensionValue id="555" name="Alabama" description="1" shortName=""/>
</dimensions>
</call>

1 回の updateDimensions コールでの複数の名前変更の処理

リモート システム内の同一エンティティに対して複数の名称変更が発生する可能性があります。
updateDimensions
。リモート システムのエンティティ名は、同じエンティティ ID と交換できます。条件
updateDimensions
 名前の交換後に呼び出しが発生する場合、
updateDimensions
 呼び出しは、氏名変更全体の ID を追跡することによって、これらの変更を管理します。この呼び出しは、既存の名称を使用する新しい ID の導入を処理することもできます。
それぞれの例が成功するには、固有の値を使って ID が完全に交換される必要があります。
例 1: リモート システムでの単純な名称交換。

ID     Unique Value   New Unique Value
1      AA             BB
2      BB             AA
例 2: リモート システムでの 3 つの名前変更のシーケンス。

ID     Unique Value   New Unique Value
1      AA             BB
2      BB             CC
3      CC             AA
例 3: 既存の一意値を使用した新しいエンティティ。

ID     Unique Value   New Unique Value
4                     AA
1      AA             BB
2      BB             Old BB
認証情報要素
タグ名
認証情報
説明
すべての API 呼び出しには、API を呼び出したユーザーを識別するための単一の認証情報要素が含まれている必要があります。その後、この API 呼び出しはこのユーザーとして実行されます (システムの監査証跡やアクション履歴は、このユーザーがアクションを実行したことを示します)。そのため、API 呼び出しが成功:
要素の特性
特性名
必須？
値
例
ログイン
あり
API メソッドを呼び出すユーザーのログイン名。このユーザーは、メソッドを呼び出すために必要な権限を持っている必要があります。
sampleuser@company.com
以下
あり
API メソッドを呼び出すユーザーのパスワード。
my_password
ロケール
なし
入力される数値と日付の解釈、および出力する数値と日付の形式設定 (適切な千単位の区切り文字、月名、日付の形式設定を使用) に使用されるロケールを指定します。ロケールは、応答内のシステム メッセージを表示する言語を指定するためにも使用されます。指定しない場合は、en_US (米国英語) が使用されます。
fr_FR
instanceCode
なし
認証情報で指定されたユーザーが Adaptive Planning の複数のインスタンスにアクセスできる場合、この属性を使用して、ユーザーがデフォルトのインスタンス以外のインスタンスにアクセスしようとしていることを指定できます。指定しない場合、ユーザーのデフォルトのインスタンスが使用されます。使用可能なインスタンス コードを決定するには、exportInstances API を使用します。
MYINSTANCE1
エレメントの内容
(なし)
属性要素
タグ名
属性
説明
1 つ以上の属性または属性値が含まれます。
要素の特性
特性名
必須？
値
例
retainExistingOrder
API v27+ で使用可能
なし
tainExistingOrder="1" は、updateDimensions API が XML ペイロード内の要素の順序を無視し、既存の定義済み順序を保持することを示します。
retainExistingOrder="0" は、updateDimensions API が XML ペイロード内の他の兄弟と比較したタグの位置に基づいて要素の順序を更新することを示します。
属性で "keepSorted" フラグが有効になっている場合、retainExistingOrder フラグは無視されます。
retainExistingOrder のデフォルト値は "1" です。
1
displayNameEnabled
表示名を有効にしたインスタンスの API v30 以上でのみ使用できます。
なし
displayNameEnabled=1 は、updateDimensions が の表示名プロパティを考慮する必要があることを示します
code
,
displayNameType
、および
description
 インスタンスで "表示名の有効化" がオンの場合。
displayNameEnabled=0 は、インスタンスで "表示名の有効化" がオンになっている場合でも、updateDimensions API が v30 前の API 契約に従うべきであることを示します。updateDimensions API は表示名プロパティを無視します。
code
,
displayNameType
 および
description
。
displayNameEnabled のデフォルト値は "0" です。
エレメントの内容
1 つ以上の属性または属性値が含まれます。
属性要素
タグ名
属性
説明
作成する属性を指定します。
要素の特性
特性名
必須？
値
例
ID
あり
更新されている属性の ID。
34
名前
なし
属性の名前。名前は一意である必要があります。
NewDimensionName
コード
API v39+ で使用できます。
属性のコード。コードは一意である必要があります
NewDimensionCode
shortName
なし
シートに表示される列の表示可能なタイトル。
NewDimensionShortName
listDimension
なし
"1" はこれがリスト属性であることを意味し、"0" (または指定されない) はリスト属性でないことを意味します。
0
useOnLevels
なし
"1" はこの属性が組織で使用できることを意味し、"0" (または指定されていない場合) は使用できないことを示します。
0
autoCreate
なし
"1" はこの属性の値がインポート経由で作成できることを意味し、"0" (または指定されていない場合) は作成できないことを意味します。
0
keepSorted
なし
"1" はこの属性の値が常にアルファベット順にソートされることを意味し、"0" (または指定されていない場合) はこの属性が手動で並べ替えられることを意味します。
表示名のコンポーネントを変更すると、"並べ替えを維持" が有効になっている場合でも、要素のソート順が変わります。
0
displayNameType
表示名を有効にしたインスタンスの API v30 以上でのみ使用できます。
なし
属性値の表示を制御します。指定可能な値は、NAME、CODE、NAME_CODE、CODE_NAME です。
空白の場合または指定されていない場合は、デフォルトの NAME になります。
このプロパティは、インスタンスで "表示名の有効化" がオンになっている場合にのみ使用できます。
"CODE_NAME"
説明
表示名を有効にしたインスタンスの API v30 以上でのみ使用できます。
なし
属性の説明。
このプロパティは、インスタンスで "表示名の有効化" がオンになっている場合にのみ使用できます。
"dim について降順"
property1, property2, ...
なし
属性の管理で入力された属性のプロパティ (存在する場合)。各属性には最大 5 つのプロパティを含めることができます。
"緯度"
エレメントの内容
任意の dimensionValue 要素。
dimensionValue element
タグ名
dimensionValue
説明
更新する属性値を指定します。
要素の特性
特性名
必須？
値
例
ID
あり
属性値の ID。
34
コード
表示名を有効にしたインスタンスの API v30 以上でのみ使用できます。
なし
属性値の一意のコード。
NewDimensionValue
名前
あり
属性値の名前。API v30 以上のインスタンスで "表示名の有効化" がオンの場合、名前の重複値が許可されます。インスタンスで "表示名の有効化" がオフになっている場合、コードを使用できないため、名前は一意である必要があります。
改行文字 (
&#10;)
 単語の間で見つかった値は、ペイロードの処理中に 1 つのスペースに置き換えられます。
名前の先頭または末尾にある改行文字も、単一のスペースに置き換えられます。ペイロード処理中に空白がトリミングされるため、これらのスペースはユーザー インターフェイスに表示されません。
NewDimensionValue
shortName
なし
属性値の短い名前。
NewDimensionValueShortName
説明
なし
属性値の説明。
これは NewDimensionValue です
allVersions
なし
"1" は属性値がすべての計画バージョンで使用可能であることを示し、"0" は次の計画バージョンではないことを示します。allVersions がない場合のデフォルト値は 1 です。
updateDimensions は、計画バージョンのバージョン使用可否のみを更新します。allVersions=1 の場合でも、実績バージョンのバージョン使用可否を更新できません。
特定のバージョンの使用可否を示すには、allVersions を 0 に設定し、各バージョンの属性値の使用可否を指定します。
例: バージョンが 2018a、2018b、2018c、2018d であるとします。バージョン 2018b にのみ属性値を含めるには、次のようにします。
<dimensionValue .... allVersions="0"> <version name="2018a" enabled="0"> <version name="2018c" enabled="0"> <version name="2018d" enabled="0" >
上の例で、allVersions="1" の場合、その下の子バージョン要素は無視されます。
0
エレメントの内容
オプションのプロパティ要素を含めることができます。
特性要素
タグ名
特性
説明
1 つの属性特性要素のコンテナです。既存の特性名と値が必要です。
要素の特性
特性名
必須？
値
例
名前
あり
属性特性の名前。
勤務地
値
API v34 で更新済
あり
属性特性の値。
"属性のインポートにより自動的に特性値を作成する" が属性特性管理者 UI で有効になっている場合、まだ存在しない特性値はルート属性の新しい特性値になります。
API v32 および v33 では、この属性が意味を持つのは、インスタンスの表示名設定がオフになっている場合のみです。
API v34 以降の場合:
  • 有効な表示名の設定がオンの場合にサポートされます。
  • valueCode と valueName が存在するとエラーになります。
  • 特性管理者 UI で "属性のインポートにより特性値を自動的に作成" が有効になっている場合、値が存在しない場合、値の文字列がコードと名前になります。
この特性のタグ付けを削除するには、value="" に設定します。
SFO
valueCode
表示名が有効になっているインスタンスの API v32 および API v33 でのみ使用できます。
API v34 ではサポートされていません。
あり
この特性の特性値コード。
valueCode 入力が意味を持つのは、displayNameEnabled=1で、表示名の設定が API v32 および API v33 のインスタンスに対してオンになっている場合に限られます。
この特性のタグ付けを削除するには、valueCode="" を設定します。
SFO
valueName
表示名が有効になっているインスタンスの API v32 および API v33 でのみ使用できます。
API v34 ではサポートされていません。
なし
新しく自動作成された特性値の名前。
特性が意味を持つのは、次の場合に限られます。
  • valueCode は存在しない特性値を保持しています。
  • インスタンスの "表示名" 設定がオンになっています。
  • displayNameEnabled=1
  • API v32 および API v33 を呼び出す。
valueCode が既存の特性値を保持している場合、valueName は無視されます。
サンフランシスコ
エレメントの内容
(なし)
バージョン要素
タグ名
バージョン
説明
ディメンション値の計画バージョンの使用可否を指定します。既存の計画バージョンが必要です。仮想、非表示、実績、ロック済、またはアーカイブ済みのバージョンのバージョン使用可否を変更することはできません。
要素の特性
特性名
必須？
値
例
名前
あり
"バージョンの管理" に表示されるバージョンの名前です。
2015 年予算
使用可能
あり
1 の場合、この属性値はこのバージョンで使用可能です。
1
エレメントの内容
各属性値に対して 1 つ以上のバージョン要素
プロパティ要素
API v22 でサポート
タグ名
プロパティ
説明
プロパティ要素を含む任意の要素。
要素の特性
(なし)
エレメントの内容
最大 5 つのプロパティ要素が含まれます。
プロパティ要素
API v22 でサポート
タグ名
プロパティ
説明
更新するカスタム プロパティを指定します。プロパティ要素値には、数字のみを含めることができます。
要素の特性
特性名
必須？
値
例
名前
あり
プロパティの名前。
緯度
値
あり
プロパティの値。値が空の場合、属性値のプロパティ値は消去されます。
33.6015
エレメントの内容
(なし)

回答フォーマット


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
<messages>
 <message type="INFO">Dimension was saved successfully.</message>
</messages>
<output>
 <dimensions>
   <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0" status="">
     <dimensionValue id="44" name="Documentation" description="docs" shortName="" status="created">
     </dimensionValue>
   </dimension>
   <dimension id="16" name="Geography" shortName="" autoCreate="0" listDimension="0" keepSorted="0" useOnLevels="0" property1="Latitude" property2="Longitude" status="">                
     <dimensionValue id="521" name="United States" shortName="" description="USA" status="">                    
       <dimensionValue id="555" name="Alabama" shortName="" description="1" status="">                        
         <dimensionValue id="579" name="205" shortName="" description="1" status="">                            
           <dimensionValue id="4718" name="35004" shortName="" description="33" status="">                                
             <properties>                                    
               <property name="Latitude" value="33.6015" status="created" />                                    
               <property name="Longitude" value="86.4895" status="" />                                
             </properties>                            
           </dimensionValue>                            
           <dimensionValue id="4719" name="35005" shortName="" description="" status="" />                        
         </dimensionValue>                        
         <properties>                            
           <property name="Latitude" value="" status="deleted" />                            
           <property name="Longitude" value="86.9023" status="updated" />                        
         </properties>                    
       </dimensionValue>                
     </dimensionValue>            
   </dimension>
 </dimensions>
</output>
</response>
属性要素
タグ名
属性
説明
1 つ以上の属性または属性値が含まれます。
要素の特性
(なし)
エレメントの内容
1 つ以上の属性または属性値が含まれます。
retainExistingOrder
なし
0 の場合、updateDimensions API は XML ペイロードの内容に基づいてソート順を更新します。
1 つの場合、updateDimensions API は既存のソート順を保持する必要があります。
1
displayNameEnabled
表示名を有効にしたインスタンスの API v30 以上でのみ使用できます。
displayNameEnabled=1 は、updateDimensions が の表示名プロパティを考慮する必要があることを示します
code
,
displayNameType
、および
description
 インスタンスで "表示名の有効化" がオンの場合。
displayNameEnabled=0 は、インスタンスで "表示名の有効化" がオンになっている場合でも、updateDimensions API が 2021.42 前の API 契約に従って続行する必要があることを示します。updateDimensions API は表示名プロパティを無視します。
code
,
displayNameType
 および
description
。
displayNameEnabled のサポートは、2021.42 で開始されます。displayNameEnabled のデフォルト値は "0" です。
1
属性要素
タグ名
属性
説明
exportDimensions API コールへの応答で返される単一のカスタム属性を示します。
要素の特性
特性名
必須？
値
例
ID
あり
作成の場合、新しい ID が入力されます。
16
名前
あり
レポートおよびシートに表示される属性の名前。
顧客
コード
API v39+ で使用できます。
なし
属性のコード。
顧客
shortName
なし
属性の管理で入力された属性の短縮名 (存在する場合)
cust.
autoCreate
あり
1: 選択した属性に "データのインポートにより自動的に属性値を作成する" フィールドが設定されている場合。それ以外の場合は 0。
0
listDimension
あり
選択した属性がリスト属性の場合は 1。それ以外の場合は 0。
1
keepSorted
あり
選択した属性がソート状態で維持される場合は 1、それ以外の場合は 0。
1
useOnLevels
あり
選択した属性を組織で使用できる場合は 1、それ以外の場合は 0。
1
displayNameType
表示名を有効にしたインスタンスの API v30 以上でのみ使用できます。
なし
属性値の表示を制御します。指定可能な値は、NAME、CODE、NAME_CODE、CODE_NAME です。
空白の場合または指定されていない場合は、デフォルトの NAME になります。
このプロパティは、インスタンスで "表示名の有効化" がオンになっている場合にのみ使用できます。
CODE_NAME
説明
表示名を有効にしたインスタンスの API v30 以上でのみ使用できます。
なし
属性の説明。
property1,propert2,...
なし
属性のカスタム プロパティ。
エレメントの内容
0 個以上の dimensionValue 要素。個々の囲まれた dimensionValue 要素は、属性の「ルート属性値」、つまり親の値を持たない値を表します。
dimensionValue element
タグ名
dimensionValue
説明
exportDimensions API コールへの応答で返されるカスタム属性の単一メンバー値を表します。
要素の特性
特性名
必須？
値
例
ID
あり
作成の場合、新しい ID が入力されます。
16
コード
表示名を有効にしたインスタンスの API v30 以上でのみ使用できます。
なし
属性値の一意のコード。
会社
名前
あり
レポートに表示され、数式で使用される属性のメンバー値のラベル。
会社
shortName
なし
属性の管理で入力された属性値の短縮名 (存在する場合)
A
説明
なし
属性管理で入力された属性値の説明 (存在する場合)
法人
status
あり
更新後の属性値のステータス。警告とエラーの場合は、メッセージ要素にメッセージ内容が含まれます。更新ステータスはメッセージ内容を返しません。
  • エラー: エンティティでエラーが見つかりました
  • 警告: エンティティで警告が見つかりました
  • 作成済: エンティティは正常に作成されました
  • 更新済: エンティティが更新されました
更新されました
メッセージ
なし
無効な dimensionValue が入力されたことを示すエラー メッセージ。
属性名 ProductFirst01234567890123456... は 64 文字を超えることはできません
エレメントの内容
0 以上の任意の dimensionValue 要素囲まれた各 dimensionValue 要素はこの属性値の「子属性値」を表し、そのメンバーは暗黙的にこの値にロールアップされます。
特性要素
タグ名
特性
説明
1 つの属性特性要素のコンテナです。
要素の特性
特性名
必須？
値
例
名前
あり
属性特性の名前。
勤務地
値
API v32 で更新済
あり
属性特性の値。
API v32 以降では、この属性が意味を持つのは、インスタンスの表示名設定がオフになっている場合のみです。
サンフランシスコ
valueCode
表示名を有効にするインスタンスの API v32 以上でのみ使用できます。
あり
この特性の特性値コード。
API v32 以降では、valueCode が意味を持つのは次の場合のみです。
  • インスタンスの "表示名" 設定がオンになっています。
  • displayNameEnabled=1
SFO
valueName
表示名を有効にするインスタンスの API v32 以上でのみ使用できます。
なし
新しく自動作成された特性値の名前。
特性が意味を持つのは、次の場合に限られます。
  • valueCode は存在しない特性値を保持しています。
  • インスタンスの "表示名" 設定がオンになっています。
  • displayNameEnabled=1value
valueCode が既存の特性値を保持している場合、名前は無視されます。
サンフランシスコ
status
あり
更新後の属性値のステータス。警告とエラーの場合は、メッセージ要素にメッセージ内容が含まれます。更新ステータスはメッセージ内容を返しません。
  • エラー: エンティティでエラーが見つかりました
  • 警告: エンティティで警告が見つかりました
  • 作成済: エンティティは正常に作成されました
  • 更新済: エンティティが更新されました
更新されました
メッセージ
なし
無効な特性が入力されたことを示すエラー メッセージ。
エレメントの内容
(なし)
バージョン要素
タグ名
バージョン
説明
ディメンション値の計画バージョンの使用可否を指定します。
要素の特性
特性名
必須？
値
例
名前
あり
"バージョンの管理" に表示されるバージョンの名前です。
2015 年予算
使用可能
あり
1 の場合、この属性値はこの計画バージョンで使用可能です。
1
status
あり
更新後の属性値のステータス。警告とエラーの場合は、メッセージ要素にメッセージ内容が含まれます。更新ステータスはメッセージ内容を返しません。
  • エラー: エンティティでエラーが見つかりました
  • 警告: エンティティで警告が見つかりました
  • 作成済: エンティティは正常に作成されました
  • 更新済: エンティティが更新されました
更新されました
メッセージ
なし
無効なバージョンを入力した場合のエラー メッセージ。
エレメントの内容
各属性値に対して 1 つ以上のバージョン要素
プロパティ要素
タグ名
プロパティ
説明
最大 5 つのプロパティ要素が含まれます。
要素の特性
(なし)
エレメントの内容
最大 5 つのプロパティ要素が含まれます。
プロパティ要素
タグ名
プロパティ
説明
更新するカスタム プロパティを指定します。
要素の特性
特性名
値
例
名前
プロパティの名前。
緯度
値
プロパティの値。値が空の場合、属性値のプロパティ値は消去されます。
33.6015
ステータス
更新後の資産のステータス。エラーの場合は、メッセージ要素にエラー メッセージの内容が含まれます。更新ステータスはメッセージ内容を返しません。
  • エラー: エンティティでエラーが見つかりました
  • 作成済: エンティティは正常に作成されました
  • 更新済: エンティティが更新されました
  • 変更なし: ステータスが空の場合、エンティティについては何も変更されていません。
メッセージ
無効なプロパティ入力に関するエラー メッセージ。
プロパティ タグには名前特性が必要です。