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 imported 3 of 4 documents", "data": { "_id": "0576de356a37dcf59fc198fa", "font_size": -10329324, "type": "automation", "created": "1980-08-11T06:25:40.362Z", "last_updated": "2006-08-20T04:25:52.208Z", "createdVersion": "5.48336360.0944234", "lastUpdatedVersion": "10532056778.16751.7120804695-1612.303503874.4967270792.49", "canvasVersion": 3, "encodingVersion": 1, "migrationVersion": -5766193, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": -33801593.529255845, "sla": -72928308.64149185, "decorators": [ { "type": "encryption", "pointer": "/tyV+/~0/~1/~1/Um2w" }, { "type": "encryption", "pointer": "/~1/~0/~0" }, { "type": "encryption", "pointer": "/HbdC4upp/~0/HUUew/GN,-g2/QJf/U2RuKjXUKZv/~1" }, { "type": "encryption", "pointer": "/jnGT5S61P1t/n-W42/~0/U,ShnF/t-X6ajatY/L/~0" } ], "status": "incomplete", "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": "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_start", "name": "myCoolDocumentName", "message": "esse sunt ex elit aute" }, { "task": "e28f", "name": "myCoolDocumentName" }, { "task": "workflow_end", "name": "myCoolDocumentName", "message": "ullamco" } ], "ancestors": [ "003e3ba550509d28f6931b2a", "7b3018840a399e4829400faa", "bda74dab606ff0239339aac2" ], "validationErrors": [ { "keyword": "elit consequat officia velit", "dataPath": "non mollit sunt cillum", "schemaPath": "ex ad enim", "message": "reprehenderit" }, { "keyword": "dolore", "dataPath": "adipisicing laborum in nulla", "schemaPath": "Duis exercitation", "message": "esse aute in" }, { "keyword": "aliqua", "dataPath": "elit", "schemaPath": "Excepteur veniam eiusmod", "message": "ea Lorem in" }, { "keyword": "do", "dataPath": "sit aliquip eu in", "schemaPath": "anim nisi qui officia magna", "message": "non" } ], "created_by": null, "last_updated_by": { "_id": "d81122469fb3b2f5b41b540a", "provenance": "in fugiat nisi in amet", "username": "dolor do cillum ut Ut", "firstname": "tempor", "memberOf": [ { "groupId": "9589334a58c0eb82998e911b", "aaaManaged": false }, { "groupId": "2bbc3ac6113817a772ab7b94", "aaaManaged": false }, { "groupId": "c281c75df94befce35ddef68", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ipsum ex eu est nostrud" }, { "roleId": "fugiat laboris" } ], "inactive": false, "lastLogin": "1952-03-03T02:05:30.518Z", "_meta": { "created": "2020-12-27T14:33:35.474Z", "updated": "2021-08-05T22:57:25.104Z", "migrationVersion": 91937518 }, "email": "in labore" }, "tasks": { "17": { "actor": "job", "groups": [ "default", "8d833001ee36beed705227de" ], "iterations": [], "x": 15315136.640247002, "y": 53881164.984092236, "gridCoordinate": { "x": 9203778.48628892, "y": 75974512.75447243 }, "name": "minim", "location": "Application", "locationType": null, "app": "occaecat", "canvasName": "amet Duis non nostrud", "displayName": "magna aliqua dolor", "summary": "eiusmod ea veniam", "description": "culpa nostrud do Duis id", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/I/,JFffpA4/m/l/bVa/M7-2oF5wJ/~1/~0/~1" }, { "type": "encryption", "pointer": "/~0/pq5VJj/i9f.PIM/R.WPP/WKjMRj/Hs32aSEK7Pi/~1" }, { "type": "encryption", "pointer": "/SiwfvMg/~1" }, { "type": "encryption", "pointer": "/~1/~1/P2g,aGQ" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "eiusmod aliqua incididunt fugiat Excepteur", "highlightString": "nulla ea labore tempor sit" }, { "key": "labore in eu dolor Excepteur", "highlightString": "aliquip Lorem ut" }, { "key": "esse voluptate occaecat sed irure", "highlightString": "tempor" }, { "key": "tempor laboris", "highlightString": "ullamco" } ], "status": "incomplete", "previous": { "incomplete": [ "workflow_end", "workflow_start", "3a1f", "workflow_start" ], "complete": [ "workflow_start", "e28f" ], "error": [ "e28f", "e28f" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "3a1f", "type": "revert" }, { "task": "error_handler", "type": "standard" } ], "failure": [ { "task": "3a1f", "type": "revert" } ], "error": [ { "task": "error_handler", "type": "loop" }, { "task": "3a1f", "type": "revert" }, { "task": "error_handler", "type": "standard" } ] }, "serverId": "id sint ea", "start_time": "1955-11-06T09:38:51.58Z", "end_time": 69087516.33698758, "finish_state": "failure", "retrySettings": null, "type": "automatic" }, "workflow_start": { "x": 45287345.9424783, "y": 1051216.3170162588, "gridCoordinate": { "x": -62493640.28092019, "y": -13721937.695550546 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -7105258.715664625, "finish_state": "success", "user": "Pronghorn" }, "groups": [ "default" ], "iterations": [ "5c8daDa5-EC38-Acab-98ba-c7Fcd73E5E96", "Ea5a0ceF-fcAe-0d23-f24F-Ada78aEBFF7D", "2De5E29e-93Df-287E-3614-7e62A73A88e7" ] }, "workflow_end": { "x": 4161558.0841605663, "y": -79260212.60422131, "gridCoordinate": { "x": 8497740.098592252, "y": -72230157.5519709 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_end", "workflow_start", "e28f", "3a1f", "error_handler" ], "complete": [ "workflow_start" ], "error": [ "3a1f", "error_handler", "workflow_start", "workflow_start", "error_handler" ] }, "metrics": { "end_time": -28681093.0774509, "run_time": 21477253.445548117 }, "groups": [ "default", "6f7dea28fa15e8080e76092d", "62dcbfdc5ba782f098babce4" ], "iterations": [ "9Fa873f7-6d5b-fB0b-b978-189E83db31fB" ] }, "error_handler": { "x": -2461415.2429261804, "y": 90379544.620018, "gridCoordinate": { "x": -94712005.14890255, "y": -56679380.41377654 }, "name": "childJob", "location": "Application", "locationType": null, "app": "Ut pariatur mollit quis", "canvasName": "Ut culpa exercitation", "displayName": "amet in ad aliquip dolor", "summary": "ullamco id magna in ut", "description": "non", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/k47SpfIVx5T/~0/~1/Lk8st3fROee/~1/GQZfJ/~1" }, { "type": "encryption", "pointer": "/~1/~0" }, { "type": "encryption", "pointer": "/~1/tk1/Gf9bTw/~1/~1/~1" }, { "type": "encryption", "pointer": "/Kza/~0/~1/S/~0/mtleeD+/~0" }, { "type": "encryption", "pointer": "/~0/~1/~0/~1/~1" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "in", "highlightString": "officia" } ], "status": "running", "previous": { "incomplete": [ "3a1f", "workflow_start" ], "complete": [ "workflow_start" ], "error": [ "e28f", "3a1f", "workflow_start" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "workflow_end", "type": "loop" }, { "task": "error_handler", "type": "standard" }, { "task": "workflow_start", "type": "revert" } ], "failure": [ { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "loop" }, { "task": "3a1f", "type": "standard" }, { "task": "e28f", "type": "revert" }, { "task": "3a1f", "type": "standard" } ], "error": [ { "task": "e28f", "type": "standard" }, { "task": "workflow_start", "type": "standard" }, { "task": "3a1f", "type": "loop" } ] }, "serverId": "eiusmod ex est", "start_time": "1946-08-16T23:28:27.463Z", "end_time": 63335506.471423596, "finish_state": "success", "retrySettings": { "state": [ "error", "failure", "failure" ], "autoRetry": false, "limit": 1975852, "delay": 131506, "count": 73594549, "finishedRetrying": true }, "type": "operation", "actor": null, "groups": [ { "_id": "2f46a2db86f01259d3f21ee6", "provenance": "sed", "name": "nulla tempor Excepteur", "description": "minim quis et elit nulla", "memberOf": [ { "groupId": "10481d758d7a08fb5147725c", "aaaManaged": false }, { "groupId": "dc2cfe152e00323f7316cfbe", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "nostrud irure do eiusmod" }, { "roleId": "dolor ut ipsum ea est" } ], "inactive": true, "_meta": { "created": "1951-01-25T23:26:35.54Z", "updated": "2011-02-22T06:17:02.391Z", "migrationVersion": 88770146 } }, "72ebfa59dc260e6b2e52bde2" ], "iterations": [ "fAAC8C86-d63e-8a4d-7CaF-57175a2a3fD1", "8A45bE8B-766c-B009-F900-436A591FCdDd", "cab3AD2d-CC31-c97A-d3D8-E1AC0ba5b2dd", "861F509D-DF9B-dD9F-CdBA-aa39Fadb8005" ] } }, "parent": { "job": "sit irure esse", "task": "sunt", "iteration": -48260441.75079307, "element": 32089397.460893616 }, "errorHandler": null, "groups": [ "370bbedbcb807ac2b1461660", "0d4d0fcb4f651912247b1b91", { "_id": "8a3bdba7f689431132dd6ebf", "provenance": "ipsum Duis sit", "name": "sed nisi eiusmod", "description": "consectetur", "memberOf": [ { "groupId": "8212a6faf1587571b8e0b804", "aaaManaged": true }, { "groupId": "77c64c58275bbf0c88047ba1", "aaaManaged": true }, { "groupId": "580d90766ceffc5c2424c105", "aaaManaged": true }, { "groupId": "5b3214844e0ebeadfa5cfa94", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "nostrud ut Duis consectetur dolore" }, { "roleId": "sed dolor cillum exercitation" }, { "roleId": "anim veniam ipsum nulla aliquip" }, { "roleId": "laboris cupidatat consectetur Lorem ut" }, { "roleId": "minim exercitation deserunt dolore" } ], "inactive": true, "_meta": { "created": "2004-01-07T19:26:54.34Z", "updated": "1960-03-17T13:40:51.081Z", "migrationVersion": -71274086 } }, { "_id": "f673c042758be8cd57aefd8c", "provenance": "qui", "name": "tempor veniam Lorem commodo", "description": "incididunt sit irure reprehenderit ipsum", "memberOf": [ { "groupId": "5d489ad6b3a7540547f4757e", "aaaManaged": true }, { "groupId": "dd37d321b323e094af784cd4", "aaaManaged": false }, { "groupId": "67a53e58b60439c7c12bd9b1", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "aliquip cillum ut" }, { "roleId": "enim" }, { "roleId": "eiusmod Duis" }, { "roleId": "nulla exercitation" } ], "inactive": false, "_meta": { "created": "1956-06-18T08:46:41.722Z", "updated": "1952-01-23T10:37:50.518Z", "migrationVersion": 71415837 } } ], "watchers": [ "Pronghorn", null, null, { "_id": "f7d94c3ffe8b8a9d4cd324fd", "provenance": "adipisicing amet", "username": "magna consequat", "firstname": "non elit", "memberOf": [ { "groupId": "09a448b64e2d3c4ead8eeada", "aaaManaged": true }, { "groupId": "9203e63a3164b18c5300ee1a", "aaaManaged": false }, { "groupId": "d091d729442b27ebdccf02e4", "aaaManaged": true }, { "groupId": "03c797bc099e031a520f1621", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "laboris irure dolor in" } ], "inactive": false, "lastLogin": "1984-10-14T21:01:16.744Z", "_meta": { "created": "1997-11-27T02:24:29.625Z", "updated": "1988-03-25T18:24:17.194Z", "migrationVersion": 67277772 }, "email": "veniam magna" }, "Pronghorn" ], "metrics": { "start_time": 43172400.55231112, "progress": 0.6557712310139514, "end_time": -66948766.63616496, "user": "4fbc1609b5a50ed382748a9d", "owner": null } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }