{ "opencollection": "1.0.0", "info": { "name": "Flowable REST Access Tokens Query API", "version": "v1" }, "items": [ { "info": { "name": "Query", "type": "folder" }, "items": [ { "info": { "name": "Query for activity instances", "type": "http" }, "http": { "method": "POST", "url": "/flowable-rest/service/query/activity-instances", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "All supported JSON parameter fields allowed are exactly the same as the parameters found for getting a collection of historic task instances, but passed in as JSON-body arguments rather than URL-parameters to allow for more advanced querying and preventing errors with request-uri’s that are too long." }, { "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": "Query for historic activity instances", "type": "http" }, "http": { "method": "POST", "url": "/flowable-rest/service/query/historic-activity-instances", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "All supported JSON parameter fields allowed are exactly the same as the parameters found for getting a collection of historic task instances, but passed in as JSON-body arguments rather than URL-parameters to allow for more advanced querying and preventing errors with request-uri’s that are too long." }, { "info": { "name": "Query for historic details", "type": "http" }, "http": { "method": "POST", "url": "/flowable-rest/service/query/historic-detail", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "All supported JSON parameter fields allowed are exactly the same as the parameters found for getting a collection of historic process instances, but passed in as JSON-body arguments rather than URL-parameters to allow for more advanced querying and preventing errors with request-uri’s that are too long." }, { "info": { "name": "Query for historic process instances", "type": "http" }, "http": { "method": "POST", "url": "/flowable-rest/service/query/historic-process-instances", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "All supported JSON parameter fields allowed are exactly the same as the parameters found for getting a collection of historic process instances, but passed in as JSON-body arguments rather than URL-parameters to allow for more advanced querying and preventing errors with request-uri’s that are too long. On top of that, the query allows for filtering based on process variables. The variables property is a JSON-array containing objects with the format as described here." }, { "info": { "name": "Query for historic task instances", "type": "http" }, "http": { "method": "POST", "url": "/flowable-rest/service/query/historic-task-instances", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "All supported JSON parameter fields allowed are exactly the same as the parameters found for getting a collection of historic task instances, but passed in as JSON-body arguments rather than URL-parameters to allow for more advanced querying and preventing errors with request-uri’s that are too long. On top of that, the query allows for filtering based on process variables. The taskVariables and processVariables properties are JSON-arrays containing objects with the format as described here." }, { "info": { "name": "Query for historic variable instances", "type": "http" }, "http": { "method": "POST", "url": "/flowable-rest/service/query/historic-variable-instances", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "All supported JSON parameter fields allowed are exactly the same as the parameters found for getting a collection of historic process instances, but passed in as JSON-body arguments rather than URL-parameters to allow for more advanced querying and preventing errors with request-uri’s that are too long. On top of that, the query allows for filtering based on process variables. The variables property is a JSON-array containing objects with the format as described here." }, { "info": { "name": "Query process instances", "type": "http" }, "http": { "method": "POST", "url": "/flowable-rest/service/query/process-instances", "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 process instances URL query. On top of these, it’s possible to provide an array of variables 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": "Query for tasks", "type": "http" }, "http": { "method": "POST", "url": "/flowable-rest/service/query/tasks", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "All supported JSON parameter fields allowed are exactly the same as the parameters found for getting a collection of tasks (except for candidateGroupIn which is only available in this POST task query REST service), but passed in as JSON-body arguments rather than URL-parameters to allow for more advanced querying and preventing errors with request-uri’s that are too long. On top of that, the query allows for filtering based on task and process variables. The taskVariables and processInstanceVari" }, { "info": { "name": "Query for variable instances", "type": "http" }, "http": { "method": "POST", "url": "/flowable-rest/service/query/variable-instances", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "All supported JSON parameter fields allowed are exactly the same as the parameters found for getting a collection of variable instances, but passed in as JSON-body arguments rather than URL-parameters to allow for more advanced querying and preventing errors with request-uri’s that are too long." }, { "info": { "name": "Query case instances", "type": "http" }, "http": { "method": "POST", "url": "/flowable-rest/service/cmmn-query/case-instances", "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 case instances URL query. On top of these, it’s possible to provide an array of variables 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": "Query for historic case instances", "type": "http" }, "http": { "method": "POST", "url": "/flowable-rest/service/cmmn-query/historic-case-instances", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "All supported JSON parameter fields allowed are exactly the same as the parameters found for getting a collection of historic case instances, but passed in as JSON-body arguments rather than URL-parameters to allow for more advanced querying and preventing errors with request-uri’s that are too long. On top of that, the query allows for filtering based on process variables. The variables property is a JSON-array containing objects with the format as described here." }, { "info": { "name": "Query for historic milestone instances", "type": "http" }, "http": { "method": "POST", "url": "/flowable-rest/service/cmmn-query/historic-milestone-instances", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "All supported JSON parameter fields allowed are exactly the same as the parameters found for getting a collection of historic milestone instances, but passed in as JSON-body arguments rather than URL-parameters to allow for more advanced querying and preventing errors with request-uri’s that are too long." }, { "info": { "name": "Query for historic plan item instances", "type": "http" }, "http": { "method": "POST", "url": "/flowable-rest/service/cmmn-query/historic-planitem-instances", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "All supported JSON parameter fields allowed are exactly the same as the parameters found for getting a collection of historic plan item instances, but passed in as JSON-body arguments rather than URL-parameters to allow for more advanced querying and preventing errors with request-uri’s that are too long." }, { "info": { "name": "Query for historic task instances", "type": "http" }, "http": { "method": "POST", "url": "/flowable-rest/service/cmmn-query/historic-task-instances", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "All supported JSON parameter fields allowed are exactly the same as the parameters found for getting a collection of historic task instances, but passed in as JSON-body arguments rather than URL-parameters to allow for more advanced querying and preventing errors with request-uri’s that are too long. On top of that, the query allows for filtering based on process variables. The taskVariables and processVariables properties are JSON-arrays containing objects with the format as described here." }, { "info": { "name": "Query for historic variable instances", "type": "http" }, "http": { "method": "POST", "url": "/flowable-rest/service/cmmn-query/historic-variable-instances", "params": [ { "name": "sort", "value": "", "type": "query", "description": "The field to sort by. Defaults to 'variableName'." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "All supported JSON parameter fields allowed are exactly the same as the parameters found for getting a collection of historic process instances, but passed in as JSON-body arguments rather than URL-parameters to allow for more advanced querying and preventing errors with request-uri’s that are too long. On top of that, the query allows for filtering based on process variables. The variables property is a JSON-array containing objects with the format as described here." }, { "info": { "name": "Query plan item instances", "type": "http" }, "http": { "method": "POST", "url": "/flowable-rest/service/cmmn-query/plan-item-instances", "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 plan item instances URL query. On top of these, it’s possible to provide an array of variables and caseInstanceVariables 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": "Query for tasks", "type": "http" }, "http": { "method": "POST", "url": "/flowable-rest/service/cmmn-query/tasks", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "All supported JSON parameter fields allowed are exactly the same as the parameters found for getting a collection of tasks (except for candidateGroupIn which is only available in this POST task query REST service), but passed in as JSON-body arguments rather than URL-parameters to allow for more advanced querying and preventing errors with request-uri’s that are too long. On top of that, the query allows for filtering based on task and process variables. The taskVariables and processInstanceVari" }, { "info": { "name": "Query for variable instances", "type": "http" }, "http": { "method": "POST", "url": "/flowable-rest/service/cmmn-query/variable-instances", "params": [ { "name": "sort", "value": "", "type": "query", "description": "The field to sort by. Defaults to 'variableName'." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "All supported JSON parameter fields allowed are exactly the same as the parameters found for getting a collection of variable instances, but passed in as JSON-body arguments rather than URL-parameters to allow for more advanced querying and preventing errors with request-uri’s that are too long. " }, { "info": { "name": "Query for rendition items", "type": "http" }, "http": { "method": "POST", "url": "/flowable-rest/service/query/rendition-items", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "All supported JSON parameter fields allowed are exactly the same as the parameters found for getting a collection of rendition items, but passed in as JSON-body arguments rather than URL-parameters to allow for more advanced querying and preventing errors with request-uri’s that are too long." }, { "info": { "name": "Query form instances", "type": "http" }, "http": { "method": "POST", "url": "/flowable-rest/service/query/form-instances", "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 form instances URL query. On top of these, it’s possible to provide an array of variables 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": "Query groups", "type": "http" }, "http": { "method": "POST", "url": "/flowable-rest/service/query/groups", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Query groups" }, { "info": { "name": "Query users", "type": "http" }, "http": { "method": "POST", "url": "/flowable-rest/service/query/users", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Query users" } ] } ], "bundled": true }