{ "opencollection": "1.0.0", "info": { "name": "Flowable REST Access Tokens Deployment API", "version": "v1" }, "items": [ { "info": { "name": "Deployment", "type": "folder" }, "items": [ { "info": { "name": "List Deployments", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/repository/deployments", "params": [ { "name": "name", "value": "", "type": "query", "description": "Only return deployments with the given name." }, { "name": "nameLike", "value": "", "type": "query", "description": "Only return deployments with a name like the given name." }, { "name": "category", "value": "", "type": "query", "description": "Only return deployments with the given category." }, { "name": "categoryNotEquals", "value": "", "type": "query", "description": "Only return deployments which do not have the given category." }, { "name": "parentDeploymentId", "value": "", "type": "query", "description": "Only return deployments with the given parent deployment id." }, { "name": "parentDeploymentIdLike", "value": "", "type": "query", "description": "Only return deployments with a parent deployment id like the given value." }, { "name": "tenantId", "value": "", "type": "query", "description": "Only return deployments with the given tenantId." }, { "name": "tenantIdLike", "value": "", "type": "query", "description": "Only return deployments with a tenantId like the given value." }, { "name": "withoutTenantId", "value": "", "type": "query", "description": "If true, only returns deployments 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." }, { "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 Deployments" }, { "info": { "name": "Create a new deployment", "type": "http" }, "http": { "method": "POST", "url": "/flowable-rest/service/repository/deployments", "params": [ { "name": "deploymentKey", "value": "", "type": "query" }, { "name": "deploymentName", "value": "", "type": "query" }, { "name": "tenantId", "value": "", "type": "query" } ], "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" } ] }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "The request body should contain data of type multipart/form-data. There should be exactly one file in the request, any additional files will be ignored. The deployment name is the name of the file-field passed in. If multiple resources need to be deployed in a single deployment, compress the resources in a zip and make sure the file-name ends with .bar or .zip.\n\nAn additional parameter (form-field) can be passed in the request body with name tenantId. The value of this field will be used as the " }, { "info": { "name": "Get a deployment", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/repository/deployments/:deploymentId", "params": [ { "name": "deploymentId", "value": "", "type": "path", "description": "The id of the deployment to get." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Get a deployment" }, { "info": { "name": "Delete a deployment", "type": "http" }, "http": { "method": "DELETE", "url": "/flowable-rest/service/repository/deployments/:deploymentId", "params": [ { "name": "deploymentId", "value": "", "type": "path" }, { "name": "cascade", "value": "", "type": "query" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Delete a deployment" }, { "info": { "name": "Get a deployment resource content", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/repository/deployments/:deploymentId/resourcedata/:resourceName", "params": [ { "name": "deploymentId", "value": "", "type": "path" }, { "name": "resourceName", "value": "", "type": "path", "description": "The name of the resource to get. Make sure you URL-encode the resourceName in case it contains forward slashes. Eg: use diagrams%2Fmy-process.bpmn20.xml instead of diagrams/my-process.bpmn20.xml." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "The response body will contain the binary resource-content for the requested resource. The response content-type will be the same as the type returned in the resources mimeType property. Also, a content-disposition header is set, allowing browsers to download the file instead of displaying it." }, { "info": { "name": "List resources in a deployment", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/repository/deployments/:deploymentId/resources", "params": [ { "name": "deploymentId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "The dataUrl property in the resulting JSON for a single resource contains the actual URL to use for retrieving the binary resource." }, { "info": { "name": "Get a deployment resource", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/repository/deployments/:deploymentId/resources/**", "params": [ { "name": "deploymentId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Replace ** by ResourceId" }, { "info": { "name": "List Deployments", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/cmmn-repository/deployments", "params": [ { "name": "name", "value": "", "type": "query", "description": "Only return deployments with the given name." }, { "name": "nameLike", "value": "", "type": "query", "description": "Only return deployments with a name like the given name." }, { "name": "category", "value": "", "type": "query", "description": "Only return deployments with the given category." }, { "name": "categoryNotEquals", "value": "", "type": "query", "description": "Only return deployments which do not have the given category." }, { "name": "parentDeploymentId", "value": "", "type": "query", "description": "Only return deployments with the given parent deployment id." }, { "name": "parentDeploymentIdLike", "value": "", "type": "query", "description": "Only return deployments with a parent deployment id like the given value." }, { "name": "tenantIdLike", "value": "", "type": "query", "description": "Only return deployments with a tenantId like the given value." }, { "name": "tenantId", "value": "", "type": "query", "description": "Only return deployments with the given tenantId." }, { "name": "withoutTenantId", "value": "", "type": "query", "description": "If true, only returns deployments 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." }, { "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 Deployments" }, { "info": { "name": "Create a new deployment", "type": "http" }, "http": { "method": "POST", "url": "/flowable-rest/service/cmmn-repository/deployments", "params": [ { "name": "deploymentKey", "value": "", "type": "query" }, { "name": "deploymentName", "value": "", "type": "query" }, { "name": "tenantId", "value": "", "type": "query" } ], "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" } ] }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "The request body should contain data of type multipart/form-data. There should be exactly one file in the request, any additional files will be ignored. The deployment name is the name of the file-field passed in. If multiple resources need to be deployed in a single deployment, compress the resources in a zip and make sure the file-name ends with .bar or .zip.\n\nAn additional parameter (form-field) can be passed in the request body with name tenantId. The value of this field will be used as the " }, { "info": { "name": "Get a deployment", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/cmmn-repository/deployments/:deploymentId", "params": [ { "name": "deploymentId", "value": "", "type": "path", "description": "The id of the deployment to get." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Get a deployment" }, { "info": { "name": "Delete a deployment", "type": "http" }, "http": { "method": "DELETE", "url": "/flowable-rest/service/cmmn-repository/deployments/:deploymentId", "params": [ { "name": "deploymentId", "value": "", "type": "path" }, { "name": "cascade", "value": "", "type": "query" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Delete a deployment" }, { "info": { "name": "Get a deployment resource content", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/cmmn-repository/deployments/:deploymentId/resourcedata/:resourceName", "params": [ { "name": "deploymentId", "value": "", "type": "path" }, { "name": "resourceName", "value": "", "type": "path", "description": "The name of the resource to get. Make sure you URL-encode the resourceName in case it contains forward slashes. Eg: use diagrams%2Fmy-process.bpmn20.xml instead of diagrams/my-process.bpmn20.xml." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "The response body will contain the binary resource-content for the requested resource. The response content-type will be the same as the type returned in the resources mimeType property. Also, a content-disposition header is set, allowing browsers to download the file instead of displaying it." }, { "info": { "name": "List resources in a deployment", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/cmmn-repository/deployments/:deploymentId/resources", "params": [ { "name": "deploymentId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "The dataUrl property in the resulting JSON for a single resource contains the actual URL to use for retrieving the binary resource." }, { "info": { "name": "Get a deployment resource", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/cmmn-repository/deployments/:deploymentId/resources/**", "params": [ { "name": "deploymentId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Replace ** by ResourceId" }, { "info": { "name": "List Deployments", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/document-repository/deployments", "params": [ { "name": "name", "value": "", "type": "query", "description": "Only return deployments with the given name." }, { "name": "nameLike", "value": "", "type": "query", "description": "Only return deployments with a name like the given name." }, { "name": "category", "value": "", "type": "query", "description": "Only return deployments with the given category." }, { "name": "categoryNotEquals", "value": "", "type": "query", "description": "Only return deployments which don’t have the given category." }, { "name": "parentDeploymentId", "value": "", "type": "query", "description": "Only return deployments with the given parent deployment id." }, { "name": "parentDeploymentIdLike", "value": "", "type": "query", "description": "Only return deployments with a parent deployment id like the given value." }, { "name": "tenantIdLike", "value": "", "type": "query", "description": "Only return deployments with a tenantId like the given value." }, { "name": "tenantId", "value": "", "type": "query", "description": "Only return deployments with the given tenantId." }, { "name": "withoutTenantId", "value": "", "type": "query", "description": "If true, only returns deployments 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 Deployments" }, { "info": { "name": "Create a new deployment", "type": "http" }, "http": { "method": "POST", "url": "/flowable-rest/service/document-repository/deployments", "params": [ { "name": "deploymentKey", "value": "", "type": "query" }, { "name": "deploymentName", "value": "", "type": "query" }, { "name": "tenantId", "value": "", "type": "query" } ], "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" } ] }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "The request body should contain data of type multipart/form-data. There should be exactly one file in the request, any additional files will be ignored. The deployment name is the name of the file-field passed in. If multiple resources need to be deployed in a single deployment, compress the resources in a zip and make sure the file-name ends with .bar or .zip.\n\nAn additional parameter (form-field) can be passed in the request body with name tenantId. The value of this field will be used as the " }, { "info": { "name": "Get a deployment", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/document-repository/deployments/:deploymentId", "params": [ { "name": "deploymentId", "value": "", "type": "path", "description": "The id of the deployment to get." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Get a deployment" }, { "info": { "name": "Delete a deployment", "type": "http" }, "http": { "method": "DELETE", "url": "/flowable-rest/service/document-repository/deployments/:deploymentId", "params": [ { "name": "deploymentId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Delete a deployment" }, { "info": { "name": "Get a deployment resource content", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/document-repository/deployments/:deploymentId/resourcedata/:resourceName", "params": [ { "name": "deploymentId", "value": "", "type": "path" }, { "name": "resourceName", "value": "", "type": "path", "description": "The name of the resource to get. Make sure you URL-encode the resourceName in case it contains forward slashes. Eg: use test%2Fsimple.document instead of test/simple.document." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "The response body will contain the binary resource-content for the requested resource. The response content-type will be the same as the type returned in the resources mimeType property. Also, a content-disposition header is set, allowing browsers to download the file instead of displaying it." }, { "info": { "name": "List resources in a deployment", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/document-repository/deployments/:deploymentId/resources", "params": [ { "name": "deploymentId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "The dataUrl property in the resulting JSON for a single resource contains the actual URL to use for retrieving the binary resource." }, { "info": { "name": "Get a deployment resource", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/document-repository/deployments/:deploymentId/resources/**", "params": [ { "name": "deploymentId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Replace ** by ResourceId" }, { "info": { "name": "List of decision deployments", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/dmn-repository/deployments", "params": [ { "name": "name", "value": "", "type": "query", "description": "Only return decision deployments with the given name." }, { "name": "nameLike", "value": "", "type": "query", "description": "Only return decision deployments with a name like the given name." }, { "name": "category", "value": "", "type": "query", "description": "Only return decision deployments with the given category." }, { "name": "categoryNotEquals", "value": "", "type": "query", "description": "Only return decision deployments which do not have the given category." }, { "name": "parentDeploymentId", "value": "", "type": "query", "description": "Only return decision deployments with the given parent deployment id." }, { "name": "parentDeploymentIdLike", "value": "", "type": "query", "description": "Only return decision deployments with a parent deployment id like the given value." }, { "name": "tenantId", "value": "", "type": "query", "description": "Only return decision deployments with the given tenantId." }, { "name": "tenantIdLike", "value": "", "type": "query", "description": "Only return decision deployments with a tenantId like the given value." }, { "name": "withoutTenantId", "value": "", "type": "query", "description": "If true, only returns decision deployments 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." }, { "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 decision deployments" }, { "info": { "name": "Create a new decision deployment", "type": "http" }, "http": { "method": "POST", "url": "/flowable-rest/service/dmn-repository/deployments", "params": [ { "name": "tenantId", "value": "", "type": "query" } ], "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" } ] }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "The request body should contain data of type multipart/form-data. There should be exactly one file in the request, any additional files will be ignored. The deployment name is the name of the file-field passed in. If multiple resources need to be deployed in a single deployment, compress the resources in a zip and make sure the file-name ends with .bar or .zip.\n\nAn additional parameter (form-field) can be passed in the request body with name tenantId. The value of this field will be used as the " }, { "info": { "name": "Get a decision deployment", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/dmn-repository/deployments/:deploymentId", "params": [ { "name": "deploymentId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Get a decision deployment" }, { "info": { "name": "Delete a decision deployment", "type": "http" }, "http": { "method": "DELETE", "url": "/flowable-rest/service/dmn-repository/deployments/:deploymentId", "params": [ { "name": "deploymentId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Delete a decision deployment" }, { "info": { "name": "Get a decision deployment resource content", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/dmn-repository/deployments/:deploymentId/resourcedata/:resourceName", "params": [ { "name": "deploymentId", "value": "", "type": "path" }, { "name": "resourceName", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "The response body will contain the binary resource-content for the requested resource. The response content-type will be the same as the type returned in the resources mimeType property. Also, a content-disposition header is set, allowing browsers to download the file instead of displaying it." } ] } ], "bundled": true }