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": "B1aA2110-cAce-eFbD-ca3a-4fe073Be218C",
"location": "Application",
"view": "in amet nisi",
"status": "error",
"app": "aliquip dolor non ullamco",
"name": "reprehenderit",
"variables": {
"decorators": [
{
"type": "encryption",
"pointer": "/jG/~1/L-3nhczD/~0/ThM/~0/A/~0/VGg.+8ue4Kj/g"
},
{
"type": "encryption",
"pointer": "/~1"
},
{
"type": "encryption",
"pointer": "/~1/McPuli/hxer08/JapO/GKZ"
},
{
"type": "encryption",
"pointer": "/aDer/qc-cePU,XyL/bPGO3ERbh/~1/~0/LlJHdy"
}
]
},
"last_updated": "1991-05-01T02:45:51.346Z",
"encodingVersion": 1,
"job": {
"_id": "a66045e906b0a34c5ed6d8d4",
"task": "3a1f",
"name": "myCoolDocumentName",
"description": "Some helpful information about the document",
"ancestors": null
},
"incomingRefs": [],
"groups": [
{
"_id": "974490f51141e66af8b42fee",
"provenance": "non dolor incididunt in ad",
"name": "ut ullamco ad ea minim",
"description": "pariatur non",
"memberOf": [
{
"groupId": "68b15052e16f3276e523c44f",
"aaaManaged": false
}
],
"assignedRoles": [
{
"roleId": "cupidatat enim nostrud"
}
],
"inactive": false,
"_meta": {
"created": "2012-08-26T21:59:12.815Z",
"updated": "2025-04-02T19:50:51.968Z",
"migrationVersion": -41894928
}
},
"5551ec9cca6a3aecf559d00b"
],
"type": "manual",
"metrics": {
"start_time": "esse",
"claim_time": "1956-11-21T14:45:47.255Z",
"end_time": 26873294.181497127,
"server_id": "minim enim in velit",
"finish_state": "success",
"run_time": -28726146.63969153,
"user": "Pronghorn",
"owner": {
"_id": "5574497c28e010af8170bcd9",
"provenance": "labore cillum",
"username": "enim",
"firstname": "voluptate",
"memberOf": [
{
"groupId": "7871fdb3efba3a26f2cf664a",
"aaaManaged": false
},
{
"groupId": "363ef648cb1953f8a7eeefac",
"aaaManaged": true
},
{
"groupId": "334a54289ca4d013f39c286f",
"aaaManaged": true
}
],
"assignedRoles": [
{
"roleId": "exercitation"
}
],
"inactive": false,
"lastLogin": "1987-03-15T18:39:33.096Z",
"_meta": {
"created": "1981-08-27T00:59:27.554Z",
"updated": "1981-09-25T01:03:04.016Z",
"migrationVersion": 34640829
},
"email": "dolor ipsum culpa sint"
}
}
}
}