Skip to main content

Celonis Product Documentation

Data Job Execution API

API endpoints
  1. Execute a Data Job

    You can trigger a Data Job execution using the following RESTful API:

    POST /integration/api/v2/data-pools/{poolId}/data-jobs/{jobId}/execute?mode={mode}
    Screenshot showing how to identify the Data Pool ID and Data Job ID using the URL of the Data Job.

    To use this API you need three pieces of information:

    1. Data Pool ID

    2. Data Job ID

    3. Mode of the Data Job - 'FULL' for a full load or 'DELTA' for a delta load

    The first two pieces can be retrieved from the URL of the Data Job as shown in the screenshot above.

    The following is an example of how this API can be used in Python:

    import requests
    
    tenant = 'xyz' # the name of your team (your subdomain)
    realm = 'xyz' # e.g. eu-1, us-1, eu-2
    api_key = 'xyz' # the API key
    pool_id = 'xyz' # the Data Pool ID (see above)
    data_job_id = 'xyz' # the Data Job ID (see above)
    data_job_mode = 'DELTA' # the mode of the Data Job (see above)
    
    url = "https://{}.{}.celonis.cloud/integration/api/v1/data-pools/{}/data-jobs/{}/execute?mode={}".format(tenant, realm, pool_id, data_job_id, data_job_mode)
    
    requests.post(url, headers={'authorization': "Bearer {}".format(api_key)})
  2. Query the status of a Data Job

    After executing a Data Job, you can query the status of a Data Job using the following RESTful API:

    GET /integration/api/pools/{poolId}/jobs/{jobId}

    As described above, the Data Pool ID (poolId) and Data Job ID (jobId) can be retrieved from the URL of the respective Data Job. The current status of the job will be returned as seen in the screenshot below:

    Sample API response showing the current status of the Data Job.