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 retrieved search results",
"data": {
"_id": "e2c287f7-9FAb-7D2a-A10d-5BA9Fe00EbFf",
"location": "Application",
"view": "minim ullamco Duis anim ut",
"status": "canceled",
"app": "Duis commodo eu minim dolore",
"name": "velit enim nulla et dolore",
"variables": {
"decorators": [
{
"type": "encryption",
"pointer": "/~1/cl1ylECKGd/zqXEDJG0O/~0/JIMW.Msq/y/~1"
},
{
"type": "encryption",
"pointer": "/~0/DA16BAqQ/zx02fVepV/N2akZrc/i/x9F4QKu5E/EfK.TABBc/~1/~0"
},
{
"type": "encryption",
"pointer": "/~0/~1/H8Uoa5clR5"
},
{
"type": "encryption",
"pointer": "/~1/~1/~1/~1/~1"
},
{
"type": "encryption",
"pointer": "/~0/fOuG7/~1/~0/~0/~0/~1/EKul/Pj75Evd1Zd2/u5/~0"
}
]
},
"last_updated": "1977-08-25T07:14:33.276Z",
"encodingVersion": 1,
"job": {
"_id": "9d925c48387bb9cb1eb38938",
"task": "b4f",
"name": "myCoolDocumentName",
"description": "Some helpful information about the document",
"ancestors": [
"7fed03680c9ac2419a34a6ea"
]
},
"incomingRefs": [],
"groups": [
"34d2e8b03900c6afb5b3232d",
"34761c1aee105da7e58b454b",
"ecb44e3fd88b4176b186e9ab"
],
"type": "automatic",
"metrics": {
"start_time": "sint",
"end_time": 51464402.31312844,
"server_id": "commodo",
"finish_state": "scheduled",
"run_time": 33073459.949512035,
"retrying": true,
"user": {
"_id": "1c21ab0534bde5d68984fb80",
"provenance": "quis Duis magna non mollit",
"username": "et officia nostrud",
"firstname": "in qui in aliqua cillum",
"memberOf": [
{
"groupId": "377e9a4998aea8eb2c7d6d10",
"aaaManaged": true
}
],
"assignedRoles": [
{
"roleId": "laborum in ex officia"
},
{
"roleId": "sit dolore labore"
},
{
"roleId": "mollit eiusmod dolor ad Duis"
}
],
"inactive": false,
"lastLogin": "1983-07-30T02:57:58.179Z",
"_meta": {
"created": "2022-01-17T09:37:46.198Z",
"updated": "2000-01-04T17:10:59.294Z",
"migrationVersion": 10867854
},
"email": "laborum nostrud minim esse sit"
},
"owner": {
"_id": "ceed2a30d4edc29743b739bc",
"provenance": "officia ex",
"username": "mollit",
"firstname": "ut",
"memberOf": [
{
"groupId": "f6c6aa1ef70616d8913f3b5b",
"aaaManaged": false
},
{
"groupId": "c222ca7439f76d701705d989",
"aaaManaged": true
},
{
"groupId": "ea330aa5d4d2b566f13ada6e",
"aaaManaged": false
}
],
"assignedRoles": [
{
"roleId": "Duis"
},
{
"roleId": "id dolor"
},
{
"roleId": "incididunt"
}
],
"inactive": false,
"lastLogin": "2014-01-10T14:18:38.332Z",
"_meta": {
"created": "1975-04-11T16:23:52.336Z",
"updated": "2025-07-23T02:08:38.317Z",
"migrationVersion": -66462337
},
"email": "in"
}
}
}
}