For the complete documentation index, see llms.txt. This page is also available as Markdown.

Streams

Read the streams of a configuration.

Retrieving all streams of a configuration

get

Retrieves the streams belonging to a configuration, ordered by sequence.

Required scopes
This endpoint requires the following scopes:
  • : Needed to trigger, schedule, monitor, and cancel import runs and to read configurations, streams, schedules, runs, and imported data.
Authorizations
OAuth2clientCredentialsRequired
Token URL:
Path parameters
tenantstringRequired

The tenant you want to access.

Example: mytenant
configIdstring · uuidRequired

The configuration identifier.

Example: 7c9e6679-7425-40de-944b-e07fc1f90ae7
Responses
200

The request was successful. The streams are returned.

application/json

A stream that extracts from a source, maps fields, and upserts into an Emporix target type.

idstring · uuidOptional

The stream identifier.

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
configIdstring · uuidOptional

The parent configuration.

Example: 7c9e6679-7425-40de-944b-e07fc1f90ae7
namestringOptional

The stream name.

Example: Products
sourceEntitystringOptional

The logical source entity or record.

Example: PRODUCT
targetWriterstringOptional

The target writer code, for example emporix.customEntity.

Example: emporix.customEntity
targetTypestringOptional

The default target type (custom-entity type identifier).

Example: product
modestring · enumOptional

How the stream contributes to the target.

Example: STANDALONEPossible values:
enabledbooleanOptional

Whether the stream is active.

Example: true
get/importtool/{tenant}/configs/{configId}/streams

Retrieving a stream

get

Retrieves a single stream by its identifier, including its resolved target types.

Required scopes
This endpoint requires the following scopes:
  • : Needed to trigger, schedule, monitor, and cancel import runs and to read configurations, streams, schedules, runs, and imported data.
Authorizations
OAuth2clientCredentialsRequired
Token URL:
Path parameters
tenantstringRequired

The tenant you want to access.

Example: mytenant
idstring · uuidRequired

The resource identifier.

Example: 7c9e6679-7425-40de-944b-e07fc1f90ae7
Responses
200

The request was successful. The stream is returned.

application/json

A stream that extracts from a source, maps fields, and upserts into an Emporix target type.

idstring · uuidOptional

The stream identifier.

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
configIdstring · uuidOptional

The parent configuration.

Example: 7c9e6679-7425-40de-944b-e07fc1f90ae7
namestringOptional

The stream name.

Example: Products
sourceEntitystringOptional

The logical source entity or record.

Example: PRODUCT
targetWriterstringOptional

The target writer code, for example emporix.customEntity.

Example: emporix.customEntity
targetTypestringOptional

The default target type (custom-entity type identifier).

Example: product
modestring · enumOptional

How the stream contributes to the target.

Example: STANDALONEPossible values:
enabledbooleanOptional

Whether the stream is active.

Example: true
get/importtool/{tenant}/streams/{id}

Last updated

Was this helpful?