For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Open sourceSupportFAQsDocs Home
DocumentationAPI referenceRelease notes
DocumentationAPI referenceRelease notes
  • Introduction
    • Overview
    • Authentication
  • Guides
    • Operations Manager search APIs
    • Search API
    • URL query parameters
    • Use query parameters in API requests
  • Reference
        • POSTAdd GBAC to a job
        • POSTAdd watchers to a job
        • POSTAssign a task to a user
        • POSTBulk delete root jobs
        • POSTCancel jobs
        • POSTClaim a task
        • POSTClone automation
        • POSTContinue a job from a specified task
        • POSTCreate automation
        • POSTCreate trigger
        • DELDelete a root job and all related items
        • DELDelete automation
        • POSTDelete root jobs and related items
        • DELDelete trigger
        • DELDelete triggers by action ID
        • GETExport automation
        • GETExport large data for a job or task variable
        • GETExport trigger
        • POSTFinish a manual task
        • GETGet a job
        • GETGet a task by ID
        • GETGet automation
        • GETGet automations
        • GETGet event definition
        • GETGet jobs
        • GETGet manual task controller
        • GETGet tasks
        • GETGet trigger
        • GETGet triggers
        • PUTImport automations
        • PUTImport triggers
        • POSTPauses jobs
        • POSTRelease a currently assigned task
        • DELRemove all GBAC from a job
        • DELRemove GBAC from a job
        • PUTReplace all GBAC from a job with the provided list
        • POSTResume jobs
        • POSTRetry a task
        • POSTRevert a job
        • POSTRun endpoint trigger with POST
        • POSTRun manual trigger
        • GETSearch system events
        • POSTStart a job
        • POSTUnwatch job
        • POSTUnwatch jobs
        • PATCHUpdate automation
        • PATCHUpdate trigger
        • POSTValidate automation
        • POSTValidate trigger
        • POSTWatch a job
        • POSTWatch jobs
LogoLogo
Open sourceSupportFAQsDocs Home
ReferenceOperations Manager

Claim a task

POST
http://localhost:3000/operations-manager/tasks/:taskId/claim
POST
/operations-manager/tasks/:taskId/claim
$curl -X POST http://localhost:3000/operations-manager/tasks/taskId/claim \
>     -u "<username>:<password>"
1{
2  "message": "Successfully created the requested item",
3  "data": {
4    "_id": "string",
5    "location": "Adapter",
6    "view": "/workflow_engine/task/ViewData",
7    "status": "incomplete",
8    "app": "WorkFlowEngine",
9    "name": "ViewData",
10    "variables": {
11      "incoming": {},
12      "outgoing": {},
13      "decorators": [
14        {
15          "type": null,
16          "pointer": "string"
17        }
18      ]
19    },
20    "last_updated": "2024-01-15T09:30:00Z",
21    "encodingVersion": 1,
22    "job": {
23      "_id": "string",
24      "task": "e28f",
25      "name": "Cisco IOS upgrade",
26      "description": "View Task Data",
27      "ancestors": [
28        "string"
29      ]
30    },
31    "incomingRefs": [
32      "string"
33    ],
34    "mockId": "string",
35    "groups": [
36      {
37        "_id": "string",
38        "provenance": "Local AAA",
39        "name": "admin",
40        "description": "string",
41        "memberOf": [
42          {
43            "groupId": "string",
44            "aaaManaged": true
45          }
46        ],
47        "assignedRoles": [
48          {
49            "roleId": "66ec91e12b18975149d9e0d9"
50          }
51        ],
52        "inactive": true,
53        "_meta": {
54          "created": "2024-01-15T09:30:00Z",
55          "updated": "2024-01-15T09:30:00Z",
56          "migrationVersion": 1
57        }
58      }
59    ],
60    "type": null,
61    "metrics": {
62      "start_time": [
63        "2025-03-11T19:03:31.515Z"
64      ],
65      "claim_time": "2024-01-15T09:30:00Z",
66      "end_time": 1740438512495,
67      "server_id": "9349c650f70d50e4fe89c95327b7d4d9e6b5228ac83fe4fae120045b37b67860",
68      "finish_state": null,
69      "run_time": 5,
70      "user": {
71        "_id": "string",
72        "provenance": "Local AAA",
73        "username": "admin@pronghorn",
74        "firstname": "admin",
75        "memberOf": [
76          {
77            "groupId": "string",
78            "aaaManaged": true
79          }
80        ],
81        "assignedRoles": [
82          {
83            "roleId": "66ec91e12b18975149d9e0d9"
84          }
85        ],
86        "inactive": true,
87        "lastLogin": "2024-01-15T09:30:00Z",
88        "_meta": {
89          "created": "2024-01-15T09:30:00Z",
90          "updated": "2024-01-15T09:30:00Z",
91          "migrationVersion": 1
92        },
93        "email": "admin@itential.com"
94      },
95      "owner": {
96        "_id": "string",
97        "provenance": "Local AAA",
98        "username": "admin@pronghorn",
99        "firstname": "admin",
100        "memberOf": [
101          {
102            "groupId": "string",
103            "aaaManaged": true
104          }
105        ],
106        "assignedRoles": [
107          {
108            "roleId": "66ec91e12b18975149d9e0d9"
109          }
110        ],
111        "inactive": true,
112        "lastLogin": "2024-01-15T09:30:00Z",
113        "_meta": {
114          "created": "2024-01-15T09:30:00Z",
115          "updated": "2024-01-15T09:30:00Z",
116          "migrationVersion": 1
117        },
118        "email": "admin@itential.com"
119      }
120    }
121  },
122  "metadata": {}
123}
Assigns a Task to the current user.
Was this page helpful?
Previous

Clone automation

Next
Built with

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

taskIdstringRequiredformat: "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$"
The id of the Task iteration to be claimed.

Response

The result of the claim operation.
messagestring

A human-readable message summarizing the result of the operation

dataobject
Any successfully retrieved information related to the request.
metadatamap from strings to any

Any structured, wordy or machine-readable information related to the result of the operation. For success responses, this may contain information like pagination values from a search operation.

Errors

500
Internal Server Error