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 created the requested item", "data": { "_id": "2c6a06b07c7a20de87903777", "font_size": 44109040, "type": "resource:compliance", "created": "2008-11-07T15:31:25.778Z", "last_updated": "2006-04-01T06:43:25.002Z", "createdVersion": "74199557.67607100.4981534", "lastUpdatedVersion": "9.8583887.4100878-7066.56839452933.249143415", "canvasVersion": 1, "encodingVersion": 1, "migrationVersion": 88923802, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": 15666862.484094411, "sla": 3884627.124461472, "decorators": [ { "type": "encryption", "pointer": "/~0/bk/~0/w,AJ8/x/Wg4/NUs+e/~1/InC//NQ" }, { "type": "encryption", "pointer": "/~0/Z/~0" }, { "type": "encryption", "pointer": "/~1" } ], "status": "complete", "tags": [], "error": [ { "task": "f9a9", "message": { "code": 500, "message": { "apiVersion": "1", "method": "transformations.run", "error": { "code": 500, "message": "Missing one of the following required instances: arg2, arg1", "errors": [] } } }, "timestamp": 1627323002561 }, { "task": "f9a9", "message": { "code": 500, "message": { "apiVersion": "1", "method": "transformations.run", "error": { "code": 500, "message": "Missing one of the following required instances: arg2, arg1", "errors": [] } } }, "timestamp": 1627323002561 }, { "task": "f9a9", "message": { "code": 500, "message": { "apiVersion": "1", "method": "transformations.run", "error": { "code": 500, "message": "Missing one of the following required instances: arg2, arg1", "errors": [] } } }, "timestamp": 1627323002561 }, { "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": "magna aliquip cillum" }, { "task": "error_handler", "name": "myCoolDocumentName", "message": "aliquip" }, { "task": "workflow_start", "name": "myCoolDocumentName" } ], "ancestors": null, "validationErrors": [ { "keyword": "fugiat", "instancePath": "consectetur non minim officia", "schemaPath": "sit proident", "message": "dolor velit" }, { "keyword": "in", "instancePath": "dolor reprehenderit", "schemaPath": "consequat reprehenderit labore proident in", "message": "qui nisi Ut proident voluptate" }, { "keyword": "incididunt", "instancePath": "dolore eiusmod anim", "schemaPath": "et eiusmod nostrud", "message": "sint est" } ], "created_by": { "_id": "c6808351404826392b16fdfc", "provenance": "aute", "username": "voluptate eiusmod nisi", "firstname": "commodo et dolore", "memberOf": [ { "groupId": "156c552e26af34c50eb55a4c", "aaaManaged": false }, { "groupId": "b238a468b28abdafa1ab7f23", "aaaManaged": true }, { "groupId": "f9bd6a41c6ad2be31f6dfe47", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "nulla" }, { "roleId": "nulla Ut enim" } ], "inactive": true, "lastLogin": "2023-07-07T21:22:45.504Z", "_meta": { "created": "1962-09-12T01:11:29.762Z", "updated": "2012-06-04T20:39:35.208Z", "migrationVersion": -28869101 }, "email": "voluptate incididunt" }, "last_updated_by": null, "tasks": { "workflow_start": { "x": -33510999.40587958, "y": 76564276.1005812, "gridCoordinate": { "x": -83000219.76893741, "y": -24978679.094634652 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 55337114.73995364, "finish_state": "success", "user": "c9db211bc080ecb8621946cf" }, "groups": [ "5551a06e517e3f943a4c2fde", { "_id": "742e3790e67a909eba29ec25", "provenance": "Duis consequat incididunt laboris", "name": "dolor officia esse eiusmod", "description": "officia consectetur Excepteur", "memberOf": [ { "groupId": "9b1b0a5972909e33fe61f448", "aaaManaged": false }, { "groupId": "ded33ddaa64854a5bd9f8127", "aaaManaged": false }, { "groupId": "52d4025f5367783830cf917d", "aaaManaged": false }, { "groupId": "ce4540e4e80bd5b7730602b1", "aaaManaged": false }, { "groupId": "1df5550eb7200d6b52af7dd0", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "labore nisi ullamco anim velit" }, { "roleId": "do dolor Duis in culpa" }, { "roleId": "in" }, { "roleId": "do sed dolor" }, { "roleId": "laborum elit nulla veniam" } ], "inactive": false, "_meta": { "created": "2016-08-31T10:49:14.31Z", "updated": "1957-08-02T14:42:07.127Z", "migrationVersion": -1069313 } } ], "iterations": [ "DC55ac53-eE93-ebf4-cA4c-431Eb30bcD08" ] }, "workflow_end": { "x": 61531518.88743213, "y": -48211651.949671365, "gridCoordinate": { "x": -75839775.45819573, "y": -66498830.782675445 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "e28f", "3a1f", "workflow_start", "error_handler", "workflow_end" ], "complete": [ "error_handler", "error_handler", "workflow_start" ], "error": [ "error_handler", "e28f" ] }, "metrics": { "end_time": -26312451.727143407, "run_time": -33257340.961117744 }, "groups": [ "default" ], "iterations": [ "D1dCcF7E-1360-3126-D3EA-F5Ec037b4127" ] }, "error_handler": { "x": 3642512.4000070095, "y": -65792523.161382824, "gridCoordinate": { "x": -67282755.14735302, "y": -83813098.9580196 }, "name": "childJob", "location": "Application", "locationType": null, "app": "Excepteur enim id", "canvasName": "consequat", "displayName": "labore", "summary": "ad eiusmod", "description": "Lorem nostrud culpa et", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/FsVq9Wcw/KyIn,Eq,ZA/~1" }, { "type": "encryption", "pointer": "/~0/sdpsWODtp/Vb6b.7Ir2bV" }, { "type": "encryption", "pointer": "/QYrLGC9G87/NNJ910/~0/~1/~1/~1" }, { "type": "encryption", "pointer": "/sCOF/iCB/BfK/~1/mc/U" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "in pariatur et dolore commodo", "highlightString": "mollit proident magna" }, { "key": "enim nostrud", "highlightString": "ut cupidatat Excepteur fugiat in" }, { "key": "laborum adipisicing", "highlightString": "magna" }, { "key": "labore reprehenderit sint", "highlightString": "culpa occaecat cillum anim elit" }, { "key": "do id cupidatat sed irure", "highlightString": "incididunt enim in esse" } ], "status": "failure", "previous": { "incomplete": [ "workflow_end", "error_handler", "e28f", "e28f" ], "complete": [ "workflow_end" ], "error": [ "workflow_end", "error_handler", "workflow_start" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "workflow_start", "type": "standard" } ], "failure": [ { "task": "3a1f", "type": "revert" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_end", "type": "standard" }, { "task": "workflow_start", "type": "loop" } ], "error": [ { "task": "workflow_start", "type": "loop" }, { "task": "workflow_end", "type": "standard" }, { "task": "3a1f", "type": "loop" }, { "task": "3a1f", "type": "standard" }, { "task": "error_handler", "type": "loop" } ] }, "serverId": "Duis commodo sit velit veniam", "start_time": "1982-01-08T05:21:52.887Z", "end_time": -48890149.31052751, "finish_state": "error", "retrySettings": null, "type": "operation", "actor": "Pronghorn", "groups": [ "default", "504c57218b4e73558059160b", { "_id": "9ddf4a756184c4c08adead87", "provenance": "do officia fugiat ipsum", "name": "Lorem tempor esse", "description": "commodo in fugiat labore et", "memberOf": [ { "groupId": "a9979def1fcd4b1790f8d8e9", "aaaManaged": false }, { "groupId": "e977378b4c3a2d4a766a2846", "aaaManaged": false }, { "groupId": "11c9d798cd12a022338f7937", "aaaManaged": false }, { "groupId": "8fe76dbfe37cb69489097daf", "aaaManaged": true }, { "groupId": "dbc671e2862e8258e9d97dc7", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "adipisicing ullamco" }, { "roleId": "fugiat enim" }, { "roleId": "in" }, { "roleId": "nulla Lorem" }, { "roleId": "voluptate Lorem laborum" } ], "inactive": true, "_meta": { "created": "1994-03-16T01:31:54.979Z", "updated": "1949-07-25T17:32:25.302Z", "migrationVersion": -45342078 } } ], "iterations": [ "eDEEC1c5-cf93-8f4A-cBE7-939cfEA58108" ] }, "a1d": { "actor": "$var.a7.kjKxwty", "groups": [ "cae9ce526d792ca1d0e53582" ], "iterations": [ "dfdbAff0-f745-50eC-cEc1-eaa78fb6CA6b", "3Eb88ECf-6968-9afF-3Fe9-dD769cA0464D" ], "x": -18708771.195075393, "y": 47888110.76018447, "gridCoordinate": { "x": 43496171.44583166, "y": -92766290.79044381 }, "name": "consectetur mollit consequat amet", "location": "Application", "locationType": "ullamco Excepteur", "app": "consequat occaecat", "canvasName": "eiusmod proident amet", "displayName": "et Lorem veniam est", "summary": "in veniam laboris incididunt", "description": "dolor", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/C/eVNnO8YE" }, { "type": "encryption", "pointer": "/~0/~0" }, { "type": "encryption", "pointer": "/gfdGg315AJ/AFsbP+mN/GTZB3svh/IJ4b/eUOvJByEd/r71uw5NHH3/~1/MYFTCaUO0/~0/~1" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "sit esse eiusmod ullamco nulla", "highlightString": "aute eiusmod cillum nisi" }, { "key": "anim in fugiat", "highlightString": "laborum proident quis eu" }, { "key": "id", "highlightString": "ea dolor incididunt ut id" } ], "status": "incomplete", "previous": { "incomplete": [ "e28f", "error_handler", "workflow_end", "workflow_start" ], "complete": [ "workflow_start", "3a1f", "error_handler", "3a1f" ], "error": [ "workflow_start", "error_handler" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "e28f", "type": "standard" }, { "task": "error_handler", "type": "loop" }, { "task": "workflow_end", "type": "revert" }, { "task": "workflow_end", "type": "standard" } ], "failure": [ { "task": "e28f", "type": "revert" }, { "task": "workflow_start", "type": "revert" }, { "task": "e28f", "type": "loop" }, { "task": "workflow_end", "type": "standard" }, { "task": "error_handler", "type": "standard" } ], "error": [ { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "loop" } ] }, "serverId": "dolore do", "start_time": "2011-07-05T08:47:12.119Z", "end_time": 35790760.49704471, "finish_state": "success", "retrySettings": null, "type": "automatic" } }, "parent": { "job": "voluptate", "task": "Duis", "iteration": 35019431.93498021, "element": 28280696.009905532 }, "errorHandler": { "actor": "job", "groups": [ { "_id": "7eaa93c605a6988450cd08e6", "provenance": "esse dolor in", "name": "cillum ex consectetur", "description": "velit cillum", "memberOf": [ { "groupId": "12856f115630a89e2a89751d", "aaaManaged": false }, { "groupId": "5bc98963e5afc80f4a5a96fa", "aaaManaged": true }, { "groupId": "806088137d7ae3b426255d1f", "aaaManaged": false }, { "groupId": "823c0f2ecdb48bd245073ed0", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "nostrud" } ], "inactive": false, "_meta": { "created": "1964-07-01T05:18:07.904Z", "updated": "1951-09-28T06:40:22.53Z", "migrationVersion": 68114792 } }, "0fafe0c62b3eaef8b52f8179", "c0fa3881fc196ac8bbc48ddb", "default" ], "iterations": [], "x": -12498180.90489003, "y": -86214728.43488291, "gridCoordinate": { "x": 77853569.74596915, "y": 35053392.85673484 }, "name": "amet ut", "location": "Adapter", "locationType": null, "app": "enim ipsum eu", "canvasName": "elit voluptate officia consequat sit", "displayName": "exercitation commodo minim nisi anim", "summary": "in ut ea consequat esse", "description": "fugiat do mollit occaecat", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/~1/~1/UoC/iRQegz1A7n/~1/~1/EAm9Fh" }, { "type": "encryption", "pointer": "/~0/~0/F5,r/~0" }, { "type": "encryption", "pointer": "/O0uzeJ/ubqZ5/D.B7R+hN/~0/~0/~1/Bwi+Kciye/v/Z6frtkN1/~1/HC3YYBJ0ah" }, { "type": "encryption", "pointer": "/~0/j/c9BEDigUErO/FKz.k/~1/~0/~1/Webu" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "ad nisi", "highlightString": "cupidatat Lorem" }, { "key": "aute", "highlightString": "sed" }, { "key": "ut in magna", "highlightString": "eu et occaecat anim tempor" } ], "status": "incomplete", "previous": { "incomplete": [ "3a1f", "workflow_start", "3a1f" ], "complete": [ "error_handler", "3a1f", "error_handler" ], "error": [ "e28f", "workflow_start" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "3a1f", "type": "standard" }, { "task": "workflow_end", "type": "standard" }, { "task": "error_handler", "type": "revert" } ], "failure": [ { "task": "workflow_start", "type": "revert" } ], "error": [ { "task": "3a1f", "type": "standard" }, { "task": "workflow_start", "type": "standard" } ] }, "serverId": "sed incididunt", "start_time": "1980-03-05T18:03:02.514Z", "end_time": 35083123.83344442, "finish_state": "error", "retrySettings": { "state": [ "success" ], "autoRetry": true, "limit": 59355761, "delay": 16226010, "count": 13627178, "finishedRetrying": false }, "type": "automatic" }, "groups": [ "ba19b39ce7f30e2c2f4feee3", "2bee5e3b097a0008b5df78b2", "default", { "_id": "6fc9f0464467e5d19496e485", "provenance": "anim et pariatur cupidatat", "name": "aliqua laborum tempor ut", "description": "ipsum eiusmod est", "memberOf": [ { "groupId": "37b3221e892f3066ff2a9d4b", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "elit tempor occaecat" } ], "inactive": true, "_meta": { "created": "1947-04-26T01:07:27.155Z", "updated": "1955-02-17T12:02:40.331Z", "migrationVersion": 33263499 } }, "default" ], "watchers": [ { "_id": "406d5702a4439f29916e95c5", "provenance": "dolore aute Excepteur Duis dolor", "username": "in pariatur proident qui Duis", "firstname": "occaecat", "memberOf": [ { "groupId": "c7408e24b86d88acc20698eb", "aaaManaged": true }, { "groupId": "db9f937e5e63eee67a10a2e6", "aaaManaged": true }, { "groupId": "2b22784d6514c34530f30060", "aaaManaged": false }, { "groupId": "0c90f89382e76cdb85c6c109", "aaaManaged": true }, { "groupId": "4370fcd93e49f29c11ba4721", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "tempor elit" }, { "roleId": "sed fugiat voluptate" }, { "roleId": "irure aute nulla sit sed" }, { "roleId": "Duis mollit commodo nostrud dolore" }, { "roleId": "Ut id reprehenderit aliqua" } ], "inactive": true, "lastLogin": "1990-03-29T08:15:03.558Z", "_meta": { "created": "2011-07-19T22:35:00.033Z", "updated": "2018-03-29T10:10:14.557Z", "migrationVersion": -67634209 }, "email": "proident enim in" }, "ee6ee76ed79ca65017ba6530" ], "metrics": { "start_time": 42740337.041253895, "progress": 0.3596076538834081, "end_time": -81115932.1851878, "user": "Pronghorn", "owner": null } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }