{ "opencollection": "1.0.0", "info": { "name": "Flowable REST Access Tokens Executions API", "version": "v1" }, "items": [ { "info": { "name": "Executions", "type": "folder" }, "items": [ { "info": { "name": "Query executions", "type": "http" }, "http": { "method": "POST", "url": "/flowable-rest/service/query/executions", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "The request body can contain all possible filters that can be used in the List executions URL query. On top of these, it’s possible to provide an array of variables and processInstanceVariables to include in the query, with their format described here.\n\nThe general paging and sorting query-parameters can be used for this URL." }, { "info": { "name": "List of executions", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/runtime/executions", "params": [ { "name": "id", "value": "", "type": "query", "description": "Only return models with the given version." }, { "name": "activityId", "value": "", "type": "query", "description": "Only return executions with the given activity id." }, { "name": "processDefinitionKey", "value": "", "type": "query", "description": "Only return executions with the given process definition key." }, { "name": "processDefinitionId", "value": "", "type": "query", "description": "Only return executions with the given process definition id." }, { "name": "processInstanceId", "value": "", "type": "query", "description": "Only return executions which are part of the process instance with the given id." }, { "name": "processInstanceIds", "value": "", "type": "query", "description": "Only return executions which are part of the process instances with the given ids." }, { "name": "messageEventSubscriptionName", "value": "", "type": "query", "description": "Only return executions which are subscribed to a message with the given name." }, { "name": "signalEventSubscriptionName", "value": "", "type": "query", "description": "Only return executions which are subscribed to a signal with the given name." }, { "name": "parentId", "value": "", "type": "query", "description": "Only return executions which are a direct child of the given execution." }, { "name": "tenantId", "value": "", "type": "query", "description": "Only return process instances with the given tenantId." }, { "name": "tenantIdLike", "value": "", "type": "query", "description": "Only return process instances with a tenantId like the given value." }, { "name": "withoutTenantId", "value": "", "type": "query", "description": "If true, only returns process instances without a tenantId set. If false, the withoutTenantId parameter is ignored." }, { "name": "sort", "value": "", "type": "query", "description": "Property to sort on, to be used together with the order." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "List of executions" }, { "info": { "name": "Signal event received", "type": "http" }, "http": { "method": "PUT", "url": "/flowable-rest/service/runtime/executions", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Signal event received" }, { "info": { "name": "Get an execution", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/runtime/executions/:executionId", "params": [ { "name": "executionId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Get an execution" }, { "info": { "name": "Execute an action on an execution", "type": "http" }, "http": { "method": "PUT", "url": "/flowable-rest/service/runtime/executions/:executionId", "params": [ { "name": "executionId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Execute an action on an execution" }, { "info": { "name": "List active activities in an execution", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/runtime/executions/:executionId/activities", "params": [ { "name": "executionId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns all activities which are active in the execution and in all child-executions (and their children, recursively), if any." }, { "info": { "name": "Change the state of an execution", "type": "http" }, "http": { "method": "POST", "url": "/flowable-rest/service/runtime/executions/:executionId/change-state", "params": [ { "name": "executionId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Change the state of an execution" }, { "info": { "name": "List variables for an execution", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/runtime/executions/:executionId/variables", "params": [ { "name": "executionId", "value": "", "type": "path" }, { "name": "scope", "value": "", "type": "query" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "List variables for an execution" }, { "info": { "name": "Create variables on an execution", "type": "http" }, "http": { "method": "POST", "url": "/flowable-rest/service/runtime/executions/:executionId/variables", "params": [ { "name": "executionId", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "name", "type": "text", "value": "" }, { "name": "type", "type": "text", "value": "" }, { "name": "scope", "type": "text", "value": "" } ] }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This endpoint can be used in 2 ways: By passing a JSON Body (array of RestVariable) or by passing a multipart/form-data Object.\nAny number of variables can be passed into the request body array.\nNB: Swagger V2 specification does not support this use case that is why this endpoint might be buggy/incomplete if used with other tools." }, { "info": { "name": "Update variables on an execution", "type": "http" }, "http": { "method": "PUT", "url": "/flowable-rest/service/runtime/executions/:executionId/variables", "params": [ { "name": "executionId", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "name", "type": "text", "value": "" }, { "name": "type", "type": "text", "value": "" }, { "name": "scope", "type": "text", "value": "" } ] }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This endpoint can be used in 2 ways: By passing a JSON Body (array of RestVariable) or by passing a multipart/form-data Object.\nAny number of variables can be passed into the request body array.\nNB: Swagger V2 specification does not support this use case that is why this endpoint might be buggy/incomplete if used with other tools." }, { "info": { "name": "Delete all variables for an execution", "type": "http" }, "http": { "method": "DELETE", "url": "/flowable-rest/service/runtime/executions/:executionId/variables", "params": [ { "name": "executionId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Delete all variables for an execution" }, { "info": { "name": "Create variables on an execution asynchronously", "type": "http" }, "http": { "method": "POST", "url": "/flowable-rest/service/runtime/executions/:executionId/variables-async", "params": [ { "name": "executionId", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "name", "type": "text", "value": "" }, { "name": "type", "type": "text", "value": "" }, { "name": "scope", "type": "text", "value": "" } ] }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This endpoint can be used in 2 ways: By passing a JSON Body (array of RestVariable) or by passing a multipart/form-data Object.\nAny number of variables can be passed into the request body array.\nNB: Swagger V2 specification does not support this use case that is why this endpoint might be buggy/incomplete if used with other tools." }, { "info": { "name": "Update variables on an execution asynchronously", "type": "http" }, "http": { "method": "PUT", "url": "/flowable-rest/service/runtime/executions/:executionId/variables-async", "params": [ { "name": "executionId", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "name", "type": "text", "value": "" }, { "name": "type", "type": "text", "value": "" }, { "name": "scope", "type": "text", "value": "" } ] }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This endpoint can be used in 2 ways: By passing a JSON Body (array of RestVariable) or by passing a multipart/form-data Object.\nAny number of variables can be passed into the request body array.\nNB: Swagger V2 specification does not support this use case that is why this endpoint might be buggy/incomplete if used with other tools." }, { "info": { "name": "Update a variable on an execution asynchronously", "type": "http" }, "http": { "method": "PUT", "url": "/flowable-rest/service/runtime/executions/:executionId/variables-async/:variableName", "params": [ { "name": "executionId", "value": "", "type": "path" }, { "name": "variableName", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" }, { "name": "name", "type": "text", "value": "" }, { "name": "type", "type": "text", "value": "" }, { "name": "scope", "type": "text", "value": "" } ] }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This endpoint can be used in 2 ways: By passing a JSON Body (RestVariable) or by passing a multipart/form-data Object.\nNB: Swagger V2 specification does not support this use case that is why this endpoint might be buggy/incomplete if used with other tools." }, { "info": { "name": "Get a variable for an execution", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/runtime/executions/:executionId/variables/:variableName", "params": [ { "name": "executionId", "value": "", "type": "path" }, { "name": "variableName", "value": "", "type": "path" }, { "name": "scope", "value": "", "type": "query" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Get a variable for an execution" }, { "info": { "name": "Update a variable on an execution", "type": "http" }, "http": { "method": "PUT", "url": "/flowable-rest/service/runtime/executions/:executionId/variables/:variableName", "params": [ { "name": "executionId", "value": "", "type": "path" }, { "name": "variableName", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" }, { "name": "name", "type": "text", "value": "" }, { "name": "type", "type": "text", "value": "" }, { "name": "scope", "type": "text", "value": "" } ] }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This endpoint can be used in 2 ways: By passing a JSON Body (RestVariable) or by passing a multipart/form-data Object.\nNB: Swagger V2 specification does not support this use case that is why this endpoint might be buggy/incomplete if used with other tools." }, { "info": { "name": "Delete a variable for an execution", "type": "http" }, "http": { "method": "DELETE", "url": "/flowable-rest/service/runtime/executions/:executionId/variables/:variableName", "params": [ { "name": "executionId", "value": "", "type": "path" }, { "name": "variableName", "value": "", "type": "path" }, { "name": "scope", "value": "", "type": "query" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Delete a variable for an execution" }, { "info": { "name": "Get the binary data for an execution", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/runtime/executions/:executionId/variables/:variableName/data", "params": [ { "name": "executionId", "value": "", "type": "path" }, { "name": "variableName", "value": "", "type": "path" }, { "name": "scope", "value": "", "type": "query" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Get the binary data for an execution" } ] } ], "bundled": true }