Skip to main content

Celonis Product Documentation

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

Type

Name

Description

Schema

Path

poolId

required

poolId

string

Body

Job

required

The descriptor of the Job which you want to create.

DataPushJob

Responses

HTTP Code

Description

Schema

200

OK

DataPushJob

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json
Produces
  • \*/*
Tags
  • Chunk

  • Job

Security

Type

Name

Scopes

apiKey

Bearer

global

apiKey

AppKey

global

List Jobs that are currently in your data pool
GET /api/v1/data-push/{poolId}/jobs/
Parameters

Type

Name

Description

Schema

Path

poolId

required

poolId

string

Responses

HTTP Code

Description

Schema

200

OK

< DataPushJob > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • \*/*
Tags
  • Chunk

  • Job

Security

Type

Name

Scopes

apiKey

Bearer

global

apiKey

AppKey

global

Execute a single Job in a data pool
POST /api/v1/data-push/{poolId}/jobs/{id}
Parameters

Type

Name

Description

Schema

Path

id

required

The ID of the Job you want to execute.

string

Path

poolId

required

poolId

string

Responses

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
  • application/json
Produces
  • \*/*
Tags
  • Chunk

  • Job

Security

Type

Name

Scopes

apiKey

Bearer

global

apiKey

AppKey

global

Return a single Job from the API
GET /api/v1/data-push/{poolId}/jobs/{id}
Parameters

Type

Name

Description

Schema

Path

id

required

id

string

Path

poolId

required

poolId

string

Responses

HTTP Code

Description

Schema

200

OK

DataPushJob

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • \*/*
Tags
  • Chunk

  • Job

Security

Type

Name

Scopes

apiKey

Bearer

global

apiKey

AppKey

global

Delete a Job
DELETE /api/v1/data-push/{poolId}/jobs/{id}
Parameters

Type

Name

Description

Schema

Path

id

required

The ID of the Job you want to delete.

string

Path

poolId

required

poolId

string

Responses

HTTP Code

Description

Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Produces
  • \*/*
Tags
  • Chunk

  • Job

Security

Type

Name

Scopes

apiKey

Bearer

global

apiKey

AppKey

global

Execute a single Job in a data pool (old URL)
POST /api/v1/data-push/{poolId}/jobs/{id}/
Parameters

Type

Name

Description

Schema

Path

id

required

The ID of the Job you want to execute.

string

Path

poolId

required

poolId

string

Responses

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
  • application/json
Produces
  • \*/*
Tags
  • Chunk

  • Job

Security

Type

Name

Scopes

apiKey

Bearer

global

apiKey

AppKey

global

List the chunks for a Job
GET /api/v1/data-push/{poolId}/jobs/{id}/chunks
Parameters

Type

Name

Description

Schema

Path

id

required

Job Id

string

Path

poolId

required

poolId

string

Responses

HTTP Code

Description

Schema

200

OK

< DataPushChunk > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • \*/*
Tags
  • Chunk

  • Job

Security

Type

Name

Scopes

apiKey

Bearer

global

apiKey

AppKey

global

Create chunk for deleted rows
POST /api/v1/data-push/{poolId}/jobs/{id}/chunks/deleted
Parameters

Type

Name

Description

Schema

Path

id

required

Job Id

string

Path

poolId

required

poolId

string

FormData

chunk

required

Chunk file

file

Responses

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
  • multipart/form-data
Produces
  • \*/*
Tags
  • Chunk

  • Job

Security

Type

Name

Scopes

apiKey

Bearer

global

apiKey

AppKey

global

Create chunk for updated or created rows
POST /api/v1/data-push/{poolId}/jobs/{id}/chunks/upserted
Parameters

Type

Name

Description

Schema

Path

id

required

Job Id

string

Path

poolId

required

poolId

string

FormData

chunk

required

Chunk file

file

Responses

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
  • multipart/form-data
Produces
  • \*/*
Tags
  • Chunk

  • Job

Security

Type

Name

Scopes

apiKey

Bearer

global

apiKey

AppKey

global

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

CSVParsingOptions

dataPoolId

optional

string

fallbackVarcharLength

optional

integer

fileType

optional

enum (PARQUET, CSV)

keys

optional

< string > array

tableSchema

optional

TableTransport

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