{ "opencollection": "1.0.0", "info": { "name": "Flowable REST Access Tokens Document Definitions API", "version": "v1" }, "items": [ { "info": { "name": "Document Definitions", "type": "folder" }, "items": [ { "info": { "name": "List of document definitions", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/document-repository/document-definitions", "params": [ { "name": "accessibleByUser", "value": "", "type": "query", "description": "Only return document definitions accessible by the given user." }, { "name": "category", "value": "", "type": "query", "description": "Only return document definitions with the given category" }, { "name": "categoryLike", "value": "", "type": "query", "description": "Only return document definitions with a category like the given value" }, { "name": "deploymentId", "value": "", "type": "query", "description": "Only return document definitions with the given deployment id" }, { "name": "id", "value": "", "type": "query", "description": "Only return document definitions with the given id" }, { "name": "ids", "value": "", "type": "query", "description": "Only return document definitions with the given ids" }, { "name": "key", "value": "", "type": "query", "description": "Only return document definitions with the given key" }, { "name": "keyLike", "value": "", "type": "query", "description": "Only return document definitions with a key like the given value" }, { "name": "keys", "value": "", "type": "query", "description": "Only return document definitions with the given keys" }, { "name": "latest", "value": "", "type": "query", "description": "Only return document definitions with the latest version" }, { "name": "name", "value": "", "type": "query", "description": "Only return document definitions with the given name" }, { "name": "nameLike", "value": "", "type": "query", "description": "Only return document definitions with a name like the given value" }, { "name": "order", "value": "", "type": "query", "description": "From the paginate request. The sort order, either 'asc' or 'desc'. Defaults to 'asc'." }, { "name": "size", "value": "", "type": "query", "description": "From the paginate request. Number of rows to fetch, starting from start. Defaults to 10." }, { "name": "sort", "value": "", "type": "query", "description": "Property to sort the results on" }, { "name": "start", "value": "", "type": "query", "description": "From the paginate request. Index of the first row to fetch. Defaults to 0." }, { "name": "tenantId", "value": "", "type": "query", "description": "Only return document definitions within the given tenant." }, { "name": "tenantIdLike", "value": "", "type": "query", "description": "Only return document definitions with a tenant id like the given value." }, { "name": "version", "value": "", "type": "query", "description": "Only return document definitions with the given version" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "List of document definitions" }, { "info": { "name": "Get a document definition", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/document-repository/document-definitions/:documentDefinitionId", "params": [ { "name": "documentDefinitionId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Get a document definition" }, { "info": { "name": "Execute actions for a document definition", "type": "http" }, "http": { "method": "PUT", "url": "/flowable-rest/service/document-repository/document-definitions/:documentDefinitionId", "params": [ { "name": "documentDefinitionId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Execute actions for a document definition (Update category)" }, { "info": { "name": "getDocumentDefinitionForm", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/document-repository/document-definitions/:documentDefinitionId/form-model", "params": [ { "name": "documentDefinitionId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } } }, { "info": { "name": "Get a document definition model", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/document-repository/document-definitions/:documentDefinitionId/model", "params": [ { "name": "documentDefinitionId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Get a document definition model" } ] } ], "bundled": true }