Extraction Pipelines Config

Extraction Pipelines Configs are configuration file revisions tied to an extraction pipeline. Users can create new configuration revisions, and extractors can fetch the latest, making it easy to deploy configuration files from source control, automated scripts, etc.

Get a single configuration revision

Required capabilities: extractionconfigsAcl:READ

Retrieves a single configuration revision. By default, the latest revision is retrieved.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
query Parameters
externalId
required
string
revision
integer <int32> >= 0
Default: 0
activeAtTime
integer <int64> >= 0
Default: 0
Responses
200

Response with the retrieved configuration revision

400

Response for a failed request

get/extpipes/config
Response samples
application/json
{
  • "externalId": "string",
  • "config": "string",
  • "revision": 2147483647,
  • "createdTime": 1730204346000,
  • "description": "string"
}

Create extraction configuration revision

Required capabilities: extractionconfigsAcl:WRITE

Creates a configuration revision for the given extraction pipeline.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required
externalId
required
string [ 1 .. 255 ] characters

External ID of the extraction pipeline this configuration revision belongs to.

config
string

Configuration content.

description
string or null

A description of this configuration revision.

Responses
200

Response with the created configuration revision

400

Response for a failed request

post/extpipes/config
Request samples
application/json
{
  • "externalId": "string",
  • "config": "string",
  • "description": "string"
}
Response samples
application/json
{
  • "externalId": "string",
  • "config": "string",
  • "revision": 2147483647,
  • "createdTime": 1730204346000,
  • "description": "string"
}

List configuration revisions

Required capabilities: extractionconfigsAcl:READ

Lists configuration revisions for the given extraction pipeline.

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 the retrieved configuration revisions and an optional cursor

400

Response for a failed request

get/extpipes/config/revisions
Response samples
application/json
{
  • "items": [
    ]
}

Revert configuration revision

Required capabilities: extractionconfigsAcl:WRITE

Reverts the latest configuration revision to an older revision. Equivalent to creating a new revision identical to the old revision.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required
externalId
required
string [ 1 .. 255 ] characters

External ID of the extraction pipeline to revert configurations for.

revision
integer <int32> [ 0 .. 2147483647 ]

Revision number of this configuration.

Responses
200

Response with the new latest configuration revision

400

Response for a failed request

post/extpipes/config/revert
Request samples
application/json
{
  • "externalId": "string",
  • "revision": 2147483647
}
Response samples
application/json
{
  • "externalId": "string",
  • "config": "string",
  • "revision": 2147483647,
  • "createdTime": 1730204346000,
  • "description": "string"
}
➔ Next to Extractors