exportAttributes
Diese API unterstützt nur Benutzer Konzept: Zugriffsregeln in API v22 und höher.
Kategorie
| Abrufen von Metadaten |
Beschreibung
| Gibt Metadaten für die vollständige Liste aller Attribute im System zurück. |
Zum Aufrufen sind Berechtigungen erforderlich
| Keine (es müssen gültige Zugangsdaten für die Instanz sein) |
Auf Anforderung erforderliche Parameter
| Zugangsdaten |
Die Anforderung dieser Methode enthält nur ein Credentials-Tag zur Identifizierung und Autorisierung des aufrufenden Benutzers. Nach der Verifizierung gibt die Methode ein XML-Dokument zurück, das den vollständigen Satz aller benutzerdefinierten Attribute (mit Ausnahme des Systemattributs des Handelspartners für Konsolidierungsinstanzen) einschließlich aller ihrer Elementwerte beschreibt. Elementwerte innerhalb eines Attributs werden in Baumform zurückgegeben, wobei übergeordnete Elemente ihre untergeordneten Elemente enthalten.
Anforderungsformat
<?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>
Element „Zugangsdaten“.
| |||
Tag-Name
| -Zugangsdaten | ||
Beschreibung
| Alle API-Aufrufe müssen ein einzelnes Element mit den Zugangsdaten enthalten, um den Benutzer zu identifizieren, der die API aufruft. Der API-Aufruf wird dann als dieser Benutzer ausgeführt (jeder Audit-Trail oder jede Aktionshistorie im System zeigt, dass dieser Benutzer die Aktion ausgeführt hat). Daher muss der Benutzer über die erforderlichen Berechtigungen verfügen, um die Aktion in Reihenfolge für die API auszuführen -Aufruf erfolgreich ist. | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
anmelden | J | Der Anmeldename des Benutzers, der die API-Methode aufruft. Dieser Benutzer muss über die erforderlichen Berechtigungen zum Aufrufen der Methode verfügen. | sampleuser@company.com |
Kennwort | J | Das Kennwort des Benutzers, der die API-Methode aufruft. | my_password |
Gebietsschema | N | Geben Sie das Gebietsschema an, das verwendet werden soll, um eingehende Zahlen und Datumsangaben zu interpretieren und ausgehende Zahlen und Datumsangaben zu formatieren (mit dem entsprechenden Tausendertrennzeichen, den Monatsnamen und der Datumsformatierung). Das Gebietsschema wird auch verwendet, um die Sprache anzugeben, in der Systemmeldungen in der Antwort angezeigt werden sollen. Wenn nicht angegeben, wird en_US (amerikanisches Englisch) verwendet. | fr_FR |
instanceCode | N | Wenn der in den Zugangsdaten angegebene Benutzer Zugriff auf mehr als eine Instanz von hat, Adaptive Planning : Dieses Attribut kann verwendet werden, um anzugeben, dass der Benutzer auf eine andere Instanz als seine Standardinstanz zugreifen möchte. Wenn nicht angegeben, wird die Standardinstanz des Benutzers verwendet. Verwenden Sie die exportInstances-API, um die verfügbaren Instanzcodes zu ermitteln. | MYINSTANCE1 |
Inhalt des Elements
| |||
(Keine) | |||
Element einschließen Wird unterstützt in API v17 + | |||
Tag-Name
| einschließen | ||
Beschreibung
| Stellt einen Satz von Kennzeichen dar, die angeben, welche Aspekte der Informationen zu "Attributwerten" in die Antwort aufgenommen oder daraus ausgeschlossen werden sollen. Dieses Element ist optional: Wenn es nicht vorhanden ist, werden alle Attribute in der Antwort angezeigt. | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
attributeIDs Wird unterstützt in API v17 + | N | Eine Liste der IDs, die in der API-Antwort angezeigt werden. Es wirkt wie ein Filter. | "1,2,3,14" |
in AccessibleValues Wird unterstützt in API v18 + | N | Gibt an, ob die Antwort Werte enthalten soll, auf die der aktuelle Benutzer nicht zugreifen kann. Der Standardwert ist „false“. Nur Benutzer mit den Berechtigungen "Modellierung" oder "In alle Ebenen importieren" können diese Option auf "true" setzen. | false |
Ohne Kategorie Wird in API v22 und höher unterstützt, wenn die Instanz aus Sicherheitsgründen Zugriffsregeln verwendet. | N | Gibt an, ob die Antwort die Pseudoknoten für jedes Attribut in der Antwort enthalten soll. Der Standardwert ist „false“. Die Pseudoknoten werden nur dann in die Antwort aufgenommen, wenn der Benutzer Zugriff auf sie hat. | false |
displayNameEnabled
Nur in API v30 und höher für Instanzen verfügbar, die den Anzeigenamen aktivieren. | N | displayNameEnabled=true gibt an, dass exportAttributes die Eigenschaften des Anzeigenamens berücksichtigen sollen, wenn "Anzeigenamen aktivieren" für die Instanz auf EIN gesetzt ist. displayNameEnabled=false gibt an, dass die exportAttributes-API weiterhin den API-Vertrag vor v30 einhalten soll, auch wenn "Anzeigenamen aktivieren" für die Instanz auf EIN gesetzt ist. Die exportAttributes-API ignoriert die Eigenschaften des Anzeigenamens. Der Standardwert für displayNameEnabled ist "false". | wahr |
Inhalt des Elements
| |||
(Keine) | |||
Antwortformat
<?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>
Antwortelement
| |||
Tag-Name
| -Antwort | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
Erfolg haben | J | Entweder „true“ oder „false“, was angibt, ob der API-Aufruf erfolgreich war oder nicht. Selbst erfolgreiche Aufrufe können in ihrer Antwort Warnmeldungen enthalten. | wahr |
veraltet | N | Wenn dieses Attribut im Antwort-Tag vorhanden ist und auf „true“ gesetzt ist, zeigt es an, dass die Version der Methode oder API, die aufgerufen wird, veraltet und offiziell veraltet ist. Auch wenn es zu diesem Zeitpunkt noch funktioniert, kann es sein, dass Sie in Kürze nicht mehr funktionieren. In der Regel ist dieses Attribut nicht vorhanden. | false |
Inhalt des Elements
| |||
Ein einzelnes optionales Nachrichtenelement und genau ein erforderliches Ausgabeelement. | |||
Ausgabeelement
| |||
Tag-Name
| Ausgabe | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
(Keine) | |||
Inhalt des Elements
| |||
Ein einzelnes erforderliches Attributelement. Dieser Ausgabe-Wraper ist ein Standard für alle API-Antworten und schließt die gültige Ausgabe jedes erfolgreichen API-Aufrufs ein. | |||
Element „Attribute“.
| |||
Tag-Name
| Attribute | ||
Beschreibung
| Container für null oder mehr Attributelemente. Die Attribute werden so sortiert, dass die Attribute je nach Art in der folgenden Reihenfolge vorliegen: "Konto", "Ebene" und "Dimension". Attribute mit derselben Art werden nach Name sortiert. | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
(Keine) | |||
Inhalt des Elements
| |||
Null oder mehr Attributelemente. | |||
Attributelement
| |||
Tag-Name
| Attribut | ||
Beschreibung
| Stellt ein einzelnes Attribut dar, das in der Antwort auf einen exportAttributes-API-Aufruf zurückgegeben wird. | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
id | J | Die interne System-ID für das Attribut. | 16 |
Name | J | Der Name des Attributs, wie er auf der Seite für die Attributverwaltung angezeigt wird. | Branche |
displayNameType
Nur in API v30 und höher für Instanzen verfügbar, die den Anzeigenamen aktivieren. | Die interne Darstellung des ausgewählten Formats des Anzeigenamens für Werte auf den Seiten der Attributverwaltung.
| NAME | |
type | J | Die Art des Attributs. Dies ist „Konto“, wenn das Attribut für ein Konto ist, „Ebene“, wenn das Attribut für eine Ebene ist, oder „Dimension“, wenn das Attribut für eine Dimension ist. | Dimension |
autoCreate Wird unterstützt in API v20 und höher | J | "1", wenn für das ausgewählte Attribut der Feldsatz "Ebene/Konto/Dimensionsimport erstellt automatisch Attributwerte" festgelegt ist, anderenfalls "0". | 0 |
keepSorted Wird unterstützt in API v20 und höher | J | "1" gibt an, dass Werte für dieses Attribut immer alphabetisch sortiert sind. „0“ (oder nicht angegeben) bedeutet, dass Attributwerte basierend auf ihrer Position in der Nutzlastanfrage sortiert werden. Wenn die XML-Datei sowohl den übergeordneten Wert als auch mindestens ein gleichgeordnetes Element eines nicht aufgeführten hierarchischen Attributwerts enthält, wird der nicht aufgeführte Wert während der Aktualisierung an das Ende der aufgeführten gleichgeordneten Werte verschoben (beim Neuordnen der untergeordneten Elemente des übergeordneten Elements stehen alle aufgeführten gleichgeordneten Werte an erster Stelle in). der Reihenfolge, in der sie im XML-Format angegeben sind. Alle nicht aufgeführten gleichgeordneten Elemente kommen zuletzt in der Reihenfolge, in der sie bereits im System vorhanden sind. behältSorted gilt für untergeordnete Elemente jedes übergeordneten Attributwerts. | 1 |
Dimensions-ID | N | Die ID der Dimension, wenn das Attribut die Art "Dimension" hat. | 15 |
Sequenznr Hinzugefügt in API v17, aber für zukünftige Verwendung reserviert. | |||
Inhalt des Elements
| |||
Null oder mehr optionale AttributeValue-Elemente. Jedes eingeschlossene Element AttributeValue stellt einen „Root-Attributwert“ im Attribut dar, einen Wert, der keinen übergeordneten Wert hat. | |||
AttributeValue-Element
| |||
Tag-Name
| attributeValue | ||
Beschreibung
| Stellt einen einzelnen Elementwert eines Attributs dar, der in der Antwort auf einen exportAttributes-API-Aufruf zurückgegeben wird. | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
id | J | Die interne System-ID-Nummer für diesen Elementwert des Attributs. | 34 |
-Code
Nur in API v30 und höher für Instanzen verfügbar, die den Anzeigenamen aktivieren. | N | Der Code des Elementwerts des Attributs. | Verfügbar |
Name | J | Das Label für den Elementwert des Attributs, wie auf der Seite für die Attributverwaltung angezeigt. | Verfügbar |
displayName
Nur in API v30 und höher für Instanzen verfügbar, die den Anzeigenamen aktivieren. | N | Der displayName des Elementwerts des Attributs, der aus dem displayNameType des Attributs abgeleitet wurde. | Verfügbar |
Beschreibung
Nur in API v30 und höher für Instanzen verfügbar, die den Anzeigenamen aktivieren. | N | Die Beschreibung des Elementwerts des Attributs, wie sie auf der Seite für die Attributverwaltung angezeigt wird. | |
Inhalt des Elements
| |||
Null oder mehr optionale AttributeValue-Elemente. Jedes eingeschlossene Element AttributeValue stellt einen „untergeordneten Attributwert“ dieses Attributwerts dar, dessen Elemente implizit ein Rollup zu diesem Wert durchführen. | |||