CopyEntities resource
Use the CopyEntities resource to copy streaming ingestion tasks.
POST request
To copy streaming ingestion tasks, use the following URL:
<server URI>/sisvc/restapi/v1/CopyEntities
You can include the following fields in the request:
Field | Type | Required | Description |
|---|
targetLocationID | String | Yes | ID of the target location to copy the objects to. |
sourceEntities | Array | Yes | Configuration of the source and target connections. |
sourceId | String | Yes | ID of the source object. |
targetName | String | Yes | Name of the target object. |
targetDescription | String | - | Description of the target object. |
POST request example
To copy two streaming ingestion tasks, you might send a request similar to the following example:
POST <serverUrl>/sisvc/restapi/v1/CopyEntities
Content-Type: application/json
Accept:application/json
IDS-SESSION-ID:2l0oeVx22Rujiej7yTokmT
{
"targetLocationID": "2RGmVdwN15PbfnQP5PSoSB",
"sourceEntities": [
{
"sourceId": "5Ff6jeaSh2UfAqiV01ldKD",
"targetName": "Test_Copy_A",
"targetDescription": "Description_1"
},
{
"sourceId": "fZnCSqcWTOQkJOr8VCWZQE",
"targetName": "Test_Copy_B",
"targetDescription": "Description_2"
}
]
}
If the request is unsuccessful, the response includes a reason for the failure.
POST response
When you use a POST request to copy streaming ingestion tasks, it returns a success response if successful or an error object if an error occurs.
POST response example
If the request is successful, you might receive a response similar to the following example:
{
"Status Message": "Operation succeeded on 2 artifacts.",
"Success": {
"Test_Copy_A": "ideNJw6l54gizxofF53HQH",
"Test_Copy_B": "cOQ3gcWKSYikzVqqg6IOok"
}
}