Summary
Claim a task
Description
Assign a Task to the current user.
Route
POST /operations-manager/tasks/:taskId/claim
Roles
admin
apiwrite
engineering
operations
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| taskId |
string |
yes |
The id of the Task iteration to be claimed. |
Copied to Clipboard
{
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| result |
object |
The result of the claim operation. |
Copied to Clipboard
{
"message": "Successfully imported 3 of 4 documents",
"data": {
"_id": "FDeDF6e7-Ba6E-31Cc-211d-eCcE5Cd041Bf",
"location": "Application",
"view": "sunt veniam ea",
"status": "running",
"app": "aliqua nisi occaecat incididunt",
"name": "commodo voluptate Excepteur qui",
"variables": {
"decorators": [
{
"type": "encryption",
"pointer": "/~0/~1/~0/h/bTqbs693qN7"
},
{
"type": "encryption",
"pointer": "/m/MQR.ce+E"
}
]
},
"last_updated": "2024-07-14T13:08:27.007Z",
"encodingVersion": 1,
"job": {
"_id": "c39a225ddc386d4b387bd505",
"task": "3a1f",
"name": "myCoolDocumentName",
"description": "Some helpful information about the document",
"ancestors": [
"2be021254d7c797e740ce073",
"96856e12ea262039dadf1d9f",
"14bb526fa22438c7a96699b3",
"20380a02ea498a8761ca31a6"
]
},
"incomingRefs": [],
"groups": [
"0bdd3b07c10eca36647bca40",
{
"_id": "9e891e295fa042efa5482080",
"provenance": "enim ex",
"name": "Ut Excepteur eiusmod esse",
"description": "eiusmod",
"memberOf": [
{
"groupId": "23319edec0dac168984295c3",
"aaaManaged": true
},
{
"groupId": "2f2d720e9aaabda7e69acd5a",
"aaaManaged": true
}
],
"assignedRoles": [
{
"roleId": "consequat enim aliqua"
},
{
"roleId": "eiusmod occaecat dolor sed"
}
],
"inactive": true,
"_meta": {
"created": "1950-09-28T05:55:42.539Z",
"updated": "1951-05-29T11:56:16.148Z",
"migrationVersion": -68888445
}
},
{
"_id": "bf2d635e682d9838f0dfb1b2",
"provenance": "in veniam proident cupidatat eu",
"name": "minim",
"description": "sunt consequat sed cupidatat",
"memberOf": [
{
"groupId": "3372de3c6767aa7c8a049c7a",
"aaaManaged": true
},
{
"groupId": "442bd60a9e754c2e54074079",
"aaaManaged": false
}
],
"assignedRoles": [
{
"roleId": "aliquip culpa sunt ea"
},
{
"roleId": "nulla do in"
},
{
"roleId": "in quis est"
},
{
"roleId": "dolor"
}
],
"inactive": true,
"_meta": {
"created": "1958-05-07T18:49:55.611Z",
"updated": "2017-06-17T11:29:48.448Z",
"migrationVersion": 27464757
}
},
"e78ef37f5099fd5cdba25f8b"
],
"type": "automatic",
"metrics": {
"start_time": "ex dolore Ut velit qui",
"end_time": -82199224.95831007,
"server_id": "eu ipsum deserunt",
"finish_state": "complete",
"run_time": -79657294.82077974,
"retrying": null,
"user": "0527a9b3342573d29e20dd76",
"owner": "22eac4156f4b96abff76f9dc"
}
}
}