Skip to content

Application Job exposure with RESTful API

Application Job exposure with RESTful API

CCH Tagetik exposes the execution of application jobs using Open RESTful APIs.
STATUS SWAGGER
ACTIVE -
FORMAT ROOT ENDPOINT
OData <api root>/dataprocessing/job/v1

Application job

To run the Application job, you can call the following URL through a POST method :

http://server:port/tagetikcpm/api/dataprocessing/job/v1/database_id/job_code**

the application job job_code will be run on the environment specified via database_id.

An error will be returned if the application job code does not exist.

Currently managed tasks are:

  • ETL
  • Loading to Analytical Workspace
  • Update Financial Workspace from Analytical Workspace
  • DTP
  • Stored procedures
  • Calculation logics
  • Preliminary data processing on Original scenarios
  • Preliminary on Consolidation area
  • Data processing for Legal Entities
  • Consolidation

In the response, the following will be returned in JSON format:

dataprocessingId: data processing ID

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

To check the execution status of the application job, a GET request can be used to invoke the URL:

http://server:port/tagetikcpm/api/dataprocessing/job/v1/**dataprocessingId

In the response, the following will be returned in JSON format:

status: RUNNING/FAILED/COMPLETED - depending on whether the data processing is running, failed or successfully completed.

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

To interrupt the execution of the application job, you can call the following URL via DELETE method:

http://server:port/tagetikcpm/api/dataprocessing/job/v1/dataprocessingId

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 is complete.

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

Warning: For the job to be executed via API, all tasks must use fixed parameters set to ‘From elements list’. Cases where a parameter is set to ‘From Parameter’ are not supported.