Jobs

A hosted extractor job represents the running extractor. Jobs produce logs and metrics that give the state of the job. For details on available states and metrics see documentation here.

List Jobs

Required capabilities: hostedExtractors:READ

List all jobs in a given project. If more than limit jobs exist, a cursor for pagination will be returned with the response.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
query Parameters
limit
integer [ 1 .. 100 ]
Default: 100

Limits the number of results to be returned. The maximum results returned by the server is 100 even if you specify a higher limit.

cursor
string

Cursor for paging through results. In general, if a response contains a nextCursor property, it means that there may be more results, and you should pass that value as the cursor parameter in the next request.

Note that the cursor may or may not be encrypted, but either way, it is not intended to be decoded. Its internal structure is not a part of the public API, and may change without notice. You should treat it as an opaque string and not attempt to craft your own cursors.

Example: cursor=4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo
source
string (Source)

External ID of source the returned jobs must be tied to.

destination
string (Destination)

External ID of destination the returned jobs must be tied to.

mapping
string (Mapping)

External ID of mapping the returned jobs must be tied to.

Responses
200

List of jobs and an optional cursor.

400

The response for a bad request.

422

Validation Error

get/hostedextractors/jobs
Request samples 
job_list = client.hosted_extractors.jobs.list(limit=5)

for job in client.hosted_extractors.jobs:
    job # do something with the job

for job_list in client.hosted_extractors.jobs(chunk_size=25):
    job_list # do something with the jobs
Response samples
application/json
{
  • "items": [
    ],
  • "nextCursor": "string"
}

Create Jobs

Required capabilities: hostedExtractors:READ hostedExtractors:WRITE

Create up to 10 jobs.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required

Jobs to create.

required
Array of objects (Items) [ 1 .. 10 ] items
Responses
200

Successful Response

400

The response for a bad request.

422

Validation Error

post/hostedextractors/jobs
Request samples
application/json
{
  • "items": [
    ]
}
Response samples
application/json
{
  • "items": [
    ]
}

Retrieve Jobs

Required capabilities: hostedExtractors:READ

Retrieve a list of up to 100 jobs by their external ID, optionally ignoring unknown IDs.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required

List of external IDs of jobs to retrieve.

required
Array of objects (Items) [ 1 .. 100 ] items
ignoreUnknownIds
boolean (IgnoreUnknownIds)

Ignore IDs and external IDs that are not found

Responses
200

List of retrieved jobs.

400

The response for a bad request.

422

Validation Error

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

Delete Jobs

Required capabilities: hostedExtractors:WRITE

Delete a list of jobs by their external ID.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required

List of external IDs of jobs to delete.

required
Array of objects (Items) [ 1 .. 100 ] items
ignoreUnknownIds
boolean (IgnoreUnknownIds)

Ignore IDs and external IDs that are not found

Responses
200

Empty response

400

The response for a bad request.

422

Validation Error

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

Get Job Logs

Required capabilities: hostedExtractors:READ

List logs, optionally filtering on job, source, or destination. Logs are retrieved in reverse chronological order.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
query Parameters
job
string (Job)

Require returned logs to belong to the job given by this external ID.

limit
integer [ 1 .. 1000 ]
Default: 100

Limits the number of results to be returned. The maximum results returned by the server is 1000 even if you specify a higher limit.

cursor
string

Cursor for paging through results. In general, if a response contains a nextCursor property, it means that there may be more results, and you should pass that value as the cursor parameter in the next request.

Note that the cursor may or may not be encrypted, but either way, it is not intended to be decoded. Its internal structure is not a part of the public API, and may change without notice. You should treat it as an opaque string and not attempt to craft your own cursors.

Example: cursor=4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo
source
string (Source)

Require returned logs to belong to the any job with source given by this external ID.

destination
string (Destination)

Require returned logs to belong to the any job with destination given by this external ID.

Responses
200

List of retrieved job logs

400

The response for a bad request.

422

Validation Error

get/hostedextractors/jobs/logs
Request samples 
res = client.hosted_extractors.jobs.list_logs(job="myJob")
Response samples
application/json
{
  • "items": [
    ]
}

Get Job Metrics

Required capabilities: hostedExtractors:READ

List metrics, optionally filtering on job, source, or destination. Logs are retrieved in reverse chronological order.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
query Parameters
job
string (Job)

Require returned metrics to belong to the job given by this external ID.

limit
integer [ 1 .. 1000 ]
Default: 100

Limits the number of results to be returned. The maximum results returned by the server is 1000 even if you specify a higher limit.

cursor
string

Cursor for paging through results. In general, if a response contains a nextCursor property, it means that there may be more results, and you should pass that value as the cursor parameter in the next request.

Note that the cursor may or may not be encrypted, but either way, it is not intended to be decoded. Its internal structure is not a part of the public API, and may change without notice. You should treat it as an opaque string and not attempt to craft your own cursors.

Example: cursor=4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo
source
string (Source)

Require returned metrics to belong to the any job with source given by this external ID.

destination
string (Destination)

Require returned metrics to belong to the any job with destination given by this external ID.

Responses
200

List of retrieved job metrics.

400

The response for a bad request.

422

Validation Error

get/hostedextractors/jobs/metrics
Request samples 
res = client.hosted_extractors.jobs.list_metrics(job="myJob")
Response samples
application/json
{
  • "items": [
    ]
}

Update Jobs

Required capabilities: hostedExtractors:WRITE

Update a list of up to 100 jobs.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required

Jobs to update.

required
Array of objects (Items) [ 1 .. 10 ] characters
Responses
200

List of updated jobs.

400

The response for a bad request.

422

Validation Error

post/hostedextractors/jobs/update
Request samples
application/json
{
  • "items": [
    ]
}
Response samples
application/json
{
  • "items": [
    ]
}
➔ Next to Destinations