importTransactions
Categorie
| Gegevensverzending |
Omschrijving
| Voegt nieuwe transacties in. |
Vereiste machtigingen voor aanroepen
| Importeren |
Vereiste parameters op aanvraag
| Credentials, ImportTransactionsOptions, RowData |
Deze methode is alleen van toepassing als u toegang hebt tot Transacties.
U kunt tijdens het importeren alleen transacties verwijderen. Als u tijdens het importeren alle transacties wilt verwijderen, kunt u overwegen één lege rij te importeren en de resterende gegevens te verwijderen.
Deze methode kan worden gebruikt om bestaande transactierijen te verwijderen die aan bepaalde criteria voldoen, om nieuwe transactierijen in het systeem in te voegen of om beide acties in één aanroep uit te voeren (dwz een set transactierijen te vervangen door een andere set rijen).
Aanvraagindeling
<?xml version='1.0' encoding='UTF-8'?> <call method="importTransactions" callerName="a string that identifies your client application"> <credentials login="sampleuser@company.com" password="my_pwd" instanceCode="INSTANCE1"/> <importTransactionsOptions allowParallel="false" useMappings="false"/> <rowData> <header>Posting Date|Transaction Type|Account|Plan|Transaction Amount</header> <rows> <row>01/02/2011|Invoice|70110|Marketing|100</row> </rows> </rowData> </call>
Elke aanroep van deze API-aanroep moet precies één element van elk van de vermelde typen bevatten:
- referenties
- importTransactionsOptions
- rowData
Als het aantal sluistekentekens ( | ) in de kop en de gegevens niet overeenkomen, ontstaat er een fout voor API v30 of hoger.
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, maandnamen 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) | |||
importTransactionsOptions
element
| |||
Tagnaam
| importTransactionsOptions | ||
Omschrijving
| Hiermee geeft u de opties op die moeten worden gebruikt bij het importeren. Als ten minste één vandeleteStartDate,deleteEndDate, oftransactionTypes zijn opgegeven, probeert deze methodeaanroep bestaande transacties te verwijderen die aan de opgegeven criteria voldoen. | ||
Kenmerken van het element
| |||
Kenmerknaam
| Vereist?
| Waarde
| Voorbeeld
|
deleteStartDate | N | Als deze methodeaanroep is bedoeld om bestaande transacties te verwijderen, geeft dit kenmerk de begindatum aan van de set transacties die moet worden verwijderd (inclusief). Indien niet opgegeven, worden alle transacties met een datum op of vóór dedeleteEndDate (en die overeenkomt met een van de optionele opgegevenTransactionTypes) wordt verwijderd. | 11/01/2012 |
deleteEndDate | N | Als deze methodeaanroep is bedoeld om bestaande transacties te verwijderen, geeft dit kenmerk de einddatum op van de set transacties die moet worden verwijderd (inclusief). Als dit niet is opgegeven, worden alle transacties met een datum op of na dedeleteStartDate (en die overeenkomen met een van de optionele opgegevenTransactionTypes) wordt verwijderd. | 12/31/2012 |
transactionTypes | N | Een set transactietypen die worden verwijderd, gescheiden door het pijpsymbool. Indien niet opgegeven, worden alle transacties opgegeven tussen:deleteStartDate endeleteEndDate wordt verwijderd. Zo nee:deleteStartDate ofdeleteEndDate is opgegeven, worden alle transacties van de opgegeven typen verwijderd, ongeacht hun datums. | Factuur|Inkooporder |
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 |
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 |
Inhoud van het element
| |||
(geen) | |||
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
| kop | ||
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 maanden 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 transactiegegevens.
Voorbeeld van succes
<?xml version='1.0' encoding='UTF-8'?> <response success="true"> <messages> <message key="row-imported">1 row was imported.</message> </messages> </response>
Mislukt (met context)
<?xml version='1.0' encoding='UTF-8'?> <response success="false"> <messages> <message key="error-import">Import Failed with the following error: No transactions were imported or deleted during the import.</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 Transaction Type do not exist: Invoice12.</message> <message key="invalid-dimension-choice-withCoordinate"> <context> <col header="Posting Date" value="01/02/2011" /> <col header="Transaction Type" value="Invoice12" /> <col header="Account" value="70110" /> <col header="Plan" value="Marketing" /> <col header="Transaction Amount" value="100.0" /> </context> Invalid Dimension Choice: Invoice12 on row 1 column B </message> </messages> </response>
Mislukt (geen context)
<?xml version='1.0' encoding='UTF-8'?> <response success="false"> <messages> <message key="error-import">Import Failed with the following error: No transactions were imported or deleted during the import.</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 Transaction Type do not exist: Invoice12.</message> <message key="invalid-dimension-choice-withCoordinate">Invalid Dimension Choice: Invoice12 on row 1 column B</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
| |||
| |||
context element
| |||
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
|
kop | J | De kop van de kolom. | 'Account' |
waarde | J | De waarde in de kolom. | "GL-29482-38233" |
Inhoud van het element
| |||
(geen) | |||