Manage Objects in a Pipeline

patch

https://us.hevodata.com/api/v1/pipelines/{pipeline_id}/objects

Allows you to control which Source objects are replicated in the specified pipeline_id. You can select all objects, exclude all objects, or retain the existing selection. You can also configure load mode, primary keys, and fields for selected objects.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

pipeline_id

int64

required

≥ 1

Unique identifier of the Pipeline.

Body Params

Request body to disable a Pipeline.

selection_mode

string

enum

required

Determines the objects selected for replication in the Pipeline.

Show Details

INCLUDE_ALL	Selects all Source objects for replication except the ones listed in the exclude_objects parameter.
EXCLUDE_ALL	Excludes all Source objects except those listed in the include_objects parameter.
RETAIN_EXISTING	Keeps the current selection without changing which objects are replicated.

Allowed:

include_objects

array of objects, unique

List of objects to include for replication in the Pipeline. Required when selection_mode is EXCLUDE_ALL.

include_objects

exclude_objects

array of uuids, unique

List of objects to exclude from replication in the Pipeline. Required when selection_mode is INCLUDE_ALL.

exclude_objects

Response

204

Successfully updated the object selection for the specified pipeline_id.

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here!