recalculateSheet

Ondersteund in API v16 +

Categorie	Gegevensverzending
Omschrijving	Bladen opnieuw berekenen met de eigenschap Opnieuw berekenen op aanvraag.
Vereiste machtigingen voor aanroepen	Machtiging voor bewerken van blad
Vereiste parameters op aanvraag	Referenties

De aanvraag van deze methode bevat een referentietag om de aanroepende gebruiker te identificeren en te autoriseren. De gebruiker moet de machtiging Bladbewerkingsmachtiging hebben om opnieuw te kunnen berekenen.

Aanvraagindeling


<?xml version='1.0' encoding='UTF-8'?>
<call method="recalculateSheet" callerName="a string that identifies your client application">
   <credentials login="sampleuser@company.com" password="my_password"/>
   <version name="Default Structure"/>
   <sheet name="Expense Cube"/>
   <level name="Corporate Plan"/>
</call>

version-element: er wordt een fout gegenereerd als er geen versie is opgegeven.

bladelement: als er geen bladelement is opgegeven, worden alle bladen met opties voor opnieuw berekenen op aanvraag opnieuw berekend op het hoogste niveau van de opgegeven versie. In dit geval wordt het niveau genegeerd.

niveau-element

Als er geen niveau is opgegeven, wordt het blad opnieuw berekend op het hoogste niveau in de gegeven versie.

Als de gebruiker geen toegang heeft tot het opgegeven niveau, wordt een fout gegenereerd.

Het blad wordt opnieuw berekend voor het niveau en de onderliggende niveaus in de opgegeven versie.

element referenties
Tagnaam		referenties
Omschrijving		Alle API-aanroepen moeten één . bevatten referenties 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)

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.	Standaardstructuur
ID	N	ID van de versie. ID wordt alleen overwogen als de naam niet aanwezig is.	4
Inhoud van het element
(geen)

bladelement
Tagnaam		blad
Omschrijving		Blad gedefinieerd op naam of ID
Kenmerken van het element
Kenmerknaam	Vereist?	Waarde	Voorbeeld
naam	N	De naam van het blad	Onkostenkubus
ID	N	ID van het blad. ID wordt alleen overwogen als de naam niet aanwezig is.	1
Inhoud van het element
(geen)

niveau-element
Tagnaam		niveau
Omschrijving		Niveau gedefinieerd op naam of ID
Kenmerken van het element
Kenmerknaam	Vereist?	Waarde	Voorbeeld
naam	N	De naam van het niveau	Bedrijfsplan
ID	N	ID van het niveau. Er wordt alleen rekening gehouden met het niveau als de naam niet aanwezig is.	1
Inhoud van het element
(geen)

Antwoordnotatie


<?xml version="1.0" encoding="UTF-8"?>
<response success="true">
</response>

antwoordelement
Tagnaam		antwoord
Omschrijving		Niveau gedefinieerd op naam of ID
Kenmerken van het element
Kenmerknaam	Vereist?	Waarde	Voorbeeld
succes	J	Waar of onwaar 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 optioneel berichtenelement.

berichtenelement
Tagnaam		berichten
Omschrijving		Container voor een of meer berichtelementen.
Kenmerken van het element
(geen)
Inhoud van het element
Een of meer berichtelementen.

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.