REST API Reference

Back Next

Updating a streaming ingestion and replication task

Updating a
streaming ingestion and replication
task

Use the UpdateEntity resource to update a

streaming ingestion and replication

task. You can update

streaming ingestion and replication

tasks that use the following connectors: Amazon Kinesis, Amazon S3 V2, Microsoft Azure Event Hub, Microsoft Azure Data Lake Storage Gen2, Flat file, JDBC V2, JMS, Kafka, or MQTT.

POST request

Use a POST request to update a

streaming ingestion and replication

task.

To update a

streaming ingestion and replication

task, use the following URL:

<server URI>/sisvc/restapi/v1/UpdateEntity/Documents('<document ID>')

You can include the following fields in the request:

Field	Type	Required	Description
name	String	Yes	Name of the task.
description	String	-	Description of the task.
runtimeId	String	Yes	ID of the runtime environment.
currentVersion	String	Yes	The latest dataflow object version.
nodes	Array	Yes	Details of the task source and target connections.

Fields of the nodes array

The fields in the array provide the name, type, and connection ID of the connection. It includes the configuration of the source and target connections in key-value pairs which you can edit. You can include the following fields in the nodes array:

Field	Type	Required	Description
name	String	Yes	Name of the connection.
type	String	Yes	The connection type, source or target.
connectionId	String	Yes	ID of the connection.
transformationType	String	-	Not applicable.
config	Array	Yes	Configuration of the source and target connections.

POST response

When the REST API successfully performs an action, it returns a 200 or 201 success response. When the REST API encounters an error, it returns an appropriate error code.

If the request is successful, the response returns the following fields:

Field	Type	Description
name	String	Name of the task.
description	String	Description of the task, if available.
runtimeId	String	ID of the runtime environment.
currentVersion	String	The latest dataflow object version.
nodes	Array	Details of the task source and target connections.

Fields of the nodes array

The response includes the following fields in the nodes array:

Field	Type	Description
name	String	Name of the connection.
type	String	The connection type.
connectionId	String	ID of the connection.
transformationType	String	The type of transformation.
config	String	Configuration of the source and target connections in key-value pairs. The keys in the array depend on the type of source and target connections.