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": "66e13b0d83eda7763eb672fc", "font_size": 94039587, "type": "resource:action", "created": "1974-06-23T11:47:23.207Z", "last_updated": "1971-04-18T07:49:27.505Z", "createdVersion": "817445.6029.2787-1798.0557894.549594", "lastUpdatedVersion": "2.218733391.62502076-6854.6868339.56166175116.95", "canvasVersion": 1, "encodingVersion": 1, "migrationVersion": 11612116, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": 64562804.891341865, "sla": 57374240.63348642, "decorators": [ { "type": "encryption", "pointer": "/UvNWk/QKbEX/QddIjn9/~1/~0/qgVcnX0oq.X/vJcSzHt/~1/~0/TsTNQ8TqM/A4Uy/2ux0Xn" }, { "type": "encryption", "pointer": "/~1/hu/c7+zAN7+TVd" } ], "status": "error", "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 } ], "warnings": [ { "task": "workflow_start", "name": "myCoolDocumentName" }, { "task": "error_handler", "name": "myCoolDocumentName" }, { "task": "e28f", "name": "myCoolDocumentName", "message": "sed" } ], "ancestors": [ "693d93025d031373ad6b89f0", "6ebeaa402fb7140fc4ee4da4" ], "validationErrors": [ { "keyword": "qui eiusmod exercitation velit", "dataPath": "elit consequat in Excepteur", "schemaPath": "aliqua ullamco sit incididunt cupidatat", "message": "officia ea" }, { "keyword": "eiusmod adipisicing amet aliqua", "dataPath": "dolor nulla aliquip sunt", "schemaPath": "minim", "message": "minim deserunt voluptate quis ea" }, { "keyword": "dolor", "dataPath": "velit incididunt", "schemaPath": "do voluptate nostrud Lorem", "message": "ad culpa aliquip id irure" } ], "created_by": "Pronghorn", "last_updated_by": { "_id": "5d4e4a08becf083b74a93557", "provenance": "minim eu", "username": "esse", "firstname": "fugiat consectetur nisi", "memberOf": [ { "groupId": "e89bacf9efb0b21ef1e8e19a", "aaaManaged": true }, { "groupId": "6a6393d7a8cb755d68886e93", "aaaManaged": false }, { "groupId": "9cb8eb692256803610d23ffb", "aaaManaged": true }, { "groupId": "55506f7c8f4fe5dbba9802d9", "aaaManaged": true }, { "groupId": "a5fdee64c57523b004de9545", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ad occaecat" } ], "inactive": false, "lastLogin": "2010-08-14T21:23:40.912Z", "_meta": { "created": "1993-09-23T06:22:52.096Z", "updated": "2022-10-26T05:53:22.686Z", "migrationVersion": 69203444 }, "email": "anim dolore" }, "tasks": { "workflow_start": { "x": -75822308.49550249, "y": -60153939.20636551, "gridCoordinate": { "x": 71531510.65946567, "y": 76210599.64355755 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -93167745.60738659, "finish_state": "failure", "user": "Pronghorn" }, "groups": [ "18b590ed18a3701d5eadb69e" ], "iterations": [ "B5414bFB-B7F7-Af6c-F7d6-fF9E07b834b7", "4DA562ca-5DA5-8ffd-ba5e-aAFB79a7d8dd" ] }, "workflow_end": { "x": -71618510.88299485, "y": 91226611.73633647, "gridCoordinate": { "x": -17778520.127429992, "y": -86953822.51279238 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "error_handler", "e28f" ], "complete": [ "3a1f", "3a1f", "3a1f", "workflow_start" ], "error": [ "error_handler", "workflow_start", "workflow_start" ] }, "metrics": { "end_time": 15146039.000363886, "run_time": 30219168.180088475 }, "groups": [ "default" ], "iterations": [] }, "error_handler": { "x": -29571816.13356927, "y": -56971537.176371664, "gridCoordinate": { "x": 36428266.53368148, "y": -17856366.63217853 }, "name": "childJob", "location": "Adapter", "locationType": null, "app": "sit veniam amet Excepteur enim", "canvasName": "est Excepteur qui aliqua sunt", "displayName": "ex", "summary": "amet ipsum sunt veniam", "description": "in in Duis", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/mlKiR1Z/~0" }, { "type": "encryption", "pointer": "/WWmQNBE/~1/~1" }, { "type": "encryption", "pointer": "/sJa/~1/t" }, { "type": "encryption", "pointer": "/bkfo/~0/q" }, { "type": "encryption", "pointer": "/vzlYT,yJjt/~1/iiTCOTr,b4/e/~1/~0/a9oR" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "consequat", "highlightString": "Excepteur fugiat ullamco ipsum" }, { "key": "ad dolore", "highlightString": "eu nulla nostrud" }, { "key": "et sunt", "highlightString": "enim magna ut" }, { "key": "sint ullamco adipisicing consectetur", "highlightString": "proident" } ], "status": "canceled", "previous": { "incomplete": [ "3a1f" ], "complete": [ "workflow_start", "workflow_start", "workflow_start", "workflow_end", "error_handler" ], "error": [ "error_handler", "workflow_end", "e28f" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "3a1f", "type": "revert" }, { "task": "workflow_end", "type": "revert" }, { "task": "workflow_start", "type": "loop" }, { "task": "3a1f", "type": "loop" } ], "failure": [ { "task": "workflow_start", "type": "revert" }, { "task": "workflow_end", "type": "loop" }, { "task": "3a1f", "type": "revert" } ], "error": [ { "task": "e28f", "type": "revert" } ] }, "serverId": "ut est proident", "start_time": "2016-05-01T06:23:14.811Z", "end_time": 97298457.10135397, "finish_state": "failure", "retrySettings": { "state": [ "failure", "error", "success", "failure", "error" ], "autoRetry": true, "limit": 14694464, "delay": 85251383, "count": 24362865, "finishedRetrying": true }, "type": "operation", "actor": "e3d8d50e34a129e18c3c3515", "groups": [ "default", "default", "default", { "_id": "eb1a55f094cac282b445f2cb", "provenance": "pariatur voluptate aliqua", "name": "quis id Lorem", "description": "quis do irure", "memberOf": [ { "groupId": "6c856d9dcfdbfc55589a6af1", "aaaManaged": true }, { "groupId": "f32ffee15710e3515400ef08", "aaaManaged": true }, { "groupId": "bb68dee6e7853c39bc1bc3f2", "aaaManaged": false }, { "groupId": "1233d9ef30651448b317c597", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "non reprehenderit id tempor" }, { "roleId": "Ut commodo aliquip esse nostrud" }, { "roleId": "cupidatat qui" }, { "roleId": "ad sint aliquip dolore veniam" } ], "inactive": true, "_meta": { "created": "1958-04-18T23:25:09.344Z", "updated": "2014-08-17T00:50:59.811Z", "migrationVersion": -10024707 } } ], "iterations": [] }, "a35c": { "actor": { "_id": "7dfd18b6f35cf64bc5e6b062", "provenance": "dolor veniam officia et labore", "username": "quis commodo", "firstname": "incididunt veniam", "memberOf": [ { "groupId": "e1963ad77bba5094b977fba7", "aaaManaged": true }, { "groupId": "ad0e5e7f69e3f421b3c92205", "aaaManaged": false }, { "groupId": "af9b0551de30004a545c2fa3", "aaaManaged": false }, { "groupId": "691d20bfa2ea29f0c861fd27", "aaaManaged": false }, { "groupId": "5efd0c43767d05fef501c651", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "do veniam ex minim" }, { "roleId": "nostrud Duis ut" }, { "roleId": "ipsum" }, { "roleId": "Excepteur minim sit irure" } ], "inactive": true, "lastLogin": "1991-12-27T22:29:31.96Z", "_meta": { "created": "1992-08-11T13:44:19.465Z", "updated": "1947-10-29T17:26:24.762Z", "migrationVersion": 52868747 }, "email": "culpa Excepteur laborum dolor nulla" }, "groups": [ { "_id": "4ef9293236e3219d3b9f8950", "provenance": "sit ut laborum commodo ipsum", "name": "dolore commodo laborum ea et", "description": "officia aliquip ut dolor pariatur", "memberOf": [ { "groupId": "687fa472e27bc45c0ca4faa1", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "incididunt aute aliquip" }, { "roleId": "officia et" }, { "roleId": "laborum occaecat dolore Duis dolor" }, { "roleId": "dolor dolore ullamco" } ], "inactive": false, "_meta": { "created": "1950-11-08T20:58:49.243Z", "updated": "1960-09-09T10:28:49.936Z", "migrationVersion": -32849643 } } ], "iterations": [ "D41F0f83-9Dfb-1b5D-b473-ecEb6c5a7A3e" ], "x": -70517543.67864142, "y": -58235177.25996678, "gridCoordinate": { "x": -17420549.803658277, "y": 17781090.682225153 }, "name": "pending", "summary": "ex magna cupidatat dolore", "description": "fugiat" } }, "parent": { "job": "esse occaecat eu culpa", "task": "aliqua fugiat cillum non magna", "iteration": 95511497.45572287, "element": -75283251.25244732 }, "errorHandler": null, "groups": [ "7c0275fd2cb1e0ac6b55f16e", { "_id": "e713c28ea29d7587ebacd13a", "provenance": "reprehenderit irure eu dolore minim", "name": "fugiat proident aliquip ullamco", "description": "eiusmod aute deserunt id cupidatat", "memberOf": [ { "groupId": "5ecd3b7b04b0414be955dc5b", "aaaManaged": true }, { "groupId": "a30cc169a8865cdf453417f1", "aaaManaged": true }, { "groupId": "9cae82b361a0667d68d2c63b", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "sit cupidatat laboris consectetur non" }, { "roleId": "elit nisi ut laborum" }, { "roleId": "ut commodo id cillum" }, { "roleId": "pariatur sit nisi" }, { "roleId": "dolor consectetur sit dolor" } ], "inactive": false, "_meta": { "created": "1946-12-13T06:26:02.594Z", "updated": "1944-06-26T04:15:28.465Z", "migrationVersion": -57360682 } }, { "_id": "d9785301b6fee40883951dae", "provenance": "irure quis sunt aute", "name": "aliquip est in ea", "description": "officia quis", "memberOf": [ { "groupId": "b6b46adcc971d268d3698770", "aaaManaged": false }, { "groupId": "2e9c67e37c6c57f4e9a7dac1", "aaaManaged": false }, { "groupId": "3274c4a17775bbdcbb0611d7", "aaaManaged": false }, { "groupId": "cb48c477f6772bd859b9371f", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "labore ut Ut do" }, { "roleId": "in minim culpa" } ], "inactive": true, "_meta": { "created": "1962-09-14T09:45:23.292Z", "updated": "2006-05-10T07:35:24.02Z", "migrationVersion": 10724280 } }, { "_id": "829e55fd423fcb126ea532e5", "provenance": "eu proident aliquip", "name": "nulla reprehenderit incididunt occaecat", "description": "enim consectetur", "memberOf": [ { "groupId": "bbb640e8bc378e9d25be5b06", "aaaManaged": false }, { "groupId": "3dfdd134fa7195bb8925f0a4", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ut dolor eu" }, { "roleId": "laboris non incididunt fugiat" }, { "roleId": "Ut" }, { "roleId": "eiusmod nulla" } ], "inactive": true, "_meta": { "created": "1968-03-04T01:11:11.127Z", "updated": "1987-12-17T00:39:07.277Z", "migrationVersion": 98049920 } } ], "watchers": [ "c41acad8c17c0b50b4fd6ac1" ], "metrics": { "start_time": 34455698.048243344, "progress": 0.8926658066624429, "end_time": -84166029.94035007, "user": { "_id": "81e9bc241d9716902ea9505f", "provenance": "qui dolore anim", "username": "incididunt fugiat exercitation culpa", "firstname": "ex esse laborum dolore", "memberOf": [ { "groupId": "1725b08ddf196bce94a8f30b", "aaaManaged": false }, { "groupId": "645840f430832d69ce2f5144", "aaaManaged": false }, { "groupId": "21047d13ac1de4c9508b536e", "aaaManaged": true }, { "groupId": "26d44b2b83fdb8e337c7e843", "aaaManaged": true }, { "groupId": "47de4a8f36c9d06e0e099c89", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "consequat amet" }, { "roleId": "officia mollit deserunt" }, { "roleId": "aliqua quis sint dolor" }, { "roleId": "cupidatat anim consectetur proident adipisicing" } ], "inactive": true, "lastLogin": "1953-08-28T17:19:24.576Z", "_meta": { "created": "1975-02-17T22:14:44.921Z", "updated": "2018-11-14T11:39:47.957Z", "migrationVersion": -21738821 }, "email": "culpa Ut" }, "owner": "dfc8f03fae6b02be6f818b07" } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }