exportAttributes
この API はユーザーのみをサポートします 概念: アクセス ルール API v22 以上
カテゴリ | Metadata retrieval |
説明 | システム内のすべての特性を含む完全なリストのメタデータを返します。 |
起動に必要な権限 | なし (インスタンスに対して有効な認証情報である必要があります) |
リクエストに応じてパラメータが必要 | 認証情報 |
このメソッドのリクエストには、呼び出し元のユーザーを識別して認証するための認証情報タグのみが含まれています。検証されると、このメソッドはすべてのメンバー値を含むすべてのカスタム属性 (連結インスタンスの取引先システム属性を除く) の完全なセットを示す XML ドキュメントを返します。特性内のメンバー値は、子を含む親メンバーとともにツリー形式で返されます。
リクエストのフォーマット
<?xml version='1.0' encoding='UTF-8'?> <call method="exportAttributes" 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 |
エレメントの内容 | |||
(なし) | |||
要素を含める API v17 以上でサポート | |||
タグ名 | 含める | ||
説明 | 「特性値」情報のどの側面を応答に含めるか、または応答から除外するかを示すフラグのセットを表します。この要素は任意です。これが存在しない場合、すべての特性が応答に表示されます。 | ||
要素の特性 | |||
特性名 | 必須？ | 値 | 例 |
attributeIDs API v17 以上でサポート | なし | API 応答に表示される ID のリスト。これはフィルタのように機能します。 | "1,2,3,14" |
inaccessibleValues API v18 以上でサポート | なし | 現在のユーザーがアクセスできない値を回答に含めるかどうかを示します。デフォルトは false です。"モデリング" または "すべての組織にインポート" の権限を持つユーザーのみが、このオプションを true に設定できます。 | false |
未分類 インスタンスがセキュリティのためにアクセス ルールを使用する場合、API v22+ でサポートされます。 | なし | 回答が各特性の回答に仮想ノードを含めるべきであるかどうかを示します。デフォルトは false です。仮想ノードは、ユーザーがそのノードへのアクセス権を持っている場合のみ、応答に含まれます。 | false |
displayNameEnabled
表示名を有効にしたインスタンスの API v30 以上でのみ使用できます。 | なし | displayNameEnabled=true は、インスタンスで "表示名の有効化" がオンになっている場合に、exportAttributes が表示名のプロパティに従う必要があることを示します。 displayNameEnabled=false は、インスタンスで "表示名の有効化" がオンになっている場合でも、exportAttributes API が v30 前の API 契約に従う必要があることを示します。exportAttributes API は表示名のプロパティを無視します。 displayNameEnabled のデフォルト値は "false" です。 | 真 |
エレメントの内容 | |||
(なし) | |||
回答フォーマット
<?xml version='1.0' encoding='UTF-8'?> <response success="true"> <output> <attributes> <attribute id="13" name="AP Eligible" type="account" seqNo="21"> <attributeValue id="118" name="No" /> <attributeValue id="117" name="Yes"> <attributeValue id="136" name="Full" /> <attributeValue id="135" name="Partial" /> </attributeValue> </attribute> <attribute id="11" name="Product Line" type="account" seqNo="3"> <attributeValue id="34" name="A" /> <attributeValue id="35" name="B" /> </attribute> <attribute id="9" name="Corporate Discount" type="level" seqNo="11"> <attributeValue id="56" name="Available" /> <attributeValue id="54" name="Not Applicable" /> <attributeValue id="57" name="Not Available" /> <attributeValue id="55" name="TBD" /> </attribute> <attribute id="10" name="Tax Code" type="level" seqNo="33"> <attributeValue id="146" name="TT-PYT" /> <attributeValue id="145" name="TT-TRE" /> </attribute> <attribute id="16" name="Industry" type="dimension" dimension-id="15" seqNo="43"> <attributeValue id="335" name="Apparel"> <attributeValue id="354" name="Mens Apparel" /> <attributeValue id="355" name="Shoes" /> <attributeValue id="356" name="Womens Apparel" /> </attributeValue> </attribute> </attributes> </output> </response>
回答エレメント | |||
タグ名 | response | ||
要素の特性 | |||
特性名 | 必須？ | 値 | 例 |
成功 | あり | "true" または "false"。API 呼び出しが成功したかどうかを示します。呼び出しが成功した場合でも、応答に警告メッセージが含まれる場合があります。 | 真 |
廃止 | なし | レスポンス タグに存在し、true に設定されている場合、この属性は呼び出しているメソッドまたは API のバージョンが廃止されており、正式に廃止されたことを示します。現時点では機能し続けていますが、まもなく機能が停止する可能性があります。通常、この属性は存在しません。 | false |
エレメントの内容 | |||
単一の任意のメッセージ要素と、厳密に 1 つの必須の出力要素。 | |||
出力要素 | |||
タグ名 | 出力 | ||
要素の特性 | |||
特性名 | 必須？ | 値 | 例 |
(なし) | |||
エレメントの内容 | |||
単一の必須特性要素この出力ラベンダーはすべての API 応答の標準であり、成功した API 呼び出しの有効な出力を囲みます。 | |||
特性要素 | |||
タグ名 | 特性 | ||
説明 | 0 個以上の特性要素のコンテナです。特性は、タイプに応じて次の順序になるように並べられます: タイプ: '科目'、'組織'、'属性'。同じタイプの特性は名前別に並べられます。 | ||
要素の特性 | |||
特性名 | 必須？ | 値 | 例 |
(なし) | |||
エレメントの内容 | |||
0 個以上の特性要素 | |||
特性要素 | |||
タグ名 | 特性 | ||
説明 | exportAttributes API コールへの応答で返される単一の特性を表します。 | ||
要素の特性 | |||
特性名 | 必須？ | 値 | 例 |
ID | あり | 特性の内部システム ID 番号。 | 16 |
名前 | あり | 特性の管理ページに表示される特性の名前。 | 業種 |
displayNameType
表示名を有効にしたインスタンスの API v30 以上でのみ使用できます。 | 選択された内部表現。"特性の管理" ページの値の表示名の形式。
| 名前 | |
type | あり | 特性のタイプ。特性が科目の場合は "科目"、特性が組織の場合は "組織"、特性が属性の場合は "属性" になります。 | 属性 |
autoCreate API v20+ でサポート | あり | 選択した特性に "組織/科目/属性のインポートにより自動的に特性値を作成する" フィールドが設定されている場合は 1、それ以外の場合は 0。 | 0 |
keepSorted API v20+ でサポート | あり | "1" は、この特性の値が常にアルファベット順にソートされていることを示します。 "0" (または指定されていない) は、リクエスト ペイロード内の位置に基づいて特性値をソートすることを意味します。 XML に親と、リストされていない階層特性値の兄弟が少なくとも 1 つ含まれている場合、リストされていない値は、更新中にリストされた兄弟の最後に移動します (親の子を並べ替える際、リストされた兄弟はすべて最初になります。 XML で指定された順序リストされていない兄弟はすべて、システムにおけるすでに設定されている順序で最後に配置されます。 "keepSorted" は各親特性値の子に適用されます。 | 1 |
dimension-id | なし | 特性のタイプが "属性" の場合、属性の ID。 | 15 |
連番 API v17 で追加されましたが、将来の使用のために予約されています。 | |||
エレメントの内容 | |||
ゼロ以上の任意の attributeValue 要素囲まれたattributeValue 要素はそれぞれ、特性の「ルート特性値」、つまり親値を持たない値を表します。 | |||
attributeValue 要素 | |||
タグ名 | attributeValue | ||
説明 | exportAttributes API コールへの応答で返される特性の単一メンバー値を表します。 | ||
要素の特性 | |||
特性名 | 必須？ | 値 | 例 |
ID | あり | 特性のこのメンバー値の内部システム ID 番号。 | 34 |
code
表示名を有効にしたインスタンスの API v30 以上でのみ使用できます。 | なし | 特性のメンバー値のコード。 | 使用可能 |
名前 | あり | 特性ページの管理に表示される特性のメンバー値のラベル。 | 使用可能 |
displayName
表示名を有効にしたインスタンスの API v30 以上でのみ使用できます。 | なし | 特性の displayNameType から派生した特性のメンバー値の displayName | 使用可能 |
説明
表示名を有効にしたインスタンスの API v30 以上でのみ使用できます。 | なし | 特性ページの管理に表示される特性のメンバー値の説明。 | |
エレメントの内容 | |||
ゼロ以上の任意の attributeValue 要素囲まれたattributeValue 要素はそれぞれこの特性値の「子特性値」を表し、そのメンバーは暗黙的にこの値にロールアップされます。 | |||