exportTime
Diese API unterstützt nur Benutzer Konzept: Zugriffsregeln in API v21 und höher.
Kategorie
| Abrufen von Metadaten |
Beschreibung
| Gibt Zeitmetadaten entweder für eine bestimmte Version oder für alle Versionen zurück, wenn keine Version angegeben ist. |
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 ein Credentials-Tag zur Identifizierung und Autorisierung des aufrufenden Benutzers und ein optionales Versions-Tag, das angibt, für welche Version Informationen abgerufen werden sollen. Wenn keine Version angegeben wird, gibt die Methode Zeitinformationen für den Zeitbereich zurück, der die Start- und Endzeiten aller Versionen umfasst. Sobald der Aufrufer verifiziert ist, gibt die Methode ein XML-Dokument zurück, das alle Zeitinformationen für die Version in einer verschachtelten Baumstruktur beschreibt.
Anforderungsformat
<?xml version='1.0' encoding='UTF-8'?> <call method="exportTime" callerName="a string that identifies your client application"> <credentials login="sampleuser@company.com" password="my_pwd" locale="fr_FR" instanceCode="INSTANCE1"/> <options includeAllLocales="1" includeLegacyInformation="1" /> </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 zum Ausführen der Aktion verfügen, damit der API-Aufruf ausgeführt werden kann 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 „Optionen“.
| |||
Tag-Name
| Optionen | ||
Beschreibung
| Gibt die Optionen an, die beim Exportieren von Zeit verwendet werden sollen. | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
includeAllLocales | N | Optional können Sie festlegen, dass für den Zeitexport alle Umrechnungen für jede Schicht/Zeitperiode exportiert werden. Wenn nicht angegeben, wird nur das Gebietsschema exportiert, das im Zugangsdatenblock angegeben ist. | "1" |
includeLegacyInformation | N | Optional können Sie mit dem Export der Zeit zusätzliche Attribute exportieren, die ältere Zeitinformationen enthalten. Diese zusätzlichen Attribute werden nicht eingeschlossen, wenn isCustom = 1 ist | "1" |
leafStratumId Wird unterstützt in API v16 + | N | Geben Sie optional die ID einer Zeitschicht an, die als Leaf behandelt werden soll. Zeitschichten, die kleiner sind als die angegebene Zeitschicht, werden nicht in die Antwort aufgenommen. Dies gilt auch für Zeitperioden, die zu Zeitschichten gehören, die kleiner als die angegebene Zeitschicht sind. | "5" |
calendarId
Wird unterstützt in API v33 + | N | Geben Sie optional die ID des Kalenders/der Hierarchie an, die abgerufen werden soll. Wenn nichts angegeben wird, gibt die API nur Zeitwerte in der Standardhierarchie zurück. | "1" |
Inhalt des Elements
| |||
(Keine) | |||
-Versionselement
| |||
Tag-Name
| Version | ||
Beschreibung
| Gibt an, welche Version zum Abrufen der angeforderten Daten verwendet werden soll. Der Benutzer muss auf die angegebene Version zugreifen können und es sich nicht um einen Ordner handeln. Ein Versionselement ist nicht erforderlich. Wenn jedoch eines enthalten ist, muss die angegebene Version gültig sein. | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
option aktualisiert in API v18 | N | Legt den zu exportierenden Zeitbereich fest. Kann auf "all" oder "single" gesetzt oder weggelassen werden. Standard ist "Single". Bei Single muss der Benutzer auch entweder "Name" oder "ID" angeben. Gibt den Zeitbereich der angegebenen Einzelversion und den Ausgangssaldo für diese Version zurück. Wenn sowohl der Name als auch die ID angegeben sind, müssen sie sich auf dieselbe Version beziehen. Wenn alle, wird der Zeitbereich von Minimum bis Maximum aller Versionen einschließlich der Ausgangssaldoperiode für die erste Schicht im Minimum-Maximum-Zeitbereich zurückgegeben. Wenn ja, darf die Version "Name" oder "ID" nicht angegeben werden. Wenn nichts angegeben wird, wird die gesamte definierte Zeit zurückgegeben. Wenn Sie eine einzelne Version angeben, ist der Aufruf nur erfolgreich, wenn der Benutzer Zugriff auf die Version hat. | Single |
Name | N | Der Name der Version, die zum Abrufen der Daten verwendet werden soll. Mit einem einzigen API-Aufruf kann nur auf eine Version zugegriffen werden. Wenn kein Name angegeben wird, muss eine ID angegeben werden. Wenn beide angegeben sind, müssen sie derselben Version entsprechen. | Budget 2014 |
id | N | Die ID der Version, die zum Abrufen der Daten verwendet werden soll. Mit einem einzigen API-Aufruf kann nur auf eine Version zugegriffen werden. Wenn die Option "single" lautet und keine ID angegeben wird, muss ein Name angegeben werden. Wenn beide angegeben sind, müssen sie derselben Version entsprechen. | 3 |
Inhalt des Elements
| |||
(Keine) | |||
Antwortformat (mit includeAllLocales="0" oder nicht angegeben)
<?xml version='1.0' encoding='UTF-8'?> <response success="true"> <output> <time isCustom="1" seqNo="24"> <stratum code="year" label="Year" shortName="Yr" id="3" inUse="1"> <stratum code="qtr" label="Quarter" shortName="Qtr" id="2" inUse="1"> <stratum code="month" label="Month" shortName="Mon" id="1" inUse="1" isDefault="1" /> </stratum> </stratum> <period code="2015" label="FY2015" shortName="FY2015" stratumId="3" timeslot="15" encodedTimePeriod="3::15" id="15003" end="2016-01-01"> <period code="Q1-2015" label="Q1-FY15" shortName="Q1-FY15" stratumId="2" timeslot="60" encodedTimePeriod="2::60" id="60002" end="2015-04-01"> <period code="01/2015" label="Jan-2015" shortName="Jan-2015" stratumId="1"timeslot="180" encodedTimePeriod="1::180" id="180001" end="2015-02-01" /> <period code="02/2015" label="Feb-2015" shortName="Feb-2015" stratumId="1" timeslot="181" encodedTimePeriod="1::181" id="181001" end="2015-03-01" /> <period code="03/2015" label="Mar-2015" shortName="Mar-2015" stratumId="1" timeslot="182" encodedTimePeriod="1::182" id="182001" end="2015-04-01" /> </period> <period code="Q2-2015" label="Q2-FY15" shortName="Q2-FY15" stratumId="2" timeslot="61" encodedTimePeriod="2::61" id="61002" end="2015-07-01"> <period code="04/2015" label="Apr-2015" shortName="Apr-2015" stratumId="1" timeslot="183" encodedTimePeriod="1::183" id="183001" end="2015-05-01" /> <period code="05/2015" label="May-2015" shortName="May-2015" stratumId="1" timeslot="184" encodedTimePeriod="1::184" id="184001" end="2015-06-01" /> <period code="06/2015" label="Jun-2015" shortName="Jun-2015" stratumId="1" timeslot="185" encodedTimePeriod="1::185" id="185001" end="2015-07-01" /> </period> <period code="Q3-2015" label="Q3-FY15" shortName="Q3-FY15" stratumId="2" timeslot="62" encodedTimePeriod="2::62" id="62002" end="2015-10-01"> <period code="07/2015" label="Jul-2015" shortName="Jul-2015" stratumId="1" timeslot="186" encodedTimePeriod="1::186" id="186001" end="2015-08-01" /> <period code="08/2015" label="Aug-2015" shortName="Aug-2015" stratumId="1" timeslot="187" encodedTimePeriod="1::187" id="187001" end="2015-09-01" /> <period code="09/2015" label="Sep-2015" shortName="Sep-2015" stratumId="1" timeslot="188" encodedTimePeriod=""1::188" id="188001" end="2015-10-01" /> </period> <period code="Q4-2015" label="Q4-FY15" shortName="Q4-FY15" stratumId="2" timeslot="63" encodedTimePeriod="2::63" id="63002" end="2016-01-01"> <period code="10/2015" label="Oct-2015" shortName="Oct-2015" stratumId="1" timeslot="189" encodedTimePeriod="1::189" id="189001" end="2015-11-01" /> <period code="11/2015" label="Nov-2015" shortName="Nov-2015" stratumId="1" timeslot="190" encodedTimePeriod="1::190" id="190001" end="2015-12-01" /> <period code="12/2015" label="Dec-2015" shortName="Dec-2015" stratumId="1" timeslot="191" encodedTimePeriod="1::191" id="191001" end="2016-01-01" /> </period> </period> <period code="2016" label="FY2016" shortName="FY2016" stratumId="3" timeslot="16" encodedTimePeriod="3::16" id="16003" end="2017-01-01"> <period code="Q1-2016" label="Q1-FY16" shortName="Q1-FY16" stratumId="2" timeslot="64" encodedTimePeriod="2::64" id="64002" end="2016-04-01"> <period code="01/2016" label="Jan-2016" shortName="Jan-2016" stratumId="1" timeslot="192" encodedTimePeriod="1::192" id="192001" end="2016-02-01" /> <period code="02/2016" label="Feb-2016" shortName="Feb-2016" stratumId="1" timeslot="193" encodedTimePeriod="1::193" id="193001" end="2016-03-01" /> <period code="03/2016" label="Mar-2016" shortName="Mar-2016" stratumId="1" timeslot="194" encodedTimePeriod="1::194" id="194001" end="2016-04-01" /> </period> <period code="Q2-2016" label="Q2-FY16" shortName="Q2-FY16" stratumId="2" timeslot="65" encodedTimePeriod="2::65" id="65002" end="2016-07-01"> <period code="04/2016" label="Apr-2016" shortName="Apr-2016" stratumId="1" timeslot="195" encodedTimePeriod="1::195" id="195001" end="2016-05-01" /> <period code="05/2016" label="May-2016" shortName="May-2016" stratumId="1" timeslot="196" encodedTimePeriod="1::196" id="196001" end="2016-06-01" /> <period code="06/2016" label="Jun-2016" shortName="Jun-2016" stratumId="1" timeslot="197" encodedTimePeriod="1::197" id="197001" end="2016-07-01" /> </period> <period code="Q3-2016" label="Q3-FY16" shortName="Q3-FY16" stratumId="2" timeslot="66" encodedTimePeriod="2::66" id="66002" end="2016-10-01"> <period code="07/2016" label="Jul-2016" shortName="Jul-2016" stratumId="1" timeslot="198" encodedTimePeriod="1::198" id="198001" end="2016-08-01" /> <period code="08/2016" label="Aug-2016" shortName="Aug-2016" stratumId="1" timeslot="199" encodedTimePeriod="1::199" id="199001" end="2016-09-01" /> <period code="09/2016" label="Sep-2016" shortName="Sep-2016" stratumId="1" timeslot="200" encodedTimePeriod="1::200" id="200001" end="2016-10-01" /> </period> <period code="Q4-2016" label="Q4-FY16" shortName="Q4-FY16" stratumId="2" timeslot="67" encodedTimePeriod="2::67" id="67002" end="2017-01-01"> <period code="10/2016" label="Oct-2016" shortName="Oct-2016" stratumId="1" timeslot="201" encodedTimePeriod="1::201" id="201001" end="2016-11-01" /> <period code="11/2016" label="Nov-2016" shortName="Nov-2016" stratumId="1" timeslot="202" encodedTimePeriod="1::202" id="202001" end="2016-12-01" /> <period code="12/2016" label="Dec-2016" shortName="Dec-2016" stratumId="1" timeslot="203" encodedTimePeriod="2::203" id="203001" end="2017-01-01" /> </period> </period> </time> </output> </response>
Partielles Antwortformat (mit includeAllLocales="1)
Normalerweise gibt es für jede Zeitperiode und jede Schicht einen Gebietsschema-Block. Unten wird nur der Zeitschichtabschnitt angezeigt. Die Gebietsschemas/Gebietsschema-Blöcken für die Zeitperioden haben ein identisches Format.
<stratum code="year" label="Year" shortName="Year" id="3"> <locales> <locale locale="en" label="Year" shortName="Year" /> <locale locale="de" label="Jahr" shortName="Jahr" /> <locale locale="fr" label="Anne" shortName="Anne" /> <locale locale="es" label="Ao" shortName="Ao" /> <locale locale="pt" label="Ano" shortName="Ano" /> <locale locale="nl" label="Jaar" shortName="Jaar" /> <locale locale="ja" label="年" shortName="年" /> </locales> <stratum code="qtr" label="Quarter" shortName="Quarter" id="2"> <locales> <locale locale="en" label="Quarter" shortName="Quarter" /> <locale locale="de" label="Quartal" shortName="Quartal" /> <locale locale="fr" label="Trimestre" shortName="Trimestre" /> <locale locale="es" label="Trimestre" shortName="Trimestre" /> <locale locale="pt" label="Trimestre" shortName="Trimestre" /> <locale locale="nl" label="Kwartaal" shortName="Kwartaal" /> <locale locale="ja" label="四半期" shortName="四半期" /> </locales> <stratum code="month" label="Month" shortName="Month" id="1" isDefault="1"> <locales> <locale locale="en" label="Month" shortName="Month" /> <locale locale="de" label="Monat" shortName="Monat" /> <locale locale="fr" label="Mois" shortName="Mois" /> <locale locale="es" label="Mes" shortName="Mes" /> <locale locale="pt" label="Ms" shortName="Ms" /> <locale locale="nl" label="Maand" shortName="Maand" /> <locale locale="ja" label="月" shortName="月" /> </locales> </stratum> </stratum> </stratum>
Antwortelement
| |||
Tag-Name
| -Antwort | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
Erfolg haben | J | Entweder wahr oder falsch, was angibt, ob der API-Aufruf erfolgreich war oder nicht. Selbst erfolgreiche Aufrufe können Warnmeldungen in ihrer Antwort 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. | |||
Nachrichtenelement
| |||
Tag-Name
| -Nachrichten | ||
Beschreibung
| Container für ein oder mehrere Nachrichtenelemente. | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
(Keine) | |||
Inhalt des Elements
| |||
Ein oder mehrere Nachrichtenelemente. | |||
Nachrichtenelement
| |||
Tag-Name
| Nachricht | ||
Beschreibung
| Stellt eine Nachricht dar, die vom System an den Aufrufer zurückgesendet wird. Nachrichten werden für Fehlermeldungen verwendet, wenn Anforderungen nicht erfolgreich sind, als Warnmeldungen, wenn Anforderungen erfolgreich sind, und als Bestätigungsmeldungen bei Erfolgreich. | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
-Schlüssel | N | Wenn ein Schlüssel angegeben wird, kann eine bestimmte Meldung oder eine bestimmte Meldungsart identifiziert werden. Dies ist für eine automatische Fehlerprotokollierung und Wiederherstellung in Client-Programmen hilfreich. Schlüssel ändern sich nicht unter verschiedenen Gebietsschemas von Anforderungen, auch wenn sich die Sprache der Nachricht ändert. Es ist auch fehlgeschlagen, dass sich Schlüssel in Zukunft aufgrund von Wording-Anpassungen oder Änderungen der Terminologie ändern. | invalid-attributevalueid |
Inhalt des Elements
| |||
Der Text der Nachricht. Dieser Text ist in der Sprache des in der Anforderung angegebenen Gebietsschemas (vorausgesetzt, das Gebietsschema wird unterstützt). Der Text kann auch variable Informationen enthalten, z. B. die Anzahl der verarbeiteten Zeilen oder die bestimmte Spalte oder den Wert, die einen Fehler verursacht haben. | |||
Ausgabeelement
| |
Tag-Name
| Ausgabe |
Attribute des Elements
| |
(Keine) | |
Inhalt des Elements
| |
Ein einzelnes erforderliches Zeitelement. Dieser Ausgabe-Wraper ist ein Standard für alle API-Antworten und schließt die gültige Ausgabe jedes erfolgreichen API-Aufrufs ein. | |
Zeitelement
| |||
Tag-Name
| time | ||
Beschreibung
| Container für ein Root-Schichtelement, null oder ein Ausgangssaldoelement und ein oder mehrere Root-Schichtperiodenelemente. | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
isCustom | J | Entweder 1 oder 0, was angibt, ob der Kalender für diese Instanz angepasst wurde oder nicht. | 1 |
q1FirstMonth | N | Der Monat, in dem das Geschäftsjahr beginnt (beginnend mit 0). Dieses Attribut wird nur angezeigt, wenn includeLegacyInformation in der Anforderung 1 war und isCustom 0 ist. | 8 |
lastMonthIsFY | N | Gibt an, ob das Geschäftsjahr dem Kalenderjahr entspricht, in dem das Geschäftsjahr endet. Dieses Attribut wird nur angezeigt, wenn includeLegacyInformation in der Anforderung 1 war und isCustom 0 ist. | 0 |
Sequenznr Hinzugefügt in API v17, aber für zukünftige Verwendung reserviert. | |||
Inhalt des Elements
| |||
Genau ein Schichtelement, null oder ein Ausgangssaldoelement und ein oder mehrere Root-Schichtperiodenelemente. | |||
Schichtelement
| |||
Tag-Name
| stratum | ||
Beschreibung
| Stellt eine Zeitschicht des Kalenders dar, der vom exportTime-API-Aufruf zurückgegeben wird. | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
-Code | J | Eine eindeutige, benutzerdefinierte ID für die Zeitschicht. | Jahr |
Label | J | Eine nicht eindeutige, benutzerdefinierte Text-ID für die Zeitschicht. | Geschäftsjahr |
shortName | J | Eine nicht eindeutige, benutzerdefinierte Text-ID, die verwendet wird, wenn ein kürzerer Name gewünscht wird. Wenn kein Kurzname definiert ist, wird das Label hier angezeigt. | Jahr |
id | J | Die eindeutige, vom System generierte Ganzzahl-ID für die Zeitschicht. | 7 |
inUse Wird unterstützt in API v16 + | N | Kennzeichen, das angibt, ob ein Cube-Tabellenblatt oder ein modelliertes Tabellenblatt mit der Zeitschicht verknüpft ist oder ob dies die Standardzeitschicht ist. | 1 |
isDefault Wird unterstützt in API v16 + | N | Kennzeichen, das angibt, ob die Zeitschicht die Standardschicht ist oder nicht. | 1 |
Inhalt des Elements
| |||
Null oder ein Gebietsschema-Element. Dies ist nur enthalten, wenn includeAllLocales festgelegt ist. Null oder ein Schichtelement. Jede Schicht außer dem Leaf hat genau ein Schichtelement. Das Leaf-Schichtelement enthält 0 enthaltene Schichtelemente. | |||
Element des Ausgangssaldos
| |||
Tag-Name
| ausgangssaldo | ||
Beschreibung
| Stellt die letzte Leaf-Zeitperiode vor dem Start der Version dar, die in der Antwort auf einen exportTime-API-Aufruf zurückgegeben wird. Sie ist nur enthalten, wenn nur eine Version angefordert wird. | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
-Code | J | Die eindeutige, benutzerdefinierte ID für die Zeitperiode des Ausgangssaldos. | 12/2003 |
Label | J | Die nicht eindeutige, benutzerdefinierte Text-ID für die Zeitperiode des Ausgangssaldos. | Dez-2003 |
Kurzname | J | Die nicht eindeutige, benutzerdefinierte Kurztext-ID für die Zeitperiode des Ausgangssaldos. Wenn kein Kurzname definiert wurde, wird das Label angezeigt. | Dez |
stratumId | J | Die ID der Zeitschicht, zu der der Ausgangssaldo gehört. | 1 |
Zeitfenster | J | Das Zeitfenster der Zeitperiode, zu der der Ausgangssaldo gehört. | 47 |
encodedTimePeriod | J | Die codierten Daten für die Zeitperiode im Format trutumId::timeslot. | 1::47 |
id | J | Die eindeutige, vom System generierte Ganzzahl-ID für die Zeitperiode des Ausgangssaldos. | 47001 |
Anfang | J | Das Startdatum (einschließlich) des Ausgangssaldos im Format JJJJ-MM-TT. | 2003-12-01 |
Ende | J | Das Enddatum (ausschließlich) des Ausgangssaldos im Format JJJJ-MM-TT. | 2004-01-01 |
legacyReportTimeId | N | Die Berichts-ID, die für diese Zeitperiode in älteren Versionen dieser API angezeigt worden wäre. Dieses Attribut wird nur angezeigt, wenn includeLegacyInformation in der Anforderung 1 war und isCustom 0 ist. | 200312 |
legacySheetTimeId | N | Die Tabellenblatt-Zeit-ID, die in älteren Versionen dieser API für diese Zeitperiode verwendet worden wäre. Dieses Attribut wird nur angezeigt, wenn includeLegacyInformation in der Anforderung 1 war und isCustom 0 ist. | 48, Q63 oder Y72 |
Inhalt des Elements
| |||
Null oder ein Gebietsschema- Element. | |||
Periodenelement
| |||
Tag-Name
| Periode | ||
Beschreibung
| Stellt eine einzelne Kalenderzeitperiode dar, die vom API-Aufruf exportTime zurückgegeben wird. | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
-Code | J | Eine eindeutige, benutzerdefinierte Kennung für die Zeitperiode. | Q1-2004 |
Label | J | Eine nicht eindeutige, benutzerdefinierte Text-ID für die Zeitperiode. | Q1-FY04 |
shortName | J | Eine nicht eindeutige, benutzerdefinierte Text-ID, die verwendet wird, wenn ein kürzerer Name gewünscht wird. Wenn kein Kurzname definiert ist, wird das Label hier angezeigt. | Q1 |
stratumId | J | Die ID der Zeitschicht, zu der die Zeitperiode gehört. | 2 |
id | J | Die eindeutige, vom System generierte Ganzzahl-ID für die Zeitperiode. | 16002 |
Anfang | J | Das Startdatum (einschließlich) der Zeitperiode im Format JJJJ-MM-TT. | 2004-01-01 |
Ende | J | Das Enddatum (ausschließlich) der Zeitperiode im Format JJJJ-MM-TT. | 2004-04-01 |
legacyReportTimeId | N | Die Berichts-ID, die für diese Zeitperiode in älteren Versionen dieser API angezeigt worden wäre. Dieses Attribut wird nur angezeigt, wenn includeLegacyInformation in der Anforderung 1 war und isCustom 0 ist. | 200491 |
legacySheetTimeId | N | Die Tabellenblatt-Zeit-ID, die in älteren Versionen dieser API für diese Zeitperiode verwendet worden wäre. Dieses Attribut wird nur angezeigt, wenn includeLegacyInformation in der Anforderung 1 war und isCustom 0 ist. | 48, Q63 oder Y72 |
Inhalt des Elements
| |||
Null oder eins enthält Elemente für die Gebietsschemas. | |||
Element „Lokales“.
| |||
Tag-Name
| Gebietsschemas | ||
Beschreibung
| Container für ein oder mehrere Gebietsschema- Elemente. | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
(Keine) | |||
Inhalt des Elements
| |||
Ein oder mehrere Gebietsschema-Elemente. | |||
Gebietsschema-Element
| |||
Tag-Name
| Gebietsschema | ||
Beschreibung
| Beschreibung des Gebietsschemas Beachten Sie, dass der Text die Fallback-Regeln für das Gebietsschema befolgt. | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
Gebietsschema | J | Der Code für das Gebietsschema. | de |
Label | J | Das lokalisierte Label für die Zeitperiode/die Schichten. | FY2016 |
shortName | J | Der lokalisierte Kurzname für die Zeitperiode/die Schichten. | 2016 |
Inhalt des Elements
| |||
(Keine) | |||