Transformation Jobs

Transformation jobs let you list jobs and their metrics. A maximum of 1000 jobs per transformation are retained, provided they are not older than 90 days.

List jobs

Required capabilities: transformationsAcl:READ

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
query Parameters
transformationId
integer <int32>

List only jobs for the specified transformation. The transformation is identified by ID.

transformationExternalId
string

List only jobs for the specified transformation. The transformation is identified by external ID.

limit
integer <int32> [ 1 .. 1000 ]

Limits the number of results to be returned. The maximum is 1000, default limit is 100.

cursor
string

Cursor for paging through results.

Responses
200

Response with list of jobs.

400

The response for a failed request.

403

The response for a forbidden request.

get/transformations/jobs
Request samples 
transformation_jobs_list = client.transformations.jobs.list()

transformation_jobs_list = client.transformations.jobs.list(transformation_id=1)
Response samples
application/json
{
  • "items": [
    ],
  • "nextCursor": "string"
}

Retrieve jobs by ids

Required capabilities: transformationsAcl:READ

Retrieve a maximum of 1000 jobs by ids per request.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required
Array of objects (TransformationCogniteInternalId)
ignoreUnknownIds
boolean

Ignore IDs and external IDs that are not found. Defaults to false.

Responses
200

Response with list of jobs.

400

The response for a failed request.

403

The response for a forbidden request.

409

The response for a conflict.

post/transformations/jobs/byids
Request samples
application/json
{
  • "items": [
    ],
  • "ignoreUnknownIds": true
}
Response samples
application/json
{
  • "items": [
    ]
}

List job metrics by job id

Required capabilities: transformationsAcl:READ

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
path Parameters
id
required
integer <int32>

The job id.

Responses
200

Metrics for how many resources has been read/written by the transformation.

400

The response for a failed request.

403

The response for a forbidden request.

get/transformations/jobs/{id}/metrics
Request samples 
res = client.transformations.jobs.list_metrics(id=1)
Response samples
application/json
{
  • "items": [
    ]
}
➔ Next to Transformation Schedules