importStandardData
Bijgewerkt in API v40 (13 september 2024)
Categorie
| Gegevensverzending |
Omschrijving
| Hiermee worden gegevens in standaardrekeningen ingevoegd of vervangen. |
Vereiste machtigingen voor aanroepen
| Importeren in alle locaties
Gegevens wissen (API v36+ om de VERVANG-modus te ondersteunen) |
Vereiste parameters op aanvraag
| Referenties, ImportDataOptions, Versie, RowData |
includeDescendants
De aanvraag van deze methode bevat de parameters die worden gebruikt om te bepalen welke versie de opgegeven rijen met gegevens ontvangt. Gegevens kunnen worden geïmporteerd in elke standaardrekening (grootboekrekening, aangepaste rekening, aanname of wisselkoers), ongeacht of de rekening op een blad is geplaatst.
importStandardData kan niet worden geïmporteerd in rekeningen die gebruikmaken van
Gegevensinvoer
voor Instelling overschrijvingsformule
.Aanvraagindeling
<?xml version='1.0' encoding='UTF-8'?> <call method="importStandardData" callerName="a string that identifies your client application"> <credentials login="sampleuser@company.com" password="my_pwd" instanceCode="INSTANCE1"/> <importDataOptions planOrActuals="Plan" allowParallel="false" moveBPtr="false" useMappings="false" /> <version name="Budget 2004" isDefault="false" /> <rowData> <header>Account|Level|Split Label|Product|Region|11/2005|01/2006</header> <rows> <row>70110|Corporate Plan||Bunnyrabbit Toy|Western-US|2037|4032</row> </rows> </rowData> </call>
Elke aanroep van deze API-aanroep moet precies één element van elk van de vermelde typen bevatten:
- referenties
- importDataOptions
- versie
- rowData
- header
- rijen
Als het aantal sluistekentekens ( | ) in de kop en de gegevens niet overeenkomen, ontstaat er een fout voor API v30 of hoger.
Als voor API v36+ het moduskenmerk importDataOptions REPLACE is, moet ook een bereikelement worden opgegeven:
Voorbeeld: aanvraag voor vervangingsmodus
|
Alleen beschikbaar in API v36+
|
element referenties
| |||
Tagnaam
| referenties | ||
Omschrijving
| Alle API-aanroepen moeten één . bevattenreferenties om de gebruiker te identificeren die de API aanroept. De API-aanroep wordt vervolgens uitgevoerd als deze gebruiker (elk audittrail of geschiedenis van acties in het systeem geeft aan dat deze gebruiker de actie heeft uitgevoerd), en daarom moet de gebruiker over de vereiste machtigingen beschikken om de actie uit te voeren om ervoor te zorgen dat de API-aanroep slagen. | ||
Kenmerken van het element
| |||
Kenmerknaam
| Vereist?
| Waarde
| Voorbeeld
|
aanmelden: | J | De aanmeldingsnaam van de gebruiker die de API-methode aanroept. Deze gebruiker moet over de vereiste machtigingen beschikken om de methode aan te roepen. | sampleuser@company.com |
wachtwoord | J | Het wachtwoord van de gebruiker die de API-methode aanroept. | my_password |
landinstelling | N | Geef de landinstelling op die moet worden gebruikt om inkomende getallen en datums te interpreteren en om uitgaande getallen en datums op te maken (met behulp van het juiste scheidingsteken voor duizendtallen,namen van perioden en datumnotatie). De landinstelling wordt ook gebruikt om de taal op te geven waarin systeemberichten in het antwoord moeten worden weergegeven. Als dit niet is opgegeven, wordt en_US (Amerikaans-Engels) gebruikt. | fr_FR |
instanceCode | N | Als de gebruiker die is opgegeven in de referenties toegang heeft tot meer dan één instance van Adaptive Planning , kan dit kenmerk worden gebruikt om op te geven dat de gebruiker van plan is toegang te krijgen tot een andere instance dan de standaardinstance. Als dit niet is opgegeven, wordt de standaardinstance van de gebruiker gebruikt. Gebruik de exportInstances-API om de beschikbare instancecodes te bepalen. | MYINSTANCE1 |
Inhoud van het element
| |||
(geen) | |||
element importDataOptions
| |||||||
Tagnaam
| importDataOptions | ||||||
Omschrijving
| Hiermee geeft u de opties op die moeten worden gebruikt bij het importeren. | ||||||
Kenmerken van het element
| |||||||
Kenmerknaam
| Vereist?
| Waarde
| Voorbeeld
| ||||
planOrActuals | J | Instellen op een van 'plan' of 'Werkelijke waarden' om het type gegevens op te geven dat wordt geïmporteerd. Als deze instelling conflicteert met de versie die is opgegeven in hetVersietag, deDe waarde van de versietag heeft voorrang en deze instelling wordt genegeerd. | Plan | ||||
moveBPtr | N | Alleen gebruikt wanneer deplanOrActuals-kenmerk is ingesteld op:Werkelijke waarden. AlsmoveBPtr is ingesteld optrue, wordt bij het importeren de aanwijzer voor beschikbaarheid van werkelijke waarden in de versie met werkelijke waarden verplaatst naar de laatste periode die in de geïmporteerde gegevens is gevonden. Indien ingesteld op:false, heeft de import geen invloed op welke perioden de werkelijke waarden in een versie weergeven. Dit kenmerk moet worden ingesteld op 'false' als:planOrActuals is ingesteld op:Plannen. | false | ||||
allowParallel | J | Alleen gebruikt wanneer deplanOrActuals-kenmerk is ingesteld op:Werkelijke waarden. Indien ingesteld op:true, wordt de import voortgezet, zelfs als er al een andere import van werkelijke waarden of transacties wordt verwerkt voor deze instance. Indien ingesteld op:false, mislukt de importpoging als er al een import van werkelijke waarden of transacties voor deze instance wordt verwerkt. | false | ||||
useMappings | N | Hiermee geeft u op of importtoewijzingen moeten worden gebruikt voor rekeningen, plannen en dimensiewaarden in de rij-elementen. Overwogenstandaardwaarde true. Alsfalse, moeten de interne ID's worden gebruikt: rekeningen worden geïdentificeerd met een code, niveaus en dimensiewaarden met een naam. | false | ||||
includeContext | N | Hiermee geeft u op of berichten het contextblok mogen bevatten. Waarden zijn:onwaar (nooit context weergeven) oftrue (toon indien van toepassing context). Als dit niet is opgegeven,waar wordt aangenomen. | false | ||||
displayNameIngeschakeld
Alleen beschikbaar in API v30+ voor instances waarvoor de weergavenaam is ingeschakeld. | N | displayNameEnabled=true geeft aan dat importStandardData moet verwachten Account Code , Level Code , Dimension Code , and Dimension Name Column in de payload wanneer Weergavenaam inschakelen is ingeschakeld voor de instance.displayNameEnabled=false geeft aan dat de API importStandardData het API-contract van vóór v30 moet blijven volgen, zelfs als Weergavenaam inschakelen is ingeschakeld voor de instance. De importStandardData-API negeert de eigenschappen van de weergavenaam Account Code , Level Code , Dimension Code , and Dimension Name Column .De standaardwaarde voor displayNameEnabled is onwaar. | false | ||||
splitsToUnsplit
Alleen beschikbaar in API v40+ | N | splitsToUnsplit=true staat toe dat splitsingen worden geïmporteerd naar een niet-gesplitste locatie met bestaande gegevens. De standaardwaarde voor dit kenmerk is onwaar. | false | ||||
modus
Alleen beschikbaar in API v36+ | N | Hiermee geeft u de importmodus op. Dit is APPEND of REPLACE.
Dit moduskenmerk wordt ondersteund vanaf API v36 en latere versies. Het aanroepen van een eerdere versie van de API met mode="REPLACE" is een fout. De standaardwaarde voor modus wanneer deze niet is opgegeven, is APPEND. | TOEVOEGEN | ||||
Inhoud van het element
| |||||||
(geen) | |||||||
versie-element
| |||
Tagnaam
| versie | ||
Omschrijving
| Hiermee wordt aangegeven welke versie moet worden gebruikt om de aangevraagde gegevens te ontvangen. Voor elke aanroep moet een versie worden opgegeven. | ||
Kenmerken van het element
| |||
Kenmerknaam
| Vereist?
| Waarde
| Voorbeeld
|
naam | N | De naam van de versie die moet worden gebruikt om de gegevens te ontvangen. Er is slechts toegang tot één versie binnen één API-aanroep. Als er geen naam is opgegeven, wordtDe markering isDefault moet voor dit element zijn ingesteld op true.
Als u een lijst met vertaalde valutaversies en hun namen wilt krijgen, maakt u een aanvraagexportVersions met currencyVersions=true in het element include. | Budget 2014 |
isDefault | N | Als de aanroeper toegang wil tot de huidige standaardversie van de instance, ongeacht de naam, kan dit kenmerk worden ingesteld op true. In dat geval wordt het kenmerk name van de tag (indien aanwezig) genegeerd. Als deze waarde onwaar is of als dit kenmerk niet aanwezig is, moet er een versie met de opgegeven naam aanwezig zijn die toegankelijk is voor de gebruiker om deze aanroep te laten slagen. | false |
Inhoud van het element
| |||
(geen) | |||
bereikelement
| |||
Tagnaam
| scope
Alleen beschikbaar in API-versie 36+ | ||
Omschrijving
| Hiermee geeft u het bereik voor deze import op.
Alleen toegestaan wanneer het modekenmerk van het element importDataOptions REPLACE is. | ||
Kenmerken van het element
| |||
Kenmerknaam
| Vereist?
| Waarde
| Voorbeeld
|
eraseCellNotes | N | Hiermee geeft u op of celopmerkingen in het bereik moeten worden gewist. Moet een van de drie opgesomde waarden zijn:
GEEN - celopmerkingen niet wissen.ALLE : alle celopmerkingen binnen het bereik wissen.MODIFIED_ONLY - Wis celopmerkingen voor cellen binnen het bereik die door de import zijn gewijzigd. Dit omvat voorheen lege cellen waarin feiten zijn geïmporteerd en cellen waarvan de feiten zijn gewist.Als eraseCellNotes niet is opgegeven, wordt deze standaard ingesteld op GEEN. | GEEN |
Inhoud van het element
| |||
Eén tijdselement , één rekeningenelement en één niveau -element zijn allemaal verplicht. | |||
rekeningenelement
| |||
Tagnaam
| rekeningen
Alleen beschikbaar in API-versie 36+ | ||
Omschrijving
| Hiermee worden de rekeningen voor het importbereik opgegeven. Als er een opgegeven rekening bestaat maar er geen gegevens voor deze rekening in de importgegevens zijn, worden de gegevens in deze rekening verwijderd voor het tijdsbereik en de rest van de bereikcoördinaten.
Alleen toegestaan wanneer het modekenmerk van het element importDataOptions REPLACE is. | ||
Kenmerken van het element
| |||
Kenmerknaam
| Vereist?
| Waarde
| Voorbeeld
|
modus | J | Hiermee geeft u de modus voor het rekeningbereik op. Moet een van de volgende drie opties zijn.
EXPLICIET - als deze modus is opgegeven, verwachten we een of meer rekeningsubelementen te zien die het rekeningbereik voor de import bepalen.INPUT - wanneer deze modus is opgegeven, wordt het rekeningbereik bepaald door de unieke set rekeningen in de importgegevens.Opmerking: accounts mode="ALL" is niet toegestaan voor het standaardimportbereik. | EXPLICIET |
Inhoud van het element
| |||
Als modus INPUT is, mogen er geen <rekening> -subelementen zijn.Als de modus EXPLICIT is, moeten er een of meer <rekening> -subelementen zijn.Als de modus EXPLICIT is en een rekeningcode in een <rekening>-subelement ongeldig is, wordt het hele element <accounts> en bij uitbreiding het <scope> als ongeldig beschouwd. Voor elke ongeldige code wordt in het antwoord een foutbericht opgenomen. | |||
rekeningelement
| |||
Tagnaam
| rekening
Alleen beschikbaar in API-versie 36+ | ||
Omschrijving
| Hiermee geeft u de rekeningcode op die moet worden opgenomen in het bereik voor de import.
Alleen toegestaan wanneer het modekenmerk van het element importDataOptions REPLACE is. | ||
Kenmerken van het element
| |||
Kenmerknaam
| Vereist?
| Waarde
| Voorbeeld
|
includeDescendants | N | Als de rekening een rekening op het laagste niveau is, heeft includeDescendants geen effect.
Als de rekening een bovenliggende rekening is, worden alle onderliggende onderliggende rekeningen van deze rekening in het bereik opgenomen als u dit kenmerk opgeeft als waar. Het is een fout als de rekening een bovenliggende rekening is en includeDescendants onwaar is. We kunnen alleen importeren in rekeningen op het laagste niveau. Dit is een optioneel kenmerk en de standaardwaarde wordt als onwaar beschouwd. | waar |
selector | N | Hiermee geeft u het inhoudstype van het rekeningelement op:
De standaardwaarde voor de selector is code. | |
Inhoud van het element
| |||
De hoofdlettergevoelige rekeningcode van de rekening die wordt gebruikt als onderdeel van het importbereik. Bijvoorbeeld Crediteuren. De code mag niet leeg zijn en de rekening die overeenkomt met de code moet bestaan. De rekening kan geen systeemrekening of gekoppelde rekening zijn. Als de rekening een berekende rekening is, moet er een overschrijving voor gegevensinvoer voor die rekening zijn, anders wordt deze als ongeldig beschouwd.
Als een rekeningcode ongeldig is, wordt het volledige element <accounts> en bij uitbreiding <scope> als ongeldig beschouwd. | |||
niveaus-element
| |||
Tagnaam
| niveaus
Alleen beschikbaar in API-versie 36+ | ||
Omschrijving
| Hiermee worden de niveaucodes voor het importbereik opgegeven. Als hier een niveaucode is opgegeven, maar er zijn geen gegevens voor dit niveau in de importgegevens, worden de gegevens in dit niveau verwijderd voor het tijdsbereik en de rest van de bereikcoördinaten.
Alleen toegestaan wanneer het modekenmerk van het element importDataOptions REPLACE is. | ||
Kenmerken van het element
| |||
Kenmerknaam
| Vereist?
| Waarde
| Voorbeeld
|
modus | J | Hiermee geeft u de modus voor het niveaubereik op. Moet een van de volgende drie opties zijn.
EXPLICIT - als deze modus is opgegeven, verwachten we een of meer <level>-subelementen te zien die het niveaubereik voor de import bepalen.INPUT - wanneer deze modus is opgegeven, wordt het niveaubereik bepaald door de unieke set niveaus in de importgegevens.ALLE : wanneer deze modus is opgegeven, bestaat het niveaubereik uit alle importeerbare niveaus. | EXPLICIET |
Inhoud van het element
| |||
Als de modus INPUT of ALL is, mogen er geen <level>-subelementen zijn.
Als de modus EXPLICIET is, moeten er een of meer <level>-subelementen zijn. Als de modus EXPLICIET is en een niveaucode in een <level>-subelement ongeldig is, wordt het hele element <levels> en bij uitbreiding het <scope> als ongeldig beschouwd. Voor elke ongeldige code wordt in het antwoord een foutbericht opgenomen. | |||
niveau-element
| |||
Tagnaam
| niveau
Alleen beschikbaar in API-versie 36+ | ||
Omschrijving
| Hiermee geeft u de niveaucode op die moet worden opgenomen in het bereik voor de import.
Alleen toegestaan wanneer het modekenmerk van het element importDataOptions REPLACE is. | ||
Kenmerken van het element
| |||
Kenmerknaam
| Vereist?
| Waarde
| Voorbeeld
|
includeDescendants | N | Als het niveau een bovenliggend niveau is en dit kenmerk opgeeft als waar, worden alle onderliggende niveaus van dit niveau opgenomen, inclusief zichzelf (het enige knooppunt) in het bereik.
Dit is een optioneel kenmerk. Als het kenmerk niet wordt opgegeven, is de standaardwaarde onwaar. Als het kenmerk niet is opgegeven of is opgegeven als onwaar en het opgegeven niveau een bovenliggend niveau is, betekent dit dat bij de import rekening wordt gehouden met het knooppunt Alleen (bijvoorbeeld alleen techniek) voor dat niveau voor bereik. Onderliggende niveaus van het niveau worden niet opgenomen in het bereik, tenzij expliciet aangegeven door andere niveau-elementen. | waar |
Inhoud van het element
| |||
Hiermee geeft u de hoofdlettergevoelige code van het niveau op. Bijvoorbeeld <level>Ontwikkeling</level>. Als er een probleem is met de niveaucode, bijvoorbeeld een niveau waar de code niet wordt gevonden, worden de hele <levels> en bij uitbreiding de <scope> als ongeldig beschouwd. Voor elke ongeldige code wordt in het antwoord een foutbericht opgenomen. | |||
tijdselement
| |||
Tagnaam
| time
Alleen beschikbaar in API-versie 36+ | ||
Omschrijving
| Hiermee worden een of meer tijdsbereikwaarden opgegeven die het tijdsbereik voor de import vertegenwoordigen.
Alleen toegestaan wanneer het modekenmerk van het element importDataOptions REPLACE is. | ||
Kenmerken van het element
| |||
Kenmerknaam
| Vereist?
| Waarde
| Voorbeeld
|
modus | J | Hiermee geeft u de modus voor het tijdsbereik op. Moet een van de volgende drie opties zijn. INPUT - wanneer deze modus is opgegeven, wordt het tijdsbereik bepaald door de tijdcodes in de <header> element. Als de kop twee maanden bevat, is het bereik voor de import deze twee maanden.EXPLICIT - als deze modus is opgegeven, verwachten we een of meer timeRange-subelementen te zien die het tijdsbereik voor de import bepalen.VERSIE - wanneer deze modus is opgegeven, is het tijdsbereik het begin en einde van de versie, inclusief een eventuele aanvangssaldoperiode.Als de modus INPUT of VERSION is, is het subelement timeRange niet toegestaan. Als er timeRange-subelementen aanwezig zijn, wordt dit behandeld als een fout. | INPUT |
Inhoud van het element
| |||
Een of meer timeRange-elementen, tenzij de modus INPUT of VERSION is. | |||
element timeRange
| |||
Tagnaam
| timeRange
Alleen beschikbaar in API-versie 36+ | ||
Omschrijving
| Hiermee geeft u één tijdsbereik op voor het tijdsbereik.
Alleen toegestaan wanneer het modekenmerk van het element importDataOptions REPLACE is. | ||
Kenmerken van het element
| |||
Kenmerknaam
| Vereist?
| Waarde
| Voorbeeld
|
begin | J | De beginperiode voor het importtijdsbereik. | 07/2021 |
end | J | De eindperiode voor het importtijdsbereik. | 08/2021 |
Inhoud van het element
| |||
Een of meer timeRange-elementen, tenzij de modus INPUT of VERSION is. | |||
rowData-element
| |||
Tagnaam
| rowData | ||
Omschrijving
| Container voor de rijen met gegevens die worden geïmporteerd. | ||
Kenmerken van het element
| |||
(geen) | |||
Inhoud van het element
| |||
Exact éénheader-element en exact éénrows-element. | |||
header-element
| |||
Tagnaam
| header | ||
Omschrijving
| Hiermee geeft u de namen en volgorde op van de kolommen van de gegevens in de bijbehorenderows-element. | ||
Kenmerken van het element
| |||
(geen) | |||
Inhoud van het element
| |||
Een regel tekst met kolomnamen die met verticale staven zijn gescheiden. Deze kolomnamen moeten overeenkomen met de namen van de dimensies of velden op het blad of met tijdsperiodecodes die gegevens kunnen bevatten. Ze zijn identiek aan de kolomnamen in de importsjabloon voor het blad waarnaar de gegevens worden geïmporteerd, waarbij elke kolomkop van de volgende wordt gescheiden door een verticale balk of een pijpsymbool.
Voor instances waarvoor Weergavenaam is ingeschakeld, biedt de kop geen ondersteuning voor: "<dimension>" in combinatie met "<dimension> Name" of "<dimension> Code" in API v30 of hoger voor door Adaptive Planning ondersteunde landinstellingen. | |||
rows-element
| |||
Tagnaam
| rijen | ||
Omschrijving
| Container voor een of meerrij-elementen. | ||
Kenmerken van het element
| |||
(geen) | |||
Inhoud van het element
| |||
Een of meerrij-elementen. | |||
rij-element
| |||
Tagnaam
| rij | ||
Omschrijving
| Gegevens voor één rij die worden geïmporteerd. | ||
Kenmerken van het element
| |||
(geen) | |||
Inhoud van het element
| |||
Gegevens voor de velden in één rij die worden geïmporteerd, waarbij de waarde van elk veld wordt gescheiden door een verticaal staaf- of pijpsymbool. De gegevensvelden moeten in dezelfde volgorde staan als de regel in het kopelement. Als getallen in de waarden scheidingstekens voor duizendtallen gebruiken, wordt aangenomen dat dit de kommascheidingstekens zijn die worden gebruikt in de landinstelling die is opgegeven in de referenties van de aanvraag. | |||
Antwoordnotatie
Dit zijn voorbeelden van antwoorden op het succesvol en niet succesvol importeren van standaardrekeninggegevens.
Voorbeeld van succes
<?xml version='1.0' encoding='UTF-8'?> <response success="true"></response>
Mislukt (met context)
<?xml version='1.0' encoding='UTF-8'?> <response success="false"> <messages> <message key="error-empty-account"> <context> <col header="Account" value="" /> <col header="Level" value="Corporate Plan" /> <col header="Split Label" value="" /> <col header="Product" value="Bunnyrabbit Toy" /> <col header="Region" value="Western-US" /> <col header="11/2005" value="2037" /> <col header="01/2006" value="4032" /> </context> Account cannot be empty on row 1. </message> </messages> </response>
Mislukt (geen context)
<?xml version='1.0' encoding='UTF-8'?> <response success="false"> <messages> <message key="error-empty-account">Account cannot be empty on row 1.</message> </messages> </response>
antwoordelement
| |||
Tagnaam
| antwoord | ||
Kenmerken van het element
| |||
Kenmerknaam
| Vereist?
| Waarde
| Voorbeeld
|
succes | J | Ofwel:waar offalse om aan te geven of de API-aanroep is geslaagd of niet. Zelfs geslaagde aanroepen kunnen waarschuwingsberichten in hun antwoord bevatten. | waar |
Inhoud van het element
| |||
Eén optioneleberichtenelement. | |||
berichtenelement
| |||
Tagnaam
| berichten | ||
Omschrijving
| Container voor een of meerberichtelementen. | ||
Kenmerken van het element
| |||
(geen) | |||
Inhoud van het element
| |||
Een of meerberichtelementen. | |||
berichtelement
| |||
Tagnaam
| bericht | ||
Omschrijving
| Vertegenwoordigt een bericht dat door het systeem wordt teruggestuurd naar de beller. Berichten worden gebruikt voor foutberichten wanneer aanvragen niet slagen, voor waarschuwingsberichten wanneer aanvragen wel slagen en voor bevestigingsberichten na slagen. | ||
Kenmerken van het element
| |||
Kenmerknaam
| Vereist?
| Waarde
| Voorbeeld
|
sleutel | N | Een sleutel is een manier om een bepaald bericht of type bericht te identificeren, wat handig is voor automatische foutregistratie en herstel in clientprogramma's. Sleutels worden niet gewijzigd onder verschillende landinstellingen van aanvragen, zelfs niet als de taal van het bericht verandert. Het is ook onwaarschijnlijk dat sleutels in de toekomst worden gewijzigd als gevolg van aanpassingen in de formulering of terminologie. | invalid-attributevalueid |
Inhoud van het element
| |||
| |||
contextelement
| |||
Tagnaam
| context | ||
Omschrijving
| Container voor een of meer col-elementen. | ||
Kenmerken van het element
| |||
Kenmerknaam
| Vereist?
| Waarde
| Voorbeeld
|
geen | |||
Inhoud van het element
| |||
Een of meer col-elementen. | |||
col-element
| |||
Tagnaam
| col | ||
Omschrijving
| Vertegenwoordigt de context voor het bericht. Geeft een kop/waarde-paar zodat de rij die het bericht genereert, kan worden geïdentificeerd. | ||
Kenmerken van het element
| |||
Kenmerknaam
| Vereist?
| Waarde
| Voorbeeld
|
header | J | De kop van de kolom. | "Account" |
waarde | J | De waarde in de kolom. | "GL-29482-38233" |
Inhoud van het element
| |||
(geen) | |||