eraseActuals

Categorie	Gegevensverzending
Omschrijving	Hiermee worden numerieke gegevens in de opgegeven perioden en rekeningen van een versie met werkelijke waarden gewist.
Vereiste machtigingen voor aanroepen	Gegevens wissen
Vereiste parameters op aanvraag	Credentials, EraseOptions

Met deze methode worden numerieke waarden uit een versie met werkelijke waarden gewist voor alle niveaus van de opgegeven set rekeningen voor een bepaald tijdsbestek. Er worden geen formules gewist (zoals gedeelde formules, celformules, rekeningformules). Hiermee worden de rekeningsplitsingen verwijderd die leeg zijn als gevolg van het proces voor het wissen van werkelijke waarden. Een lege splitsing is een splitsing die geen gegevens, formules of celopmerkingen bevat. Als het wissen van werkelijke waarden ertoe leidt dat de laatste gegevens van een splitsing worden verwijderd, wordt die splitsing verwijderd. Deze API laat splitsingen ongewijzigd als ze leeg waren voordat de API werd aangeroepen.

Aanvraagindeling

Numerieke waarden en zojuist lege splitsingen wissen voor de perioden tussen het begin en het einde van alle grootboekrekeningen voor alle niveaus van de standaardversie met werkelijke waarden:


 <?xml version='1.0' encoding='UTF-8'?>
<call method="eraseActuals" callerName="a string that identifies your client application">
   <credentials login="sampleuser@company.com" password="my_password"/>
   <eraseOptions
     accountType="GL"
     start="01/2013"     
     end="03/2013"
     includeCellNotes="false" />
</call>

Numerieke waarden en celopmerkingen wissen uit één kubusblad voor alle niveaus van een specifieke versie met werkelijke waarden tussen het opgegeven begin en einde:


 <?xml version='1.0' encoding='UTF-8'?>
<call method="eraseActuals" callerName="a string that identifies your client application">
   <credentials login="sampleuser@company.com" password="my_password"/>
   <eraseOptions
     actualsVersionName="Actuals"
     accountType="CUBE"
     cubeSheetName="Sales Cube"
     start="01/2013"         
     end="03/2013"
     includeCellNotes="true" />
</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)

eraseOptions element
Tagnaam		eraseOptions
Omschrijving		Hiermee geeft u de opties op die moeten worden gebruikt bij het wissen van werkelijke waarden.
Kenmerken van het element
Kenmerknaam	Vereist?	Waarde	Voorbeeld
actualsVersionName	N	Vereist wanneer er meer dan één versie met werkelijke waarden is. Als deze instance alleen het planningsproduct bevat, wordt:EraseActuals wist gegevens uit de enige echte versie met werkelijke waarden.	Werkelijke waarden
accountType	J	Hiermee wordt aangegeven of het rekeningtype grootboek is ("GB")), aangepast ("AANGEPAST") of kubusblad ("KUBUS").	GB
cubeSheetName	N	Vereist alsaccountType="CUBE". Hiermee geeft u de naam van het kubusblad op.	Sales Cube
start	J	Hiermee geeft u de code op van de beginperiode van het tijdsbereik van de werkelijke waarden. De code moet verwijzen naar een periode in het tijdstratum van de rekening. Als u een kubusblad opgeeft, moet de code verwijzen naar een tijdsperiode in het tijdstratum van het kubusblad. Als u een grootboek- of aangepast rekeningtype opgeeft, moet de code verwijzen naar het standaardtijdstratum. Voor API v15+ moet de opgegeven periode overeenkomen met het tijdstratum van de rekening. Als de rekening bijvoorbeeld een tijdstratum van Kwartalen heeft dat begint in januari, kunt u februari niet als begin selecteren.	01/2013
end	J	Hiermee geeft u de code op van de eindperiode van het tijdsbereik voor werkelijke waarden. De code moet verwijzen naar een periode in het tijdstratum van de rekening. Als u een kubusblad opgeeft, moet de code verwijzen naar een tijdsperiode in het tijdstratum van het kubusblad. Als u een grootboek- of aangepast rekeningtype opgeeft, moet de code verwijzen naar het standaardtijdstratum. Voor API v15+ moet de opgegeven periode overeenkomen met het tijdstratum van de rekening. Als de rekening bijvoorbeeld een tijdstratum heeft van Kwartalen dat begint in januari, kunt u februari niet selecteren als einddatum.	03/2013
includeCellNotes	J	Indien ingesteld op 'true", danEraseActuals wist alle celopmerkingen in de geselecteerde versie, het rekeningtype en het geselecteerde tijdsbereik, ongeacht of de gegevens ook uit de cel worden gewist. Als 'false", worden geen celopmerkingen verwijderd.	waar
Inhoud van het element
(geen)

Antwoordnotatie


 <?xml version="1.0" encoding="UTF-8"?>
<response success="true">
   <messages>
     <message key="erase-actuals-success">Successfully erased actuals data.</message>
     <message key="erase-actuals-facts-deleted">4 facts deleted.</message>
     <message key="erase-actuals-notes-deleted">2 notes deleted.</message>
     <message key="erase-actuals-splits-deleted">1 splits deleted.</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.	waarschuwing-ongeldige-timespan-start
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.