GET v1/jobs-queue/{environment}/{orgId}/cloning-queue
This endpoint will upgrade to a web socket handshake when the request is a web socket request (Upgrade: websocket) or simply return a json if the request is a standard HTTP web request.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| environment |
Environment where the org originated from. |
string |
Required |
| orgId |
Organization Id |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Upgrades to a websocket connection when requested or returns the list of active clone tasks.
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
Sample:
{
"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"
}
}
]
}