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": "75bb802e86546be21e7a4825", "uuid": "7cd5871f-4324-50a8-dfcc-2595795f0f27", "font_size": -88374250, "type": "resource:compliance", "created": "1985-05-12T00:05:31.181Z", "last_updated": "1985-02-28T01:28:52.282Z", "createdVersion": "9875.3.99277-6126.899086280.09706686", "lastUpdatedVersion": "5447755.20907.8834-6147.93717.46008919.136794685", "canvasVersion": 1.5, "encodingVersion": 1, "migrationVersion": 74603482, "name": "myCoolDocumentName", "description": null, "preAutomationTime": 40732914.403436124, "sla": -74222338.49601118, "decorators": [ { "type": "encryption", "pointer": "/~1/~0/~0/VjRNqmaYb/~0/~1/HH//~0/~0" }, { "type": "encryption", "pointer": "/fI592xS" }, { "type": "encryption", "pointer": "/~1/~1/~1/~0/XQLeKWc/HUI0t/~0/~1" }, { "type": "encryption", "pointer": "/~1/~0" } ], "status": "complete", "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 } ], "warnings": [ { "task": "workflow_start", "name": "myCoolDocumentName" } ], "ancestors": null, "validationErrors": [ { "keyword": "Excepteur eiusmod aute", "instancePath": "velit adipisicing laboris in", "schemaPath": "nulla in amet elit", "message": "fugiat aute" }, { "keyword": "amet qui laboris minim", "instancePath": "ipsum dolore in est", "schemaPath": "ad et do laboris", "message": "ea officia adipisicing est" }, { "keyword": "laboris aliquip", "instancePath": "enim nisi magna aliqua", "schemaPath": "ex sint", "message": "laborum et elit tempor" }, { "keyword": "elit", "instancePath": "aliquip sint", "schemaPath": "elit velit esse", "message": "do pariatur" } ], "created_by": { "_id": "3a5b02029f4c467183b88608", "provenance": "dolor ad qui et Ut", "username": "do", "firstname": "elit consectetur Duis do aliqua", "memberOf": [ { "groupId": "9ceb2e6a5e4c81bf66178ee2", "aaaManaged": false }, { "groupId": "7e845da793f3042df0ea151c", "aaaManaged": true }, { "groupId": "425bf9c425cf2972d491d67e", "aaaManaged": true }, { "groupId": "844c996ce85c365c785ae764", "aaaManaged": true }, { "groupId": "f6434c479cac7e8def893181", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "in quis proident aliquip dolore" }, { "roleId": "exercitation" }, { "roleId": "laboris ullamco culpa" } ], "inactive": false, "lastLogin": "2013-03-06T17:16:51.631Z", "_meta": { "created": "2003-05-14T10:09:17.968Z", "updated": "1947-04-27T01:37:30.216Z", "migrationVersion": 53914606 }, "email": "sit reprehenderit anim" }, "last_updated_by": null, "tasks": { "workflow_start": { "x": 85337223.64760098, "y": -77913526.1201989, "gridCoordinate": { "x": 35040442.75530264, "y": -73559820.33933173 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 80036986.55611521, "finish_state": "error", "user": "bb90768d39acb10074cfca6f" }, "groups": [ "9e8fc9cb35f76fc50b150146" ], "iterations": [] }, "workflow_end": { "x": -3901583.658392042, "y": 71284427.80357102, "gridCoordinate": { "x": 5845014.942820057, "y": -61473316.91322755 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "3a1f", "workflow_start", "workflow_end" ], "complete": [ "e28f", "workflow_start", "workflow_start", "workflow_start", "e28f" ], "error": [ "workflow_start", "workflow_end", "3a1f" ] }, "metrics": { "end_time": 92848321.9981921, "run_time": -4680790.250972718 }, "groups": [ "608c926530127eeca39bf9ca", "default", "62c5d73b3267f236b6baa704" ], "iterations": [ "2B38C44B-d2DC-2a96-c7dd-2155886305Dd", "ce50baC2-c54E-533D-fc78-e1A63cb587f8", "4e9c5eEC-B5EB-d3DB-fb20-66c7013Fa8d5" ] }, "error_handler": { "x": 33388573.937182248, "y": 80645643.71710584, "gridCoordinate": { "x": -20160558.070420504, "y": 40351616.22670254 }, "name": "childJob", "location": "Broker", "locationType": null, "app": "dolore", "canvasName": "labore dolor dolore", "displayName": "dolor eu id eiusmod", "summary": "ipsum", "description": "est in ut ad", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/yVNWvgYnNNx/Gzh4q/~1/~0/~1/~0/g/Cf" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "amet aliquip", "highlightString": "et elit cillum" }, { "key": "mollit sed cillum dolore tempor", "highlightString": "id Ut minim amet" }, { "key": "mollit", "highlightString": "qui culpa ullamco dolor officia" }, { "key": "veniam non elit", "highlightString": "anim" }, { "key": "consequat cillum labore ex minim", "highlightString": "consectetur minim" } ], "status": "canceled", "previous": { "incomplete": [ "e28f", "workflow_start", "error_handler", "error_handler" ], "complete": [ "e28f", "workflow_end" ], "error": [ "e28f" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "3a1f", "type": "revert" }, { "task": "workflow_start", "type": "standard" } ], "failure": [ { "task": "3a1f", "type": "loop" }, { "task": "e28f", "type": "standard" }, { "task": "workflow_start", "type": "revert" }, { "task": "error_handler", "type": "loop" }, { "task": "workflow_start", "type": "loop" } ], "error": [ { "task": "workflow_end", "type": "revert" }, { "task": "error_handler", "type": "standard" }, { "task": "error_handler", "type": "revert" }, { "task": "e28f", "type": "revert" } ] }, "serverId": "dolor aliquip consequat", "start_time": "1951-10-16T20:28:37.13Z", "end_time": 52546897.521478355, "finish_state": "success", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ { "_id": "0d42d33aff2704c9df89ab79", "provenance": "culpa sint non", "name": "nisi", "description": "deserunt Ut", "memberOf": [ { "groupId": "64863842be91ed0ada657da1", "aaaManaged": false }, { "groupId": "17c8c4c1ba635027a324a9f3", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "quis Excepteur do ad" }, { "roleId": "esse voluptate anim magna incididunt" }, { "roleId": "Lorem reprehenderit ipsum qui veniam" }, { "roleId": "commodo velit" } ], "inactive": true, "_meta": { "created": "1987-09-30T23:25:01.979Z", "updated": "1965-03-19T10:34:51.912Z", "migrationVersion": -31022480 } } ], "iterations": [ "82bD3B3B-DCD2-cD3B-6092-B881eB3f77Ca", "CeE7C04D-C854-6eD0-FaeC-dF50546E9ddD", "6A7B8E95-aa7D-D75C-f5C3-C56DCfEc4B5D" ] }, "a5": { "actor": "job", "groups": [ "default", "default", { "_id": "641a8046d4a8ce2936a5eb79", "provenance": "sed occaecat consectetur dolore in", "name": "laboris", "description": "non magna ullamco in", "memberOf": [ { "groupId": "618cebf68732fb78e387fc82", "aaaManaged": true }, { "groupId": "63ed60608a597fa8a8aacafd", "aaaManaged": true }, { "groupId": "41e7022779e1bddc1add578a", "aaaManaged": true }, { "groupId": "bcf3f18083b113945761e185", "aaaManaged": true }, { "groupId": "c77e8e1db7409af11d18c392", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "dolor veniam nulla adipisicing incididunt" } ], "inactive": false, "_meta": { "created": "2012-12-13T09:37:19.338Z", "updated": "1971-04-26T14:19:20.049Z", "migrationVersion": -37315873 } }, { "_id": "f907ce179908e134fc8133b6", "provenance": "amet", "name": "sed laborum pariatur", "description": "dolore dolor ut est", "memberOf": [ { "groupId": "55f6a8cf9972ce7fb0843b6d", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "elit pariatur deserunt sit" }, { "roleId": "esse ullamco amet occaecat dolore" }, { "roleId": "culpa" } ], "inactive": true, "_meta": { "created": "1966-06-27T17:34:46.014Z", "updated": "1981-08-24T05:02:26.746Z", "migrationVersion": -57627487 } }, "0417505e5566055d50c6eac8" ], "iterations": [ "23a2A1a8-6faF-Abba-D3eB-7eEC7b79A9ca" ], "x": -80950857.39452505, "y": 80531609.09935904, "gridCoordinate": { "x": 56411819.449056745, "y": 86145575.01623374 }, "name": "incididunt consectetur in voluptate", "location": "Broker", "locationType": null, "app": "eu mollit nisi est", "canvasName": "childJob", "displayName": "magna quis", "summary": "ut", "description": "pariatur consequat ut aute", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/~0/OaiMx2o" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "occaecat irure", "highlightString": "nostrud Ut eu ullamco" }, { "key": "amet adipisicing ut pariatur", "highlightString": "cupidatat in fugiat" }, { "key": "anim consectetur adipisicing", "highlightString": "in esse officia" }, { "key": "Excepteur", "highlightString": "Lorem incididunt cupidatat fugiat elit" } ], "status": "scheduled", "previous": { "incomplete": [ "error_handler" ], "complete": [ "3a1f", "error_handler", "error_handler", "workflow_start" ], "error": [ "3a1f", "3a1f", "workflow_start", "workflow_start" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "error_handler", "type": "revert" }, { "task": "error_handler", "type": "loop" }, { "task": "3a1f", "type": "revert" } ], "failure": [ { "task": "error_handler", "type": "standard" }, { "task": "workflow_start", "type": "revert" }, { "task": "error_handler", "type": "revert" }, { "task": "workflow_start", "type": "standard" } ], "error": [ { "task": "workflow_start", "type": "standard" }, { "task": "e28f", "type": "revert" }, { "task": "3a1f", "type": "standard" }, { "task": "e28f", "type": "loop" }, { "task": "3a1f", "type": "standard" } ] }, "serverId": "et exercitation", "start_time": "1978-08-28T01:35:47.949Z", "end_time": -52780770.48870014, "finish_state": "success", "retrySettings": { "state": [ "success" ], "autoRetry": true, "limit": 74177519, "delay": 91426391, "count": 22285431, "finishedRetrying": true }, "loop": { "atLeastOneComplete": true, "finishedCount": 74601009.42923349, "outgoing": [] }, "childJobs": [ { "_id": "ad Duis dolor irure", "name": "amet laboris velit", "iteration": -40260438.540130526 }, { "_id": "mollit Lorem irure sit", "name": "magna reprehenderit dolore sit", "iteration": -73219821.44846025 }, { "_id": "minim dolore magna ea", "name": "dolor velit", "iteration": -31484810.130288824 } ] } }, "parent": { "task": "mollit laboris adipisicing officia sint", "iteration": -49398711.92285823, "element": 69642974.64080903 }, "errorHandler": { "actor": { "_id": "c4d081d0ac66bf5df1b019cc", "provenance": "eiusmod ut", "username": "fugiat consectetur exercitation", "firstname": "pariatur", "memberOf": [ { "groupId": "556617a5481b9d03eed3d5c2", "aaaManaged": true }, { "groupId": "0d1e5a8738b9bf92f5fd31c3", "aaaManaged": false }, { "groupId": "12216158110a5dde9332bff9", "aaaManaged": true }, { "groupId": "1bfbe681d87f2aff4b13b06e", "aaaManaged": false }, { "groupId": "dc75b460d357bf68fc457414", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "reprehenderit" }, { "roleId": "dolore non labore Excepteur" }, { "roleId": "id" } ], "inactive": true, "lastLogin": "2023-05-04T21:48:46.603Z", "_meta": { "created": "1976-01-25T08:21:18.468Z", "updated": "1971-04-25T16:38:45.803Z", "migrationVersion": 22261159 }, "email": "eu cupidatat deserunt et" }, "groups": [ { "_id": "5efaa692fee36f3ef50c1832", "provenance": "Lorem cupidatat dolore", "name": "veniam sed irure ullamco ex", "description": "mollit consectetur est", "memberOf": [ { "groupId": "7d219f4047df695d77d3b3e0", "aaaManaged": true }, { "groupId": "42492848de6a139afba7b801", "aaaManaged": true }, { "groupId": "454d64efcd06862244d81e19", "aaaManaged": true }, { "groupId": "21660683f899688fcbf774ad", "aaaManaged": false }, { "groupId": "ad54a72725f2e51bd3106caa", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "dolore magna cupidatat minim consectetur" } ], "inactive": true, "_meta": { "created": "1989-04-04T06:55:35.602Z", "updated": "1967-04-28T22:22:25.503Z", "migrationVersion": 80197553 } }, "75b3af851d7b87400f177042", "2d6ad9c3532b66136e06cc49", { "_id": "3531dca1d773a37f96aa79b6", "provenance": "nisi culpa eu", "name": "fugiat sint", "description": "commodo enim consequat", "memberOf": [ { "groupId": "8a4898a04e9e928eb7e6ee24", "aaaManaged": false }, { "groupId": "b7573a5991503622c11c1a85", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "sint" }, { "roleId": "ut nulla sunt Lorem" }, { "roleId": "eiusmod in ex" } ], "inactive": true, "_meta": { "created": "1977-10-15T00:45:03.46Z", "updated": "2005-08-30T07:31:21.311Z", "migrationVersion": 87289267 } }, { "_id": "5b5d8d2510a405faac43cf5b", "provenance": "aliqua est in sit enim", "name": "non velit reprehenderit fugiat", "description": "sunt magna cupidatat", "memberOf": [ { "groupId": "46694627d6dd527553391f07", "aaaManaged": false }, { "groupId": "4a41ff5a6a0ecc8f7a8235f6", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "labore" } ], "inactive": true, "_meta": { "created": "1981-08-27T13:21:17.861Z", "updated": "2021-08-12T18:33:08.535Z", "migrationVersion": 24069074 } } ], "iterations": [ "387C2f7A-0ded-6a1b-Fb86-F3e6E9b68A3c", "e3Ae5Da3-bFe8-FaDC-3578-6E8aee712Cae" ], "x": -62438991.5161256, "y": 23924088.5389774, "gridCoordinate": { "x": -38202011.25528406, "y": -13771866.820050344 }, "name": "velit", "location": "Application", "locationType": null, "app": "elit et reprehenderit pariatur", "canvasName": "childJob", "displayName": "ex", "summary": "laborum Excepteur ad elit laboris", "description": "Excepteur laboris ullamco", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/q.hvaH+Dm6r/j6-R+h6j/d0.E.icV/~0/X-E/tSBirVl/OR-A1GSO/In/~1/~0/~1/H37c,ZP" }, { "type": "encryption", "pointer": "/~1" }, { "type": "encryption", "pointer": "/TMCg6T5hDw/~0/~0/XP3A3Q1g/BtYAGbxrO2/gSerpI/zDiBKejHo/~0" }, { "type": "encryption", "pointer": "/~1/~0/~1/~0/~0/~1/~0/~1/Zdd,cbqkiwY" }, { "type": "encryption", "pointer": "/~0/FZMZYqIe/~1/s/lRl/VePaUTruJo/OU/SdJN" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "esse id", "highlightString": "dolor exercitation sunt" }, { "key": "minim", "highlightString": "aliqua" }, { "key": "consequat nisi magna eiusmod sed", "highlightString": "sed anim enim" } ], "status": "error", "previous": { "incomplete": [ "error_handler", "workflow_end", "e28f", "3a1f", "3a1f" ], "complete": [ "workflow_end", "workflow_start" ], "error": [ "workflow_start", "workflow_start", "e28f", "workflow_start" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "error_handler", "type": "standard" }, { "task": "workflow_start", "type": "revert" } ], "failure": [ { "task": "workflow_start", "type": "loop" }, { "task": "3a1f", "type": "loop" }, { "task": "workflow_end", "type": "standard" }, { "task": "workflow_start", "type": "loop" } ], "error": [ { "task": "workflow_start", "type": "revert" }, { "task": "e28f", "type": "loop" } ] }, "serverId": "qui ad deserunt", "start_time": "1983-06-02T07:05:11.558Z", "end_time": 7333515.617351472, "finish_state": "failure", "retrySettings": null, "loop": { "atLeastOneComplete": true, "finishedCount": -76175795.72686672, "outgoing": [] }, "childJobs": [ { "_id": "Duis cillum sit consequat", "name": "ipsum esse reprehenderit", "iteration": -33954959.87588219 } ] }, "groups": [ "24a8f144dd58ec34cfdc80bf", { "_id": "9ce7c24f4f1edc9b81fd5c84", "provenance": "eu", "name": "proident occaecat qui Excepteur", "description": "commodo voluptate", "memberOf": [ { "groupId": "c58958e42dac57efc6a23196", "aaaManaged": true }, { "groupId": "2f2b7098fea7d845e5401ece", "aaaManaged": true }, { "groupId": "63a3d1870110ed57adc1d59e", "aaaManaged": true }, { "groupId": "c21254fe8408981476c7d857", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ea dolore deserunt" }, { "roleId": "adipisicing dolor ullamco quis" }, { "roleId": "ut voluptate aliqua sed officia" } ], "inactive": false, "_meta": { "created": "1981-12-16T22:21:29.951Z", "updated": "1976-11-15T12:09:40.43Z", "migrationVersion": -83310294 } }, { "_id": "dc441545d222a924dde696c5", "provenance": "enim consectetur sint exercitation", "name": "veniam exercitation reprehenderit", "description": "ad consectetur dolore fugiat magna", "memberOf": [ { "groupId": "96ed382107f1d2cade73fc0a", "aaaManaged": true }, { "groupId": "5a668fd6521f9f3710aa6045", "aaaManaged": false }, { "groupId": "bbb09ba7713dc3ff8dc91110", "aaaManaged": false }, { "groupId": "28beb37c61e23c31e16c7193", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "culpa" }, { "roleId": "ad in eu officia Excepteur" }, { "roleId": "Duis" } ], "inactive": true, "_meta": { "created": "2019-08-09T13:01:30.178Z", "updated": "1969-02-14T13:39:23.634Z", "migrationVersion": 90316709 } }, "ca362ff22f447f7b0c94e3d2", "default" ], "watchers": [ "7019c9ac63f471ee6c5935d1", { "_id": "170d6263424a192fe0037f51", "provenance": "ut nisi est ad", "username": "proident", "firstname": "in incididunt qui dolore in", "memberOf": [ { "groupId": "7d11e7573ed821b602c47260", "aaaManaged": false }, { "groupId": "504ee7eba78ff9eb56723f6e", "aaaManaged": false }, { "groupId": "dbc081fbda82bae0224c7140", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "quis incididunt pariatur tempor amet" }, { "roleId": "irure tempor" }, { "roleId": "veniam consequat" }, { "roleId": "enim et sed culpa Duis" }, { "roleId": "aliquip ut" } ], "inactive": false, "lastLogin": "2019-12-31T12:47:32.232Z", "_meta": { "created": "1993-09-26T21:45:00.893Z", "updated": "1947-05-15T10:34:10.277Z", "migrationVersion": 75173843 }, "email": "dolore esse quis in magna" }, "eed551b8f7d5c08971a2a8b0", "b5ceaab4fa6bc8f9d85ac94b", "Pronghorn" ], "metrics": { "start_time": 6160981.356446534, "progress": 0.5930768164525464, "end_time": -59605666.667142734, "user": { "_id": "a4756262b5b20b33506e71f8", "provenance": "adipisicing dolore", "username": "Ut elit", "firstname": "non adipisicing qui Duis officia", "memberOf": [ { "groupId": "e4ce36e0092d47e79bbeaf35", "aaaManaged": true }, { "groupId": "3e8de77e5be8f826ae4f2fdc", "aaaManaged": true }, { "groupId": "e114f9732f4e866256053a90", "aaaManaged": false }, { "groupId": "cf5116e4965c32b16511aee1", "aaaManaged": true }, { "groupId": "19102b035c7ac01313580d8a", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "et" }, { "roleId": "laboris nisi Duis amet" }, { "roleId": "enim" } ], "inactive": false, "lastLogin": "1979-04-15T16:12:56.94Z", "_meta": { "created": "2012-08-08T10:07:03.344Z", "updated": "2008-07-07T21:47:32.803Z", "migrationVersion": -61289712 }, "email": "dolore proident Lorem sed" }, "owner": "Pronghorn" } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }