diff --git a/assets/maestro-collection.json b/assets/maestro-collection.json index 41b4102..a8462ea 100644 --- a/assets/maestro-collection.json +++ b/assets/maestro-collection.json @@ -2,2507 +2,41 @@ "item": [ { "name": "WorkflowTrigger", - "description": "Method to trigger a workflow.", - "item": [ - { - "id": "166bfca9-ffc9-4b14-a374-ec9007be77e4", - "name": "Triggers a new instance of the workflow.", - "request": { - "name": "Triggers a new instance of the workflow.", - "description": { - "content": "Creates a new workflow instance, triggering the workflow.\n\n### Related topics\n\n- [How to trigger a Maestro workflow](/docs/maestro-api/how-to/trigger-workflow/)", - "type": "text/plain" - }, - "url": { - "path": [ - "v1.0", - "accounts", - ":accountId", - "workflows", - "trigger" - ], - "host": [ - "{{baseUrl}}aow-auth" - ], - "query": [ - { - "disabled": true, - "description": { - "content": "Managed Token Id registered with Docusign Account Server", - "type": "text/plain" - }, - "key": "mtid", - "value": "" - }, - { - "disabled": true, - "description": { - "content": "Managed Token Secret registered with Docusign account server", - "type": "text/plain" - }, - "key": "mtsec", - "value": "" - } - ], - "variable": [ - { - "type": "any", - "value": "", - "key": "accountId", - "disabled": false, - "description": { - "content": "(Required) The account ID.", - "type": "text/plain" - } - } - ] - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "body": { - "mode": "raw", - "raw": "{\n \"instanceName\": \"\",\n \"metadata\": {},\n \"participants\": {},\n \"payload\": {}\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, - "auth": null - }, - "response": [ - { - "id": "2fabd891-e24f-4f90-ab69-07b26bbad925", - "name": "Returns a workflow instance trigger URL that can be used to trigger a new instance or return to an instance in progress", - "originalRequest": { - "url": { - "path": [ - "v1.0", - "accounts", - ":accountId", - "workflows", - "trigger" - ], - "host": [ - "{{baseUrl}}aow-auth" - ], - "query": [ - { - "disabled": true, - "description": { - "content": "Managed Token Id registered with Docusign Account Server", - "type": "text/plain" - }, - "key": "mtid", - "value": "" - }, - { - "disabled": true, - "description": { - "content": "Managed Token Secret registered with Docusign account server", - "type": "text/plain" - }, - "key": "mtsec", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "body": { - "mode": "raw", - "raw": "{\n \"instanceName\": \"\",\n \"metadata\": {},\n \"participants\": {},\n \"payload\": {}\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - } - }, - "status": "Created", - "code": 201, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"instanceId\": \"\",\n \"workflowInstanceUrl\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "0ddc03e5-f053-4941-a1ee-db97d6c21511", - "name": "Bad Request received", - "originalRequest": { - "url": { - "path": [ - "v1.0", - "accounts", - ":accountId", - "workflows", - "trigger" - ], - "host": [ - "{{baseUrl}}aow-auth" - ], - "query": [ - { - "disabled": true, - "description": { - "content": "Managed Token Id registered with Docusign Account Server", - "type": "text/plain" - }, - "key": "mtid", - "value": "" - }, - { - "disabled": true, - "description": { - "content": "Managed Token Secret registered with Docusign account server", - "type": "text/plain" - }, - "key": "mtsec", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "body": { - "mode": "raw", - "raw": "{\n \"instanceName\": \"\",\n \"metadata\": {},\n \"participants\": {},\n \"payload\": {}\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - } - }, - "status": "Bad Request", - "code": 400, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"errorCode\": \"ERR_10999\",\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "c5dc987f-fbce-4662-be67-9684e4092ba4", - "name": "Authentication details are invalid", - "originalRequest": { - "url": { - "path": [ - "v1.0", - "accounts", - ":accountId", - "workflows", - "trigger" - ], - "host": [ - "{{baseUrl}}aow-auth" - ], - "query": [ - { - "disabled": true, - "description": { - "content": "Managed Token Id registered with Docusign Account Server", - "type": "text/plain" - }, - "key": "mtid", - "value": "" - }, - { - "disabled": true, - "description": { - "content": "Managed Token Secret registered with Docusign account server", - "type": "text/plain" - }, - "key": "mtsec", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "body": { - "mode": "raw", - "raw": "{\n \"instanceName\": \"\",\n \"metadata\": {},\n \"participants\": {},\n \"payload\": {}\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - } - }, - "status": "Unauthorized", - "code": 401, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"errorCode\": \"ERR_10999\",\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "3cb8ec93-8552-46e0-8146-f72f82fc5a5e", - "name": "Authorization Denied", - "originalRequest": { - "url": { - "path": [ - "v1.0", - "accounts", - ":accountId", - "workflows", - "trigger" - ], - "host": [ - "{{baseUrl}}aow-auth" - ], - "query": [ - { - "disabled": true, - "description": { - "content": "Managed Token Id registered with Docusign Account Server", - "type": "text/plain" - }, - "key": "mtid", - "value": "" - }, - { - "disabled": true, - "description": { - "content": "Managed Token Secret registered with Docusign account server", - "type": "text/plain" - }, - "key": "mtsec", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "body": { - "mode": "raw", - "raw": "{\n \"instanceName\": \"\",\n \"metadata\": {},\n \"participants\": {},\n \"payload\": {}\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - } - }, - "status": "Forbidden", - "code": 403, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"errorCode\": \"ERR_10999\",\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "254e21e8-63bc-4216-919f-86a5d9d5347c", - "name": "Resource not found when workflow definition id or workflow instance id doesn't exist", - "originalRequest": { - "url": { - "path": [ - "v1.0", - "accounts", - ":accountId", - "workflows", - "trigger" - ], - "host": [ - "{{baseUrl}}aow-auth" - ], - "query": [ - { - "disabled": true, - "description": { - "content": "Managed Token Id registered with Docusign Account Server", - "type": "text/plain" - }, - "key": "mtid", - "value": "" - }, - { - "disabled": true, - "description": { - "content": "Managed Token Secret registered with Docusign account server", - "type": "text/plain" - }, - "key": "mtsec", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "body": { - "mode": "raw", - "raw": "{\n \"instanceName\": \"\",\n \"metadata\": {},\n \"participants\": {},\n \"payload\": {}\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - } - }, - "status": "Not Found", - "code": 404, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"errorCode\": \"ERR_10999\",\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "ec80f1b1-737a-47b6-9c2a-2940c649dcb6", - "name": "Internal server error", - "originalRequest": { - "url": { - "path": [ - "v1.0", - "accounts", - ":accountId", - "workflows", - "trigger" - ], - "host": [ - "{{baseUrl}}aow-auth" - ], - "query": [ - { - "disabled": true, - "description": { - "content": "Managed Token Id registered with Docusign Account Server", - "type": "text/plain" - }, - "key": "mtid", - "value": "" - }, - { - "disabled": true, - "description": { - "content": "Managed Token Secret registered with Docusign account server", - "type": "text/plain" - }, - "key": "mtsec", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "body": { - "mode": "raw", - "raw": "{\n \"instanceName\": \"\",\n \"metadata\": {},\n \"participants\": {},\n \"payload\": {}\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - } - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"errorCode\": \"ERR_10999\",\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - } - ], - "event": [], - "protocolProfileBehavior": { - "disableBodyPruning": true - } - } - ] - }, - { - "name": "WorkflowInstanceManagement", - "description": "Methods to get information about workflow instances.", - "item": [ - { - "id": "9163e098-6e53-4475-9ba9-a1b6b85f02a4", - "name": "Cancels a running workflow instance.", - "request": { - "name": "Cancels a running workflow instance.", - "description": { - "content": "Cancels a running \n[workflow][workflows-concept]\ninstance.\n\n### Related topics\n\n- [How to cancel a Maestro workflow instance][howto-cancel]\n\n\n[howto-cancel]: /docs/maestro-api/how-to/cancel-workflow/\n[workflows-concept]: /docs/maestro-api/maestro101/workflows/", - "type": "text/plain" - }, - "url": { - "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "instances", - ":instanceId", - "cancel" - ], - "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [], - "variable": [ - { - "type": "any", - "value": "", - "key": "accountId", - "disabled": false, - "description": { - "content": "(Required) The account ID.", - "type": "text/plain" - } - }, - { - "type": "any", - "value": "", - "key": "instanceId", - "disabled": false, - "description": { - "content": "(Required) The instance ID of the workflow to cancel.", - "type": "text/plain" - } - } - ] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "body": {}, - "auth": null - }, - "response": [ - { - "id": "f7ab9559-cf48-43a2-85a4-b14cb169534e", - "name": "Return Success", - "originalRequest": { - "url": { - "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "instances", - ":instanceId", - "cancel" - ], - "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"message\": \"\",\n \"code\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "ddc10d10-fb6b-400e-abd8-fb691f9ad97b", - "name": "Authentication details are invalid", - "originalRequest": { - "url": { - "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "instances", - ":instanceId", - "cancel" - ], - "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "body": {} - }, - "status": "Unauthorized", - "code": 401, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"errorCode\": \"ERR_10999\",\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "4318522b-60e9-4579-86ac-a3953dc13b83", - "name": "The requested resource was not found", - "originalRequest": { - "url": { - "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "instances", - ":instanceId", - "cancel" - ], - "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "body": {} - }, - "status": "Not Found", - "code": 404, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"errorCode\": \"ERR_10999\",\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "f5a2f090-54c3-413a-8335-3539acb1b36d", - "name": "Internal server error", - "originalRequest": { - "url": { - "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "instances", - ":instanceId", - "cancel" - ], - "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "body": {} - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"errorCode\": \"ERR_10999\",\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - } - ], - "event": [], - "protocolProfileBehavior": { - "disableBodyPruning": true - } - }, - { - "id": "043a63e6-030a-4f3c-9e79-8417f0ddea0a", - "name": "Gets a list of configuration instances for a workflow definition", - "request": { - "name": "Gets a list of configuration instances for a workflow definition", - "description": { - "content": "Gets a list of configuration instances for a workflow definition.", - "type": "text/plain" - }, - "url": { - "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions", - ":workflowDefinitionId", - "configInstances" - ], - "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [], - "variable": [ - { - "type": "any", - "value": "", - "key": "accountId", - "disabled": false, - "description": { - "content": "(Required) The account ID.", - "type": "text/plain" - } - }, - { - "type": "any", - "value": "", - "key": "workflowDefinitionId", - "disabled": false, - "description": { - "content": "(Required) Workflow definition ID.", - "type": "text/plain" - } - } - ] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {}, - "auth": null - }, - "response": [ - { - "id": "36556fcf-3adf-48b5-92e1-4d82cb204fdb", - "name": "Returns a list of configuration instances for a workflow definition", - "originalRequest": { - "url": { - "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions", - ":workflowDefinitionId", - "configInstances" - ], - "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"configInstances\": [\n {\n \"savedValues\": {\n \"non_d\": false,\n \"officia9ad\": \"minim commodo magna pariatur\"\n },\n \"stepId\": \"\"\n },\n {\n \"savedValues\": {\n \"irure__1\": false\n },\n \"stepId\": \"\"\n }\n ],\n \"count\": \"\",\n \"workflowDefinitionId\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "fce51f15-2301-4709-a199-927d300d386f", - "name": "Bad request received", - "originalRequest": { - "url": { - "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions", - ":workflowDefinitionId", - "configInstances" - ], - "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "Bad Request", - "code": 400, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"errorCode\": \"ERR_10999\",\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "00bf2b00-75a7-4743-b0ca-2d8cfd028533", - "name": "Authentication details are invalid", - "originalRequest": { - "url": { - "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions", - ":workflowDefinitionId", - "configInstances" - ], - "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "Unauthorized", - "code": 401, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"errorCode\": \"ERR_10999\",\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "d4b80a0b-45b3-468d-9848-78aaa20eb3d6", - "name": "Authorization details are invalid", - "originalRequest": { - "url": { - "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions", - ":workflowDefinitionId", - "configInstances" - ], - "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "Forbidden", - "code": 403, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"errorCode\": \"ERR_10999\",\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "2d35d9cd-da6c-4fe4-9191-68533fb01bcb", - "name": "Resource not found", - "originalRequest": { - "url": { - "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions", - ":workflowDefinitionId", - "configInstances" - ], - "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "Not Found", - "code": 404, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"errorCode\": \"ERR_10999\",\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "f20322c1-00ea-4f5e-98d1-3f868e946af7", - "name": "Internal server error", - "originalRequest": { - "url": { - "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions", - ":workflowDefinitionId", - "configInstances" - ], - "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"errorCode\": \"ERR_10999\",\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - } - ], - "event": [], - "protocolProfileBehavior": { - "disableBodyPruning": true - } - }, - { - "id": "98dcf889-e91c-49fc-9fa1-bccf0dab10f7", - "name": "Get a list of instances of a deployed workflow definition.", - "request": { - "name": "Get a list of instances of a deployed workflow definition.", - "description": { - "content": "Get a list of instances of a deployed workflow definition.\n\nA successful response is an array of \n[`WorkflowInstance`](/docs/maestro-api/reference/workflowinstancemanagement/workflowinstancemanagement/getworkflowinstance/#schema_200_workflowinstance_workflowinstance)\nobjects.\n", - "type": "text/plain" - }, - "url": { - "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions", - ":workflowDefinitionId", - "instances" - ], - "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [], - "variable": [ - { - "type": "any", - "value": "", - "key": "accountId", - "disabled": false, - "description": { - "content": "(Required) The account ID.", - "type": "text/plain" - } - }, - { - "type": "any", - "value": "", - "key": "workflowDefinitionId", - "disabled": false, - "description": { - "content": "(Required) The ID of the workflow definition to delete.", - "type": "text/plain" - } - } - ] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {}, - "auth": null - }, - "response": [ - { - "id": "d26bfc44-2427-432e-b662-9f94f83b663a", - "name": "A list of workflow instances for a workflow definition in the specified account.", - "originalRequest": { - "url": { - "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions", - ":workflowDefinitionId", - "instances" - ], - "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "[\n {\n \"templateId\": \"\",\n \"dacId\": \"\",\n \"creatorId\": \"\",\n \"users\": {\n \"dolore5\": \"\",\n \"ea_327\": \"\",\n \"ut84\": \"\"\n },\n \"instanceState\": \"Failed\",\n \"accountId\": \"\",\n \"endDate\": \"\",\n \"instanceName\": \"\",\n \"progress\": {\n \"completedSteps\": \"\",\n \"currentCompletedStepName\": \"\",\n \"totalSteps\": \"\"\n },\n \"startDate\": \"\",\n \"startedBy\": {\n \"startedById\": \"\",\n \"startedByName\": \"\",\n \"startedByType\": \"Preparer\"\n }\n },\n {\n \"templateId\": \"\",\n \"dacId\": \"\",\n \"creatorId\": \"\",\n \"users\": {\n \"dolore_9\": \"\",\n \"nulla2\": \"\",\n \"nulla_9\": \"\"\n },\n \"instanceState\": \"Completed\",\n \"accountId\": \"\",\n \"endDate\": \"\",\n \"instanceName\": \"\",\n \"progress\": {\n \"completedSteps\": \"\",\n \"currentCompletedStepName\": \"\",\n \"totalSteps\": \"\"\n },\n \"startDate\": \"\",\n \"startedBy\": {\n \"startedById\": \"\",\n \"startedByName\": \"\",\n \"startedByType\": \"Participant\"\n }\n }\n]", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "cc86bab1-6220-4a3c-b0b4-aeadf7c90202", - "name": "Authentication details are invalid", - "originalRequest": { - "url": { - "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions", - ":workflowDefinitionId", - "instances" - ], - "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "Unauthorized", - "code": 401, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"errorCode\": \"ERR_10999\",\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "2ec6ad07-4d82-4725-8a35-69af542c5960", - "name": "Authorization details are invalid", - "originalRequest": { - "url": { - "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions", - ":workflowDefinitionId", - "instances" - ], - "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "Forbidden", - "code": 403, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"errorCode\": \"ERR_10999\",\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "e4886eee-7359-4b5c-8165-94ef0b0f53e2", - "name": "The requested resource was not found", - "originalRequest": { - "url": { - "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions", - ":workflowDefinitionId", - "instances" - ], - "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "Not Found", - "code": 404, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"errorCode\": \"ERR_10999\",\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "678e2efc-80e2-49b2-abaa-eb68909d9f11", - "name": "Internal server error", - "originalRequest": { - "url": { - "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions", - ":workflowDefinitionId", - "instances" - ], - "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"errorCode\": \"ERR_10999\",\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - } - ], - "event": [], - "protocolProfileBehavior": { - "disableBodyPruning": true - } - }, - { - "id": "ffabcba9-812b-43a5-9e58-5f53c05253b4", - "name": "Gets the details for a specific instance for a deployed workflow definition.", - "request": { - "name": "Gets the details for a specific instance for a deployed workflow definition.", - "description": { - "content": "Gets the details for a specific instance for a deployed workflow definition.\n\n### Related topics\n\n- [How to get the status of a Maestro workflow instance][howto-status]\n\n[howto-status]: /docs/maestro-api/how-to/get-workflow-status/\n", - "type": "text/plain" - }, - "url": { - "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions", - ":workflowDefinitionId", - "instances", - ":instanceId" - ], - "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [], - "variable": [ - { - "type": "any", - "value": "", - "key": "accountId", - "disabled": false, - "description": { - "content": "(Required) The account ID.", - "type": "text/plain" - } - }, - { - "type": "any", - "value": "", - "key": "workflowDefinitionId", - "disabled": false, - "description": { - "content": "(Required) Workflow definition ID.", - "type": "text/plain" - } - }, - { - "type": "any", - "value": "", - "key": "instanceId", - "disabled": false, - "description": { - "content": "(Required) Workflow instance ID. \nA string in UUID format: 4a6d6a08-xxxx-xxxx-xxxx-bae4fecc99c8\n", - "type": "text/plain" - } - } - ] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {}, - "auth": null - }, - "response": [ - { - "id": "39e48081-01e2-4702-8eaa-ba26fff369cc", - "name": "Details for a specific instance for a workflow definition in the specified account.", - "originalRequest": { - "url": { - "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions", - ":workflowDefinitionId", - "instances", - ":instanceId" - ], - "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"templateId\": \"\",\n \"dacId\": \"\",\n \"creatorId\": \"\",\n \"users\": {\n \"exercitationb0\": \"\",\n \"ipsum_879\": \"\"\n },\n \"instanceState\": \"Failed\",\n \"accountId\": \"\",\n \"endDate\": \"\",\n \"instanceName\": \"\",\n \"progress\": {\n \"completedSteps\": \"\",\n \"currentCompletedStepName\": \"\",\n \"totalSteps\": \"\"\n },\n \"startDate\": \"\",\n \"startedBy\": {\n \"startedById\": \"\",\n \"startedByName\": \"\",\n \"startedByType\": \"Anonymous\"\n }\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "3b345969-6b53-4ef1-a8c4-63e73407207e", - "name": "Authentication details are invalid", - "originalRequest": { - "url": { - "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions", - ":workflowDefinitionId", - "instances", - ":instanceId" - ], - "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "Unauthorized", - "code": 401, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"errorCode\": \"ERR_10999\",\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "e1b00f69-8faa-431a-90c1-22df5679de29", - "name": "Authorization details are invalid", - "originalRequest": { - "url": { - "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions", - ":workflowDefinitionId", - "instances", - ":instanceId" - ], - "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "Forbidden", - "code": 403, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"errorCode\": \"ERR_10999\",\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "dd305b05-a90c-4bc3-a2bf-49b1c0924ae5", - "name": "The requested resource was not found", - "originalRequest": { - "url": { - "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions", - ":workflowDefinitionId", - "instances", - ":instanceId" - ], - "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "Not Found", - "code": 404, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"errorCode\": \"ERR_10999\",\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "6549b6d6-3bab-46e2-b2bf-95165828ccc6", - "name": "Internal server error", - "originalRequest": { - "url": { - "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions", - ":workflowDefinitionId", - "instances", - ":instanceId" - ], - "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"errorCode\": \"ERR_10999\",\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - } - ], - "event": [], - "protocolProfileBehavior": { - "disableBodyPruning": true - } - } - ] - }, - { - "name": "WorkflowManagement", - "description": "Returns the history of the workflow instance steps.", - "item": [ - { - "id": "5d0377ad-6d6c-4474-9b62-f455fdd2af69", - "name": "Gets the step history for a workflow instance.", - "request": { - "name": "Gets the step history for a workflow instance.", - "description": { - "content": "Gets the step history for a workflow instance.", - "type": "text/plain" - }, - "url": { - "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "instances", - ":instanceId", - "history" - ], - "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [], - "variable": [ - { - "type": "any", - "value": "", - "key": "accountId", - "disabled": false, - "description": { - "content": "(Required) The account ID.", - "type": "text/plain" - } - }, - { - "type": "any", - "value": "", - "key": "instanceId", - "disabled": false, - "description": { - "content": "(Required) Workflow instance ID. \nA string in UUID format: 4a6d6a08-xxxx-xxxx-xxxx-bae4fecc99c8\n", - "type": "text/plain" - } - } - ] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {}, - "auth": null - }, - "response": [ - { - "id": "d06fd5b4-f7c3-4c2b-8459-fc3262ab34e0", - "name": "History of workflow steps is returned", - "originalRequest": { - "url": { - "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "instances", - ":instanceId", - "history" - ], - "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "[\n {\n \"dacId\": \"\",\n \"stepName\": \"\",\n \"stepState\": \"Completed\",\n \"userId\": \"\",\n \"accountId\": \"\",\n \"dsStepId\": \"\",\n \"endDate\": \"\",\n \"error\": {\n \"code\": \"\",\n \"endTime\": \"\",\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"name\": \"\",\n \"startTime\": \"\"\n },\n \"outputModuleProperties\": {\n \"inf\": 44663490.227534235,\n \"est1\": 47410090,\n \"ad_23_\": true,\n \"pariatur6\": \"laborum veniam et culpa elit\"\n },\n \"startDate\": \"\",\n \"stepId\": \"\"\n },\n {\n \"dacId\": \"\",\n \"stepName\": \"\",\n \"stepState\": \"Completed\",\n \"userId\": \"\",\n \"accountId\": \"\",\n \"dsStepId\": \"\",\n \"endDate\": \"\",\n \"error\": {\n \"code\": \"\",\n \"endTime\": \"\",\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"name\": \"\",\n \"startTime\": \"\"\n },\n \"outputModuleProperties\": {\n \"commodo_f\": \"Duis\",\n \"Lorem4e\": 83151973,\n \"tempor_8\": true\n },\n \"startDate\": \"\",\n \"stepId\": \"\"\n }\n]", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "7418e534-21fc-415f-9eac-61d11513de95", - "name": "Authentication details are invalid", - "originalRequest": { - "url": { - "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "instances", - ":instanceId", - "history" - ], - "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "Unauthorized", - "code": 401, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"errorCode\": \"ERR_10999\",\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "d1212a04-cf5d-4bd6-9eae-5548b3a6e7fa", - "name": "Authorization details are invalid", - "originalRequest": { - "url": { - "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "instances", - ":instanceId", - "history" - ], - "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "Forbidden", - "code": 403, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"errorCode\": \"ERR_10999\",\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "271064f0-92d7-4894-a96b-5a49de68a19e", - "name": "The requested resource was not found", - "originalRequest": { - "url": { - "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "instances", - ":instanceId", - "history" - ], - "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "Not Found", - "code": 404, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"errorCode\": \"ERR_10999\",\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "1e41a21f-7891-43a2-8576-93349a1fccc6", - "name": "Internal server error", - "originalRequest": { - "url": { - "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "instances", - ":instanceId", - "history" - ], - "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"errorCode\": \"ERR_10999\",\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - } - ], - "event": [], - "protocolProfileBehavior": { - "disableBodyPruning": true - } - }, - { - "id": "3ba81d8e-b50c-440d-ac6e-b72573c9c61a", - "name": "Gets a list of workflow definition metadata.", - "request": { - "name": "Gets a list of workflow definition metadata.", - "description": { - "content": "Gets a list of workflow definition metadata.", - "type": "text/plain" - }, - "url": { - "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions" - ], - "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [ - { - "disabled": true, - "description": { - "content": "Workflow definition metadata status. ", - "type": "text/plain" - }, - "key": "status", - "value": "publishing" - } - ], - "variable": [ - { - "type": "any", - "value": "", - "key": "accountId", - "disabled": false, - "description": { - "content": "(Required) The account ID.", - "type": "text/plain" - } - } - ] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {}, - "auth": null - }, - "response": [ - { - "id": "8df12965-ea1d-4213-bd7c-7aa86739c268", - "name": "Returns a list of workflow definitions' metadata.", - "originalRequest": { - "url": { - "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions" - ], - "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [ - { - "disabled": true, - "description": { - "content": "Workflow definition metadata status. ", - "type": "text/plain" - }, - "key": "status", - "value": "publishing" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"count\": \"\",\n \"value\": [\n {\n \"id\": \"\",\n \"accountId\": \"\",\n \"createdDate\": \"\",\n \"isDraft\": \"\",\n \"lastDeployedId\": \"\",\n \"lastDeployedVersion\": \"\",\n \"lastUpdatedDate\": \"\",\n \"name\": \"\",\n \"status\": \"inactive\",\n \"triggerUrl\": \"\"\n },\n {\n \"id\": \"\",\n \"accountId\": \"\",\n \"createdDate\": \"\",\n \"isDraft\": \"\",\n \"lastDeployedId\": \"\",\n \"lastDeployedVersion\": \"\",\n \"lastUpdatedDate\": \"\",\n \"name\": \"\",\n \"status\": \"active\",\n \"triggerUrl\": \"\"\n }\n ]\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "c7a826f8-1a37-4e38-90f6-1fc8ead9d521", - "name": "Bad Request received", - "originalRequest": { - "url": { - "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions" - ], - "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [ - { - "disabled": true, - "description": { - "content": "Workflow definition metadata status. ", - "type": "text/plain" - }, - "key": "status", - "value": "publishing" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "Bad Request", - "code": 400, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"errorCode\": \"ERR_10999\",\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "41688a1a-6429-40dc-837a-c4ea501e16cd", - "name": "Authentication details are invalid", - "originalRequest": { - "url": { - "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions" - ], - "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [ - { - "disabled": true, - "description": { - "content": "Workflow definition metadata status. ", - "type": "text/plain" - }, - "key": "status", - "value": "publishing" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "Unauthorized", - "code": 401, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"errorCode\": \"ERR_10999\",\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "a9e118b7-75bd-4f31-b24a-d0d7a1d344dc", - "name": "Authorization details are invalid", - "originalRequest": { - "url": { - "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions" - ], - "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [ - { - "disabled": true, - "description": { - "content": "Workflow definition metadata status. ", - "type": "text/plain" - }, - "key": "status", - "value": "publishing" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "Forbidden", - "code": 403, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"errorCode\": \"ERR_10999\",\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "76b3cd79-5b46-41b3-9db2-05108412e7e7", - "name": "Internal server error", - "originalRequest": { - "url": { - "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions" - ], - "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [ - { - "disabled": true, - "description": { - "content": "Workflow definition metadata status. ", - "type": "text/plain" - }, - "key": "status", - "value": "publishing" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"errorCode\": \"ERR_10999\",\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - } - ], - "event": [], - "protocolProfileBehavior": { - "disableBodyPruning": true - } - }, - { - "id": "5de58289-6a84-466b-b7dc-f61743a18cf2", - "name": "Creates a workflow definition.", - "request": { - "name": "Creates a workflow definition.", - "description": { - "content": "Creates a workflow definition. In general, it is much easier to create a workflow through the web interface.\n\nA Maestro workflow is an object that represents your end-to-end agreement workflow, including all pre and post-signing steps. You can add and order steps as necessary for your workflow and add conditional logic to create branches within that workflow. \n\nTo learn the basics of workflows and to see an example workflow definition,\nsee [Workflows](/docs/maestro-api/maestro101/workflows/) in\nthe Maestro API concepts guide.\n\n", - "type": "text/plain" - }, - "url": { - "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions" - ], - "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [], - "variable": [ - { - "type": "any", - "value": "", - "key": "accountId", - "disabled": false, - "description": { - "content": "(Required) The account ID.", - "type": "text/plain" - } - } - ] - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "body": { - "mode": "raw", - "raw": "{\n \"workflowDefinition\": {\n \"workflowName\": \"\",\n \"workflowDescription\": \"\",\n \"documentVersion\": \"\",\n \"schemaVersion\": \"\",\n \"accountId\": \"\",\n \"trigger\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"Http-API\",\n \"httpType\": \"Put\",\n \"input\": {\n \"magna_e\": {}\n },\n \"output\": {\n \"in_c_\": {},\n \"anim_0\": {}\n },\n \"eventType\": \"Sent\"\n },\n \"variables\": {\n \"aliquipd_\": {},\n \"dolor_cf\": {},\n \"Ut_48\": {},\n \"laboris_\": {}\n },\n \"steps\": [],\n \"createdByName\": \"\",\n \"participants\": {\n \"est_6_1\": {\n \"participantRole\": \"\",\n \"participantEmail\": \"\",\n \"participantFirstName\": \"\",\n \"participantLastName\": \"\"\n },\n \"dolor_2\": {\n \"participantRole\": \"\",\n \"participantEmail\": \"\",\n \"participantFirstName\": \"\",\n \"participantLastName\": \"\"\n },\n \"culpa_7\": {\n \"participantRole\": \"\",\n \"participantEmail\": \"\",\n \"participantFirstName\": \"\",\n \"participantLastName\": \"\"\n }\n }\n }\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, - "auth": null - }, - "response": [ - { - "id": "20fc6ee2-368b-442e-aae6-64583247572d", - "name": "Return Success", - "originalRequest": { - "url": { - "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions" - ], - "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [], - "variable": [] - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "body": { - "mode": "raw", - "raw": "{\n \"workflowDefinition\": {\n \"workflowName\": \"\",\n \"workflowDescription\": \"\",\n \"documentVersion\": \"\",\n \"schemaVersion\": \"\",\n \"accountId\": \"\",\n \"trigger\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"Http-API\",\n \"httpType\": \"Put\",\n \"input\": {\n \"magna_e\": {}\n },\n \"output\": {\n \"in_c_\": {},\n \"anim_0\": {}\n },\n \"eventType\": \"Sent\"\n },\n \"variables\": {\n \"aliquipd_\": {},\n \"dolor_cf\": {},\n \"Ut_48\": {},\n \"laboris_\": {}\n },\n \"steps\": [],\n \"createdByName\": \"\",\n \"participants\": {\n \"est_6_1\": {\n \"participantRole\": \"\",\n \"participantEmail\": \"\",\n \"participantFirstName\": \"\",\n \"participantLastName\": \"\"\n },\n \"dolor_2\": {\n \"participantRole\": \"\",\n \"participantEmail\": \"\",\n \"participantFirstName\": \"\",\n \"participantLastName\": \"\"\n },\n \"culpa_7\": {\n \"participantRole\": \"\",\n \"participantEmail\": \"\",\n \"participantFirstName\": \"\",\n \"participantLastName\": \"\"\n }\n }\n }\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - } - }, - "status": "OK", - "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"workflowDefinitionId\": \"\",\n \"workflowDefinition\": {\n \"workflowName\": \"\",\n \"workflowDescription\": \"\",\n \"documentVersion\": \"\",\n \"schemaVersion\": \"\",\n \"accountId\": \"\",\n \"trigger\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"Http-API\",\n \"httpType\": \"Post\",\n \"input\": {\n \"mollit__5\": {}\n },\n \"output\": {\n \"nullae6e\": {},\n \"doc6\": {}\n },\n \"eventType\": \"Completed\"\n },\n \"variables\": {\n \"elite\": {}\n },\n \"createdByName\": \"\",\n \"participants\": {\n \"cillumec\": {\n \"participantRole\": \"\",\n \"participantEmail\": \"\",\n \"participantFirstName\": \"\",\n \"participantLastName\": \"\"\n },\n \"aute_f_\": {\n \"participantRole\": \"\",\n \"participantEmail\": \"\",\n \"participantFirstName\": \"\",\n \"participantLastName\": \"\"\n }\n }\n },\n \"isValidWorkflowDefinition\": \"\",\n \"validationErrors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ]\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "6014ba0a-2e7e-47b8-a154-6d5ac219b433", - "name": "Authentication details are invalid", - "originalRequest": { - "url": { - "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions" - ], - "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [], - "variable": [] - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "body": { - "mode": "raw", - "raw": "{\n \"workflowDefinition\": {\n \"workflowName\": \"\",\n \"workflowDescription\": \"\",\n \"documentVersion\": \"\",\n \"schemaVersion\": \"\",\n \"accountId\": \"\",\n \"trigger\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"Http-API\",\n \"httpType\": \"Put\",\n \"input\": {\n \"magna_e\": {}\n },\n \"output\": {\n \"in_c_\": {},\n \"anim_0\": {}\n },\n \"eventType\": \"Sent\"\n },\n \"variables\": {\n \"aliquipd_\": {},\n \"dolor_cf\": {},\n \"Ut_48\": {},\n \"laboris_\": {}\n },\n \"steps\": [],\n \"createdByName\": \"\",\n \"participants\": {\n \"est_6_1\": {\n \"participantRole\": \"\",\n \"participantEmail\": \"\",\n \"participantFirstName\": \"\",\n \"participantLastName\": \"\"\n },\n \"dolor_2\": {\n \"participantRole\": \"\",\n \"participantEmail\": \"\",\n \"participantFirstName\": \"\",\n \"participantLastName\": \"\"\n },\n \"culpa_7\": {\n \"participantRole\": \"\",\n \"participantEmail\": \"\",\n \"participantFirstName\": \"\",\n \"participantLastName\": \"\"\n }\n }\n }\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - } - }, - "status": "Unauthorized", - "code": 401, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"errorCode\": \"ERR_10999\",\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "2d57ffa8-2396-4974-8792-49cc0231caa3", - "name": "The requested resource was not found", - "originalRequest": { - "url": { - "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions" - ], - "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [], - "variable": [] - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "body": { - "mode": "raw", - "raw": "{\n \"workflowDefinition\": {\n \"workflowName\": \"\",\n \"workflowDescription\": \"\",\n \"documentVersion\": \"\",\n \"schemaVersion\": \"\",\n \"accountId\": \"\",\n \"trigger\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"Http-API\",\n \"httpType\": \"Put\",\n \"input\": {\n \"magna_e\": {}\n },\n \"output\": {\n \"in_c_\": {},\n \"anim_0\": {}\n },\n \"eventType\": \"Sent\"\n },\n \"variables\": {\n \"aliquipd_\": {},\n \"dolor_cf\": {},\n \"Ut_48\": {},\n \"laboris_\": {}\n },\n \"steps\": [],\n \"createdByName\": \"\",\n \"participants\": {\n \"est_6_1\": {\n \"participantRole\": \"\",\n \"participantEmail\": \"\",\n \"participantFirstName\": \"\",\n \"participantLastName\": \"\"\n },\n \"dolor_2\": {\n \"participantRole\": \"\",\n \"participantEmail\": \"\",\n \"participantFirstName\": \"\",\n \"participantLastName\": \"\"\n },\n \"culpa_7\": {\n \"participantRole\": \"\",\n \"participantEmail\": \"\",\n \"participantFirstName\": \"\",\n \"participantLastName\": \"\"\n }\n }\n }\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - } - }, - "status": "Not Found", - "code": 404, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"errorCode\": \"ERR_10999\",\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "0e498733-2900-4818-93ab-af22585254c7", - "name": "Internal server error", - "originalRequest": { - "url": { - "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions" - ], - "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [], - "variable": [] - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "body": { - "mode": "raw", - "raw": "{\n \"workflowDefinition\": {\n \"workflowName\": \"\",\n \"workflowDescription\": \"\",\n \"documentVersion\": \"\",\n \"schemaVersion\": \"\",\n \"accountId\": \"\",\n \"trigger\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"Http-API\",\n \"httpType\": \"Put\",\n \"input\": {\n \"magna_e\": {}\n },\n \"output\": {\n \"in_c_\": {},\n \"anim_0\": {}\n },\n \"eventType\": \"Sent\"\n },\n \"variables\": {\n \"aliquipd_\": {},\n \"dolor_cf\": {},\n \"Ut_48\": {},\n \"laboris_\": {}\n },\n \"steps\": [],\n \"createdByName\": \"\",\n \"participants\": {\n \"est_6_1\": {\n \"participantRole\": \"\",\n \"participantEmail\": \"\",\n \"participantFirstName\": \"\",\n \"participantLastName\": \"\"\n },\n \"dolor_2\": {\n \"participantRole\": \"\",\n \"participantEmail\": \"\",\n \"participantFirstName\": \"\",\n \"participantLastName\": \"\"\n },\n \"culpa_7\": {\n \"participantRole\": \"\",\n \"participantEmail\": \"\",\n \"participantFirstName\": \"\",\n \"participantLastName\": \"\"\n }\n }\n }\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - } - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"errorCode\": \"ERR_10999\",\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - } - ], - "event": [], - "protocolProfileBehavior": { - "disableBodyPruning": true - } - }, + "description": "", + "item": [] + }, + { + "name": "WorkflowInstanceManagement", + "description": "", + "item": [] + }, + { + "name": "WorkflowManagement", + "description": "", + "item": [] + }, + { + "name": "Workflows", + "description": "", + "item": [ { - "id": "bb65c982-1739-4e4a-9753-1d9848c48580", - "name": "Deletes a workflow definition.", + "id": "709655ee-9af3-4e02-8f09-45f04b08dfb3", + "name": "Retrieve a list of available Maestro workflows", "request": { - "name": "Deletes a workflow definition.", + "name": "Retrieve a list of available Maestro workflows", "description": { - "content": "Deletes a workflow definition.", + "content": "This operation retrieves a list of all available Maestro workflows. It returns basic information \nabout each workflow, including its unique identifier (`id`), name, description, and the input \nschema required to trigger the workflow.\n\nThe response provides key details that help users identify which workflows are available \nand understand the input requirements for triggering each one. Each workflow entry also includes \nmetadata, such as when it was created, last modified, and by whom.\n\nThis operation is useful for obtaining an overview of all workflows within the system, helping \nusers and systems know what workflows are defined, what inputs they require, and how they can \nbe triggered.\n\n### Use Cases:\n- Listing all available workflows in a system for manual or automated workflow initiation.\n- Reviewing the input requirements for a workflow before triggering it programmatically.\n- Gathering basic metadata about workflows for auditing, logging, or reporting purposes.\n\n### Key Features:\n- **Comprehensive Workflow Overview**: Provides a full list of workflows, giving visibility \n into all the automated processes available within the Maestro platform.\n- **Input Schema Information**: Each workflow includes its trigger input schema, showing \n what data must be provided when triggering the workflow.\n- **Metadata for Tracking**: Useful metadata like creation time, last modification date, \n and user details are included to support tracking and auditing workflows.\n- **Future-Proof**: The operation is designed to be expandable as more workflows are added \n or the platform grows, ensuring scalability in the workflow management process.\n", "type": "text/plain" }, "url": { "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions", - ":workflowDefinitionId" + "workflows" ], "host": [ - "{{baseUrl}}aow-manage" + "{{baseUrl}}" ], "query": [], - "variable": [ - { - "type": "any", - "value": "", - "key": "accountId", - "disabled": false, - "description": { - "content": "(Required) The account ID.", - "type": "text/plain" - } - }, - { - "type": "any", - "value": "", - "key": "workflowDefinitionId", - "disabled": false, - "description": { - "content": "(Required) The ID of the workflow definition to delete.", - "type": "text/plain" - } - } - ] + "variable": [] }, "header": [ { @@ -2510,26 +44,21 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "body": {}, "auth": null }, "response": [ { - "id": "0cab7bd6-957e-4c88-9da1-75ad3da6c7f4", - "name": "Returns Delete Successful.", + "id": "d6931c13-8812-4d4e-9e61-7db447669ade", + "name": "A list of workflows has been successfully returned.", "originalRequest": { "url": { "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions", - ":workflowDefinitionId" + "workflows" ], "host": [ - "{{baseUrl}}aow-manage" + "{{baseUrl}}" ], "query": [], "variable": [] @@ -2538,9 +67,17 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" } ], - "method": "DELETE", + "method": "GET", "body": {} }, "status": "OK", @@ -2551,65 +88,20 @@ "value": "application/json" } ], - "body": "{\n \"workflowDefinitionId\": \"\",\n \"pollUrl\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "1c543435-7057-4804-98ac-62b147cf7807", - "name": "Resource not found", - "originalRequest": { - "url": { - "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions", - ":workflowDefinitionId" - ], - "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "DELETE", - "body": {} - }, - "status": "Not Found", - "code": 404, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"errorCode\": \"ERR_10999\",\n \"message\": \"\"\n}", + "body": "{\n \"data\": {\n \"workflows\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"name\": \"\",\n \"account_id\": \"00000000-0000-0000-0000-000000000000\",\n \"status\": \"\",\n \"metadata\": {\n \"created_at\": \"\",\n \"created_by\": \"\",\n \"modified_at\": \"\",\n \"modified_by\": \"\"\n }\n },\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"name\": \"\",\n \"account_id\": \"00000000-0000-0000-0000-000000000000\",\n \"status\": \"\",\n \"metadata\": {\n \"created_at\": \"\",\n \"created_by\": \"\",\n \"modified_at\": \"\",\n \"modified_by\": \"\"\n }\n }\n ]\n },\n \"response_metadata\": {\n \"response_timestamp\": \"\",\n \"response_duration_ms\": \"\",\n \"request_id\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "77b77ddb-d44d-4e7a-9f67-b00c1a744684", - "name": "Internal server error", + "id": "8d2c171e-bc03-4fb6-8287-02e3937f25a4", + "name": "Bad Request - The request could not be understood or was missing required parameters.", "originalRequest": { "url": { "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions", - ":workflowDefinitionId" + "workflows" ], "host": [ - "{{baseUrl}}aow-manage" + "{{baseUrl}}" ], "query": [], "variable": [] @@ -2618,328 +110,186 @@ { "key": "Accept", "value": "application/json" - } - ], - "method": "DELETE", - "body": {} - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"errorCode\": \"ERR_10999\",\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - } - ], - "event": [], - "protocolProfileBehavior": { - "disableBodyPruning": true - } - }, - { - "id": "83633cce-75c7-4fd3-a82e-332ef07043d8", - "name": "Gets a workflow definition.", - "request": { - "name": "Gets a workflow definition.", - "description": { - "content": "Returns a workflow definition.\n\n### Related topics\n\n- [How to trigger a Maestro workflow][howto-trigger]\n\n[howto-trigger]: /docs/maestro-api/how-to/trigger-workflow/\n\n", - "type": "text/plain" - }, - "url": { - "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions", - ":workflowDefinitionId" - ], - "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [ - { - "disabled": true, - "description": { - "content": "The ID of the deployed workflow definition.", - "type": "text/plain" }, - "key": "lastDeployedId", - "value": "" - } - ], - "variable": [ - { - "type": "any", - "value": "", - "key": "accountId", - "disabled": false, - "description": { - "content": "(Required) The account ID.", - "type": "text/plain" - } - }, - { - "type": "any", - "value": "", - "key": "workflowDefinitionId", - "disabled": false, - "description": { - "content": "(Required) Workflow definition ID.", - "type": "text/plain" - } - } - ] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {}, - "auth": null - }, - "response": [ - { - "id": "2ef5787d-bef2-48e6-8ebf-811dea989e3e", - "name": "Returns a workflow definition.", - "originalRequest": { - "url": { - "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions", - ":workflowDefinitionId" - ], - "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [ - { - "disabled": true, - "description": { - "content": "The ID of the deployed workflow definition.", - "type": "text/plain" - }, - "key": "lastDeployedId", - "value": "" - } - ], - "variable": [] - }, - "header": [ { - "key": "Accept", - "value": "application/json" + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" } ], "method": "GET", "body": {} }, - "status": "OK", - "code": 200, + "status": "Bad Request", + "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"accountId\": \"\",\n \"createdDate\": \"\",\n \"isDraft\": \"\",\n \"lastDeployedId\": \"\",\n \"lastDeployedVersion\": \"\",\n \"lastDeployedWorkflowDefinition\": {\n \"workflowName\": \"\",\n \"workflowDescription\": \"\",\n \"documentVersion\": \"\",\n \"schemaVersion\": \"\",\n \"accountId\": \"\",\n \"trigger\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"Http-API\",\n \"httpType\": \"Put\",\n \"input\": {\n \"nostrudf\": {}\n },\n \"output\": {\n \"deserunt_e58\": {},\n \"amet_\": {},\n \"aliqua27b\": {},\n \"cupidatat_1e2\": {}\n },\n \"eventType\": \"Sent\"\n },\n \"variables\": {\n \"est8\": {},\n \"esse_37d\": {}\n },\n \"steps\": [],\n \"createdByName\": \"\",\n \"participants\": {\n \"aliquae\": {\n \"participantRole\": \"\",\n \"participantEmail\": \"\",\n \"participantFirstName\": \"\",\n \"participantLastName\": \"\"\n },\n \"consequat_758\": {\n \"participantRole\": \"\",\n \"participantEmail\": \"\",\n \"participantFirstName\": \"\",\n \"participantLastName\": \"\"\n }\n }\n },\n \"lastUpdatedDate\": \"\",\n \"status\": \"archived\",\n \"triggerUrl\": \"\",\n \"validationErrors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"workflowDefinition\": {\n \"workflowName\": \"\",\n \"workflowDescription\": \"\",\n \"documentVersion\": \"\",\n \"schemaVersion\": \"\",\n \"accountId\": \"\",\n \"trigger\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"Http\",\n \"httpType\": \"Get\",\n \"input\": {\n \"incididunt9\": {},\n \"voluptate4\": {},\n \"culpa6da\": {},\n \"dolor9\": {},\n \"voluptate_5\": {}\n },\n \"output\": {\n \"aute51\": {},\n \"dolore__33\": {}\n },\n \"eventType\": \"Signed\"\n },\n \"variables\": {\n \"aute7f\": {}\n },\n \"steps\": [],\n \"createdByName\": \"\",\n \"participants\": {\n \"sintc\": {\n \"participantRole\": \"\",\n \"participantEmail\": \"\",\n \"participantFirstName\": \"\",\n \"participantLastName\": \"\"\n },\n \"Lorem3d5\": {\n \"participantRole\": \"\",\n \"participantEmail\": \"\",\n \"participantFirstName\": \"\",\n \"participantLastName\": \"\"\n },\n \"in_16b\": {\n \"participantRole\": \"\",\n \"participantEmail\": \"\",\n \"participantFirstName\": \"\",\n \"participantLastName\": \"\"\n }\n }\n }\n}", + "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"timestamp\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "33f5bd0d-d2c7-478e-978a-de190dc2c33d", - "name": "Bad Request received", + "id": "425618b0-3b17-48bc-b0aa-3781f4932135", + "name": "Unauthorized - Authentication is required and has failed or not been provided.", "originalRequest": { "url": { "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions", - ":workflowDefinitionId" + "workflows" ], "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [ - { - "disabled": true, - "description": { - "content": "The ID of the deployed workflow definition.", - "type": "text/plain" - }, - "key": "lastDeployedId", - "value": "" - } + "{{baseUrl}}" ], + "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" } ], "method": "GET", "body": {} }, - "status": "Bad Request", - "code": 400, + "status": "Unauthorized", + "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], - "body": "{\n \"errorCode\": \"ERR_10999\",\n \"message\": \"\"\n}", + "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"timestamp\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "0b3757e4-2394-4a9b-9618-409191279f95", - "name": "Authentication details are invalid", + "id": "cd1550e7-23ed-4535-a756-9ee6d3fdb4a7", + "name": "Forbidden - The request was valid, but you do not have permission to perform the action.", "originalRequest": { "url": { "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions", - ":workflowDefinitionId" + "workflows" ], "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [ - { - "disabled": true, - "description": { - "content": "The ID of the deployed workflow definition.", - "type": "text/plain" - }, - "key": "lastDeployedId", - "value": "" - } + "{{baseUrl}}" ], + "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" } ], "method": "GET", "body": {} }, - "status": "Unauthorized", - "code": 401, + "status": "Forbidden", + "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], - "body": "{\n \"errorCode\": \"ERR_10999\",\n \"message\": \"\"\n}", + "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"timestamp\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "0fe35af0-34bd-46bc-bbdb-d02fe5acbb82", - "name": "Authorization details are invalid", + "id": "dd5ee8c2-70c4-4b39-9be3-892665671bf4", + "name": "Not Found - The requested resource could not be found.", "originalRequest": { "url": { "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions", - ":workflowDefinitionId" + "workflows" ], "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [ - { - "disabled": true, - "description": { - "content": "The ID of the deployed workflow definition.", - "type": "text/plain" - }, - "key": "lastDeployedId", - "value": "" - } + "{{baseUrl}}" ], + "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" } ], "method": "GET", "body": {} }, - "status": "Forbidden", - "code": 403, + "status": "Not Found", + "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], - "body": "{\n \"errorCode\": \"ERR_10999\",\n \"message\": \"\"\n}", + "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"timestamp\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "ee298ba6-0832-441a-95a6-a51246d7d20f", - "name": "Internal server error", + "id": "9f98eaf1-c950-47ff-b4a9-71c58e764ab2", + "name": "Internal Server Error", "originalRequest": { "url": { "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions", - ":workflowDefinitionId" + "workflows" ], "host": [ - "{{baseUrl}}aow-manage" - ], - "query": [ - { - "disabled": true, - "description": { - "content": "The ID of the deployed workflow definition.", - "type": "text/plain" - }, - "key": "lastDeployedId", - "value": "" - } + "{{baseUrl}}" ], + "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" } ], "method": "GET", @@ -2953,7 +303,7 @@ "value": "application/json" } ], - "body": "{\n \"errorCode\": \"ERR_10999\",\n \"message\": \"\"\n}", + "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"timestamp\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -2964,114 +314,80 @@ } }, { - "id": "b31f3ae3-d793-46a2-8be7-6dbc24abfd78", - "name": "Updates a workflow definition.", + "id": "7c2a2435-203a-4b76-8779-4963a2ac68e6", + "name": "Retrieve trigger requirements for a specific Maestro workflow", "request": { - "name": "Updates a workflow definition.", + "name": "Retrieve trigger requirements for a specific Maestro workflow", "description": { - "content": "Updates a workflow definition.\n\nA Maestro workflow is an object that represents your end-to-end agreement workflow, including all pre and post-signing steps. You can add and order steps as necessary for your workflow and add conditional logic to create branches within that workflow.\n\nTo learn the basics of workflows and to see an example workflow definition,\nsee [Workflows](/docs/maestro-api/maestro101/workflows/) in\nthe Maestro API concepts guide.\n\n", + "content": "This operation retrieves the configuration and input requirements necessary to trigger a specific \nMaestro workflow. It provides detailed information about the `trigger_event_type`, such as HTTP \nor other supported types, and specifies the required input schema, including field names, data types, \nand any default values. \n\nThis information is essential for understanding the data and parameters required to initiate the \nworkflow. It enables developers to prepare the necessary inputs and configuration before triggering \nthe workflow instance, ensuring seamless execution and compliance with workflow requirements.\n\n### Use Cases:\n- Identifying the required input fields and their data types to successfully trigger the workflow.\n- Reviewing the trigger configuration for validation and compliance with expected input.\n- Preparing and validating data in advance of triggering the workflow, minimizing runtime errors.\n\n### Key Features:\n- **Detailed Trigger Input Requirements**: Provides an exhaustive schema of required fields, \n their data types, and optional default values for easy reference and data validation.\n- **Trigger Event Type Information**: Specifies the type of event required to initiate the workflow \n (e.g., HTTP), helping developers configure their systems to invoke the workflow appropriately.\n- **Configurable for Custom Triggers**: Suitable for custom configurations, enabling flexibility \n in how workflows can be triggered according to system needs.\n", "type": "text/plain" }, "url": { "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions", - ":workflowDefinitionId" + "workflows", + ":workflowId", + "trigger-requirements" ], "host": [ - "{{baseUrl}}aow-manage" + "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", - "value": "", - "key": "accountId", + "value": "00000000-0000-0000-0000-000000000000", + "key": "workflowId", "disabled": false, "description": { - "content": "(Required) The account ID.", - "type": "text/plain" - } - }, - { - "type": "any", - "value": "", - "key": "workflowDefinitionId", - "disabled": false, - "description": { - "content": "(Required) Workflow definition ID.", + "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PUT", - "body": { - "mode": "raw", - "raw": "{\n \"workflowDefinition\": {\n \"workflowName\": \"\",\n \"workflowDescription\": \"\",\n \"documentVersion\": \"\",\n \"schemaVersion\": \"\",\n \"accountId\": \"\",\n \"trigger\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"Http-API\",\n \"httpType\": \"Put\",\n \"input\": {\n \"magna_e\": {}\n },\n \"output\": {\n \"in_c_\": {},\n \"anim_0\": {}\n },\n \"eventType\": \"Sent\"\n },\n \"variables\": {\n \"aliquipd_\": {},\n \"dolor_cf\": {},\n \"Ut_48\": {},\n \"laboris_\": {}\n },\n \"steps\": [],\n \"createdByName\": \"\",\n \"participants\": {\n \"est_6_1\": {\n \"participantRole\": \"\",\n \"participantEmail\": \"\",\n \"participantFirstName\": \"\",\n \"participantLastName\": \"\"\n },\n \"dolor_2\": {\n \"participantRole\": \"\",\n \"participantEmail\": \"\",\n \"participantFirstName\": \"\",\n \"participantLastName\": \"\"\n },\n \"culpa_7\": {\n \"participantRole\": \"\",\n \"participantEmail\": \"\",\n \"participantFirstName\": \"\",\n \"participantLastName\": \"\"\n }\n }\n }\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, + "method": "GET", + "body": {}, "auth": null }, "response": [ { - "id": "1aa03305-70ab-43da-997d-f4e05886b4b0", - "name": "Return Success", + "id": "72b2fe97-a6e7-4244-9392-9a459f03d59f", + "name": "Describes the requirements for triggering a workflow", "originalRequest": { "url": { "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions", - ":workflowDefinitionId" + "workflows", + ":workflowId", + "trigger-requirements" ], "host": [ - "{{baseUrl}}aow-manage" + "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, { - "key": "Accept", - "value": "application/json" + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" } ], - "method": "PUT", - "body": { - "mode": "raw", - "raw": "{\n \"workflowDefinition\": {\n \"workflowName\": \"\",\n \"workflowDescription\": \"\",\n \"documentVersion\": \"\",\n \"schemaVersion\": \"\",\n \"accountId\": \"\",\n \"trigger\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"Http-API\",\n \"httpType\": \"Put\",\n \"input\": {\n \"magna_e\": {}\n },\n \"output\": {\n \"in_c_\": {},\n \"anim_0\": {}\n },\n \"eventType\": \"Sent\"\n },\n \"variables\": {\n \"aliquipd_\": {},\n \"dolor_cf\": {},\n \"Ut_48\": {},\n \"laboris_\": {}\n },\n \"steps\": [],\n \"createdByName\": \"\",\n \"participants\": {\n \"est_6_1\": {\n \"participantRole\": \"\",\n \"participantEmail\": \"\",\n \"participantFirstName\": \"\",\n \"participantLastName\": \"\"\n },\n \"dolor_2\": {\n \"participantRole\": \"\",\n \"participantEmail\": \"\",\n \"participantFirstName\": \"\",\n \"participantLastName\": \"\"\n },\n \"culpa_7\": {\n \"participantRole\": \"\",\n \"participantEmail\": \"\",\n \"participantFirstName\": \"\",\n \"participantLastName\": \"\"\n }\n }\n }\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - } + "method": "GET", + "body": {} }, "status": "OK", "code": 200, @@ -3081,50 +397,42 @@ "value": "application/json" } ], - "body": "{\n \"workflowDefinitionId\": \"\",\n \"workflowDefinition\": {\n \"workflowName\": \"\",\n \"workflowDescription\": \"\",\n \"documentVersion\": \"\",\n \"schemaVersion\": \"\",\n \"accountId\": \"\",\n \"trigger\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"Http-API\",\n \"httpType\": \"Post\",\n \"input\": {\n \"mollit__5\": {}\n },\n \"output\": {\n \"nullae6e\": {},\n \"doc6\": {}\n },\n \"eventType\": \"Completed\"\n },\n \"variables\": {\n \"elite\": {}\n },\n \"createdByName\": \"\",\n \"participants\": {\n \"cillumec\": {\n \"participantRole\": \"\",\n \"participantEmail\": \"\",\n \"participantFirstName\": \"\",\n \"participantLastName\": \"\"\n },\n \"aute_f_\": {\n \"participantRole\": \"\",\n \"participantEmail\": \"\",\n \"participantFirstName\": \"\",\n \"participantLastName\": \"\"\n }\n }\n },\n \"isValidWorkflowDefinition\": \"\",\n \"validationErrors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ]\n}", + "body": "{\n \"trigger_id\": \"00000000-0000-0000-0000-000000000000\",\n \"trigger_event_type\": \"\",\n \"trigger_http_config\": {\n \"method\": \"PATCH\",\n \"url\": \"\"\n },\n \"trigger_input_schema\": [\n {\n \"field_name\": \"\",\n \"field_data_type\": {},\n \"default_value\": \"\"\n },\n {\n \"field_name\": \"\",\n \"field_data_type\": {},\n \"default_value\": \"\"\n }\n ],\n \"metadata\": {\n \"created_at\": \"\",\n \"created_by\": \"\",\n \"modified_at\": \"\",\n \"modified_by\": \"\"\n },\n \"response_timestamp\": \"\",\n \"response_duration_ms\": \"\",\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "3c261706-e171-40d8-9c15-cf222f2a48cf", - "name": "Bad request, malformed input", + "id": "06fbffde-a47a-4258-aff5-39b5d9c77f7e", + "name": "Bad Request - The request could not be understood or was missing required parameters.", "originalRequest": { "url": { "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions", - ":workflowDefinitionId" + "workflows", + ":workflowId", + "trigger-requirements" ], "host": [ - "{{baseUrl}}aow-manage" + "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, { - "key": "Accept", - "value": "application/json" + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" } ], - "method": "PUT", - "body": { - "mode": "raw", - "raw": "{\n \"workflowDefinition\": {\n \"workflowName\": \"\",\n \"workflowDescription\": \"\",\n \"documentVersion\": \"\",\n \"schemaVersion\": \"\",\n \"accountId\": \"\",\n \"trigger\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"Http-API\",\n \"httpType\": \"Put\",\n \"input\": {\n \"magna_e\": {}\n },\n \"output\": {\n \"in_c_\": {},\n \"anim_0\": {}\n },\n \"eventType\": \"Sent\"\n },\n \"variables\": {\n \"aliquipd_\": {},\n \"dolor_cf\": {},\n \"Ut_48\": {},\n \"laboris_\": {}\n },\n \"steps\": [],\n \"createdByName\": \"\",\n \"participants\": {\n \"est_6_1\": {\n \"participantRole\": \"\",\n \"participantEmail\": \"\",\n \"participantFirstName\": \"\",\n \"participantLastName\": \"\"\n },\n \"dolor_2\": {\n \"participantRole\": \"\",\n \"participantEmail\": \"\",\n \"participantFirstName\": \"\",\n \"participantLastName\": \"\"\n },\n \"culpa_7\": {\n \"participantRole\": \"\",\n \"participantEmail\": \"\",\n \"participantFirstName\": \"\",\n \"participantLastName\": \"\"\n }\n }\n }\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - } + "method": "GET", + "body": {} }, "status": "Bad Request", "code": 400, @@ -3134,50 +442,42 @@ "value": "application/json" } ], - "body": "{\n \"errorCode\": \"ERR_10999\",\n \"message\": \"\"\n}", + "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"timestamp\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "9b80aece-be55-4473-91ea-a44cc37a749b", - "name": "Authentication details are invalid", + "id": "c48718c8-5117-4b76-b88e-80a590a758dc", + "name": "Unauthorized - Authentication is required and has failed or not been provided.", "originalRequest": { "url": { "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions", - ":workflowDefinitionId" + "workflows", + ":workflowId", + "trigger-requirements" ], "host": [ - "{{baseUrl}}aow-manage" + "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, { - "key": "Accept", - "value": "application/json" + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" } ], - "method": "PUT", - "body": { - "mode": "raw", - "raw": "{\n \"workflowDefinition\": {\n \"workflowName\": \"\",\n \"workflowDescription\": \"\",\n \"documentVersion\": \"\",\n \"schemaVersion\": \"\",\n \"accountId\": \"\",\n \"trigger\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"Http-API\",\n \"httpType\": \"Put\",\n \"input\": {\n \"magna_e\": {}\n },\n \"output\": {\n \"in_c_\": {},\n \"anim_0\": {}\n },\n \"eventType\": \"Sent\"\n },\n \"variables\": {\n \"aliquipd_\": {},\n \"dolor_cf\": {},\n \"Ut_48\": {},\n \"laboris_\": {}\n },\n \"steps\": [],\n \"createdByName\": \"\",\n \"participants\": {\n \"est_6_1\": {\n \"participantRole\": \"\",\n \"participantEmail\": \"\",\n \"participantFirstName\": \"\",\n \"participantLastName\": \"\"\n },\n \"dolor_2\": {\n \"participantRole\": \"\",\n \"participantEmail\": \"\",\n \"participantFirstName\": \"\",\n \"participantLastName\": \"\"\n },\n \"culpa_7\": {\n \"participantRole\": \"\",\n \"participantEmail\": \"\",\n \"participantFirstName\": \"\",\n \"participantLastName\": \"\"\n }\n }\n }\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - } + "method": "GET", + "body": {} }, "status": "Unauthorized", "code": 401, @@ -3187,50 +487,87 @@ "value": "application/json" } ], - "body": "{\n \"errorCode\": \"ERR_10999\",\n \"message\": \"\"\n}", + "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"timestamp\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "48d2df11-c16d-4977-bd8a-a335287cc808", - "name": "The requested resource was not found", + "id": "f56b1822-6e6c-42ef-80d7-945e63205f59", + "name": "Forbidden - The request was valid, but you do not have permission to perform the action.", "originalRequest": { "url": { "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions", - ":workflowDefinitionId" + "workflows", + ":workflowId", + "trigger-requirements" ], "host": [ - "{{baseUrl}}aow-manage" + "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"timestamp\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "383bdf7c-fc1f-4b36-bb55-bc1965ac5bd8", + "name": "Not Found - The requested resource could not be found.", + "originalRequest": { + "url": { + "path": [ + "workflows", + ":workflowId", + "trigger-requirements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" } ], - "method": "PUT", - "body": { - "mode": "raw", - "raw": "{\n \"workflowDefinition\": {\n \"workflowName\": \"\",\n \"workflowDescription\": \"\",\n \"documentVersion\": \"\",\n \"schemaVersion\": \"\",\n \"accountId\": \"\",\n \"trigger\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"Http-API\",\n \"httpType\": \"Put\",\n \"input\": {\n \"magna_e\": {}\n },\n \"output\": {\n \"in_c_\": {},\n \"anim_0\": {}\n },\n \"eventType\": \"Sent\"\n },\n \"variables\": {\n \"aliquipd_\": {},\n \"dolor_cf\": {},\n \"Ut_48\": {},\n \"laboris_\": {}\n },\n \"steps\": [],\n \"createdByName\": \"\",\n \"participants\": {\n \"est_6_1\": {\n \"participantRole\": \"\",\n \"participantEmail\": \"\",\n \"participantFirstName\": \"\",\n \"participantLastName\": \"\"\n },\n \"dolor_2\": {\n \"participantRole\": \"\",\n \"participantEmail\": \"\",\n \"participantFirstName\": \"\",\n \"participantLastName\": \"\"\n },\n \"culpa_7\": {\n \"participantRole\": \"\",\n \"participantEmail\": \"\",\n \"participantFirstName\": \"\",\n \"participantLastName\": \"\"\n }\n }\n }\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - } + "method": "GET", + "body": {} }, "status": "Not Found", "code": 404, @@ -3240,50 +577,42 @@ "value": "application/json" } ], - "body": "{\n \"errorCode\": \"ERR_10999\",\n \"message\": \"\"\n}", + "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"timestamp\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "68fe0895-1404-4eb5-adf2-048764221041", - "name": "Internal server error", + "id": "8b503c7d-9a3b-4f6e-bfb1-8cec73aaf79d", + "name": "Internal Server Error", "originalRequest": { "url": { "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions", - ":workflowDefinitionId" + "workflows", + ":workflowId", + "trigger-requirements" ], "host": [ - "{{baseUrl}}aow-manage" + "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, { - "key": "Accept", - "value": "application/json" + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" } ], - "method": "PUT", - "body": { - "mode": "raw", - "raw": "{\n \"workflowDefinition\": {\n \"workflowName\": \"\",\n \"workflowDescription\": \"\",\n \"documentVersion\": \"\",\n \"schemaVersion\": \"\",\n \"accountId\": \"\",\n \"trigger\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"Http-API\",\n \"httpType\": \"Put\",\n \"input\": {\n \"magna_e\": {}\n },\n \"output\": {\n \"in_c_\": {},\n \"anim_0\": {}\n },\n \"eventType\": \"Sent\"\n },\n \"variables\": {\n \"aliquipd_\": {},\n \"dolor_cf\": {},\n \"Ut_48\": {},\n \"laboris_\": {}\n },\n \"steps\": [],\n \"createdByName\": \"\",\n \"participants\": {\n \"est_6_1\": {\n \"participantRole\": \"\",\n \"participantEmail\": \"\",\n \"participantFirstName\": \"\",\n \"participantLastName\": \"\"\n },\n \"dolor_2\": {\n \"participantRole\": \"\",\n \"participantEmail\": \"\",\n \"participantFirstName\": \"\",\n \"participantLastName\": \"\"\n },\n \"culpa_7\": {\n \"participantRole\": \"\",\n \"participantEmail\": \"\",\n \"participantFirstName\": \"\",\n \"participantLastName\": \"\"\n }\n }\n }\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - } + "method": "GET", + "body": {} }, "status": "Internal Server Error", "code": 500, @@ -3293,7 +622,7 @@ "value": "application/json" } ], - "body": "{\n \"errorCode\": \"ERR_10999\",\n \"message\": \"\"\n}", + "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"timestamp\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -3304,46 +633,33 @@ } }, { - "id": "d941eb3f-435b-4f14-8bc5-d9a425373ddb", - "name": "Publishes or unpublishes a workflow definition.", + "id": "1f335420-3e7c-4506-b67c-4e582bd99706", + "name": "Trigger a new instance of a Maestro workflow", "request": { - "name": "Publishes or unpublishes a workflow definition.", + "name": "Trigger a new instance of a Maestro workflow", "description": { - "content": "Publishes or unpublishes a workflow definition.", + "content": "This operation triggers a new instance of a specified Maestro workflow. When invoked, \nthe workflow is started based on the provided input data, and the workflow instance \nbegins executing according to its defined logic and configuration.\n\nThe request requires an `instance_name` and any input data necessary to start the workflow, \nas described by the workflow's `trigger_input_schema`. The `instance_name` is a user-defined \nlabel for tracking the workflow run, while the input data fields should match the schema defined \nin the workflow.\n\nThe operation is event-driven and typically triggered by an external HTTP event or system call, \nallowing for the automatic execution of complex processes that span multiple systems or components.\n\nUpon successful execution, the response returns the unique identifier (`id`) for the newly \ncreated workflow instance, along with a URL (`workflow_instance_url`) that can be used to \ninteract with or track the running instance.\n\n### Use Cases:\n- Automating user registration workflows where input fields like `name` and `email` are provided.\n- Processing financial transactions where details such as `amount` and `currency` are required.\n- Sending notifications based on user interactions in other systems.\n\n### Key Features:\n- **Automated Execution**: Once triggered, the workflow runs until a step requires manual intervention.\n- **Input-Driven**: Workflow execution is based on the provided input data, which is validated \n against the workflow's input schema.\n- **Real-Time Triggering**: Designed to be invoked as part of an event-driven architecture, \n allowing for workflows to respond to external events.\n- **Tracking and Interaction**: The response includes a URL that allows users to check the status \n of the workflow instance or take further actions while it runs.\n", "type": "text/plain" }, "url": { "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions", - ":workflowDefinitionId", - "publish" + "workflows", + ":workflowId", + "actions", + "trigger" ], "host": [ - "{{baseUrl}}aow-manage" + "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", - "value": "", - "key": "accountId", - "disabled": false, - "description": { - "content": "(Required) The account ID.", - "type": "text/plain" - } - }, - { - "type": "any", - "value": "", - "key": "workflowDefinitionId", + "value": "00000000-0000-0000-0000-000000000000", + "key": "workflowId", "disabled": false, "description": { - "content": "(Required) Workflow definition ID.", + "content": "(Required) ", "type": "text/plain" } } @@ -3362,7 +678,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"deploymentStatus\": \"Publish\"\n}", + "raw": "{\n \"instance_name\": \"\",\n \"trigger_inputs\": {\n \"consequatd1_\": \"\",\n \"laboris_db\": \"\",\n \"ea_628\": \"\",\n \"aliquip_9\": \"\",\n \"voluptate594\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -3374,21 +690,18 @@ }, "response": [ { - "id": "9f7c44bc-ab02-4a43-8780-5416ed674d93", - "name": "Return Success", + "id": "7cb0215f-3455-49f5-8020-2d42864b463a", + "name": "Indicates a trigger has successfully launched a workflow instance", "originalRequest": { "url": { "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions", - ":workflowDefinitionId", - "publish" + "workflows", + ":workflowId", + "actions", + "trigger" ], "host": [ - "{{baseUrl}}aow-manage" + "{{baseUrl}}" ], "query": [], "variable": [] @@ -3401,12 +714,20 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" } ], "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"deploymentStatus\": \"Publish\"\n}", + "raw": "{\n \"instance_name\": \"\",\n \"trigger_inputs\": {\n \"consequatd1_\": \"\",\n \"laboris_db\": \"\",\n \"ea_628\": \"\",\n \"aliquip_9\": \"\",\n \"voluptate594\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -3415,34 +736,31 @@ } } }, - "status": "OK", - "code": 200, + "status": "Created", + "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], - "body": "{\n \"message\": \"\",\n \"pollUrl\": \"\",\n \"method\": \"\",\n \"receivedTime\": \"\"\n}", + "body": "{\n \"instance_id\": \"00000000-0000-0000-0000-000000000000\",\n \"instance_url\": \"\",\n \"response_timestamp\": \"\",\n \"response_duration_ms\": \"\",\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "06f708cb-a08d-4024-aa3f-bf854b686fe6", - "name": "Workflow Definition is invalid", + "id": "72e77300-e472-4c3f-8fa5-0b524db01322", + "name": "Bad Request - The request could not be understood or was missing required parameters.", "originalRequest": { "url": { "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions", - ":workflowDefinitionId", - "publish" + "workflows", + ":workflowId", + "actions", + "trigger" ], "host": [ - "{{baseUrl}}aow-manage" + "{{baseUrl}}" ], "query": [], "variable": [] @@ -3455,12 +773,20 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" } ], "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"deploymentStatus\": \"Publish\"\n}", + "raw": "{\n \"instance_name\": \"\",\n \"trigger_inputs\": {\n \"consequatd1_\": \"\",\n \"laboris_db\": \"\",\n \"ea_628\": \"\",\n \"aliquip_9\": \"\",\n \"voluptate594\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -3477,26 +803,23 @@ "value": "application/json" } ], - "body": "{\n \"message\": \"\",\n \"validationErrors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ]\n}", + "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"timestamp\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "950cebd6-040f-4867-b2d2-f6ef32540d80", - "name": "Authentication details are invalid", + "id": "3741fa94-e8e9-4149-9b72-902f8f0fc600", + "name": "Unauthorized - Authentication is required and has failed or not been provided.", "originalRequest": { "url": { "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions", - ":workflowDefinitionId", - "publish" + "workflows", + ":workflowId", + "actions", + "trigger" ], "host": [ - "{{baseUrl}}aow-manage" + "{{baseUrl}}" ], "query": [], "variable": [] @@ -3509,12 +832,20 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" } ], "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"deploymentStatus\": \"Publish\"\n}", + "raw": "{\n \"instance_name\": \"\",\n \"trigger_inputs\": {\n \"consequatd1_\": \"\",\n \"laboris_db\": \"\",\n \"ea_628\": \"\",\n \"aliquip_9\": \"\",\n \"voluptate594\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -3531,26 +862,82 @@ "value": "application/json" } ], - "body": "{\n \"errorCode\": \"ERR_10999\",\n \"message\": \"\"\n}", + "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"timestamp\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "67a28085-2e7f-4493-af05-b54f62fce2ca", + "name": "Forbidden - The request was valid, but you do not have permission to perform the action.", + "originalRequest": { + "url": { + "path": [ + "workflows", + ":workflowId", + "actions", + "trigger" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"instance_name\": \"\",\n \"trigger_inputs\": {\n \"consequatd1_\": \"\",\n \"laboris_db\": \"\",\n \"ea_628\": \"\",\n \"aliquip_9\": \"\",\n \"voluptate594\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"timestamp\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "eb7aea93-22b4-4d62-8a5d-b221fc26afa2", - "name": "The requested resource was not found", + "id": "0d57f3e8-15e8-4295-aea0-aeb109723033", + "name": "Not Found - The requested resource could not be found.", "originalRequest": { "url": { "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions", - ":workflowDefinitionId", - "publish" + "workflows", + ":workflowId", + "actions", + "trigger" ], "host": [ - "{{baseUrl}}aow-manage" + "{{baseUrl}}" ], "query": [], "variable": [] @@ -3563,12 +950,20 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" } ], "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"deploymentStatus\": \"Publish\"\n}", + "raw": "{\n \"instance_name\": \"\",\n \"trigger_inputs\": {\n \"consequatd1_\": \"\",\n \"laboris_db\": \"\",\n \"ea_628\": \"\",\n \"aliquip_9\": \"\",\n \"voluptate594\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -3585,26 +980,23 @@ "value": "application/json" } ], - "body": "{\n \"errorCode\": \"ERR_10999\",\n \"message\": \"\"\n}", + "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"timestamp\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "4a554865-dbf2-4958-b233-1e17cfa4269c", - "name": "Internal server error", + "id": "db16c6b9-8813-400b-80b4-dd4fdcc75d53", + "name": "Internal Server Error", "originalRequest": { "url": { "path": [ - "v1.0", - "management", - "accounts", - ":accountId", - "workflowDefinitions", - ":workflowDefinitionId", - "publish" + "workflows", + ":workflowId", + "actions", + "trigger" ], "host": [ - "{{baseUrl}}aow-manage" + "{{baseUrl}}" ], "query": [], "variable": [] @@ -3617,12 +1009,20 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" } ], "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"deploymentStatus\": \"Publish\"\n}", + "raw": "{\n \"instance_name\": \"\",\n \"trigger_inputs\": {\n \"consequatd1_\": \"\",\n \"laboris_db\": \"\",\n \"ea_628\": \"\",\n \"aliquip_9\": \"\",\n \"voluptate594\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -3639,7 +1039,7 @@ "value": "application/json" } ], - "body": "{\n \"errorCode\": \"ERR_10999\",\n \"message\": \"\"\n}", + "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"timestamp\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -3652,11 +1052,40 @@ ] } ], + "auth": { + "type": "oauth2", + "oauth2": [ + { + "type": "any", + "value": "adm_store_unified_repo_read aow_manage signature", + "key": "scope" + }, + { + "type": "any", + "value": "https://account-d.docusign.com/oauth/token", + "key": "accessTokenUrl" + }, + { + "type": "any", + "value": "https://account-d.docusign.com/oauth/auth", + "key": "authUrl" + }, + { + "type": "any", + "value": "authorization_code", + "key": "grant_type" + } + ] + }, "event": [], "variable": [ + { + "key": "accountId", + "value": "00000000-0000-0000-0000-000000000000" + }, { "key": "baseUrl", - "value": "https://www.docusign.net" + "value": "https://api.docusign.com/v1/accounts/{{accountId}}" } ], "info": {