{ "opencollection": "1.0.0", "info": { "name": "Flowable REST Access Tokens Models API", "version": "v1" }, "items": [ { "info": { "name": "Models", "type": "folder" }, "items": [ { "info": { "name": "List models", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/repository/models", "params": [ { "name": "id", "value": "", "type": "query", "description": "Only return models with the given version." }, { "name": "category", "value": "", "type": "query", "description": "Only return models with the given category." }, { "name": "categoryLike", "value": "", "type": "query", "description": "Only return models with a category like the given name." }, { "name": "categoryNotEquals", "value": "", "type": "query", "description": "Only return models which do not have the given category." }, { "name": "name", "value": "", "type": "query", "description": "Only return models with the given name." }, { "name": "nameLike", "value": "", "type": "query", "description": "Only return models with a name like the given name." }, { "name": "key", "value": "", "type": "query", "description": "Only return models with the given key." }, { "name": "deploymentId", "value": "", "type": "query", "description": "Only return models with the given category." }, { "name": "version", "value": "", "type": "query", "description": "Only return models with the given version." }, { "name": "latestVersion", "value": "", "type": "query", "description": "If true, only return models which are the latest version. Best used in combination with key. If false is passed in as value, this is ignored and all versions are returned." }, { "name": "deployed", "value": "", "type": "query", "description": "If true, only deployed models are returned. If false, only undeployed models are returned (deploymentId is null)." }, { "name": "tenantId", "value": "", "type": "query", "description": "Only return models with the given tenantId." }, { "name": "tenantIdLike", "value": "", "type": "query", "description": "Only return models with a tenantId like the given value." }, { "name": "withoutTenantId", "value": "", "type": "query", "description": "If true, only returns models 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 models" }, { "info": { "name": "Create a model", "type": "http" }, "http": { "method": "POST", "url": "/flowable-rest/service/repository/models", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "All request values are optional. For example, you can only include the name attribute in the request body JSON-object, only setting the name of the model, leaving all other fields null." }, { "info": { "name": "Get a model", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/repository/models/:modelId", "params": [ { "name": "modelId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Get a model" }, { "info": { "name": "Update a model", "type": "http" }, "http": { "method": "PUT", "url": "/flowable-rest/service/repository/models/:modelId", "params": [ { "name": "modelId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "All request values are optional. For example, you can only include the name attribute in the request body JSON-object, only updating the name of the model, leaving all other fields unaffected. When an attribute is explicitly included and is set to null, the model-value will be updated to null. " }, { "info": { "name": "Delete a model", "type": "http" }, "http": { "method": "DELETE", "url": "/flowable-rest/service/repository/models/:modelId", "params": [ { "name": "modelId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Delete a model" }, { "info": { "name": "Get the editor source for a model", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/repository/models/:modelId/source", "params": [ { "name": "modelId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Response body contains the model’s raw editor source. The response’s content-type is set to application/octet-stream, regardless of the content of the source." }, { "info": { "name": "Set the editor source for a model", "type": "http" }, "http": { "method": "PUT", "url": "/flowable-rest/service/repository/models/:modelId/source", "params": [ { "name": "modelId", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" } ] }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Response body contains the model’s raw editor source. The response’s content-type is set to application/octet-stream, regardless of the content of the source." }, { "info": { "name": "Get the extra editor source for a model", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/repository/models/:modelId/source-extra", "params": [ { "name": "modelId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Response body contains the model’s raw editor source. The response’s content-type is set to application/octet-stream, regardless of the content of the source." }, { "info": { "name": "Set the extra editor source for a model", "type": "http" }, "http": { "method": "PUT", "url": "/flowable-rest/service/repository/models/:modelId/source-extra", "params": [ { "name": "modelId", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" } ] }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Response body contains the model’s raw editor source. The response’s content-type is set to application/octet-stream, regardless of the content of the source." } ] } ], "bundled": true }