{ "opencollection": "1.0.0", "info": { "name": "Flowable REST Access Tokens Case Definitions API", "version": "v1" }, "items": [ { "info": { "name": "Case Definitions", "type": "folder" }, "items": [ { "info": { "name": "List of case definitions", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/cmmn-repository/case-definitions", "params": [ { "name": "version", "value": "", "type": "query", "description": "Only return case definitions with the given version." }, { "name": "name", "value": "", "type": "query", "description": "Only return case definitions with the given name." }, { "name": "nameLike", "value": "", "type": "query", "description": "Only return case definitions with a name like the given name." }, { "name": "nameLikeIgnoreCase", "value": "", "type": "query", "description": "Only return case definitions with a name like the given name ignoring case." }, { "name": "key", "value": "", "type": "query", "description": "Only return case definitions with the given key." }, { "name": "keyLike", "value": "", "type": "query", "description": "Only return case definitions with a name like the given key." }, { "name": "resourceName", "value": "", "type": "query", "description": "Only return case definitions with the given resource name." }, { "name": "resourceNameLike", "value": "", "type": "query", "description": "Only return case definitions with a name like the given resource name." }, { "name": "category", "value": "", "type": "query", "description": "Only return case definitions with the given category." }, { "name": "categoryLike", "value": "", "type": "query", "description": "Only return case definitions with a category like the given name." }, { "name": "categoryNotEquals", "value": "", "type": "query", "description": "Only return case definitions which do not have the given category." }, { "name": "deploymentId", "value": "", "type": "query", "description": "Only return case definitions which are part of a deployment with the given deployment id." }, { "name": "parentDeploymentId", "value": "", "type": "query", "description": "Only return case definitions which are part of a deployment with the given parent deployment id." }, { "name": "startableByUser", "value": "", "type": "query", "description": "Only return case definitions which are part of a deployment with the given id." }, { "name": "latest", "value": "", "type": "query", "description": "Only return the latest case definition versions. Can only be used together with key and keyLike parameters, using any other parameter will result in a 400-response." }, { "name": "suspended", "value": "", "type": "query", "description": "If true, only returns case definitions which are suspended. If false, only active process definitions (which are not suspended) are returned." }, { "name": "sort", "value": "", "type": "query", "description": "Property to sort on, to be used together with the order." }, { "name": "order", "value": "", "type": "query", "description": "The sort order, either 'asc' or 'desc'. Defaults to 'asc'." }, { "name": "start", "value": "", "type": "query", "description": "Index of the first row to fetch. Defaults to 0." }, { "name": "size", "value": "", "type": "query", "description": "Number of rows to fetch, starting from start. Defaults to 10." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "List of case definitions" }, { "info": { "name": "Get a case definition", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/cmmn-repository/case-definitions/:caseDefinitionId", "params": [ { "name": "caseDefinitionId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Get a case definition" }, { "info": { "name": "Execute actions for a case definition", "type": "http" }, "http": { "method": "PUT", "url": "/flowable-rest/service/cmmn-repository/case-definitions/:caseDefinitionId", "params": [ { "name": "caseDefinitionId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Execute actions for a case definition (Update category)" }, { "info": { "name": "Batch migrate all instances of case definition", "type": "http" }, "http": { "method": "POST", "url": "/flowable-rest/service/cmmn-repository/case-definitions/:caseDefinitionId/batch-migrate", "params": [ { "name": "caseDefinitionId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Batch migrate all instances of case definition" }, { "info": { "name": "Batch migrate all historic instances of case definition", "type": "http" }, "http": { "method": "POST", "url": "/flowable-rest/service/cmmn-repository/case-definitions/:caseDefinitionId/batch-migrate-historic-instances", "params": [ { "name": "caseDefinitionId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Batch migrate all historic instances of case definition" }, { "info": { "name": "List decision tables for a case definition", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/cmmn-repository/case-definitions/:caseDefinitionId/decision-tables", "params": [ { "name": "caseDefinitionId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "List decision tables for a case definition" }, { "info": { "name": "List decisions for a case definition", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/cmmn-repository/case-definitions/:caseDefinitionId/decisions", "params": [ { "name": "caseDefinitionId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "List decisions for a case definition" }, { "info": { "name": "List form definitions for a case definition", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/cmmn-repository/case-definitions/:caseDefinitionId/form-definitions", "params": [ { "name": "caseDefinitionId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "List form definitions for a case definition" }, { "info": { "name": "List candidate starters for a case definition", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/cmmn-repository/case-definitions/:caseDefinitionId/identitylinks", "params": [ { "name": "caseDefinitionId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "List candidate starters for a case definition" }, { "info": { "name": "Add a candidate starter to a case definition", "type": "http" }, "http": { "method": "POST", "url": "/flowable-rest/service/cmmn-repository/case-definitions/:caseDefinitionId/identitylinks", "params": [ { "name": "caseDefinitionId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "It is possible to add either a user or a group." }, { "info": { "name": "Get a candidate starter from a case definition", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/cmmn-repository/case-definitions/:caseDefinitionId/identitylinks/:family/:identityId", "params": [ { "name": "caseDefinitionId", "value": "", "type": "path" }, { "name": "family", "value": "", "type": "path" }, { "name": "identityId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Get a candidate starter from a case definition" }, { "info": { "name": "Delete a candidate starter from a case definition", "type": "http" }, "http": { "method": "DELETE", "url": "/flowable-rest/service/cmmn-repository/case-definitions/:caseDefinitionId/identitylinks/:family/:identityId", "params": [ { "name": "caseDefinitionId", "value": "", "type": "path" }, { "name": "family", "value": "", "type": "path" }, { "name": "identityId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Delete a candidate starter from a case definition" }, { "info": { "name": "Get a case definition image", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/cmmn-repository/case-definitions/:caseDefinitionId/image", "params": [ { "name": "caseDefinitionId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Get a case definition image" }, { "info": { "name": "Migrate all instances of case definition", "type": "http" }, "http": { "method": "POST", "url": "/flowable-rest/service/cmmn-repository/case-definitions/:caseDefinitionId/migrate", "params": [ { "name": "caseDefinitionId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Migrate all instances of case definition" }, { "info": { "name": "Migrate all historic case instances of case definition", "type": "http" }, "http": { "method": "POST", "url": "/flowable-rest/service/cmmn-repository/case-definitions/:caseDefinitionId/migrate-historic-instances", "params": [ { "name": "caseDefinitionId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Migrate all historic case instances of case definition" }, { "info": { "name": "Get a case definition CMMN model", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/cmmn-repository/case-definitions/:caseDefinitionId/model", "params": [ { "name": "caseDefinitionId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Get a case definition CMMN model" }, { "info": { "name": "Get a case definition resource content", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/cmmn-repository/case-definitions/:caseDefinitionId/resourcedata", "params": [ { "name": "caseDefinitionId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Get a case definition resource content" }, { "info": { "name": "Get a case definition start form", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/cmmn-repository/case-definitions/:caseDefinitionId/start-form", "params": [ { "name": "caseDefinitionId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Get a case definition start form" }, { "info": { "name": "Get a document definition resource content", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/document-repository/document-definitions/:documentDefinitionId/resourcedata", "params": [ { "name": "documentDefinitionId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Get a document definition resource content" } ] } ], "bundled": true }