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

Finish a manual task

Deprecated
POST
http://localhost:3000/operations-manager/jobs/:jobId/tasks/:taskId/finish
POST
/operations-manager/jobs/:jobId/tasks/:taskId/finish
$curl -X POST http://localhost:3000/operations-manager/jobs/jobId/tasks/workflow_start/finish \
>     -H "Content-Type: application/json" \
>     -u "<username>:<password>" \
>     -d '{}'
1{
2  "message": "Successfully created the requested item",
3  "data": {
4    "_id": "string",
5    "uuid": "string",
6    "font_size": 12,
7    "type": "automation",
8    "created": "2024-01-15T09:30:00Z",
9    "last_updated": "2024-01-15T09:30:00Z",
10    "createdVersion": "5.55.5",
11    "lastUpdatedVersion": "5.55.6",
12    "canvasVersion": 1,
13    "encodingVersion": 1,
14    "migrationVersion": 1,
15    "name": "Cisco IOS upgrade",
16    "description": "Turn up the port",
17    "preAutomationTime": 0,
18    "sla": 0,
19    "decorators": [
20      {
21        "type": null,
22        "pointer": "string"
23      }
24    ],
25    "transitions": {},
26    "status": "error",
27    "variables": {
28      "initiator": {
29        "location": "job_data",
30        "_id": "67be20c2dda0df69ebe60826"
31      },
32      "_id": {
33        "location": "job_data",
34        "_id": "67be20c2dda0df69ebe60825"
35      }
36    },
37    "tags": [
38      "string"
39    ],
40    "error": [
41      {
42        "task": null,
43        "message": {},
44        "timestamp": 1.1
45      }
46    ],
47    "warnings": [
48      {
49        "task": "workflow_start",
50        "name": "Cisco IOS upgrade",
51        "message": {}
52      }
53    ],
54    "ancestors": [
55      "string"
56    ],
57    "validationErrors": [
58      {
59        "keyword": "string",
60        "instancePath": "string",
61        "schemaPath": "string",
62        "params": {},
63        "message": "string"
64      }
65    ],
66    "namespace": {},
67    "mocked": true,
68    "created_by": null,
69    "last_updated_by": null,
70    "tasks": {
71      "workflow_start": {
72        "metrics": {
73          "user": null
74        },
75        "groups": [
76          "string"
77        ],
78        "iterations": [
79          {}
80        ]
81      },
82      "workflow_end": {
83        "groups": [
84          "string"
85        ],
86        "iterations": [
87          {}
88        ]
89      },
90      "error_handler": {
91        "actor": null,
92        "groups": [
93          "string"
94        ],
95        "iterations": [
96          {}
97        ]
98      }
99    },
100    "parent": {
101      "job": "fe7043ac41d24206aa556c49",
102      "task": "defc",
103      "iteration": 1,
104      "element": 0
105    },
106    "errorHandler": null,
107    "groups": [
108      "string"
109    ],
110    "watchers": [
111      null
112    ],
113    "metrics": {
114      "start_time": 1.1,
115      "progress": 0.5,
116      "end_time": 1.1,
117      "user": null,
118      "owner": null
119    },
120    "output": {},
121    "outputData": {}
122  },
123  "metadata": {}
124}
Work a manual Task.
Was this page helpful?
Previous

Get a job

Next
Built with

Authentication

AuthorizationBasic

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

Path parameters

jobIdstringRequiredformat: "^[0-9a-f]{24}$"
The id of the Job containing the Task to be worked.
taskIdenum or stringRequired
The id of the Task to be worked.

Request

request body
taskDataobjectOptional

Response

The result of the finish manual Task 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