API for directly loading Quick Data Loader data
URL¶
Parameters on the execution context¶
| Parameter | Description | Options |
|---|---|---|
| process | Mandatory. Process selected for loading. | - |
| scenario | Only required for processes with submission by scenario and period, but not needed for single submission processes. Scenario selected for loading. | - |
| period | Only required for processes with submission by scenario and period, but not needed for single submission processes. Period selected for loading | - |
| entity | Mandatory. Entity or node selected for loading. | - To indicate the entity, the entity code (e.g. A01) - To indicate a node, the string made up of " |
Parameters on the target type¶
| Parameter | Description | Options |
|---|---|---|
| targetType | Mandatory. Target type. | - AW: loaded onto the Analytical Workspace - AMOUNTS: loaded onto the Financial Workspace (Gross Amount Data and/or IC Amount Data) |
| loadingPolicy | Mandatory. Policy for loading data onto the target. If necessary, the editability and validation checks are applied both to data to be deleted and to data to be inserted. | - ONLY_INSERT: only inserts data, without deleting. - DELETE_FOR_FILTER_AND_ORIGIN_AND_INSERT: deletes for the execution context, origin and dimensions to filter as indicated in the fieldDeletionFilter parameter before running the insertion. - DELETE_FOR_FILTER_AND_INSERT: deletes for the execution context and dimensions to filter as indicated in the fieldDeletionFilter parameter before running the insertion. |
| fieldDeletionFilter | Optional. Allows you to indicate the names of the fields related to the target on which to filter the deletion of data. Only deletes records with values equal to those present in the input data to be inserted. | Depending on the selected target type, dedicated options must be specified; see Particular features of the fieldDeletionFilter property |
Particular features of the fieldDeletionFilter property¶
| Option | Description | Options |
|---|---|---|
| With type AW | ||
| workspace | Mandatory. Analytical Workspace code | - |
| dataset | Mandatory. Dataset code | - |
| typology | Optional. Type code. Default: $ - Reporting layer | - |
| With type AMOUNT | ||
| grossType | Optional. Method by which records must be subdivided between Gross Amounts and Intercompany Amounts. Default: GROSS | - GROSS: Rows with no counterparty are downloaded as Gross Amounts, while the others are downloaded as Intercompany Amounts. - THIRD_PARTY: The row totals, ignoring the counterparty value, are downloaded as Gross Amounts, while those with the counterparty are downloaded as Intercompany Amounts. |
| periodLength | Optional. Specifies whether the amounts loaded for the data are expressed cumulatively or by period. Default: YEAR_TO_DATE | - MONTHLY: Monthly - BIMESTRAL: Bimonthly - QUARTERLY: Quarterly - FOURMONTHLY: Every four months - SEMIANNUAL: Every six months - ANNUAL: Annual - YEAR_TO_DATE: Cumulative |
| carryForwardPolicy | Optional. Indicates the way in which data from the previous period is reopened in the event that the selected process is not Single Submission and the selected periodLength is not YEAR_TO_DATE - cumulative. Default RELATED_TO_IMPORTED_DATA | - RELATED_TO_IMPORTED_DATA: Reopens the data from the previous period with the same n-pla logic present in the imported data to be made cumulative, without considering the origin. - ACCORDING_TO_DELETION_POLICY: Reopens the data from the previous period applying the filters defined by the deletion policy specified in the loadingPolicy parameter. |
Parameters related to data¶
Data can be specified both in CSV format and in JSON format.
| Parameter | Description | Options |
|---|---|---|
| CSV format | ||
| headerCsvFormat | Mandatory. List of field names related to the source data. There may be more or less than those of the target. | - |
| dataCsvFormat | Mandatory. List of records. Each record is a list of values separated by , sorted according to the headers defined in the headerCsvFormat parameter. Each data record must have the same cardinality as the specified headers. | - |
| JSON format | ||
| dataJsonFormat | Mandatory. List of records. Each record is an object in JSON format in which data are represented as key-value pairs in which the key is the name of the source column and the value is the value of the field. Each data record must have the same cardinality as the others and must contain the usual field names. |
Examples¶
Body for loading onto Analytical Workspace for a Scenario/Period submission process, for a single entity, with data in JSON format¶
Copy
{
"process" : "ACTUAL",
"scenario" : "2022ACT",
"period" : "12",
"entity" : "001",
"targetType": "AW",
"workspace" : "001",
"dataset" : "000001",
"typology" : "$",
"loadingPolicy" : "DELETE_FOR_FILTER_AND_ORIGIN_AND_INSERT"
"fieldDeletionFilter" : [ "ACCOUNT", "COST_CENTER"]
"dataJsonFormat" : [
{ "SCENARIO" : "2022ACT", "PERIOD" : "12", "ENTITY" : "001", "ACCOUNT" : "00001", "COST_CENTER" : "00001", "CURRENCY" : "EUR", "AMOUNT" : 100.00, "NOTE" : "" },
{ "SCENARIO" : "2022ACT", "PERIOD" : "12", "ENTITY" : "001", "ACCOUNT" : "00002", "COST_CENTER" : "00001", "CURRENCY" : "EUR", "AMOUNT" : 200.00, "NOTE" : "" },
{ "SCENARIO" : "2022ACT", "PERIOD" : "12", "ENTITY" : "001", "ACCOUNT" : "00003", "COST_CENTER" : "00001", "CURRENCY" : "EUR", "AMOUNT" : 300.00, "NOTE" : "" }
]
}
Body for loading onto Analytical Workspace for a single submission process, for a node of entities, with data in CSV format¶
Copy
{
"process" : "BUDGET",
"entity" : "01|01",
"targetType": "AW",
"workspace" : "001",
"dataset" : "000001",
"typology" : "CALC",
"loadingPolicy" : "DELETE_FOR_FILTER_AND_INSERT"
"fieldDeletionFilter" : [ "ACCOUNT", "COST_CENTER"]
"headerCsvFormat" : [ "SCENARIO", "PERIOD","ENTITY","ACCOUNT","COST_CENTER","CURRENCY","AMOUNT","NOTE"]
"dataCsvFormat" : [
[ "2022ACT", "12", "001", "00001", "00001", "EUR", 100.00, "" ],
[ "2022ACT", "12", "001", "00002", "00001", "EUR", 200.00, "" ],
[ "2022ACT", "12", "001", "00003", "00001", "EUR", 300.00, "" ]
]
}
Body for loading onto Financial Workspace for a Scenario/Period submission process, for a single entity, with data in JSON format¶
Copy
{
"process" : "ACTUAL",
"scenario" : "2022ACT",
"period" : "12",
"entity" : "001",
"targetType": "AMOUNT",
"grossType" : "GROSS",
"periodLength" : "MONTHLY",
"carryForwardPolicy" : "RELATED_TO_IMPORTED_DATA",
"loadingPolicy" : "DELETE_FOR_FILTER_AND_ORIGIN_AND_INSERT"
"fieldDeletionFilter" : [ "COD_CONTO", "COD_DEST1"]
"dataJsonFormat" : [
{ "COD_SCENARIO" : "2022ACT", "COD_PERIODO" : "12", "COD_AZIENDA" : "001", "COD_CONTO" : "00001", "COD_DEST1" : "00001", "COD_CATEGORIA" : "$AMOUNT", "COD_VALUTA_ORIGINARIA" : "EUR", "IMPORTO_VALUTA_ORIGINARIA" : 100.00, "NOTE" : "" },
{ "COD_SCENARIO" : "2022ACT", "COD_PERIODO" : "12", "COD_AZIENDA" : "001", "COD_CONTO" : "00002", "COD_DEST1" : "00001", "COD_CATEGORIA" : "$AMOUNT", "COD_VALUTA_ORIGINARIA" : "EUR", "IMPORTO_VALUTA_ORIGINARIA" : 200.00, "NOTE" : "" },
{ "COD_SCENARIO" : "2022ACT", "COD_PERIODO" : "12", "COD_AZIENDA" : "001", "COD_CONTO" : "00003", "COD_DEST1" : "00001", "COD_CATEGORIA" : "$AMOUNT", "COD_VALUTA_ORIGINARIA" : "EUR", "IMPORTO_VALUTA_ORIGINARIA" : 300.00, "NOTE" : "" }
]
}
Body for loading onto Financial Workspace for a single submission process, for a node of entities, with data in CSV format¶
Copy
"process" : "BUDGET",
"entity" : "01|01",
"targetType": "AMOUNT",
"grossType" : "GROSS",
"periodLength" : "MONTHLY",
"carryForwardPolicy" : "RELATED_TO_IMPORTED_DATA",
"loadingPolicy" : "DELETE_FOR_FILTER_AND_INSERT"
"fieldDeletionFilter" : [ "ACCOUNT", "COST_CENTER"]
"headerCsvFormat" : [ "COD_SCENARIO", "COD_PERIODO","COD_AZIENDA","COD_CONTO","COD_DEST1","COD_CATEGORIA","COD_VALUTA_ORIGINARIA","IMPORTO_VALUTA_ORIGINARIA","NOTE"]
"dataCsvFormat" : [
[ "2022ACT", "12", "001", "00001", "00001", "$AMOUNT", "EUR", 100.00, "" ],
[ "2022ACT", "12", "001", "00002", "00001", "$AMOUNT", "EUR", 200.00, "" ],
[ "2022ACT", "12", "001", "00003", "00001", "$AMOUNT", "EUR", 300.00, "" ]
]
}
In the response, the following will be returned in JSON format:
dataprocessingId: data processing ID.
E.g.: { "dataprocessingId":"FF8081817A4264E5017A42D08E3C21EB" }
To check the status of the data processing, a GET request can be used to invoke the URL:
In the response, the following will be returned in JSON format:
status: RUNNING/FAILED/COMPLETED - depending on whether the data processing is in progress, failed or successfully completed.
E.g.: {"requestDateTime": "2021-06-25T10:56:42.850+0000", "status": "COMPLETED"}
To stop the data processing, a DELETE request can be used to invoke the URL:
In the response, the following will be returned in JSON format:
message: "Stop on dataprocessingOid dataprocessingId"/"Notify on dataprocessingOid dataprocessingId" - depending on whether or not the data processing has finished.
E.g.: {"message": "Stop on dataprocessingOid FF8081817A4264E5017A42D08E3C21EB"}