Data Push API documentation
Overview
Swagger Documentation for Celonis Data Push API
Version information
Version : 1.0
URI scheme
Host : teamdomain.cluster.cloud
BasePath : /integration
Tags
Chunk : Endpoints allowing you to see the status of a Job.
Job : Endpoints allowing you to control the lifecycle of a Job as well as checking status.
Security
AppKey
Type : apiKey
Name : Team-Specific application key
In : HEADER
Bearer
Type : apiKey
Name : User-Specific API Key
In : HEADER
Paths
Create a new data push Job in a data pool
POST /api/v1/data-push/{poolId}/jobs/
Parameters - Paths
Type | Name | Description | Schema |
|---|---|---|---|
Path | poolId required | poolId | string |
Body | Job required | The descriptor of the Job which you want to create. |
Responses - Paths
HTTP Code | Description | Schema |
|---|---|---|
200 | OK | |
201 | Created | No Content |
401 | Unauthorized | No Content |
403 | Forbidden | No Content |
404 | Not Found | No Content |
Consumes - Paths
application/json
Produces - Paths
\*/*
Tags - Paths
Chunk
Job
Security - Paths
List Jobs that are currently in your data pool
GET /api/v1/data-push/{poolId}/jobs/
Parameters - Jobs currently in your data pool
Type | Name | Description | Schema |
|---|---|---|---|
Path | poolId required | poolId | string |
Responses - Jobs currently in your data pool
HTTP Code | Description | Schema |
|---|---|---|
200 | OK | < DataPushJob > array |
401 | Unauthorized | No Content |
403 | Forbidden | No Content |
404 | Not Found | No Content |
Produces - Jobs currently in your data pool
\*/*
Tags - Jobs currently in your data pool
Chunk
Job
Security - Jobs currently in your data pool
Execute a single Job in a data pool
POST /api/v1/data-push/{poolId}/jobs/{id}
Parameters - Execute a single Job in a data pool
Type | Name | Description | Schema |
|---|---|---|---|
Path | id required | The ID of the Job you want to execute. | string |
Path | poolId required | poolId | string |
Responses - Execute a single Job in a data pool
HTTP Code | Description | Schema |
|---|---|---|
200 | OK | No Content |
201 | Created | No Content |
401 | Unauthorized | No Content |
403 | Forbidden | No Content |
404 | Not Found | No Content |
409 | Conflict | JSON |
429 | Too Many Requests | No Content |
Consumes - Execute a single Job in a data pool
application/json
Produces - Execute a single Job in a data pool
\*/*
Tags - Execute a single Job in a data pool
Chunk
Job
Security - Execute a single Job in a data pool
Return a single Job from the API
GET /api/v1/data-push/{poolId}/jobs/{id}
Parameters - Return a single job from the API
Type | Name | Description | Schema |
|---|---|---|---|
Path | id required | id | string |
Path | poolId required | poolId | string |
Responses - Return a single job from the API
HTTP Code | Description | Schema |
|---|---|---|
200 | OK | |
401 | Unauthorized | No Content |
403 | Forbidden | No Content |
404 | Not Found | No Content |
Produces - Return a single job from the API
\*/*
Tags - Return a single job from the API
Chunk
Job
Security - Return a single job from the API
Delete a Job
DELETE /api/v1/data-push/{poolId}/jobs/{id}
Parameters - Delete a Job
Type | Name | Description | Schema |
|---|---|---|---|
Path | id required | The ID of the Job you want to delete. | string |
Path | poolId required | poolId | string |
Responses - Delete a Job
HTTP Code | Description | Schema |
|---|---|---|
200 | OK | No Content |
204 | No Content | No Content |
401 | Unauthorized | No Content |
403 | Forbidden | No Content |
Produces - Delete a Job
\*/*
Tags - Delete a Job
Chunk
Job
Security - Delete a Job
Execute a single Job in a data pool (old URL)
POST /api/v1/data-push/{poolId}/jobs/{id}/
Parameters - Execute a single Job in a data pool (old URL)
Type | Name | Description | Schema |
|---|---|---|---|
Path | id required | The ID of the Job you want to execute. | string |
Path | poolId required | poolId | string |
Responses - Execute a single Job in a data pool (old URL)
HTTP Code | Description | Schema |
|---|---|---|
200 | OK | No Content |
201 | Created | No Content |
401 | Unauthorized | No Content |
403 | Forbidden | No Content |
404 | Not Found | No Content |
Consumes - Execute a single Job in a data pool (old URL)
application/json
Produces - Execute a single Job in a data pool (old URL)
\*/*
Tags - Execute a single Job in a data pool (old URL)
Chunk
Job
Security - Execute a single Job in a data pool (old URL)
List the chunks for a Job
GET /api/v1/data-push/{poolId}/jobs/{id}/chunks
Parameters - List the chunks for a Job
Type | Name | Description | Schema |
|---|---|---|---|
Path | id required | Job Id | string |
Path | poolId required | poolId | string |
Responses - List the chunks for a Job
HTTP Code | Description | Schema |
|---|---|---|
200 | OK | < DataPushChunk > array |
401 | Unauthorized | No Content |
403 | Forbidden | No Content |
404 | Not Found | No Content |
Produces - List the chunks for a Job
\*/*
Tags - List the chunks for a Job
Chunk
Job
Security - List the chunks for a Job
Create chunk for deleted rows
POST /api/v1/data-push/{poolId}/jobs/{id}/chunks/deleted
Parameters - Create chunk for deleted rows
Type | Name | Description | Schema |
|---|---|---|---|
Path | id required | Job Id | string |
Path | poolId required | poolId | string |
FormData | chunk required | Chunk file | file |
Responses - Create chunk for deleted rows
HTTP Code | Description | Schema |
|---|---|---|
200 | OK | No Content |
201 | Created | No Content |
400 | Job already locked | No Content |
401 | Unauthorized | No Content |
403 | Forbidden | No Content |
404 | Not Found | No Content |
Consumes - Create chunk for deleted rows
multipart/form-data
Produces - Create chunk for deleted rows
\*/*
Tags - Create chunk for deleted rows
Chunk
Job
Security - Create chunk for deleted rows
Create chunk for updated or created rows
POST /api/v1/data-push/{poolId}/jobs/{id}/chunks/upserted
Parameters - Create chunk for updated or created rows
Type | Name | Description | Schema |
|---|---|---|---|
Path | id required | Job Id | string |
Path | poolId required | poolId | string |
FormData | chunk required | Chunk file | file |
Responses - Create chunk for updated or created rows
HTTP Code | Description | Schema |
|---|---|---|
200 | OK | No Content |
201 | Created | No Content |
401 | Unauthorized | No Content |
403 | Forbidden | No Content |
404 | Not Found | No Content |
Consumes - Create chunk for updated or created rows
multipart/form-data
Produces - Create chunk for updated or created rows
\*/*
Tags - Create chunk for updated or created rows
Chunk
Job
Security - Create chunk for updated or created rows
Definitions
CSVParsingOptions
Name | Schema |
|---|---|
charSet optional | string |
dateFormat optional | string |
decimalSeparator optional | string |
escapeSequence optional | string |
lineEnding optional | string |
quoteSequence optional | string |
separatorSequence optional | string |
thousandSeparator optional | string |
ColumnTransport
Name | Schema |
|---|---|
columnName optional | string |
columnType optional | enum (INTEGER, DATE, TIME, DATETIME, FLOAT, BOOLEAN, STRING) |
decimals optional | integer (int32) |
fieldLength optional | integer (int32) |
pkField optional | boolean |
DataPushChunk
Name | Schema |
|---|---|
pushJobId optional | string |
type optional | enum (UPSERT, DELETE) |
DataPushJob
Name | Schema |
|---|---|
connectionId optional | string |
csvParsingOptions optional | |
dataPoolId optional | string |
fallbackVarcharLength optional | integer |
fileType optional | enum (PARQUET, CSV) |
keys optional | < string > array |
tableSchema optional | |
targetName optional | string |
type optional | enum (REPLACE, DELTA) |
upsertStrategy optional | enum (UPSERT_WITH_UNCHANGED_METADATA, UPSERT_WITH_NULLIFICATION) |
Optional«string»
Name | Schema |
|---|---|
empty optional | boolean |
present optional | boolean |
TableTransport
Name | Schema |
|---|---|
columns optional | < ColumnTransport > array |
tableName optional | string |