importConfigurableModelData

Adaptive Planning

Documentatie voor Workday Adaptive Planning (Workday 2025R2)
Integratie
Gegevensintegratie beheren
API-documentatie
Methoden voor het verzenden van gegevens

Laatst bijgewerkt: 2024-09-20

Bijgewerkt in API v40 (21 september 2024).

Categorie	Gegevensverzending
Omschrijving	Hiermee worden gegevens in een gemodelleerd blad ingevoegd, vervangen of bijgewerkt.
Vereiste machtigingen voor aanroepen	Importeren
Vereiste parameters op aanvraag	Referenties, ImportDataOptions, Versie, Blad, RowData

De aanvraag van deze methode bevat de parameters die worden gebruikt om te bepalen welk blad en welke versie de opgegeven rijen met gegevens ontvangt.

Deze methode kan:

Voeg nieuwe rijen toe aan het blad.

Vervang alle rijen die momenteel op het gemodelleerde blad staan door de import.

Alle gegevens in het blad vervangen, maar alleen voor geïmporteerde niveaus

Werk bestaande rijen bij door rijen uit de import te matchen met een importsleutel.

Werk bestaande rijen bij door rijen uit de import te matchen met een importsleutel en voeg nieuwe rijen toe.

Elke aanroep van deze API-aanroep moet precies één element van elk van de vermelde typen bevatten:

referenties

importDataOptions

versie

blad

rowData

Als het aantal sluistekentekens ( | ) in de kop en de gegevens niet overeenkomen, ontstaat er een fout voor API v30 of hoger.

Vanaf API v37 beperken we het maximum aantal nieuwe rijen dat u in gemodelleerde bladen kunt importeren. Neem contact op met de ondersteuningsafdeling als u deze limiet tegenkomt.

Aanvraagindeling


<?xml version='1.0' encoding='UTF-8'?>
<call method="importConfigurableModelData" 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" replaceExisting="2"/>
<version name="Budget 2014" isDefault="false" />
<sheet name="Personnel" isUserAssigned="false" />
<rowData>
 <header>Level|Region|Title|JobCode|Benefits|per|Last Name|First Name|ID|Start|End|Hr/Week|Pay Rate|Pay Rate Display Column</header>
 <rows>
   <row>Corporate Plan|Any|CEO|E1|Yes|Yr|Topdog|Andy|1000|12/20/2013|12/30/2014|80|500,000.12|888,888</row>
 </rows>
</rowData>
</call>

Aanvraagindeling voor bijwerken van bestaande rijen met importKey


<?xml version='1.0' encoding='UTF-8'?>
<call method="importConfigurableModelData" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd"instanceCode="INSTANCE1"/>
<importDataOptions planOrActuals="Plan" replaceExisting="3" importKey="Region" allowParallel="false" moveBPtr="false" useMappings="false"/>
<version name="Budget 2014" isDefault="false" />
<sheet name="Personnel" isUserAssigned="false" />
<rowData>
 <header>Plan|Region|Benefits|per</header>
 <rows>
   <row>Europe Sales|W-US|Yes|Hr</row>
 </rows>
</rowData>
</call>

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, tijdsperiodenamen 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 vanPlan ofWerkelijke waarden om het type gegevens op te geven dat wordt geïmporteerd. Als deze instelling conflicteert met de versie die is opgegeven in de versietag, heeft de waarde van de versietag voorrang en wordt deze instelling genegeerd.	Plan
moveBPtr	N	Wordt alleen gebruikt wanneer de gegevens die worden geïmporteerd een set tijdspannenummers voor elke rij hebben. 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 Plan.	false
allowParallel	J	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
replaceExisting	N	Instellen op 1 of true om alle bestaande rijen op alle niveaus te vervangen door de nieuwe rijen die worden geïmporteerd (dwz alle eerder bestaande rijen op alle niveaus wissen). Alleen gebruikers met de machtiging Importeren in alle locaties kunnen deze optie gebruiken. Stel in op 0 of false om de geïmporteerde rijen toe te voegen aan de bestaande rijen, zelfs als de nieuwe rijen duplicaten zijn. Stel in op 2 om de bestaande rijen in het gemodelleerde blad te vervangen door de nieuwe rijen die worden geïmporteerd, maar alleen voor rijen met een matchend niveau en beveiligde dimensies. Uit rijen met combinaties van niveaus en beveiligde dimensies waarvoor geen niet-gesplitste rijen in de geüploade spreadsheet staan, worden de bestaande rijen niet verwijderd, tenzij de rij een splitsing was van een rij die wordt vervangen door de upload. vervangExisting onderzoekt de gebruikte dimensies en kijkt of er gegevens aanwezig zijn in hetzelfde niveau, dezelfde rekening, dezelfde periode en dezelfde versie. Als er een rijsleutel bestaat, zoeken we ook overeenkomsten met de rijsleutelkolom of -kolommen. Als er gegevens in het systeem aanwezig zijn op dezelfde locatie, worden deze door de import vervangen. Deze vervanging vindt rij voor rij plaats. De import vervangt niet alles in één keer. Niet-matchende importrijen worden aan het blad toegevoegd. U voert bijvoorbeeld twee imports uit. Uw eerste importbestand laadt gegevens die uw tweede importbestand niet bevat. De bestaande gegevens blijven behouden na de tweede import. Als u alle gegevens in een bepaalde kolom wilt verwijderen, neemt u de kolom op maar laat u de kolomwaarden leeg. Kolomwaarden voor niet-vermelde kolommen blijven ongewijzigd. Stel in op 3 om bestaande rijen in het gemodelleerde blad bij te werken met de nieuwe rijen die worden geïmporteerd. Er wordt een waarschuwing geretourneerd als een rij niet overeenkomt met een bestaande rij. Voor deze modus is een importKey vereist. Bladen waarvoor Splitsingen toestaan is geselecteerd, bieden geen ondersteuning voor updates. Stel in op 4 om bestaande rijen in het gemodelleerde blad bij te werken met de nieuwe rijen die worden geïmporteerd en voeg nieuwe rijen in voor rijen die niet overeenkomen met een bestaande rij. Voor deze modus is een importKey vereist. De enige vereiste kolommen zijn importsleutel, niveau en eventuele tekstselecties, zelfs als er geen nieuwe rijen worden toegevoegd. Bladen waarvoor Splitsingen toestaan is geselecteerd, bieden geen ondersteuning voor updates. Stel in op 5 om bestaande rijen te vervangen op basis van een bereik dat momenteel alleen invoerniveaus ondersteunt voor de functionaliteit alleen vervangen door niveau. Het bereik wordt geleverd met een nieuw bereikelement. Alleen de rijen die overeenkomen met het opgegeven bereik worden in de import vervangen door de payload. Rijen die niet overeenkomen met het bereik, blijven ongewijzigd. De standaardwaarde is waar.	waar
importKey	N	De kolomnaam van het gemodelleerde blad die als importsleutel moet worden gebruikt bij het bijwerken van rijen van gemodelleerde bladen. Adaptive Planning gebruikt de importsleutelkolom om elke rij in de import te matchen met rijen in het gemodelleerde blad. De importsleutelwaarde van elke rij moet uniek zijn. Dit kenmerk kan alleen worden gebruikt als ReplaceExisting de waarde 3 of 4 heeft. Importsleutelkolommen kunnen een van de volgende zijn: een niveaukolom een dimensiekolom	Niveau
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 v31+ voor instances waarvoor de weergavenaam is ingeschakeld.	N	displayNameEnabled=true geeft aan dat de API de kolommen Rekeningcode, Niveaucode, Dimensiecode en Dimensienaam in de payload moet verwachten wanneer de instelling Weergavenaam inschakelen is ingeschakeld voor de instance. displayNameEnabled=false geeft aan dat de API moet worden voortgezet na het API-contract van vóór v30, zelfs als de instelling Weergavenaam inschakelen is ingeschakeld voor de instance. De standaardwaarde voor displayNameEnabled is onwaar.	false
ApplyValidationRules Alleen beschikbaar in API v38+.	N	ApplyValidationRules=true geeft aan dat de API gemodelleerde bladregelvalidaties uitvoert voor alle geïmporteerde gegevens wanneer de API-versie groter is dan v38. ApplyValidationRules=false geeft aan dat de API validaties van gemodelleerde bladregels voor alle geïmporteerde gegevens negeert. De standaardwaarde voor ApplyValidationRules is true.	false
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 zijn ingesteld optrue voor dit element.	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)

bladelement
Tagnaam		blad
Omschrijving		Hiermee wordt aangegeven in welk blad de geïmporteerde gegevens moeten worden ontvangen. Elke API-aanroep kan slechts op één bladgegevens worden gericht.
Kenmerken van het element
Kenmerknaam	Vereist?	Waarde	Voorbeeld
naam	J	De naam van het blad waarin de gegevens worden geïmporteerd.	Personeel
isUserAssigned	N	Hiermee wordt aangegeven dat het blad een aan de gebruiker toegewezen blad is. Als deze niet is opgegeven, wordt deze standaard ingesteld op 'false', wat aangeeft dat het een aan niveaus toegewezen blad is.	false
Inhoud van het element
(geen)

Bereikelement
Tagnaam		Bereik (beschikbaar met API v40)
Omschrijving		Hiermee geeft u het bereik voor deze import op. Voorbeeld: <scope> <levels> mode="INPUT"/> </scope> Alleen toegestaan wanneer het kenmerk ReplaceExisting van het element importDataOptions 5 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 de codes van de perioden 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 verticaal staaf- of 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 gegevens.

Voorbeeld van succes


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
<messages>
 <message key="modeled-import-success">Personnel import successful. Rows imported: 1</message>
 <message key="modeled-import-replace">All existing rows were replaced.</message>
</messages>
</response>

Mislukt (met context)


<?xml version='1.0' encoding='UTF-8'?>
<response success="false">
 <messages>
     <message key="modeled-import-failed">The Personnel import has failed.</message>
     <message key="error-import">Import Failed with the following error: 1 Error(s) Occurred.</message>
     <message key="import-detail">Additional information:</message>
     <message key="warning-nonexistent-dimension-value">Warning: No data was imported for rows with the following dimension values because the dimension values for Plan do not exist: Development1.</message>
     <message key="invalid-plan-choice-withCoordinate">
         <context>
             <col header="Plan" value="Development1" />
             <col header="Region" value="C-US" />
             <col header="Title" value="CEO" />
             <col header="JobCode" value="E1" />
             <col header="Benefits" value="Yes" />
             <col header="per" value="Yr" />
             <col header="Last Name" value="Topdog" />
             <col header="First Name" value="Andy" />
             <col header="ID" value="1000" />
             <col header="Start" value="12/20/2013" />
             <col header="End" value="12/30/2014" />
             <col header="Hr/Week" value="80.0" />
             <col header="Pay Rate" value="500000.12" />
             <col header="Pay Rate Display Column" value="888,888" />
 
         </context>
   Invalid Level Choice: Development1 on row 1 column A

     </message>
   </messages>
</response>

Mislukt (geen context)


<?xml version='1.0' encoding='UTF-8'?>
<response success="false">
 <messages>
     <message key="modeled-import-failed">The Personnel import has failed.</message>
     <message key="error-import">Import Failed with the following error: 1 Error(s) Occurred.</message>
     <message key="import-detail">Additional information:</message>
     <message key="warning-nonexistent-dimension-value">Warning: No data was imported for rows with the following dimension values because the dimension values for Plan do not exist: Development1.</message>
     <message key="invalid-plan-choice-withCoordinate">Invalid Level Choice: Development1 on row 1 column A</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
De tekst van het bericht. Deze tekst is opgesteld in de taal van de landinstelling die is opgegeven in de aanvraag (ervan uitgaande dat de landinstelling wordt ondersteund). De tekst kan ook variabele informatie bevatten, zoals het aantal rijen dat is verwerkt of de specifieke kolom of waarde die een fout heeft veroorzaakt. Een optioneel contextelement.

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)

Referentie: prestatievoorwaarden customReportValues

importCubeData

Was dit nuttig?

Wat wilt u onder de aandacht brengen? De informatie is juist Geeft antwoord op mijn vraag Gemakkelijk te vinden Gemakkelijk te begrijpen Helpt om mijn taak te voltooien Volledig en gedetailleerd

Wat wilt u onder de aandacht brengen? De informatie is onjuist Geeft geen antwoord op mijn vraag Moeilijk te vinden Moeilijk te begrijpen Helpt niet om mijn taak te voltooien Onvolledig of niet gedetailleerd genoeg

Vertel ons met welke taak u bezig bent. Welke aanvullende informatie kan deze inhoud verbeteren? Wilt u nog iets delen?

Volledige naam

E-mailadres

Workday gebruikt uw naam en e-mailadres om u antwoord te geven op uw feedback. Uw gegevens worden verwerkt in overeenstemming met onze Privacyverklaring.

Bedankt voor uw feedback