POST v1/application/{environment}/{orgId}/{appId}/clone?level={level}
Use this endpoint to create one or more level cloning background tasks.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| environment |
Environment where the org originated from. |
string |
Required |
| orgId |
Organization Id |
integer |
Required |
| appId |
Application Id |
integer |
Required |
| level |
Optional parameter to define the source level, if not provided TopLevel is assumed. |
string |
None. |
Body Parameters
Structure that defines the data to be cloned, as well as one or more destination targets to clone into.
LevelCloneModel| Name | Description | Type | Additional information |
|---|---|---|---|
| kind |
//This field is used to specify the kind of operation to be performed. Wipe performs deletion of all contents in target prior to cloning, new create an entire new layer at destination app. |
string |
None. |
| copies |
Number of copies to be made, if null, not present or less than 1, it will default to 1. |
integer |
None. |
| targets |
Structure defining one or multiple targets for this clone operation. |
Collection of TargetCloneModel |
None. |
Request Formats
application/json, text/json
{
"kind": "sample string 1",
"copies": 1,
"targets": [
{
"appId": 1,
"levels": [
"sample string 1",
"sample string 2"
],
"topLevel": true
},
{
"appId": 1,
"levels": [
"sample string 1",
"sample string 2"
],
"topLevel": true
}
]
}
Response Information
Resource Description
Returns a Task collection payload with information for each task scheduled, and optionally error descriptions found while validating the targets availability.
CloneTaskCollectionModel| Name | Description | Type | Additional information |
|---|---|---|---|
| type |
Used only by the web socket communication payload to indicate if the collection contains all clone operations or only the subset of operations that have changed since the connection was established. |
string |
None. |
| tasks |
List of clone tasks in this collection |
Collection of CloneTaskModel |
None. |
Response Formats
application/json, text/json
{
"type": "sample string 1",
"tasks": [
{
"id": "sample string 1",
"status": "sample string 2",
"copies": 1,
"kind": "sample string 3",
"source": {
"appId": 1,
"pages": [
"sample string 1",
"sample string 2"
],
"level": {
"id": "sample string 1",
"name": "sample string 2"
},
"topLevel": true
},
"target": {
"appId": 1,
"levels": [
{
"id": "sample string 1",
"name": "sample string 2"
},
{
"id": "sample string 1",
"name": "sample string 2"
}
],
"topLevel": true
},
"errors": {
"levels": [
{
"description": "sample string 1",
"pages": [],
"id": "sample string 2",
"name": "sample string 3"
},
{
"description": "sample string 1",
"pages": [],
"id": "sample string 2",
"name": "sample string 3"
}
],
"pages": [
{
"description": "sample string 1",
"pages": [],
"id": "sample string 2",
"name": "sample string 3"
},
{
"description": "sample string 1",
"pages": [],
"id": "sample string 2",
"name": "sample string 3"
}
],
"topLevel": true,
"description": "sample string 1"
}
},
{
"id": "sample string 1",
"status": "sample string 2",
"copies": 1,
"kind": "sample string 3",
"source": {
"appId": 1,
"pages": [
"sample string 1",
"sample string 2"
],
"level": {
"id": "sample string 1",
"name": "sample string 2"
},
"topLevel": true
},
"target": {
"appId": 1,
"levels": [
{
"id": "sample string 1",
"name": "sample string 2"
},
{
"id": "sample string 1",
"name": "sample string 2"
}
],
"topLevel": true
},
"errors": {
"levels": [
{
"description": "sample string 1",
"pages": [],
"id": "sample string 2",
"name": "sample string 3"
},
{
"description": "sample string 1",
"pages": [],
"id": "sample string 2",
"name": "sample string 3"
}
],
"pages": [
{
"description": "sample string 1",
"pages": [],
"id": "sample string 2",
"name": "sample string 3"
},
{
"description": "sample string 1",
"pages": [],
"id": "sample string 2",
"name": "sample string 3"
}
],
"topLevel": true,
"description": "sample string 1"
}
}
]
}