updateLevels
API v19 以上でサポート
カテゴリ | メタデータの変更 |
説明 | 既存の組織のセットを更新するか、新しい組織とそのプロパティを作成します。複数の値を持つ複数の組織は、1 回の呼び出しで更新できます。成功した場合、この API は更新または作成された組織の詳細を返します。API が失敗すると、エラーとその原因の包括的なリストが返されます。 |
起動に必要な権限 | 各組織のモデルと権限 |
リクエストに応じてパラメータが必要 | 認証情報 |
このメソッドのリクエストには、呼び出し元のユーザーを識別し、認証するための認証情報タグが含まれています。ユーザーには "モデル" が指定されている必要があります 概念: 権限セット および更新する組織を管理するために必要な権限
ベスト プラクティス: を呼び出す exportLevels をクリックして、updateLevels リクエストに必要な Adaptive Planning の組織 ID を取得します。updateLevels リクエストを送信する前に、他のユーザーが Adaptive Planning UI や API を使って Planning 組織に変更を加えないでください。
HTTP | 説明 |
|---|---|
Method | Post |
Content-Type | text/xml |
curl の例
curl -H "Content-Type: text/xml" -d @C:/temp/updateLevels.xml -X POST https://api.adaptiveplanning.com/api/v19
updateLevels.xml contents
リクエストのフォーマット
<?xml version='1.0' encoding='UTF-8'?> <call method="updateLevels" callerName="a string that identifies your client application"> <credentials login="sampleuser@company.com" password="my_pwd"/> <levels> <level id="1" name="HQ"> <level id="2" name="Engineering" currency="USD" shortName="Engr"> <level id="8" name="Development" currency="USD" shortName="Dev" inWorkflow="0"/> <level id="9" name="QA" currency="INR" eliminationTradingPartner="1"/> <level id="10" name="Documentation" currency="PKR" shortName="Doc" actualsStart="05/2013" actualsEnd="12/2018" inWorkflow="1" propagateToDescendants="1"> <version name="Budget 2011" available="1"/> <version name="Budget 2012" available="0"/> <version name="Budget 2013" available="1"/> </level> </level> <level id="3" name="Professional Services" currency="USD" shortName="Prof.Srv" eliminationLevel="1"> <attribute name="Corporate Discount" value="Available"/> <attribute name="Transfers Restricted" value="Yes"/> <dimension name="Region" value="C-US"/> </level> </level> </levels> </call>
ペイロードが多い場合は、圧縮 XML ファイル (ZIP 形式) を計上できます。参照 メタデータの一括更新。
次の条件が updateLevels に適用されます。
- 更新対象の組織は内部 ID 番号によって識別されます。
- 新しい組織を作成するには、空白であるか ID プロパティがない組織を指定します。
- 既存の (新規ではない) アイテムを移動して、新しいアイテムの子にすることができます。これにより、新しいアイテムが作成され、既存のアイテムが子としてその下に移動します。
- シートの使用可否とユーザー アクセスは を介して更新できませんupdateLevels。
新しい組織を作成するためのリクエスト形式
新しい組織を作成するには、その組織の親をその ID で含めます。たとえば、新しい子組織を追加すると、
Engr
次の値を持つ値 id 7
では、以下を使用できます。<?xml version='1.0' encoding='UTF-8'?> <call method="updateLevels" callerName="Steve C"> <credentials login="stevec@greenco.com" password="password"/> <levels> <level id="7"> <level id="" name="Documentation" description="docs" shortName="" > </level> </level> </levels> </call>
この方法で組織に関する情報は一切変更されません
id 7
。"子" という名前の新しい子が作成されます。 Documnentation
対象 id 7
。指定されていないすべての子 Engr
子リストの最後に移動する。これは、新しい組織において「親を設定する」ことと同じです。入力フォーマット 1: ペイロードにツリー全体が含まれる
updateLevels API は、呼び出し元が変更を考慮することなく新しいツリー状態を提供したい場合に最適です。
updateLevels API は組織構造の変更を把握し、新しく追加された組織または変更された組織のみを更新します。以下の点に注意してください。
levels
要素には直接の子が 1 つのみ含まれます level
要素その子要素に、階層の残りの部分が含まれます。<?xml version="1.0" encoding="UTF-8"?> <call method="updateLevels" callerName="a string that identifies your client application"> <credentials login="sampleuser@company.com" password="my_pwd" /> <levels> <level id="1" name="HQ"> <level id="2" name="Engineering" currency="USD" shortName="Engr"> <level id="8" name="Development" currency="USD" shortName="Dev" inWorkflow="0" /> <level id="9" name="QA" currency="INR" eliminationTradingPartner="1" /> <level id="10" name="Documentation" currency="PKR" shortName="Doc" actualsStart="05/2013" actualsEnd="12/2018" inWorkflow="1" propagateToDescendants="1" /> </level> <level id="3" name="Professional Services" currency="USD" shortName="Prof.Srv" eliminationLevel="1" /> </level> </levels> </call>
入力フォーマット 2: ペイロードに組織サブツリー構造を含める
この形式は、変更が組織のツリー構造の 1 つの部分のみに制限されるユース ケースをサポートします。
たとえば、"エンジニアリング" 組織内での変更です。繰り返しますが、
levels
要素には直接の子が 1 つのみ含まれます level
要素その組織には、サブツリー構造の残りの組織が含まれます。この形式の最小サブツリーには、親と子のみが含まれます。<?xml version="1.0" encoding="UTF-8"?> <call method="updateLevels" callerName="a string that identifies your client application"> <credentials login="sampleuser@company.com" password="my_pwd" /> <levels> <level id="2" name="Engineering" currency="USD" shortName="Engr"> <level id="8" name="Development" currency="USD" shortName="Dev" inWorkflow="0" /> <level id="9" name="QA" currency="INR" eliminationTradingPartner="1" /> <level id="10" name="Documentation" currency="PKR" shortName="Doc" actualsStart="05/2013" actualsEnd="12/2018" inWorkflow="1" propagateToDescendants="1" /> </level> </levels> </call>
入力形式 3: 単一組織の更新
この形式は、変更が 1 つの組織のみに制限されるユース ケースの処理をサポートします。設定
levels
要素には直接の子が 1 つのみ含まれます level
要素
単一の組織を更新する場合は、入力形式 3 のみを使用します。入力形式 3 は、複数の組織の更新に適した形式ではありません。この形式で新しい組織を作成することはできません。新しい子組織を追加するには、入力フォーマット 2 を使用します。
<?xml version="1.0" encoding="UTF-8"?> <call method="updateLevels" callerName="a string that identifies your client application"> <credentials login="sampleuser@company.com" password="my_pwd" /> <levels> <level id="10" name="Documentation" currency="PKR" shortName="Doc" actualsStart="05/2013" actualsEnd="12/2018" inWorkflow="1" propagateToDescendants="1" /> </levels> </call>
入力形式 4: 組織タグの下にすべての組織タグを含むフラット形式
このフォーマットに含まれる値
level
タグ levels
階層のないフラット形式のタグ組織の階層を変更することなく、リストされた各組織のプロパティのみを更新します。
差額、または階層のごく一部に対する差分変更には、フラット形式のみを使用してください。入力形式 1 は、組織の階層全体をロードする場合のパフォーマンスが最適です。
<?xml version="1.0" encoding="UTF-8"?> <call method="updateLevels" callerName="a string that identifies your client application"> <credentials login="steve@steveco.com" password="" /> <levels> <level id="2" name="Engineering" currency="USD" shortName="Engr" /> <level id="8" name="Development" currency="USD" shortName="Dev" inWorkflow="0" /> <level id="9" name="QA" currency="INR" eliminationTradingPartner="1" /> <level id="10" name="Documentation" currency="PKR" shortName="Doc" actualsStart="05/2013" actualsEnd="12/2018" inWorkflow="1" propagateToDescendants="1"> <version name="Budget 2011" available="1" /> <version name="Budget 2012" available="0" /> <version name="Budget 2013" available="1" /> </level> </levels> </call>
1 回の updateLevels コールでの複数の名前変更の処理
リモート システム内の同一エンティティに対して複数の名称変更が発生する可能性があります。
updateLevels
。リモート システムのエンティティ名は、同じエンティティ ID と交換できます。条件 updateLevels
名前の交換後に呼び出しが発生する場合、 updateLevels
呼び出しは、氏名変更全体の 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 つだけです。1 つ以上の組織要素が含まれている。 | ||
要素の特性 | |||
特性名 | 必須？ | 値 | 例 |
retainExisitingOrder
API v26+ で使用可能 | なし | retainExistingOrder="1" は、updateLevels API が XML ペイロード内の要素の順序を無視し、既存の定義済みの順序を保持することを示します。 tainExistingOrder="0" は、updateLevels API が XML ペイロード内の他の兄弟と比較したタグの位置に基づいて要素の順序を更新する必要があることを示します。 API v26 より前の API バージョンでは、retainExistingOrder 特性が無視されます。 v26 では、retainExistingOrder のデフォルト値が "0" です。API バージョン v27 以降の場合、retainExistingOrder のデフォルト値は "1" です。 | 1 |
displayNameEnabled
表示名を有効にしたインスタンスの API v30 以上でのみ使用できます。 | なし | displayNameEnabled=1 は、updateLevel が の表示名プロパティに従う必要があることを示します code , displayNameType 、および description インスタンスで "表示名の有効化" がオンの場合。displayNameEnabled=0 は、インスタンスで "表示名の有効化" がオンになっている場合でも、updateLevels API が v30 前の API 契約に従うべきであることを示します。updateLevels API は表示名プロパティを無視します code , displayNameType および description 。displayNameEnabled のデフォルト値は "0" です。 | 1 |
エレメントの内容 | |||
1 つ以上の組織要素が含まれます。 | |||
組織要素 | |||
タグ名 | level | ||
説明 | 作成する組織を指定します。 | ||
要素の特性 | |||
特性名 | 必須？ | 値 | 例 |
ID | あり | 更新されている組織の ID。 | 34 |
コード
表示名を有効にしたインスタンスの API v30 以上でのみ使用できます。 | なし | 組織の一意のコード。
このプロパティは、インスタンスで "表示名の有効化" がオンになっている場合にのみ使用できます。 | NewLevelName |
名前
| なし | 組織の名前。API v30 以上のインスタンスで "表示名の有効化" がオンの場合、名前の重複値が許可されます。インスタンスで "表示名の有効化" がオフになっている場合、コードを使用できないため、名前は一意である必要があります。
| NewLevelName |
shortName
API v30 で更新済 | なし | シートに表示される列の表示可能なタイトル。 | NewLevelShortName |
通貨 | なし | 組織のこの組織に割り当てられる通貨の通貨コード。通貨は、exportActiveCurrencies コールで検出された、インスタンスに設定された通貨の 1 つになります。 | USD |
publishCurrency
API v24+ で使用可能 | なし | "PublishCurrency" は、財務計画をパブリッシュする際の Workday 会社の通貨を設定します。パブリッシュ通貨は、組織の追加の通貨属性として Workday Adaptive Planning インテグレーションの Planning 組織ローダを介してロードされます。PublishCurrency は、exportActiveCurrencies コールと組織管理 UI にある、インスタンスに設定された通貨の 1 つを示します。 Workday で Adaptive Planning を設定した場合のみ使用できます。ステップ: HCM と財務管理に向けた Adaptive Planning の設定の "計画のパブリッシュ" セクションを参照してください。 | CAD |
inWorkflow | なし | この組織がワークフローで使用されるかどうかを示します。 | 1 |
propagateToDescendants | なし | 変更がこの組織の子に伝達されるかどうかを示します。いいえ: 0、はい: 1。
組織のプロパティのすべてが PropagateToDescendants でカバーされるわけではありません。 影響を受けるプロパティのリスト: propagateToDescendants 、 UpdateLevels リクエスト中の propagateToDescendants の動作。 | 0 |
eliminationLevel | なし | この組織が、内部取引消去で使用する相殺消去組織であるかどうかを示します。組織は、相殺消去組織または相殺消去の取引先のいずれかになることができますが、両方になることはできません。 | 1 |
eliminationTradingPartner | なし | この組織が相殺消去取引パートナーであるかどうかを示します。組織は、相殺消去取引パートナーまたは相殺消去組織のいずれかになることができますが、両方になることはできません。 | 0 |
actualsStart | なし | この組織の実績の開始を示します。デフォルトの時間層における時間管理からの既存の時間コードである必要があります。 | 2013 年 5 月 |
actualsEnd | なし | この組織の実績の終了を示します。デフォルトの時間層における時間管理からの既存の時間コードである必要があります。 | 2018 年 12 月 |
説明
表示名を有効にしたインスタンスの API v30 以上でのみ使用できます。 | なし | 組織の説明。
このプロパティは、インスタンスで "表示名の有効化" がオンになっている場合にのみ使用できます。 | 最上位の部門 |
エレメントの内容 | |||
1 つまたは複数の特性要素 (組織に関連付けられた 1 つまたは複数の組織特性を設定する場合)。 | |||
バージョン要素 | |||
タグ名 | バージョン | ||
説明 | 組織のバージョンの使用可否を指定します。既存のバージョンが必要です。 | ||
要素の特性 | |||
特性名 | 必須？ | 例 | |
名前 | あり | "バージョンの管理" に表示されるバージョンの名前です。 | 2015 年予算 |
使用可能 | あり | 1 つの場合、このバージョンはこの組織で使用可能です。 | 1 |
エレメントの内容 | |||
各組織について 1 つ以上のバージョン要素 | |||
特性要素 | |||
タグ名 | 特性 | ||
説明 | 更新する特性を指定します。 | ||
要素の特性 | |||
特性名 | 必須？ | 値 | 例 |
名前
API v30 で更新済 | あり | 特性の名前。 | 勤務地 |
値
API v34 で更新済 | あり | この特性の特性値。
API v32 および v33 では、この属性が意味を持つのは、インスタンスの表示名設定がオフになっている場合のみです。 API v34 以降の場合:
| 170 |
valueCode
表示名が有効になっているインスタンスの API v32 および API v33 でのみ使用できます。 API v34 ではサポートされていません。 | あり | この特性の特性値コード。
valueCode 入力が意味を持つのは、displayNameEnabled=1で、表示名の設定が API v32 および API v33 のインスタンスに対してオンになっている場合に限られます。 | SFO |
valueName
表示名が有効になっているインスタンスの API v32 および API v33 でのみ使用できます。 API v34 ではサポートされていません。 | なし | 特性 valueName が意味を持つのは、次の場合のみです。
| サンフランシスコ |
エレメントの内容 | |||
(なし) | |||
属性要素 | |||
タグ名 | 属性 | ||
説明 | 組織属性値の割当を指定します。 | ||
要素の特性 | |||
特性名 | 必須？ | 値 | 例 |
名前
API v30 で更新済 | あり | 属性の名前。 | 2015 年予算 |
値
API v34 で更新済 | あり | この組織で使用できるこの属性の属性値。
API v32 および API v33 では、インスタンスの表示名設定がオフになっている場合にのみ値が意味になります。 API v34 以降の場合:
| ラホール |
valueCode
表示名が有効になっているインスタンスの API v32 および API v33 でのみ使用できます。 API v34 ではサポートされていません。 | あり | この組織で使用できるこの属性の属性値コード。
API v32 および API v33 では、valueCode が意味を持つのは次の場合のみです。
| LHE |
valueName
表示名が有効になっているインスタンスの API v32 および API v33 でのみ使用できます。 API v34 ではサポートされていません。 | なし | 新しく自動作成された属性値の名前。
API v32 および API v33 では、valueName が意味を持つのは次の場合のみです。
| ラホール |
エレメントの内容 | |||
(なし) | |||
上から下へのペイロード処理
組織の特性は、値を論理的にグループ化し、組織にタグ付けします。updateLevels API は XML ペイロードを上から下に処理するため、子組織の組織特性値を変更する前に、親組織の組織特性を割り当ててください。親組織の特性値が空白の場合、子組織は任意の特性値でタグ付けできます。組織の特性が親の特性と整合しない場合、互換性検証エラーが発生します。
以下のツリー構造を考慮します。親 "カリフォルニア" に対して、"パロアルト" と "プレザントン" の 2 つの子組織があります。組織の特性 "パロアルト" と "プレザントン" は兄弟です。
Location|__USA |__California |__Palo Alto |__Pleasanton
組織特性を含む元のリクエスト XML の例
場所特性値 "Palo Alto" が、"エンジニアリング" と "開発" の両方に割り当てられていることに注意してください。
<levels deleteWorkflowSilently="0" deleteActualsSilently="0"> <level id="1" name="HQ" proceedWithWarnings="0"> <attribute name="Location" value="" /> <level id="2" name="Engineering"> <attribute name="Location" value="Palo Alto" /> <level id="8" name="Development"> <attribute name="Location" value="Palo Alto" /> </level> </level> </level> </levels>
ペイロード処理の順序の誤りの例
以下の XML ペイロードでエラーが発生します。
The attribute value Pleasanton is not compatible with the parent's attribute value
"。上から下へのペイロード処理では、親組織 "Engineering" が前のコード ブロックからの事業地特性値 "Palo Alto" を持っていると見なされ、"プレザントン" が "Palo Alto" の子として処理されます。このエラーは、子組織 "開発" の事業地特性が、ツリー構造で示されている "パロアルト" のみであるために発生します。<levels deleteWorkflowSilently="0" deleteActualsSilently="0"> <level id="1" name="HQ" proceedWithWarnings="0"> <level id="2" name="Engineering"> <level id="8" name="Development"> <attribute name="Location" value="Pleasanton" /> </level> <attribute name="Location" value="California" /> <!-- Level Attribute change ignored due to placement order--> </level> <attribute name="Location" value="" /> </level> </levels>
ペイロード処理の有効な順序の例
"Engineering" の下で特性 "カリフォルニア" の配置順序を再配置することで、API が親組織の特性を最初に処理できるようにし、子組織 "開発" の場所特性値として "Palo Alto" または "プレザントン" のいずれかを持たせることができます。 。
<levels deleteWorkflowSilently="0" deleteActualsSilently="0"> <level id="1" name="HQ" proceedWithWarnings="0"> <attribute name="Location" value="" /> <!-- Level Attribute change processed due to correct placement order--> <level id="2" name="Engineering"> <attribute name="Location" value="California" /> <level id="8" name="Development"> <attribute name="Location" value="Pleasanton" /> </level> </level> </level> </levels>
組織のバージョンの使用可否も同様に機能します。互換性エラーを回避するため、子組織を変更する前に組織のバージョン使用可否を設定します。
バージョンのある元のリクエスト XML の例
"エンジニアリング" および "開発" 組織の "2020 年予算" バージョンの使用可否が "0" に設定されていることに注意してください。
<levels deleteWorkflowSilently="0" deleteActualsSilently="0"> <level id="1" name="HQ" proceedWithWarnings="0"> <version name="Budget 2020" available="0" /> <level id="2" name="Engineering"> <version name="Budget 2020" available="0" /> <level id="8" name="Development"> <version name="Budget 2020" available="0" /> </level> </level> </level> </levels>
ペイロード処理の順序の誤りの例
以下の XML ペイロードでは、上から下へのペイロード処理により、親の "Engineering" が使用不可 ("
available=0")
が前のコード ブロックの "2020 年予算" バージョンに割り当てられ、子組織 "開発" の使用可否が "1" として処理されます。親組織 "エンジニアリング" が使用できない場合、子組織 "開発" は使用できません。<levels deleteWorkflowSilently="0" deleteActualsSilently="0"> <level id="1" name="HQ" proceedWithWarnings="0"> <level id="2" name="Engineering"> <level id="8" name="Development"> <version name="Budget 2020" available="1" /> </level> <version name="Budget 2020" available="1" /><!-- Parent version availability change ignored due to placement order--> </level> <version name="Budget 2020" available="1" /> </level> </levels>
ペイロード処理の有効な順序の例
親組織の "エンジニアリング" の下の "2020 年予算" バージョンの配置順序を再配置すると、API で親の使用可否を最初に処理できるようになり、"開発" のバージョンの使用可否値が "1" または "0" になります。
<levels deleteWorkflowSilently="0" deleteActualsSilently="0"> <level id="1" name="HQ" proceedWithWarnings="0"> <version name="Budget 2020" available="1" /> <level id="2" name="Engineering"><!-- Parent Version availability change processed due to correct placement order--> <version name="Budget 2020" available="1" /> <level id="8" name="Development"> <version name="Budget 2020" available="1" /> </level> </level> </level> </levels>
回答フォーマット
<?xml version='1.0' encoding='UTF-8'?> <response success="true"> <output> <levels> <level id="1" name="HQ" currency="CAD" shortName="" eliminationLevel="1" eliminationTradingPartner="0" inWorkflow="0" status=""> <level id="2" name="Engineering" currency="USD" shortName="Engr" eliminationLevel="0" eliminationTradingPartner="1" inWorkflow="0" status="updated"> <level id="8" name="Development" currency="USD" shortName="Dev" eliminationLevel="0" eliminationTradingPartner="0" inWorkflow="0" status="updated" /> <level id="9" name="QA" currency="INR" shortName="" eliminationLevel="0" eliminationTradingPartner="0" inWorkflow="0" status="updated" /> <level id="10" name="Documentation" currency="PKR" shortName="Doc" eliminationLevel="0" eliminationTradingPartner="0" inWorkflow="1" propagateToDescendants="1" actualsStart="05/2013" actualsEnd="12/2018" status="updated"> <version name="Budget 2011" available="1" status="" /> <version name="Budget 2012" available="0" status="updated" /> <version name="Budget 2013" available="1" status="" /> </level> </level> <level id="3" name="Professional Services" currency="USD" shortName="Prof.Srv" eliminationLevel="1" eliminationTradingPartner="0" inWorkflow="0" status="updated"> <attribute name="Corporate Discount" value="Available" status="" /> <attribute name="Transfers Restricted" value="Yes" status="" /> <dimension name="Region" value="C-US" status="" /> </level> </level> </levels> </output> </response>
出力要素 | |
タグ名 | output |
要素の特性 | |
(なし) | |
エレメントの内容 | |
必須の単一の組織要素この出力ラベンダーはすべての API 応答の標準であり、成功した API 呼び出しの有効な出力を囲みます。 | |
組織要素 | |||
タグ名 | 組織 | ||
説明 | 1 つ以上の組織要素のコンテナです。 | ||
要素の特性 | |||
特性名 | 必須？ | 値 | 例 |
既存の順序を保持 | なし | 0 updateLevels API は XML ペイロードの内容に基づいてソート順を更新する必要があります。 1 updateLevels API は既存のソート順を保持する必要があります。 | 1 |
displayNameEnabled
表示名を有効にしたインスタンスの API v30 以上でのみ使用できます。 | なし | displayNameEnabled=1 は、updateLevel が の表示名プロパティに従う必要があることを示します code , displayNameType 、および description インスタンスで "表示名の有効化" がオンの場合。 | 1 |
エレメントの内容 | |||
1 つ以上の組織要素アクセスできない組織がリクエストに含まれている場合、組織要素は 1 つしかなくなりません。これは組織の最上位組織を表します。 | |||
組織要素 | |||
タグ名 | level | ||
説明 | updateLevels API コールへの応答で返される単一の組織を表します。 | ||
要素の特性 | |||
特性名 | 必須？ | 値 | 例 |
ID | あり | 組織の内部システム ID 番号。 | 7 |
コード
表示名を有効にしたインスタンスの API v30 以上でのみ使用できます。 | なし | 組織の一意のコード。
このプロパティは、インスタンスで "表示名の有効化" がオンになっている場合にのみ使用できます。 | 本社 |
名前 | あり | レポートおよびシートに表示される組織の名前です。 | 開発 |
通貨 | あり | 組織のこの組織に割り当てられる通貨の通貨コード。通貨は、exportActiveCurrencies コールで検出された、インスタンスに設定された通貨の 1 つになります。 | INR |
publishCurrency API v24+ で使用可能 | なし | "PublishCurrency" は、財務計画をパブリッシュする際の Workday 会社の通貨を設定します。パブリッシュ通貨は、組織の追加の通貨属性として Workday Adaptive Planning インテグレーションの Planning 組織ローダを介してロードされます。パブリッシュ通貨は、インスタンスに設定された通貨の 1 つを示します。これは exportActiveCurrencies コールで検出され、組織管理 UI で示されます。 プロビジョニングで Workday Power of One が有効になっている必要があります。 | CAD |
shortName | なし | "組織の管理" で入力された組織の略語 (存在する場合)。 | 偏差 |
eliminationLevel | なし | 組織が相殺消去組織であるかどうかを示します。いいえ: 0、はい: 1。 | 1 |
eliminationTradingPartner | なし | *説明* | 1 |
inWorkflow | なし | 組織がワークフロー内にあるかどうかを示します。いいえ: 0、はい: 1。 | 1 |
propagateToDescendants | なし | 変更がこの組織の子に伝達されるかどうかを示します。いいえ: 0、はい: 1。 ProgateToDescendants の動作の詳細については、 を参照してください。 UpdateLevels リクエスト中の propagateToDescendants の動作。 | 1 |
actualsStart | なし | この組織の実績バージョンの開始に、"時間管理" で定義された時間コード。 | 05/2013 |
actualsEnd | なし | この組織の実績バージョンの最後に、"時間管理" で定義された時間コード。 | 12/2018 |
説明
表示名を有効にしたインスタンスの API v30 以上でのみ使用できます。 | なし | 組織の説明。
このプロパティは、インスタンスで "表示名の有効化" がオンになっている場合にのみ使用できます。 | 最上位の部門 |
status | あり | 更新後の組織のステータス警告とエラーの場合は、メッセージ要素にメッセージ内容が含まれます。更新ステータスはメッセージ内容を返しません。
| 更新 |
メッセージ | なし | 無効な組織入力に関するエラー メッセージ | 組織 UKregion2 は、ペイロードで重複している、または ID 6 を持つシステムに既に存在しています。 |
エレメントの内容 | |||
この組織の直接の子組織ごとに 1 つのネストされた組織要素この組織が関連付けられている場合、1 つの特性要素 | |||
特性要素 | |||
タグ名 | 特性 | ||
説明 | 1 つの組織特性要素のコンテナです。 | ||
要素の特性 | |||
特性名 | 必須？ | 値 | 例 |
名前 | あり | 組織の特性の名前 | 勤務地 |
値 | あり | 組織特性の値。 | SFO |
valueCode
表示名が有効になっているインスタンスの API v32 および API v33 でのみ使用できます。 API v34 ではサポートされていません。 | あり | この特性の特性値コード。
API v32 以降では、valueCode が意味を持つのは次の場合のみです。
| SFO |
valueName
表示名が有効になっているインスタンスの API v32 および API v33 でのみ使用できます。 API v34 ではサポートされていません。 | なし | 新しく自動作成された特性値の名前。
特性 valueName が意味を持つのは、次の場合のみです。
| サンフランシスコ |
status | あり | 更新後の特性のステータス。警告とエラーの場合は、メッセージ要素にメッセージ内容が含まれます。更新ステータスはメッセージ内容を返しません。
| 更新されました |
メッセージ | なし | 無効な特性が入力されたことを示すエラー メッセージ。 | 組織 UKregion2 は、ペイロードで重複している、または ID 6 を持つシステムに既に存在しています。 |
エレメントの内容 | |||
(なし) | |||
バージョン要素 | |||
タグ名 | バージョン | ||
説明 | 組織のバージョンの使用可否を指定します。 | ||
要素の特性 | |||
特性名 | 必須？ | 値 | 例 |
名前 | あり | "バージョンの管理" に表示されるバージョンの名前です。 | 2015 年予算 |
値 | あり | 1 の場合、この組織はこのバージョンで使用可能です。 | 1 |
status | あり | 更新後のバージョンのステータス警告とエラーの場合は、メッセージ要素にメッセージ内容が含まれます。更新ステータスはメッセージ内容を返しません。
| 更新されました |
エレメントの内容 | |||
各属性値に対して 1 つ以上のバージョン要素 | |||
属性要素 | |||
タグ名 | 属性 | ||
説明 | updateLevels API コールに応じて返される単一のカスタム属性を表します。 | ||
要素の特性 | |||
特性名 | 必須？ | 値 | 例 |
名前 | あり | レポートおよびシートに表示される属性の名前。 | 地域 |
値 | なし | この組織の属性値です。 | C-USA |
valueCode
表示名を有効にするインスタンスの API v32 以上でのみ使用できます。 | あり | この属性の属性値コード。
API v32 以降では、valueCode が意味を持つのは次の場合のみです。
| CUS |
valueName
表示名を有効にするインスタンスの API v32 以上でのみ使用できます。 | なし | 新しく自動作成された属性値の名前。
API v32 以降では、valueName が意味を持つのは次の場合のみです。
| C-USA |
status | なし | 更新後のバージョンのステータス警告とエラーの場合は、メッセージ要素にメッセージ内容が含まれます。更新ステータスはメッセージ内容を返しません。
| 更新 |
エレメントの内容 | |||
(なし) | |||
エラーと警告メッセージの説明
タイプ | メッセージ | 例/説明 |
|---|---|---|
エラー | システム エラーが発生しました。詳細については、サポートまでお問い合わせください。 | システム エラー |
エラー | content.xml ファイルが見つかりません。 | updateDimensions API にすでに存在します |
エラー | 入力内容に、組織タグが含まれていません。 | ペイロードに組織タグがありません。 |
エラー | {0} は定義された {1} として認識されません。 | バージョン名または値が不明な場合に使用します。 |
エラー | {0} は空にできません。 | バージョン名が空です。 |
エラー | 実績のバージョン使用可否は変更できません。 | ユーザーが実績バージョンのバージョンの可視性を変更しようとする場合。 |
エラー | ルート組織 {0} のバージョン使用可否は変更できません。 | ユーザーがルート組織のバージョンの可視性を変更しようとするとき。 |
エラー | 組織 {1} 上のバージョン {0} の表示設定は、{1} の親と互換性がありません。 | 組織の指定されたバージョンの表示設定が親組織と互換性がない場合。 |
エラー | リクエストで指定された 1 つ以上の組織またはバージョンを更新する権限がありません。 | ユーザーが、アクセスできない組織情報の更新を試みた場合。 |
エラー | {0} は定義された {1} として認識されません。 | 属性名または値が不明な場合に使用します。 |
エラー | {0} は空にできません。 | 属性名が空です。 |
エラー | リスト属性は組織で使用できません。 | ユーザーが組織のフラットな属性値をマッピングしようとしています。 |
エラー | 属性 {0} はこの組織では無効になっています。 | この組織の属性は無効になっています。 |
エラー | 属性値 {0} は親の属性値と互換性がありません。 | 組織の指定された属性マッピングが親組織と互換性がない場合。 |
エラー | {0} は定義された {1} として認識されません。 | 特性名または値が不明な場合に使用します。 |
エラー | 特性値 {0} は親の特性値と互換性がありません。 | 指定された組織の組織特性値が親組織と互換性がない場合。 |
エラー | {0} は空にできません。 | 特性名が空です。 |
エラー | updateLevels API リクエストの処理中に例外が発生しました。 | システム エラー |
エラー | ID {0} は存在しません。 | リクエスト ペイロードで存在しない組織 ID が指定されました。 |
エラー | {0} は親と同じ ID を持つことはできません。 | 子組織と親組織の ID が同じである。 |
エラー | {0} を {1} の子にすることはできません。 | 特定の組織を別の特定の組織の子にすることはできません。 |
エラー | ルート組織 ID がありません。 | ルート組織の ID が指定されていません。 |
エラー | 組織名が {1} のルート組織 ID {0} は子組織になることはできません。 | ルート組織を子組織にすることはできません。 |
エラー | ルート組織通貨は変更できません。 | ルート組織の通貨は変更できません。 |
エラー | 通貨 "{0}" は無効です。 | 組織タグで不明な通貨名が指定されました。 |
エラー | 組織 {0} は ID {1} について重複しています。 | 重複組織名が指定されました。 |
エラー | 組織 {0} はペイロード {1} {2} で重複しています。 | 複数の新しい組織に同じ名前が含まれています。 |
エラー | ルート組織ワークフローは変更できません。 | ルート組織の "ワークフロー中" ステータスは変更できません。 |
エラー | 組織 {0} の特性の割り当ては、親の特性値と互換性がありません。 | 指定された組織の組織特性値は、親組織と互換性がありません。 |
エラー | ID {0} を持つ組織は存在しません。 | 指定された ID の組織は Planning に存在しません。 |
エラー | リクエストで指定された 1 つ以上の組織またはバージョンを更新する権限がありません。 | ペイロードに記載されている組織に対するユーザー権限がありません。 |
エラー | 組織 {0} のバージョンの表示設定は、{0} の親 {1} と互換性がありません。 | 組織の提供されたバージョンの表示設定が、親組織と互換性がありません。 |
エラー | 組織 {0} には、親 {1} よりも多くの期間を含む実績の可用性があります。 | 現在の組織の実績の範囲が変更されました。変更された実績レンジは、その子孫の 1 つの実績レンジよりも小さくなります。 |
エラー | deleteWorkflowSilently、0 である場合、組織 ({0}) のワークフローを無効化することはできません。deleteWorkFlowSilently を 1 に設定した場合、この組織に関連付けられているすべてのワークフロー タスクが削除されます。 | "ワークフローを削除" がオフになっている場合、ワークフローを無効にすることはできません。"ワークフローをサイレントに削除" がオンになっている場合、その組織のすべてのワークフロー タスクが削除されます。 |
エラー | {0} の実績の開始日と終了日を更新できませんでした。この日付範囲が実績バージョンに定義された開始日と終了日よりも小さいため、および deleteActualsSilently が false に設定されているため、{1} の実績が削除されません。 | deleteActualsSilently フラグが設定されていないのに実績の範囲を縮小しようとします。 |
エラー | 組織 {0} の親のワークフローが無効化されているため、ワークフローを有効化できません。 | 親のワークフローが無効化されているため、この組織のワークフローを有効化することはできません。 |
エラー | 組織の {0} は、その親で TradingPartner が有効化されているため、 TradingPartner または EliminationLevel は有効化できません。 | 取引パートナーが親に対してすでに有効になっている場合、その子で取引パートナーまたは相殺消去組織を有効にすることはできません。 |
エラー | ID {0} の親は存在しません。 | 存在しない ID が親組織に提供されました。 |
エラー | 親ノード {0} が、現在の直接/間接子ノード {1} の子になります。 | 親と子の間の循環関係が作成されています。 |
エラー | 組織を自身の親にすることはできません。 | 組織がペイロードで自身の親になることはできません。 |
エラー | ID {0} を持つ組織は存在しません。 | 指定されたエンティティは Planning に存在しません。 |
エラー | 相殺消去と TradingPartner は同時に true とすることはできません。 | 組織は、相殺消去組織または取引先のいずれかになります。ただし、両方を同時に設定することはできません。 |
エラー | この組織の親が TradingPartner を無効にしている間のみ、この相殺消去を変更できます。 | 組織の相殺消去の変更は、その組織の親の取引先が無効になっている場合にのみ行うことができます。 |
エラー | この組織の下部組織は相殺消去組織であるため、この組織を取引先に指定することはできません。 | 現在の組織は相殺消去組織のため、取引先としてマークできません。 |
エラー | 親のワークフローが無効になっている間は、この組織でワークフローを有効にすることはできません。 | 組織の親のワークフローが無効になっています。 |
エラー | {0} は、ノードとその子孫に対してのみ一緒に有効化できます。これらに変更を加えるには、propagateToDescendants=1 に設定します。 | ProgateToDescendants の動作の詳細については、 を参照してください。 UpdateLevels リクエスト中の propagateToDescendants の動作。 |
エラー | 1 つ以上の内部取引科目にデータがあるため、組織 "{0}" を相殺消去組織にすることはできません。 | 内部取引科目のデータを含む組織は、相殺消去組織にできません。 |
エラー | actualsStart または actualsEnd は、ルート組織 {0} について変更できません。 | ユーザーがルート組織の実績範囲を変更しようとしています。 |
エラー | リンク組織に子を追加することはできません。 | ユーザーは、リンク組織に対して子組織を追加しようとします。 |
エラー | タイムコード {0} が存在しません。 | 指定された時間コードは存在しません。 |
エラー | 実績の開始日 {0} は、実績の終了日 {1} の後にすることはできません。 | 指定された実績の開始時間は終了時間の後です。実績の開始時間は終了時間の前である必要があります。 |
エラー | 無効なタイム コード "{0}"。actualsStart と actualsEnd について設定されたタイム コードは、時間管理で使用できる最低の時間層と一致している必要があります。 | 指定された時間コードが最下位層レベルではありません。 |
エラー | 無効なタイム コード "{0}"。actualsStart {0} は、親の actualsStart {1} より前となります。 | 指定された actualsStart 時間は、親組織の実績の開始時間より前です。 |
エラー | 無効なタイム コード "{0}"。actualsEnd {0} は、親の actualsEnd {1} より後となります。 | 指定された actualsEnd 時間が、親組織の実績の終了時間を超えています。 |
エラー | actualsStart of {0} は、実績バージョンの {1} より前となります。actualsStart は {1} の後になります。 | 指定された actualsStart 時間は、実績バージョンの開始時間より前です。 |
エラー | actualsEnd of {0} は、実績バージョンの End of {1} より後となります。actualsEnd は {1} の前になる必要があります。 | 指定された actualsEnd time が、実績バージョンの終了時間を超えています。 |
エラー | 無効な "{0}" 値 "{1}"。値は "1" または "0" である必要があります。 | ユーザーがブール値プロパティに "0" または "1" 以外の値を指定しました。 |
エラー | {0} {1} は無効です。 | ユーザーが無効な値を入力しました。 |
エラー | {0} は名前には使用できません。 | 予約語 "this" または "(+)" または "(-)" で終わる単語が組織名として提供されています。 |
エラー | ID "{0}" は存在しません。 | 指定されたエンティティは Planning に存在しません。 |
警告 | proceedWithWarnings=0 の間は、組織 {0} を別の親に移動することはできません。 | ユーザーは、WithWarning="1" に進むことなく組織の移動を試みています。 proceedWithWarning="1" は、バージョンの表示設定、特性マッピング、データが新しい親組織と一致するように調整されることを意味します。 |
警告 | 実績の可用性の範囲が、組織 {0} で縮小されました。範囲から除外された実績データは削除されました。 | 実績の可用性の範囲が縮小されました。範囲外のデータは削除されます。 |
警告 | deleteWorkflowSilently はグローバル フラグです。これを組織タグに入れてください。 | ワークフローをサイレント削除はグローバル フラグです。別のタグではなく、組織タグに属している。 |
警告 | deleteActualsSilently はグローバル フラグです。これを組織タグに入れてください。 | 実績をサイレント削除はグローバル フラグです。別のタグではなく、組織タグに属している。 |
警告 | パブリッシュされていない変更があるため、組織を変更できません。 | Planning に、管理パブリッシュに対する保留中の変更があります。 |