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": "a32f494b342e4a3ebb5c8999", "font_size": -30436233, "type": "automation", "created": "1975-09-15T04:26:47.35Z", "last_updated": "2008-10-12T11:37:07.335Z", "createdVersion": "8.867.864-0702.21197860204.96.10", "lastUpdatedVersion": "91440.60079.8371440128", "canvasVersion": 2, "encodingVersion": 1, "migrationVersion": -63935036, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": -4093179.3336648494, "sla": -61053012.77016415, "decorators": [ { "type": "encryption", "pointer": "/~1/UEUS+gCdJ/~0/x78kO/~1/jffuec/~1" }, { "type": "encryption", "pointer": "/a/udE+COp/~0/X.hHSmy/~1" }, { "type": "encryption", "pointer": "/BcGtQ/~0/~0/wZZgMIk/~1/~1/Y2Tn3f" }, { "type": "encryption", "pointer": "/~1" }, { "type": "encryption", "pointer": "/~1/~0/hmF/LplxaFKm5/~1/~1" } ], "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": "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 } ], "warnings": [ { "task": "workflow_start", "name": "myCoolDocumentName" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "cupidatat dolore dolore in" }, { "task": "e28f", "name": "myCoolDocumentName", "message": "non" } ], "ancestors": null, "validationErrors": [ { "keyword": "ex consectetur consequat amet pariatur", "instancePath": "ea", "schemaPath": "do", "message": "ad sit reprehenderit" } ], "created_by": "ffea7e5a34f3e5eaa9815b63", "last_updated_by": "Pronghorn", "tasks": { "workflow_start": { "x": 12467039.053676203, "y": 35993555.5960086, "gridCoordinate": { "x": 32048486.915116966, "y": 67650927.06726882 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -17969015.2472388, "finish_state": "failure", "user": { "_id": "c2f99870a322709803551dae", "provenance": "culpa ad sint enim consequat", "username": "ad ipsum", "firstname": "occaecat", "memberOf": [ { "groupId": "9362173748afa0eb36304312", "aaaManaged": true }, { "groupId": "22cd44f2ca3152566da3dabe", "aaaManaged": false }, { "groupId": "0c0de2e1d68b6af96ada1b9a", "aaaManaged": false }, { "groupId": "a810abcf66eb853383294a6d", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "non" }, { "roleId": "amet consectetur in minim" }, { "roleId": "adipisicing amet velit" }, { "roleId": "sunt" }, { "roleId": "veniam laborum" } ], "inactive": false, "lastLogin": "1960-11-01T06:28:08.085Z", "_meta": { "created": "1961-04-29T20:26:11.854Z", "updated": "2016-09-08T02:49:01.877Z", "migrationVersion": 1775853 }, "email": "officia nisi eiusmod" } }, "groups": [ { "_id": "c88de05a0c02ddadd06f16fb", "provenance": "quis Duis dolore ipsum sunt", "name": "id sint occaecat", "description": "consequat Ut", "memberOf": [ { "groupId": "c825664db5abdf859637b7ff", "aaaManaged": false }, { "groupId": "984129b98ac20e11cacfa809", "aaaManaged": true }, { "groupId": "71cd74b4aab6fc20be4c36bf", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ex aliquip" }, { "roleId": "eu aliquip Lorem" }, { "roleId": "labore ullamco pariatur velit aliquip" }, { "roleId": "esse eu do deserunt nulla" } ], "inactive": false, "_meta": { "created": "1989-05-13T16:36:55.887Z", "updated": "1975-07-18T02:38:18.334Z", "migrationVersion": 12758770 } }, "default", "10617c425ee7260075837a37" ], "iterations": [ "0194eFda-2bB1-8507-4b6e-11cBEAEb57ed", "70C51Fe9-44C9-d515-4176-fea72A1A07f6" ] }, "workflow_end": { "x": -43153080.55627267, "y": -71909256.66722845, "gridCoordinate": { "x": -84055566.55311415, "y": 93349546.43817577 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_end" ], "complete": [ "workflow_end", "workflow_start", "workflow_end" ], "error": [ "workflow_end", "3a1f", "workflow_end", "workflow_start" ] }, "metrics": { "end_time": 8227321.795587048, "run_time": -96681469.11338753 }, "groups": [ "18bf7efacd298a68cbbf1f3a" ], "iterations": [] }, "error_handler": { "x": -395619.6674709469, "y": 61649996.38535103, "gridCoordinate": { "x": 45096427.74717802, "y": -34083773.188159004 }, "name": "childJob", "location": "Adapter", "locationType": null, "app": "nulla elit enim ex laborum", "canvasName": "velit magna ex sint", "displayName": "adipisicing sint", "summary": "dolore", "description": "magna ullamco ea sit", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/Z.P/~1/~1/~1/~1" }, { "type": "encryption", "pointer": "/~0/BlgE0,/~1/qmj/+22/ngp0aX/~1/~0/eNCPAHOlFeL/d/~0" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "occaecat", "highlightString": "elit nisi dolore" }, { "key": "officia sed in dolore", "highlightString": "quis" } ], "status": "incomplete", "previous": { "incomplete": [ "workflow_end", "e28f", "3a1f" ], "complete": [ "workflow_start" ], "error": [ "workflow_end", "e28f" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "error_handler", "type": "revert" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "standard" } ], "failure": [ { "task": "workflow_end", "type": "standard" }, { "task": "3a1f", "type": "loop" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_end", "type": "standard" } ], "error": [ { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "revert" }, { "task": "e28f", "type": "loop" }, { "task": "error_handler", "type": "loop" }, { "task": "workflow_end", "type": "loop" } ] }, "serverId": "qui quis", "start_time": "1981-03-07T02:36:54.858Z", "end_time": 74642605.15154889, "finish_state": "error", "retrySettings": { "state": [ "failure", "success", "success", "failure" ], "autoRetry": true, "limit": 59596508, "delay": 78691019, "count": 36750225, "finishedRetrying": true }, "type": "operation", "actor": "415163c6afab9b321ef4d52a", "groups": [ "ebd998297e48c339c8049748" ], "iterations": [ "2aed8Acc-5f70-be1C-d9ab-DDEda42C7092", "c33AEA3A-9a4f-6ff1-C079-2856FbADAA78" ] }, "4a56": { "actor": "job", "groups": [ { "_id": "7b38ad1a5759bb2cbfd51d07", "provenance": "ipsum velit sint ullamco in", "name": "ad in irure elit Duis", "description": "reprehenderit laboris sunt consectetur in", "memberOf": [ { "groupId": "b316f51f2b2928e4e1165b8c", "aaaManaged": false }, { "groupId": "42be7d36fc90b6db1d416b5b", "aaaManaged": true }, { "groupId": "f07c5b4e5d9c1d1708cd2c93", "aaaManaged": true }, { "groupId": "9094699adf5f69c7e765841f", "aaaManaged": true }, { "groupId": "c4edb242b8acb700758b522d", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "voluptate culpa exercitation" } ], "inactive": true, "_meta": { "created": "2017-06-12T16:14:35.378Z", "updated": "1996-10-04T16:12:21.489Z", "migrationVersion": -49668837 } }, { "_id": "0024b3018e632705decae72d", "provenance": "tempor aliqua qui occaecat aute", "name": "laborum voluptate laboris", "description": "pariatur in ut nulla", "memberOf": [ { "groupId": "98ba571451e783ea3079527f", "aaaManaged": true }, { "groupId": "0b2b979dfe7e78019cd87974", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "et amet" }, { "roleId": "ut nostrud id ad quis" } ], "inactive": true, "_meta": { "created": "2008-10-11T18:29:46.613Z", "updated": "2016-05-26T13:26:15.025Z", "migrationVersion": -5838426 } } ], "iterations": [ "9Ae3CE8E-dbcb-625E-27a2-5708DA80cc22", "eA2A7D79-5A6d-4e1D-8727-8BC63abbB9d0" ], "x": -58987748.66518379, "y": -11732209.088479266, "gridCoordinate": { "x": 87328853.13331941, "y": -8542984.260236204 }, "name": "pariatur nulla eu qui", "location": "Broker", "locationType": "esse quis do", "app": "veniam in culpa incididunt", "canvasName": "nostrud", "displayName": "pariatur commodo ad", "summary": "in velit elit non dolor", "description": "voluptate ullamco", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~0/OzdE65fZC,/~0" }, { "type": "encryption", "pointer": "/u3Ff/~1/gW2T,u7wNb5" }, { "type": "encryption", "pointer": "/~1/CZ6Ru3/~0/~1/e/t2bnfQ9" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "occaecat id laboris laborum", "highlightString": "id fugiat deserunt in" }, { "key": "ullamco dolore", "highlightString": "dolore culpa ea labore irure" }, { "key": "elit", "highlightString": "cillum ut sed enim nulla" } ], "status": "error", "previous": { "incomplete": [ "workflow_start", "workflow_start", "workflow_end", "workflow_start", "3a1f" ], "complete": [ "error_handler", "workflow_start" ], "error": [ "workflow_start" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "error_handler", "type": "standard" }, { "task": "3a1f", "type": "standard" }, { "task": "3a1f", "type": "revert" } ], "failure": [ { "task": "error_handler", "type": "revert" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "loop" } ], "error": [ { "task": "3a1f", "type": "loop" }, { "task": "workflow_start", "type": "standard" } ] }, "serverId": "ullamco", "start_time": "1969-11-18T14:41:01.635Z", "end_time": 42128869.96754941, "finish_state": "error", "retrySettings": { "state": [ "failure", "success" ], "autoRetry": true, "limit": 69488169, "delay": 95379191, "count": 93122497, "finishedRetrying": true }, "type": "automatic" } }, "parent": { "job": "id commodo non anim sint", "task": "ad aute aliqua deserunt", "iteration": -69495665.20307386, "element": -55807695.89254775 }, "errorHandler": null, "groups": [ "0808fc60de0c69861b8c4d0b", { "_id": "9ad77b0ed43959bf208c9636", "provenance": "tempor aliquip proident", "name": "consequat", "description": "qui proident reprehenderit sit aliquip", "memberOf": [ { "groupId": "255cd154fa4f250f6e87c2b9", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "nisi" }, { "roleId": "anim tempor" }, { "roleId": "ut dolor cupidatat" }, { "roleId": "id Ut tempor" } ], "inactive": false, "_meta": { "created": "1951-11-21T05:18:19.522Z", "updated": "2019-10-05T23:53:28.115Z", "migrationVersion": 48877750 } }, "default" ], "watchers": [ null, "Pronghorn", "Pronghorn", "6ec00a7cb1a699469a672642", "175207281ca6206ecbf7fc46" ], "metrics": { "start_time": 95099537.89913985, "progress": 0.7857798228738648, "end_time": 99127409.84946543, "user": null, "owner": null } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }