eraseData
Ondersteund in API v24+.
Categorie
| Gegevensverzending |
Omschrijving
| Hiermee worden plan- of werkelijke waarden in de opgegeven perioden voor een rekening gewist met optionele filters voor niveaus en rekeningen. |
Vereiste machtigingen voor aanroepen
| Gegevens wissen |
Vereiste parameters op aanvraag
| Credentials, EraseOptions |
Hiermee worden numerieke waarden gewist uit een plan- of versie met werkelijke waarden voor 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 geraakt als gevolg van het wissen. Een lege splitsing is een splitsing die geen gegevens, formules of celopmerkingen bevat. Als het wissen 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.
De methode eraseData biedt dezelfde mogelijkheden als eraseActuals, maar omvat ook de mogelijkheid om plangegevens te wissen, met extra controle over specifieke rekening-plancombinaties die doelen zijn. Celopmerkingen die aan de criteria voldoen, worden ook verwijderd.
is een machtiging van een supergebruiker waarmee werkelijke waarden of plangegevens in Adaptive Planning kunnen worden gewist, ook in vergrendelde niveaus. Gegevens wissen overschrijft toegangsregels en beperkingen voor niveau-eigendom. U kunt alleen gegevens verwijderen uit berekende rekeningen met een overschrijving voor gegevensinvoer.
Deze API valideert het tijdstratum voor de gekozen rekeningen.
Totalisatierekeningen wissen
Met de API Erase Data worden geen gegevens voor totalisatierekeningen gewist. Neem elke rekening afzonderlijk op in uw aanvraag.
Niveaus wissen
Als u een bovenliggend niveau in uw aanvraag doorgeeft, wist de eraseData-API alleen de gegevens op het bovenliggende niveau en niet op de onderliggende niveaus. U moet elk niveau afzonderlijk in de API-aanvraag opnemen.
Aanvraagindeling
Aanvragen weigeren niet-herkende tags. Met tags is hoofdletterongevoelige matching mogelijk. Voorbeeld: <rekeningen>, <Rekeningen> en <ACCOUNTS> zijn acceptabel voor het element Rekeningen.
Werkelijke waarden wissen voor alle niveaus van de standaardversie met werkelijke waarden
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" instanceCode="MYINSTANCE" locale="en_US"/> <eraseOptions actualsVersionName="Actuals" 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>
Gegevens werkelijke waarden wissen met filters voor rekeningen op een specifiek niveau
Voor dit voorbeeld zijn de gegevens van werkelijke waarden in de versie met werkelijke waarden
ActualsSubVersion2013
voor aangepaste rekeningen WAT_Input_Custom
and WAT_Test_Custom
op niveau QA
wordt verwijderd.<?xml version="1.0" encoding="UTF-8"?> <call method="eraseData" callerName="test caller api name"> <credentials login="sampleuser@company.com" password="my_password" instanceCode="MYINSTANCE" locale="en_US" /> <eraseOptions actualsVersionName="ActualsSubVersion2013" accountType="CUSTOM" start="01/2010" end="11/2010" includeCellNotes="true"> <filters> <Accounts> <Account code="WAT_Input_Custom"/> <Account code="WAT_Test_Custom"/> </Accounts> <Levels> <Level name="QA"/> </Levels> </filters> </eraseOptions> </call>
Plangegevens wissen met een te verwijderen filter uit specifieke aangepaste rekeningen
Voor dit voorbeeld zijn de plangegevens in de planversie
clone2013Budget
voor aangepaste rekeningen SUM_TEXT
and LAST_NB
wordt verwijderd.<?xml version="1.0" encoding="UTF-8"?> <call method="eraseData callerName="a string that identifies your client application"> <credentials login="sampleuser@company.com" password="my_password" instanceCode="MYINSTANCE1" locale="en_US"/> <eraseOptions planVersionName="clone2013budget" accountType="CUSTOM" start="01/2010" end="12/2013" includeCellNotes="true"> <filters> <Accounts> <Account code="SUM_TEXT"/> <Account code="LAST_NB"/> </Accounts> </filters> </eraseOptions> </call>
Plangegevens wissen met filters die moeten worden verwijderd uit specifieke aangepaste rekeningen op specifieke niveaus
Voor dit voorbeeld zijn de plangegevens in de planversie
clone2013Budget
voor aangepaste rekeningen WA_SUM
and SUM_SUM
op de niveaus Development
and Hosting
wordt verwijderd.<?xml version="1.0" encoding="UTF-8"?> <call method="eraseData" callerName="test caller api name"> <credentials login="sampleuser@company.com" password="my_password" instanceCode="MYINSTANCE1" locale="en_US"/> <eraseOptions planVersionName="clone2013Budget" accountType="CUSTOM" start="01/2010" end="12/2013" includeCellNotes="true"> <filters> <Accounts> <Account code="WA_SUM"/> <Account code="SUM_SUM"/> </Accounts> <Levels> <Level name="Development"/> <Level name="Hosting"/> </Levels> </filters> </eraseOptions> </call>
Plangegevens wissen met filters die moeten worden verwijderd uit een specifieke kubusrekening op een specifiek niveau
Voor dit voorbeeld zijn de plangegevens in de planversie
10YearBudget
voor kubusrekening ExpenseCube.Units
in het niveau WorldWide Sales
wordt verwijderd.<?xml version="1.0" encoding="UTF-8"?> <call method="eraseData" callerName="test caller api name"> <credentials login="sampleuser@company.com" password="my_password" instanceCode="MYINSTANCE1" locale="en_US" /> <eraseOptions planVersionName="10YearBudget" accountType="CUBE" cubeSheetName="Expense Cube" start="01/2010" end="12/2017" includeCellNotes="true"> <filters> <Accounts> <Account code="ExpenseCube.Units" /> </Accounts> <Levels> <Level name="WorldWide Sales" /> </Levels> </filters> </eraseOptions> </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 worden gebruikt bij het wissen van werkelijke waarden of plangegevens. | ||
Kenmerken van het element
| |||
Kenmerknaam
| Vereist?
| Waarde
| Voorbeeld
|
actualsVersionName | N | Vereist voor het wissen van gegevens met werkelijke waarden. Hiermee geeft u de naam op van de versie met werkelijke waarden waaruit gegevens moeten worden gewist. Hiermee worden geen formules gewist (zoals gedeelde formules, celformules, rekeningformules). | ActualsSubVersion2013 |
planVersionName | N | Vereist voor het wissen van plangegevens. Hiermee geeft u de naam op van de planversie waaruit gegevens moeten worden gewist. Hiermee worden geen formules gewist (zoals gedeelde formules, celformules, rekeningformules). | clone2013Budget |
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. 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.
De opgegeven periode moet worden uitgelijnd 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. 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.
De opgegeven periode moet worden uitgelijnd 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 | Als eraseData is ingesteld op true, worden alle celopmerkingen gewist in de geselecteerde versie, het rekeningtype en het geselecteerde tijdsbereik (en combinaties op rekeningniveau die overeenkomen met de filters, als deze zijn opgegeven), ongeacht of ook de gegevens uit het geselecteerde cel. Als dit niet het geval is, worden er geen celopmerkingen verwijderd | waar |
displayNameIngeschakeld
Alleen beschikbaar in API v30+ voor instances waarvoor de weergavenaam is ingeschakeld. | N | displayNameEnabled=true geeft aan dat eraseData de weergavenaameigenschappen van moet respecteren code wanneer Weergavenaam inschakelen is ingeschakeld voor de instance.displayNameEnabled=false geeft aan dat de eraseData-API het API-contract van vóór v30 moet blijven volgen, zelfs als Weergavenaam inschakelen is ingeschakeld voor de instance. De eraseData-API negeert de eigenschappen van de weergavenaam code .De standaardwaarde voor displayNameEnabled is onwaar. | Waar |
Inhoud van het element
| |||
(geen) | |||
filterelement
| |||
Tagnaam
| Filters | ||
Omschrijving
| Hiermee geeft u de rekening- en niveaufilters op die moeten worden gebruikt bij het wissen van gegevens. | ||
Kenmerken van het element
| |||
Kenmerknaam
| Vereist?
| Waarde
| Voorbeeld
|
Inhoud van het element
| |||
Eén element Rekeningen, één element Niveaus of zowel een element Rekeningen als een element Niveaus. | |||
Rekeningenelement
| |||
Tagnaam
| Rekeningen | ||
Omschrijving
| Container voor een of meer rekeningelementen van een eraseData-filter. | ||
Kenmerken van het element
| |||
Kenmerknaam
| Vereist?
| Waarde
| Voorbeeld
|
Inhoud van het element
| |||
Een of meer rekeningelementen. | |||
Niveau-element
| |||
Tagnaam
| Niveaus | ||
Omschrijving
| Container voor een of meer niveau-elementen van een eraseData-filter. | ||
Kenmerken van het element
| |||
Kenmerknaam
| Vereist?
| Waarde
| Voorbeeld
|
Inhoud van het element
| |||
Een of meer niveau-elementen. | |||
Rekeningelement
| |||
Tagnaam
| Rekening | ||
Omschrijving
| De rekening waaruit gegevens worden gewist, opgegeven door de rekeningcode. | ||
Kenmerken van het element
| |||
Kenmerknaam
| Vereist?
| Waarde
| Voorbeeld
|
code | J | Hiermee geeft u de rekeningcode op voor de rekening van de gegevens die worden gewist. | WA_SUM |
Inhoud van het element
| |||
(geen) | |||
Niveau-element
| |||
Tagnaam
| Niveau | ||
Omschrijving
| Het niveau voor de rekeninggegevens die worden gewist, opgegeven door Niveaunaam. | ||
Kenmerken van het element
| |||
Kenmerknaam
| Vereist?
| Waarde
| Voorbeeld
|
naam | J | Hiermee geeft u de niveaunaam op voor de rekeninggegevens die worden gewist. | Verkoop wereldwijd |
code
Alleen beschikbaar in API v30+ voor instances waarvoor de weergavenaam is ingeschakeld. | N | De code van het niveau.
Vereist wanneer Weergavenaam inschakelen is ingeschakeld voor een instance. | Verkopen wereldwijd |
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. | |||