Extraction Pipelines Runs

Extraction Pipelines Runs are CDF objects to store statuses related to an extraction pipeline. The supported statuses are: success, failure and seen. The statuses are related to two different types of operation of the extraction pipeline. Success and failure indicate the status for a particular EP run where the EP attempts to send data to CDF. If the data is successfully posted to CDF the status of the run is ‘success’; if the run has been unsuccessful and the data is not posted to CDF, the status of the run is ‘failure’. Message can be stored to explain run status. Seen is a heartbeat status that indicates that the extraction pipeline is alive. This message is sent periodically on a schedule and indicates that the extraction pipeline is working even though data may not have been sent to CDF by the extraction pipeline.

List extraction pipeline runs

Required capabilities: extractionrunsAcl:READ

List of all extraction pipeline runs for a given extraction pipeline. Sorted by createdTime value with descendant order.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
query Parameters
externalId
required
string
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
Responses
200

Response with list of extraction pipeline runs

get/extpipes/runs
Response samples
application/json
{
  • "items": [
    ],
  • "nextCursor": "string"
}

Create extraction pipeline runs

Required capabilities: extractionrunsAcl:WRITE datasetsAcl:READ

Create multiple extraction pipeline runs. Current version supports one extraction pipeline run per request. Extraction pipeline runs support three statuses: success, failure, seen. The content of the Error Message parameter is configurable and will contain any messages that have been configured within the extraction pipeline.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required
required
Array of objects (ExtPipeRunRequest) [ 1 .. 1000 ] items
Responses
200

Response with list of extraction pipeline runs

400

Response for a failed request

post/extpipes/runs
Request samples
application/json
{
  • "items": [
    ]
}
Response samples
application/json
{
  • "items": [
    ]
}

Filter extraction pipeline runs

Required capabilities: extractionrunsAcl:READ

Use advanced filtering options to find extraction pipeline runs. Sorted by createdTime value with descendant order.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required
required
object (RunsFilter)
limit
integer <int32> [ 1 .. 1000 ]
Default: 100

Limits the number of results to return.

cursor
string
Responses
200

Response with list of extraction pipeline runs

400

Response for a failed request

post/extpipes/runs/list
Request samples
application/json
{
  • "filter": {
    },
  • "limit": 100,
  • "cursor": "string"
}
Response samples
application/json
{
  • "items": [
    ],
  • "nextCursor": "string"
}
➔ Next to Extraction Pipelines Config