Summary
Run Endpoint Trigger With POST
Description
Runs the Automation associated with the API Trigger.
Route
POST /operations-manager/triggers/endpoint/:routeName
Roles
Parameters
Name | Type | Required | Description |
---|---|---|---|
routeName | string | yes | The routeName of the API Trigger. |
body | object | yes | Any key-value pairs in the POST body will be used to create job variables. |
{}
{ "title": "body", "type": "object", "properties": {}, "additionalProperties": true }
Return
Name | Type | Description |
---|---|---|
result | object | The spawned Job. |
{ "message": "Successfully retrieved search results", "data": { "_id": "5142e8031cc7ab057c1925c8", "uuid": "67c2f985-57c1-e941-7025-b729365301ca", "font_size": 82355275, "type": "resource:action", "created": "1999-01-24T03:14:55.997Z", "last_updated": "1973-01-02T20:24:00.432Z", "createdVersion": "200162230.5507711.14481673658-1756.79973.5819.885", "lastUpdatedVersion": "411325339.287257911.71-1745.8.12017992", "canvasVersion": 1, "encodingVersion": 1, "migrationVersion": -68247370, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": -9318554.743213743, "sla": -43552628.68430976, "decorators": [ { "type": "encryption", "pointer": "/~1" } ], "status": "error", "tags": [], "error": [ { "task": "job", "message": "Job has no available transitions. c841 could have led to the workflow end task, but did not. These tasks performed in a way that the end of the workflow could not be reached.", "timestamp": 1627323002574 }, { "task": "job", "message": "Job has no available transitions. c841 could have led to the workflow end task, but did not. These tasks performed in a way that the end of the workflow could not be reached.", "timestamp": 1627323002574 } ], "warnings": [ { "task": "workflow_end", "name": "myCoolDocumentName", "message": "Duis ex" }, { "task": "error_handler", "name": "myCoolDocumentName", "message": "non deserunt" }, { "task": "e28f", "name": "myCoolDocumentName" } ], "ancestors": [ "0d6ece5b3997e86fe1351153", "b9f7ae95e1b38087477a756c", "75672917250a37f52eec4322" ], "validationErrors": [ { "keyword": "dolore", "instancePath": "sit nisi", "schemaPath": "ad pariatur in consectetur veniam", "message": "nostrud laborum ipsum" } ], "created_by": { "_id": "b05bb98fb5a7839e66534594", "provenance": "elit voluptate", "username": "Ut", "firstname": "exercitation aliqua", "memberOf": [ { "groupId": "022116ebd40d0a8aea4375b8", "aaaManaged": true }, { "groupId": "1fc83a93050f47d7d8462c75", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "amet enim Lorem officia" }, { "roleId": "deserunt" }, { "roleId": "velit qui" }, { "roleId": "eiusmod officia do occaecat" }, { "roleId": "irure" } ], "inactive": false, "lastLogin": "1985-11-01T02:07:59.262Z", "_meta": { "created": "1982-04-07T23:24:04.545Z", "updated": "2005-09-06T20:41:26.078Z", "migrationVersion": 90625126 }, "email": "commodo dolore aute ex deserunt" }, "last_updated_by": { "_id": "a563aeeeea6ff3120da2300b", "provenance": "veniam ea in qui", "username": "Excepteur ex id in", "firstname": "incididunt occaecat esse ut", "memberOf": [ { "groupId": "39042248a0998cf0f4c347b0", "aaaManaged": false }, { "groupId": "177033911e9394b5d14c19e9", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ullamco amet" }, { "roleId": "fugiat enim amet" }, { "roleId": "pariatur Ut laboris" } ], "inactive": false, "lastLogin": "1970-03-07T03:38:28.978Z", "_meta": { "created": "2010-07-03T18:10:10.919Z", "updated": "2022-11-03T14:04:20.089Z", "migrationVersion": 86151096 }, "email": "tempor consequat ut sint" }, "tasks": { "workflow_start": { "x": -59552412.19146621, "y": -51859196.310188025, "gridCoordinate": { "x": -89337431.85381986, "y": 46573432.58081514 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 65442829.151415974, "finish_state": "success", "user": null }, "groups": [ "default" ], "iterations": [ "a29f1Dc7-ddad-D5Bf-DF1F-f1FC70b5Aa17", "fF35c6aF-5F57-56e7-51C9-58B6Ab4719F7", "455eCeDD-58e2-08f6-d01f-e8e95C8facB8" ] }, "workflow_end": { "x": -1320577.5054378659, "y": 63176039.39920181, "gridCoordinate": { "x": -74279352.14142196, "y": 99443819.11430472 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_end", "3a1f", "workflow_start", "workflow_end", "workflow_start" ], "complete": [ "e28f", "error_handler" ], "error": [ "workflow_start", "workflow_end", "workflow_start", "3a1f" ] }, "metrics": { "end_time": 52718626.26315445, "run_time": 78361616.3503479 }, "groups": [ "default", { "_id": "46c9107cc4162384174421c2", "provenance": "qui in deserunt laboris ut", "name": "pariatur quis", "description": "est", "memberOf": [ { "groupId": "ce81ac4710301c35e17db79c", "aaaManaged": true }, { "groupId": "c6d6eac243dc4c0e08814219", "aaaManaged": true }, { "groupId": "2f68eaaef75caf311d3b10cf", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "deserunt ut eu in enim" }, { "roleId": "id commodo" }, { "roleId": "velit reprehenderit ipsum laborum" } ], "inactive": false, "_meta": { "created": "1989-04-07T01:37:08.042Z", "updated": "1995-01-20T16:18:10.804Z", "migrationVersion": -83853579 } } ], "iterations": [ "EEbaC0ff-fe6d-caDf-2CD1-CCfD3f17db6a" ] }, "error_handler": { "x": 87270285.83676386, "y": 30080738.33266294, "gridCoordinate": { "x": 67479753.88560477, "y": -50947579.960395515 }, "name": "childJob", "location": "Adapter", "locationType": "sunt aute ea veniam", "app": "irure ipsum esse mollit", "canvasName": "exercitation tempor officia", "displayName": "ad", "summary": "Lorem Excepteur ut id enim", "description": "dolore ullamco esse", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/CJ3eB1U-/~1/~1/~1/jF-/B/~1/~1/~1/~1" }, { "type": "encryption", "pointer": "/~0/~0/~0/~0/~0/jw8/ssyYkYpj/i4K5Lj" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "consectetur cupidatat aliquip dolor adipisicing", "highlightString": "reprehenderit enim commodo officia" }, { "key": "laborum officia velit", "highlightString": "ad laborum" }, { "key": "ipsum do et culpa qui", "highlightString": "laboris" }, { "key": "culpa elit", "highlightString": "Ut cupidatat voluptate" } ], "status": "canceled", "previous": { "incomplete": [ "workflow_start" ], "complete": [ "3a1f", "workflow_end", "workflow_end", "3a1f", "workflow_start" ], "error": [ "error_handler" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "error_handler", "type": "loop" }, { "task": "error_handler", "type": "standard" }, { "task": "3a1f", "type": "loop" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_end", "type": "standard" } ], "failure": [ { "task": "e28f", "type": "revert" }, { "task": "e28f", "type": "standard" }, { "task": "workflow_end", "type": "loop" }, { "task": "error_handler", "type": "revert" } ], "error": [ { "task": "e28f", "type": "standard" }, { "task": "error_handler", "type": "loop" }, { "task": "workflow_start", "type": "loop" } ] }, "serverId": "aute reprehenderit", "start_time": "1960-01-30T09:53:44.235Z", "end_time": -69207913.05920479, "finish_state": "failure", "retrySettings": null, "type": "operation", "actor": { "_id": "9c6462a9b266c14a0af918c2", "provenance": "est non cupidatat", "username": "do cillum laborum in ut", "firstname": "ut exercitation quis", "memberOf": [ { "groupId": "8e0d4cbec0730ce6c2ce311a", "aaaManaged": true }, { "groupId": "0e9f1dc037e2fd855dd1960c", "aaaManaged": false }, { "groupId": "6a84cf5b5f32d89372d411cd", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "consectetur veniam mollit" }, { "roleId": "id do in qui" } ], "inactive": true, "lastLogin": "1972-04-28T17:02:12.951Z", "_meta": { "created": "1970-11-15T12:45:09.703Z", "updated": "1997-03-20T09:32:17.767Z", "migrationVersion": 14854584 }, "email": "dolore amet ullamco" }, "groups": [ { "_id": "452f702f583bdf868218f7c8", "provenance": "velit non", "name": "nisi aliquip qui mollit labore", "description": "dolor aute ipsum", "memberOf": [ { "groupId": "d3687c1a67aba7d87e9eb3ef", "aaaManaged": false }, { "groupId": "bee3a93bd5d6b1a1dba386ef", "aaaManaged": false }, { "groupId": "d7eb8aca436528873ad966de", "aaaManaged": false }, { "groupId": "a724f1da519bcf8805b7808e", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "Lorem exercitation" }, { "roleId": "sint proident labore in" }, { "roleId": "officia dolor eu" } ], "inactive": true, "_meta": { "created": "1976-06-28T15:00:37.316Z", "updated": "1998-08-26T21:44:18.721Z", "migrationVersion": 6644637 } }, { "_id": "5289bde2c72330500f21dd52", "provenance": "dolore reprehenderit", "name": "reprehenderit", "description": "nulla cillum deserunt commodo veniam", "memberOf": [ { "groupId": "c70ad81163357d7632dcda6a", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "do culpa cupidatat in" } ], "inactive": false, "_meta": { "created": "1990-02-05T11:34:13.315Z", "updated": "1959-12-21T03:28:40.938Z", "migrationVersion": 86478980 } }, "41ff02831efe74d303baa6d4", "608bf8212ba69788ff01f68e", { "_id": "a3e6318853d3dbab7cf11c5a", "provenance": "Excepteur laboris esse", "name": "exercitation reprehenderit commodo incididunt", "description": "occaecat", "memberOf": [ { "groupId": "c31928941c01e1017137e74a", "aaaManaged": true }, { "groupId": "9b96c2874c3001b37e25836b", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "Excepteur" }, { "roleId": "exercitation labore magna" }, { "roleId": "adipisicing" }, { "roleId": "culpa enim dolore" } ], "inactive": true, "_meta": { "created": "1952-10-11T18:40:45.157Z", "updated": "2005-05-07T21:46:07.587Z", "migrationVersion": 91669712 } } ], "iterations": [ "aFE01cfc-7Bbf-e7ED-f052-9C00Fd84dbf5", "F5de4b6A-f7A6-092E-5DD5-FD95DaA1ab8b", "C5bf5Ec2-6152-C169-A0F7-5E5eef9dcFE2" ] }, "c8e9": { "actor": "Pronghorn", "groups": [ { "_id": "8f25601fb6d599e11b92c9b8", "provenance": "sint Excepteur laborum dolore labore", "name": "nostrud Excepteur incididunt", "description": "do veniam", "memberOf": [ { "groupId": "ba1f7acc8f8bd369262b69b5", "aaaManaged": false }, { "groupId": "4f15679ffbd7290a7d22f1f9", "aaaManaged": false }, { "groupId": "668984b0624b6de306563673", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "occaecat sint nostrud ad elit" }, { "roleId": "adipisicing sint aliqua" }, { "roleId": "reprehenderit nostrud Duis elit voluptate" } ], "inactive": false, "_meta": { "created": "1980-01-04T12:58:41.8Z", "updated": "1984-01-27T22:44:45.001Z", "migrationVersion": 77392339 } }, { "_id": "c1674732c5aa803873a73b43", "provenance": "ea culpa qui incididunt", "name": "qui officia labore tempor nisi", "description": "do non", "memberOf": [ { "groupId": "8ebf11d57a08e97d6ac97f84", "aaaManaged": false }, { "groupId": "c93fbabe11ab35bb2a389ff8", "aaaManaged": true }, { "groupId": "e61bb6e1bb34a61f8929e87b", "aaaManaged": false }, { "groupId": "ba9f2aab4ef65ea62f28e203", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "sit veniam aute ad" }, { "roleId": "amet fugiat" }, { "roleId": "culpa adipisicing exercitation pariatur" } ], "inactive": false, "_meta": { "created": "1951-08-07T19:23:13.216Z", "updated": "2023-06-30T04:21:51.945Z", "migrationVersion": 46348174 } }, "eba17b652329afc23f027b73", { "_id": "47fa0bb500fb66f781c6d43a", "provenance": "Excepteur mollit adipisicing", "name": "exercitation laboris", "description": "eu ullamco deserunt", "memberOf": [ { "groupId": "3a968ab4ffde1ca887084f89", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "proident aute" }, { "roleId": "veniam" } ], "inactive": false, "_meta": { "created": "2007-01-31T19:17:23.144Z", "updated": "1948-04-29T19:34:04.628Z", "migrationVersion": 18182811 } } ], "iterations": [ "F5f0f437-d4DA-ba9D-DfbC-5Bd2C1F9efd7" ], "x": 74698593.43242979, "y": -91129195.32892118, "gridCoordinate": { "x": -3092415.188315958, "y": -47862864.5647873 }, "name": "pending", "summary": "nisi ea velit", "description": "qui magna pariatur" } }, "parent": { "task": "id deserunt", "iteration": -99484562.59307066, "element": 87844397.26990816 }, "errorHandler": null, "groups": [ { "_id": "78095e94da60f3af9257c9eb", "provenance": "in cillum sunt velit", "name": "exercitation magna", "description": "Lorem labore", "memberOf": [ { "groupId": "38ca54a2798f5cf3a46bb79d", "aaaManaged": true }, { "groupId": "bf026d25b0f7488d9d88a735", "aaaManaged": true }, { "groupId": "c0baac35425d2153c95cea45", "aaaManaged": true }, { "groupId": "d425eecf3f8d3450369d3dba", "aaaManaged": false }, { "groupId": "b2936f485c52db806733a762", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "officia irure laboris elit sed" }, { "roleId": "dolore cupidatat" } ], "inactive": false, "_meta": { "created": "1952-07-27T01:53:44.754Z", "updated": "1985-01-22T08:16:29.727Z", "migrationVersion": -36576051 } } ], "watchers": [ null, "Pronghorn" ], "metrics": { "start_time": -24761600.291587576, "progress": 0.40529737295599566, "end_time": 81684945.43098456, "user": "86661a146727757158dbebd5", "owner": "8774f4e473f0bea74b1d44c9" } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }