updateDimension

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

カテゴリ	メタデータの変更
説明	属性を更新する。成功した場合、API は更新されたばかりの属性の詳細を返します。
起動に必要な権限	モデル
リクエストに応じてパラメータが必要	認証情報

このメソッドのリクエストには、呼び出し元のユーザーを識別し、認証するための認証情報タグが含まれています。属性を作成するには、"モデル" 権限が必要です。

この API には次の条件が適用されます。

パブリッシュされていない変更がある場合、このメソッドはエラーを返します。

属性特性が定義されている場合、またはすべてのバージョンで値の一部が使用できない場合、"listDimension" をオフにすることはできません。

階層 dimensionValues がある場合、listDimension をオフにすることはできません。

useOnLevels と listDimension の両方を有効にすることはできません。(同じコマンドで 1 つをオフにし、もう 1 つをオンにすることもできます。)

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


<?xml version='1.0' encoding='UTF-8'?>
<call method="updateDimension" callerName="fred">
    <credentials login="sampleuser@company.com" password="my_pwd" />
    <dimension id="34"
       name="Updated Dimension Name"
     />
</call>

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

属性要素
タグ名		属性
説明		作成する属性を指定します。
要素の特性
特性名	必須？	値	例
ID	あり	更新されている属性の ID。	34
名前	なし	属性の名前。名前は一意である必要があります。	NewDimensionName
shortName	なし	シートに表示される列の表示可能なタイトル。	NewDimensionShortName
listDimension	なし	"1" はこれがリスト属性であることを意味し、"0" (または指定されない) はリスト属性でないことを意味します。	0
useOnLevels	なし	"1" はこの属性が組織で使用できることを意味し、"0" (または指定されていない場合) は使用できないことを示します。	0
autoCreate	なし	"1" はこの属性の値がインポート経由で作成できることを意味し、"0" (または指定されていない場合) は作成できないことを意味します。	0
keepSorted	なし	"1" はこの属性の値が常にアルファベット順にソートされることを意味し、"0" (または指定されていない場合) はこの属性が手動で並べ替えられることを意味します。	0
エレメントの内容
(なし)

回答フォーマット


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
   <output>
       <dimensions>
           <dimension id="41" name="New Dimension Name" shortName="" autoCreate="0" listDimension="0" keepSorted="0" useOnLevels="0">
           </dimension>
       </dimensions>
   </output>
</response>

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

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

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

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

特性要素
タグ名		特性
説明		1 つの属性特性要素のコンテナです。
要素の特性
特性名	必須？	値	例
attributeID	あり	システムによって生成された属性特性の ID。	20
名前	あり	属性特性の名前。	学歴タイプ
valueID	あり	システムによって生成された属性特性値の一意の ID。	170
値	あり	属性特性の値。	Tech1
エレメントの内容
(なし)