{"componentChunkName":"component---src-templates-simple-markdown-js","path":"/celonis-apis/process-data-model-api/","matchPath":"","result":{"data":{"markdownRemark":{"html":"

Process Data Model API

\n

The Process Data Model API allows you to completely or partially reload your data models, ensuring that the latest data from your source system is available. This is a RESTful API that allows you run GET requests to retrieve information and POST requests to trigger the data model loads.

\n

Required parameters - Data pool and data model IDs

\n

To use this API, you need both the data pool ID and data model ID, both of which can be found from your URL when viewing that area of the Celonis Platform.

\n

Data pool ID

\n

Your data pool ID will be in the following format:

\n
\n
\n
Copy
\n
Copied
\n
\n 
[https://TEAMNAME.REALM.celonis.cloud/integration/ui/pools/DATA_POOL_ID/](null)
\n
\n

Data model ID

\n

Your data model ID will be in the following format:

\n
\n
\n
Copy
\n
Copied
\n
\n 
[https://TEAMNAME.REALM.celonis.cloud/integration/ui/pools/DATAPOOLID/data-configuration/process-data-models/DATA_MODEL_ID?tab=data-model](null)
\n
\n

Authentication methods

\n

To connect to and use the process data model API, you have the following authentication methods available:

\n\n

Complete data model reload

\n

Using a RESTful API, you can trigger a complete data model load (complete load) with this POST request:

\n
\n
\n
Copy
\n
Copied
\n
\n 
POST /integration/api/v1/data-pools/{poolId}/data-models/{dataModelId}/load
\n
\n

Partial data model reload

\n

If you only want to update a subset of tables, you can also perform a partial reload. This does a complete reload of the specified tables only and a reload from cache for the rest.

\n

To perfrom a partial reload you need to query the table list first:

\n
\n
\n
Copy
\n
Copied
\n
\n 
GET /integration/api/v1/data-pools/{poolId}/data-models/{dataModelId}/tables
\n
\n

This will return the following response parameters:

\n\n

Note the IDs of the table to which you would like to sync and then execute the following:

\n
\n
\n
Copy
\n
Copied
\n
\n 
POST /integration/api/v1/data-pools/{poolId}/data-models/{dataModelId}/load/partial-sync
\n
\n

In the body of this request, you will need to specify the tables as a list of IDs:

\n
\n
\n
Copy
\n
Copied
\n
\n 
[\"table_id1\", \"table_id2\"]
\n
\n

Last load information

\n

In order to query information about the last data model load, use the following endpoint:

\n
\n
\n
Copy
\n
Copied
\n
\n 
GET /integration/api/v1/data-pools/{poolId}/data-models/{dataModelId}/last-load
\n
\n

Python example

\n

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

\n
\n
\n
Copy
\n
Copied
\n
\n 
`import requests` \\\n \\\n`realm = 'xyz' # e.g. eu-1, us-1, eu-2` \\\n`tenant = 'xyz' # the name of your team (your subdomain)` \\\n`api_key = 'xyz' # the API key` \\\n`pool_id = 'xyz' # the Data Pool ID (see above)` \\\n`data_model_id = 'xyz' # the Data Model ID (see above)` \\\n \\\n`url = \"https://{}.{}.celonis.cloud/integration/api/v1/data-pools/{}/data-models/{}/load\".format(tenant, realm, pool_id, data_model_id)` \\\n \\\n`requests.post(url, headers={'authorization': \"Bearer {}\".format(api_key)})`
\n
","headings":[{"value":"Process Data Model API","depth":1},{"value":"Required parameters - Data pool and data model IDs","depth":2},{"value":"Data pool ID","depth":3},{"value":"Data model ID","depth":3},{"value":"Authentication methods","depth":2},{"value":"Complete data model reload","depth":2},{"value":"Partial data model reload","depth":2},{"value":"Last load information","depth":2},{"value":"Python example","depth":2}]},"contentItem":{"data":{"lastModified":"2025-08-13T20:04:37.000Z","enableToc":null,"disableLastModified":null,"tocMaxDepth":null,"requestLogin":false}},"siteConfig":{"enableToc":false,"disableLastModified":false,"tocMaxDepth":4}},"pageContext":{"matchPath":"","id":"5bba7f3e-9ac3-5f6b-a182-fade5d8453c8__redocly content/celonis-apis/process-data-model-api/","seo":{"title":"Process Data Model API","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"celonis-apis/process-data-model-api.md","pageBaseUrl":"/celonis-apis/process-data-model-api","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Process Data Model API","id":"process-data-model-api"},{"depth":2,"value":"Required parameters - Data pool and data model IDs","id":"required-parameters---data-pool-and-data-model-ids"},{"depth":3,"value":"Data pool ID","id":"data-pool-id"},{"depth":3,"value":"Data model ID","id":"data-model-id"},{"depth":2,"value":"Authentication methods","id":"authentication-methods"},{"depth":2,"value":"Complete data model reload","id":"complete-data-model-reload"},{"depth":2,"value":"Partial data model reload","id":"partial-data-model-reload"},{"depth":2,"value":"Last load information","id":"last-load-information"},{"depth":2,"value":"Python example","id":"python-example"}]},"data":{"title":""},"catalogInfo":null,"link":"/celonis-apis/process-data-model-api/","sidebarName":"celonis","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":null,"apiVersionId":null,"isDefaultApiVersion":null}},"staticQueryHashes":["1123603147","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3240152602","3743992808","561138138"]}