Skip to content

DTP run data processing APIs

URL

http://server:port/tagetikcpm/api/aih/dtp/v1/

API for running the data processing of a DTP

IMPORTANT: The launch of DTP from the API does not support multidimensional processes; it is also necessary to have the user function 0003912 enabled in order to use the following API.

Runs the data processing of a DTP with dtp_code code belonging to the DB identified by the database_id and defined on the Analytical Workspace identified by the workspace_code.

Method

POST

URL

/aih/dtp/v1/database_id/workspace_code/dtp_code

The following properties related to the execution context must be included in JSON format in the body of the request:

Property 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 data processing. -
period Only required for processes with submission by scenario and period, but not needed for single submission processes. Period selected for data processing. -
entity Mandatory. Entity or node selected for data processing - To indicate the entity, the entity code (e.g. A01) - To indicate a node, the string made up of "GER
contextIndependentRun Optional. Allows DTP to be launched in context-independent mode. If not indicated, DTP will be run in the standard mode: context-dependent. - false: standard, context-dependent execution. - true: context-independent execution.
runtimeParameters Optional. Allows the runtime parameters in the DTP configuration to be filled in. - AW parameters - Reporting parameters

Examples

{ "process": "CAV1", "scenario": "2020sp", "period": "07", "entity": "A01"} - loading for company A01 with process CAV1 and scenario/period of 2020sp/07

{ "process": "CAV1", "scenario": "2020sp", "period": "07", "entity": "GER|01"} - loading for node 01 with process CAV1 and scenario/period equal to 2020sp/07

{ "process":"CAV1", "scenario":"2020sp", "period":"07", "entity":"GER|01", "contextIndependentRun":"true"} - caricamento per il nodo 01 con processo CAV1, scenario/periodo pari a 2020sp/07 e opzione "Indipendente dal contesto" attiva.

{ "process":"CAV1", "scenario":"2020sp", "period":"07", "entity":"A01","runtimeParameters": { "reportingParameters": {"ENTITY": "010|110", "$SCE_P": "$|$|2024SCE", "$PER_P": "02"}, "AWParameters": {"AW_PARAMETER": "AW pararmeter"}}} - upload for Entity A01 with process CAV1, scenario /period equal to 2020sp/07 and runtime parameters.

Note: the values for the reporting parameters of dimension type organised by hierarchies or grouping must be given with the following syntax:

  • Dimension type parameters organised by hierarchy: GER|NODO or GER|NODO|ELEMENT
  • Dimension type parameters organised by grouping: $|NODO or $|NODO|ELEMENT
  • To indicate an element that does not belong to a hierarchy/grouping: $|$|ELEMENT
  • Dimension type parameters without organisational structure: ELEMENT

IMPORTANT: they are not currently supported:

  • User Rights

  • for dimension type reporting parameters:

  • explicit restrictions

  • dependent parameters
  • the selection of only nodes or only elements
  • multi-selection
  • default value

Data returned

The response returns the following ID in JSON format:

dataprocessingId = data processing ID.

E.g.: { "dataprocessingId":"FF8081817A4264E5017A42D08E3C21EB" }

API for checking DTP data processing status

Returns the DTP data processing status.

Method

GET

URL

/aih/dtp/v1/dataprocessingId

Data returned

The response returns the data processing status in JSON format:

status: RUNNING/FAILED/COMPLETED

Status Description
RUNNING Running
FAILED Failed
COMPLETED Successfully completed

E.g.: {"requestDateTime": "2021-06-25T10:56:42.850+0000", "status": "COMPLETED"}

API for stopping DTP data processing

Method

DELETE

URL

/aih/dtp/v1/dataprocessingId

Data returned

The response returns the following ID in JSON format:

message = Stop on dataprocessingOid dataprocessingId" / "Notify on dataprocessingOid dataprocessingId"

Message Description
Stop on dataprocessingOid Data Processing was stopped
Notify on dataprocessingOid Data processing in progress

E.g.: {"message": "Stop on dataprocessingOid FF8081817A4264E5017A42D08E3C21EB"}