Manage Objects in a Pipeline (POST)

post

https://us.hevodata.com/api/v2/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 the load mode and the fields for the selected objects.

Note: Use this endpoint if you cannot send a PATCH request. Otherwise, use the Manage Objects in a Pipeline (PATCH) endpoint, which performs the same update.

In the request body, list only the objects that you want to change. Hevo keeps the current settings of every object that you do not list, so you do not need to send the full list each time.

The following rules apply to the objects that you name in the request:

The rule for a child object depends on the group it belongs to. A child object that Hevo replicates along with its parent cannot be selected on its own, and takes the selection of its parent. You can still name such a child to change its load mode or its fields, as long as the request gives it the same selection as its parent object.
A child object that needs its parent can be selected only while the parent stays selected after the request. Select the parent object in the same request.
The effect on the child objects depends on the child_selection_mode of the parent. If it is AUTO_FOLLOW_HEAD, selecting or clearing the parent applies the same selection to the child objects, unless you name them yourself. If it is REQUIRE_HEAD_SELECTED, clearing the parent clears the child objects, and selecting the parent leaves them unselected.
If the List All Pipeline Objects endpoint does not return the selectable field for an object, you may not be able to name its child objects in the request. In that case, change the parent object instead, and the child objects take its selection. Such an object may also not be able to use the MERGE load mode if it has no primary key. Hevo applies this check only once it knows the fields of the object.
An object that Hevo marks as not selectable cannot be selected. If the status of an object does not allow a change, remove that object from the request.
Unless the Pipeline is disabled, the request must keep at least one object of the Pipeline selected for replication. A disabled Pipeline may be left with nothing selected.

Refer to Managing Objects in Pipelines for more information about load modes, fields, and object groups.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

pipeline_id

int64

required

≥ 1

Unique identifier of the Pipeline.

Body Params

selection_mode

string

enum

Defaults to RETAIN_EXISTING

Determines the objects selected for replication in the Pipeline. This field is optional and defaults to RETAIN_EXISTING. Its value is not case-sensitive.

Any other value returns a 400.

Show Details

INCLUDE_ALL	Selects all Source objects for replication except the ones you exclude.
EXCLUDE_ALL	Excludes all Source objects except the ones you include.
RETAIN_EXISTING	Keeps the current selection without changing which objects are replicated.

Allowed:

objects

array of objects

List of the objects that you want to change. List each object only once. This field is required when selection_mode is RETAIN_EXISTING, and it must then hold at least one object. With INCLUDE_ALL or EXCLUDE_ALL, you can leave this list out or send it empty.

objects

Responses

400

The object selection could not be updated. This occurs when:

The request has no body.
The selection_mode value is RETAIN_EXISTING, and the objects list is empty or missing.
The request names the same object twice, or contains an entry without name or selected.
A load_mode value is not one that the object supports.
The request sets primary_keys, which this endpoint does not accept. Primary keys come from your Source and cannot be set or changed through the API. Use include_fields and exclude_fields to choose the fields that Hevo replicates.
The request selects an object that has hashed columns. This includes a child object that the change would select.
The Pipeline is in a state that does not allow an edit, such as Failed. You can edit a Pipeline only from the Initialized or Disabled state.

403

You do not have the permission to modify a Pipeline. Ask your team administrator for a role that allows it.

404

The Pipeline or an object could not be found. This occurs when:

No Pipeline exists with the specified pipeline_id, or you do not have access to it.
The Pipeline is deleted, or its deletion is in progress.
The Pipeline is in a different region from the base URL that you call.
An object that you name does not belong to the Pipeline.

409

The object selection could not be updated. This occurs when:

The Pipeline is changing state.
Another edit is in progress, in the Hevo UI or through the API.

Retry the request once the Pipeline is in the Initialized or Disabled state.