Streams

Read the streams of a configuration.

Retrieving all streams of a configuration

get

This functionality is in preview mode - some of the features may not be fully operational yet.

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:

deltaFieldstringOptional

The source field whose value is tracked as the delta watermark. A delta run extracts only the records whose value is newer than the last run's.

Example: LASTCHANGEDATE

deltaFieldFormatstring · enumOptional

How the delta field's values are formatted, so they can be compared correctly.

Example: DATEPossible values:

compositeParentstringOptional

For a composite child stream, the name of the stream it contributes to.

Example: invoices

linkingFieldstringOptional

For a composite child stream, the source field holding its parent's key.

Example: INVOICE_ID

embedAttributestringOptional

For a composite child stream, the parent attribute its records are embedded into.

Example: lineItems

childStrategystring · enumOptional

How a composite child's records reach the parent object.

Example: EMBEDPossible values:

writeStrategystring · enumOptional

How an existing target object is updated. PATCH changes only the mapped fields and preserves everything else; REPLACE_PUT replaces the whole object, so fields this import does not manage are cleared.

Example: PATCHPossible values:

discriminatorFieldstringOptional

A source field whose value routes each record to a different target type, as defined by discriminatorMap.

Example: DOCUMENT_TYPE

targetDeleteSubscriptionEnabledbooleanOptional

Whether the stream reacts to its target objects being deleted outside the import.

Example: false

onTargetReappearstring · enumOptional

What happens when a record deleted in the target is seen in the source again.

Example: IGNOREPossible values:

createdAtstring · date-timeOptional

When the stream was created.

Example: 2024-05-01T09:00:00.000Z

enabledbooleanOptional

Whether the stream is active.

Example: true

401

Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.

application/json

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

application/json

500

Internal Service Error occurred.

application/json

get/importtool/{tenant}/configs/{configId}/streams

GET /importtool/{tenant}/configs/{configId}/streams HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "configId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "name": "Products",
    "sourceEntity": "PRODUCT",
    "targetWriter": "emporix.customEntity",
    "targetType": "product",
    "mode": "STANDALONE",
    "enabled": true
  }
]

Retrieving a stream

get

This functionality is in preview mode - some of the features may not be fully operational yet.

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:

deltaFieldstringOptional

The source field whose value is tracked as the delta watermark. A delta run extracts only the records whose value is newer than the last run's.

Example: LASTCHANGEDATE

deltaFieldFormatstring · enumOptional

How the delta field's values are formatted, so they can be compared correctly.

Example: DATEPossible values:

compositeParentstringOptional

For a composite child stream, the name of the stream it contributes to.

Example: invoices

linkingFieldstringOptional

For a composite child stream, the source field holding its parent's key.

Example: INVOICE_ID

embedAttributestringOptional

For a composite child stream, the parent attribute its records are embedded into.

Example: lineItems

childStrategystring · enumOptional

How a composite child's records reach the parent object.

Example: EMBEDPossible values:

writeStrategystring · enumOptional

How an existing target object is updated. PATCH changes only the mapped fields and preserves everything else; REPLACE_PUT replaces the whole object, so fields this import does not manage are cleared.

Example: PATCHPossible values:

discriminatorFieldstringOptional

A source field whose value routes each record to a different target type, as defined by discriminatorMap.

Example: DOCUMENT_TYPE

targetDeleteSubscriptionEnabledbooleanOptional

Whether the stream reacts to its target objects being deleted outside the import.

Example: false

onTargetReappearstring · enumOptional

What happens when a record deleted in the target is seen in the source again.

Example: IGNOREPossible values:

createdAtstring · date-timeOptional

When the stream was created.

Example: 2024-05-01T09:00:00.000Z

enabledbooleanOptional

Whether the stream is active.

Example: true

401

Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.

application/json

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

application/json

404

The requested resource does not exist.

application/json

500

Internal Service Error occurred.

application/json

get/importtool/{tenant}/streams/{id}

GET /importtool/{tenant}/streams/{id} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "configId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "name": "Products",
  "sourceEntity": "PRODUCT",
  "targetWriter": "emporix.customEntity",
  "targetType": "product",
  "mode": "STANDALONE",
  "enabled": true
}