{ "openapi": "3.0.1", "info": { "title": "api-gateway Rest API", "description": "### DMS Endpoints\nThese endpoints may be used by any kind of client, operating under an authorized user. \n\n### Admin Endpoints\nThese endpoints allow the administration of configuration resources for a tenant. The tenant administrator can use them to apply changes to the tenant-specific schema, role set and more. The target tenant is always the one the requesting administrative user belongs to.\n\n**Note:** The access to the endpoints is controlled via access condition. In the default configuration, the role YUUVIS_TENANT_ADMIN grants access.\n\n### System Endpoints\nThese endpoints allow the administration of configuration resources for the entire system. The system integrator can use them to apply changes to the global schema, apps and more. The global resources are available for all tenants.\n\n**Note:** The access to the endpoints is controlled via access condition. In the default configuration, the role YUUVIS_SYSTEM_INTEGRATOR grants access.", "termsOfService": "http://www.optimal-systems.com", "contact": { "name": "OPTIMAL SYSTEMS GmbH", "url": "http://www.optimal-systems.com", "email": "contact@optimal-systems.com" }, "version": "v1" }, "externalDocs": { "description": "yuuvis® Momentum documentation", "url": "https://help.optimal-systems.com/yuuvis/Momentum/latest/index.html" }, "security": [ { "bearerAuth": [] } ], "paths": { "/api/dms/apps": { "get": { "tags": [ "dms-apps-controller" ], "summary": "get all active apps for the tenant", "description": "Retrieves all apps available in the tenant the currently logged-in user belongs to.", "operationId": "getActiveApps", "responses": { "200": { "description": "Successfully", "content": { "application/json": { } } } } } }, "/api/dms/info": { "get": { "tags": [ "dms-info-controller" ], "summary": "get installed product version", "description": "Retrieves information on the installed product version.", "operationId": "getSystemInfo", "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object" } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object" } } } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object" } } } } } } } }, "/api/dms/objects": { "post": { "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "Multipart Request Body": { "type": "array", "items": { "format": "binary", "type": "string" } } } } } } }, "tags": [ "dms-crud-controller" ], "summary": "import one or more objects", "description": "Creates new DMS objects with the metadata and binary content that is provided in the multipart request body.", "operationId": "importDmsObjects", "parameters": [ { "name": "waitForSearchConsistency", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "patch": { "tags": [ "dms-crud-controller" ], "summary": "patch-update metadata of multiple objects", "description": "Updates metadata in multiple objects specified by ID in the JSON request body.", "operationId": "batchUpdateDmsObjects", "parameters": [ { "name": "waitForSearchConsistency", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } }, { "name": "greedy", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "content-type", "in": "header", "schema": { "type": "string", "enum": [ "application/json" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectListPatch" } } }, "required": true }, "responses": { "207": { "description": "Multi-Status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } } } } }, "delete": { "tags": [ "dms-crud-controller" ], "summary": "delete multiple objects", "description": "Deletes multiple DMS objects specified by ID in the JSON request body.", "operationId": "batchDeleteDmsObjects", "parameters": [ { "name": "waitForSearchConsistency", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } }, { "name": "greedy", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "content-type", "in": "header", "schema": { "type": "string", "enum": [ "application/json" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } }, "required": true }, "responses": { "207": { "description": "Multi-Status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } } } } } }, "/api/dms/objects/search": { "post": { "tags": [ "dms-crud-controller" ], "summary": "search for objects by search query", "description": "Searches for DMS objects by the query JSON sent in the request body.", "operationId": "search", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DmsApiSearchQuery" } } }, "required": true }, "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } } }, "403": { "description": "Forbidden", "content": { "application/hal+json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/hal+json": { "schema": { "type": "object" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/hal+json": { "schema": { "type": "object" } } } } } } }, "/api/dms/objects/{objectId}": { "get": { "tags": [ "dms-crud-controller" ], "summary": "get object metadata", "description": "Retrieves the metadata of the DMS object specified by objectId", "operationId": "getDmsObjectMetadata", "parameters": [ { "name": "objectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "includePermissions", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } } }, "400": { "description": "Bad request", "content": { "application/hal+json": { "schema": { "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/hal+json": { "schema": { "type": "object" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/hal+json": { "schema": { "type": "object" } } } } } }, "post": { "tags": [ "dms-crud-controller" ], "summary": "update object metadata", "description": "Updates the metadata of the DMS object specified by ID with the complete metadata in the JSON request body.", "operationId": "updateDmsObjectMetadata", "parameters": [ { "name": "objectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "waitForSearchConsistency", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } }, "required": true }, "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } } } } }, "patch": { "tags": [ "dms-crud-controller" ], "summary": "patch-update object metadata", "description": "Updates the metadata of a DMS object specified by ID with the new metadata in the JSON request body. Changes only those properties that are part of the request body. Properties that are missing in the request body are not changed by the update. A property value can be removed by sending null as the new value.", "operationId": "updateDmsObjectPatch", "parameters": [ { "name": "objectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "waitForSearchConsistency", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } }, "required": true }, "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } } } } }, "delete": { "tags": [ "dms-crud-controller" ], "summary": "delete object", "description": "Deletes the DMS object specified by objectId", "operationId": "deleteDmsObject", "parameters": [ { "name": "objectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "waitForSearchConsistency", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Successfully", "content": { "application/hal+json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/hal+json": { "schema": { "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/hal+json": { "schema": { "type": "object" } } } }, "404": { "description": "Not Found", "content": { "application/hal+json": { "schema": { "type": "object" } } } }, "409": { "description": "Conflict", "content": { "application/hal+json": { "schema": { "type": "object" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/hal+json": { "schema": { "type": "object" } } } } } } }, "/api/dms/objects/{objectId}/contents/file": { "get": { "tags": [ "dms-crud-controller" ], "summary": "get binary content of object", "description": "Retrieves the binary content file assigned to the DMS object specified by objectId", "operationId": "getContent", "parameters": [ { "name": "objectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "filename", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "304": { "description": "Not Modified" }, "401": { "description": "Unauthorized" }, "422": { "description": "Unprocessable entity" } } }, "post": { "tags": [ "dms-crud-controller" ], "summary": "update content of object", "description": "To update the content file of a DMS object, send the request with the new content file as binary in the request body and the ID of the DMS object as objectId.", "operationId": "updateContent", "parameters": [ { "name": "data", "in": "query", "description": "content", "required": true, "style": "form", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, { "name": "objectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "waitForSearchConsistency", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "type": "object" } } } }, "304": { "description": "Not Modified", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "delete": { "tags": [ "dms-crud-controller" ], "summary": "remove the content from the object", "description": "Removes the binary content file that is assigned to the DMS object.", "operationId": "removeContent", "parameters": [ { "name": "objectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "waitForSearchConsistency", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/dms/objects/{objectId}/contents/renditions/text": { "get": { "tags": [ "dms-rendition-controller" ], "summary": "get text rendition", "description": "Retrieve the text rendition of the binary content file assigned to the DMS object specified by objectId.", "operationId": "getRenditionText", "parameters": [ { "name": "objectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "timeout", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64", "default": 50000 } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "text/plain": { "schema": { "type": "string", "format": "binary" } } } } } }, "post": { "tags": [ "dms-rendition-controller" ], "summary": "update text rendition", "description": "Updates the text rendition with the plain text in the request body for the object specified by objectId.", "operationId": "updateRenditionText", "parameters": [ { "name": "objectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "waitForSearchConsistency", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "type": "object" } } } } } }, "delete": { "tags": [ "dms-rendition-controller" ], "summary": "delete the cached text rendition for the object's content", "description": "Deletes the text rendition for binary content file that is assigned to the DMS object from the rendition repository.", "operationId": "deleteRenditionText", "parameters": [ { "name": "objectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/dms/objects/{objectId}/contents/renditions/pdf": { "get": { "tags": [ "dms-rendition-controller" ], "summary": "get PDF rendition", "description": "Retrieves the PDF rendition of the binary content file assigned to the object specified by objectId.", "operationId": "getRenditionPdf", "parameters": [ { "name": "objectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "level", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } } } }, "delete": { "tags": [ "dms-rendition-controller" ], "summary": "delete the cached PDF rendition for the object's content", "description": "Deletes the PDF rendition for binary content file that is assigned to the DMS object from the rendition repository.", "operationId": "deleteRenditionPdf", "parameters": [ { "name": "objectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/dms/objects/{objectId}/contents/renditions/slide": { "get": { "tags": [ "dms-rendition-controller" ], "summary": "get slide rendition", "description": "Retrieves the slide rendition of the binary content file assigned to the DMS object specified by objectId.", "operationId": "getRenditionSlide", "parameters": [ { "name": "objectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "timeout", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64", "default": 50000 } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "image/*": { "schema": { "type": "string", "format": "binary" } } } } } }, "delete": { "tags": [ "dms-rendition-controller" ], "summary": "delete the cached slide rendition for the object's content", "description": "Deletes the slide rendition for the binary content file that is assigned to the DMS object from the rendition repository.", "operationId": "deleteRenditionSlide", "parameters": [ { "name": "objectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/dms/objects/{objectId}/history": { "get": { "tags": [ "dms-crud-controller" ], "summary": "get audit trail of object", "description": "Retrieves the audit entries for the DMS object specified by objectId", "operationId": "getHistory", "parameters": [ { "name": "objectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } } }, "400": { "description": "Bad request", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "403": { "description": "Forbidden", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } } } } }, "/api/dms/objects/{objectId}/actions/validate/digest": { "get": { "tags": [ "dms-crud-controller" ], "summary": "validate content digest", "description": "Validates the digest of the binary content file assigned to the DMS object specified by objectId.", "operationId": "validateContentDigest", "parameters": [ { "name": "objectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "type": "object" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/dms/objects/{objectId}/actions/move/contents/repositories/{repositoryId}": { "post": { "tags": [ "dms-crud-controller" ], "summary": "move content", "description": "Move the binary content file of the DMS object specified by objectId to the repository specified by repositoryId.", "operationId": "moveContent", "parameters": [ { "name": "objectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repositoryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } } } } } }, "/api/dms/objects/{objectId}/relationships": { "get": { "tags": [ "dms-relationships-controller" ], "summary": "get relationships of object", "description": "Retrieves the relationship objects associated with the DMS object specified by objectId", "operationId": "getRelationships", "parameters": [ { "name": "objectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "excludeSource", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "excludeTarget", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } } }, "400": { "description": "Bad request", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "403": { "description": "Forbidden", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } } } } }, "/api/dms/objects/tags": { "post": { "tags": [ "dms-tags-controller" ], "summary": "update tags of multiple objects", "description": "Updates tags in multiple DMS objects specified by ID in the JSON request body.", "operationId": "batchUpdateTags", "parameters": [ { "name": "waitForSearchConsistency", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } }, { "name": "greedy", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeObjects", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } }, "required": true }, "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } } }, "304": { "description": "Not Modified", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } } }, "401": { "description": "Unauthorized", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } } } } } }, "/api/dms/objects/tags/{name}/state/{state}": { "post": { "tags": [ "dms-tags-controller" ], "summary": "add/update tag by search query", "description": "Adds or updates the specified tag with the given value for all DMS objects that are found by the search query.", "operationId": "searchAndAddOrUpdateTag", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "state", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "waitForSearchConsistency", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } }, { "name": "query", "in": "query", "required": false, "schema": { "type": "string", "default": "SELECT * FROM system:object" } } ], "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } } }, "304": { "description": "Not Modified", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } } }, "401": { "description": "Unauthorized", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } } } } } }, "/api/dms/objects/{objectId}/tags/{name}/state/{state}": { "post": { "tags": [ "dms-tags-controller" ], "summary": "update tag of object", "description": "Add or update the specified tag with its state value to the DMS object", "operationId": "updateTag", "parameters": [ { "name": "objectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "state", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "waitForSearchConsistency", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } }, { "name": "traceIdMustMatch", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "overwrite", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeObjects", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "X-B3-TraceId", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } } }, "304": { "description": "Not Modified", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } } }, "401": { "description": "Unauthorized", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } } } } } }, "/api/dms/objects/{objectId}/tags/{name}": { "delete": { "tags": [ "dms-tags-controller" ], "summary": "deletes tag from object", "description": "Deletes the specified tag from the DMS object.", "operationId": "deleteTag", "parameters": [ { "name": "objectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "waitForSearchConsistency", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } }, { "name": "traceIdMustMatch", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "X-B3-TraceId", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } } }, "304": { "description": "Not Modified", "content": { "application/hal+json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized", "content": { "application/hal+json": { "schema": { "type": "object" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/hal+json": { "schema": { "type": "object" } } } } } } }, "/api/dms/objects/{objectId}/tags": { "get": { "tags": [ "dms-tags-controller" ], "summary": "get tags of object", "description": "Retrieves all tags currently assigned to the DMS object specified by objectId", "operationId": "getTags", "parameters": [ { "name": "objectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } } }, "304": { "description": "Not Modified", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } } }, "401": { "description": "Unauthorized", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } } } } } }, "/api/dms/uploads": { "get": { "tags": [ "dms-uploads-controller" ], "summary": "retrieve overview of uploads", "description": "Retrieves an overview of all running partial upload processes within the tenant with their already imported pieces indicated by partNumber.", "operationId": "getUploads", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/ListMultipartUploadsResult" } } } } } }, "post": { "tags": [ "dms-uploads-controller" ], "summary": "initialize upload", "description": "Initializes the import of a large content file in multiple pieces. The response body contains the uploadId that has to be referred to by the individual upload of each piece that belongs to the same binary content file.", "operationId": "initUpload", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/InitMultipartUploadResult" } } } } } } }, "/api/dms/uploads/{uploadId}": { "post": { "tags": [ "dms-uploads-controller" ], "summary": "finalize upload", "description": "Finalizes the upload process specified by uploadId. All pieces of the binary content imported via POST /api/dms/uploads/{uploadId} are concatenated to one content file ordered by their partNumber. After the successful call, no more sub-uploads of individual pieces are possible.", "operationId": "finishUpload", "parameters": [ { "name": "uploadId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "numberOfParts", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": -1 } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "Content-Disposition", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "dms-uploads-controller" ], "summary": "delete all pieces of upload", "description": "Deletes all pieces of the content file that are already uploaded with the specified uploadId via POST /api/dms/uploads/{uploadId}.", "operationId": "deleteUpload", "parameters": [ { "name": "uploadId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/dms/uploads/{uploadId}/parts/{partNumber}": { "put": { "tags": [ "dms-uploads-controller" ], "summary": "upload piece of content", "description": "Uploads the binary file (NO multipart) in the request body as a piece that belongs to the upload process specified by uploadId. Specify the index number (starting with 1) of the piece as value for partNumber.", "operationId": "uploadPart", "parameters": [ { "name": "uploadId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "partNumber", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/dms/uploads/{uploadId}/objects": { "post": { "tags": [ "dms-uploads-controller" ], "summary": "create object with uploaded content", "description": "Creates a new DMS object with the metadata specified in the JSON request body and stores the binary content file that has already been temporarily uploaded via the partial upload process specified by uploadId. The upload has to be finalized via POST /api/dms/uploads/{uploadId} first.", "operationId": "importFromUpload", "parameters": [ { "name": "uploadId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "waitForSearchConsistency", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "content-type", "in": "header", "schema": { "type": "string", "enum": [ "multipart/form-data,application/json" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } } } } } }, "/api/dms/uploads/{uploadId}/objects/{objectId}/contents/file": { "post": { "tags": [ "dms-uploads-controller" ], "summary": "replace object content by uploaded content", "description": "Updates a DMS object specified by objectId. The already temporarily uploaded content file identified by uploadId is stored as new binary content file. The upload has to be finalized via POST /api/dms/uploads/{uploadId} first.", "operationId": "updateFromUpload", "parameters": [ { "name": "uploadId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "objectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "waitForSearchConsistency", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } } } } } }, "/api/dms/objects/{objectId}/versions": { "get": { "tags": [ "dms-versions-controller" ], "summary": "get object metadata with all versions", "description": "Retrieves the metadata of the DMS object specified by objectId including all previous versions.", "operationId": "getVersionsList", "parameters": [ { "name": "objectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } } }, "400": { "description": "Bad request", "content": { "application/hal+json": { "schema": { "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/hal+json": { "schema": { "type": "object" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/hal+json": { "schema": { "type": "object" } } } } } } }, "/api/dms/objects/{objectId}/versions/{versionNr}": { "get": { "tags": [ "dms-versions-controller" ], "summary": "get metadata of a previous object version", "description": "Retrieves the metadata of the specified version of the DMS object.", "operationId": "getMetadataOfVersion", "parameters": [ { "name": "objectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "versionNr", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } } }, "400": { "description": "Bad request", "content": { "application/hal+json": { "schema": { "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/hal+json": { "schema": { "type": "object" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/hal+json": { "schema": { "type": "object" } } } } } }, "delete": { "tags": [ "dms-versions-controller" ], "summary": "delete a previous object version", "description": "Deletes the specified version of the DMS object.", "operationId": "deleteDmsObjectVersion", "parameters": [ { "name": "objectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "versionNr", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully", "content": { "application/hal+json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/hal+json": { "schema": { "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/hal+json": { "schema": { "type": "object" } } } }, "404": { "description": "Not Found", "content": { "application/hal+json": { "schema": { "type": "object" } } } }, "409": { "description": "Conflict", "content": { "application/hal+json": { "schema": { "type": "object" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/hal+json": { "schema": { "type": "object" } } } } } } }, "/api/dms/objects/{objectId}/versions/{versionNr}/contents/file": { "get": { "tags": [ "dms-versions-controller" ], "summary": "get content of a previous object version", "description": "Retrieve the binary content file assigned to the specified version of the DMS object.", "operationId": "getContentOfVersion", "parameters": [ { "name": "objectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "versionNr", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "304": { "description": "Not Modified" }, "401": { "description": "Unauthorized" }, "422": { "description": "Unprocessable entity" } } } }, "/api/dms/objects/{objectId}/versions/{versionNr}/contents/renditions/text": { "get": { "tags": [ "dms-versions-controller" ], "summary": "get text rendition for object version", "description": "Retrieves the content file’s text rendition of the DMS document object version specified by objectId and versionNr.", "operationId": "getRenditionTextVersion", "parameters": [ { "name": "objectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "versionNr", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "timeout", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64", "default": 50000 } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "text/plain": { "schema": { "type": "string", "format": "binary" } } } } } }, "delete": { "tags": [ "dms-versions-controller" ], "summary": "delete the cached text rendition for the object version's content", "description": "Deletes the text rendition for the binary content file that is assigned to the DMS object version from the rendition repository.", "operationId": "deleteRenditionTextVersion", "parameters": [ { "name": "objectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "versionNr", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/dms/objects/{objectId}/versions/{versionNr}/contents/renditions/pdf": { "get": { "tags": [ "dms-versions-controller" ], "summary": "get PDF rendition for object version", "description": "Retrieves the content file’s PDF rendition of the DMS document object version specified by objectId and versionNr.", "operationId": "getRenditionPdfVersion", "parameters": [ { "name": "objectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "versionNr", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "level", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } } } }, "delete": { "tags": [ "dms-versions-controller" ], "summary": "delete the cached PDF rendition for the object version's content", "description": "Deletes the PDF rendition for the binary content file that is assigned to the DMS object version from the rendition repository.", "operationId": "deleteRenditionPdfVersion", "parameters": [ { "name": "objectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "versionNr", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/dms/objects/{objectId}/versions/{versionNr}/contents/renditions/slide": { "get": { "tags": [ "dms-versions-controller" ], "summary": "get slide rendition for object version", "description": "Retrieves the content file’s slide rendition of the DMS document object version specified by objectId and versionNr.", "operationId": "getRenditionSlideVersion", "parameters": [ { "name": "objectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "versionNr", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "timeout", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64", "default": 50000 } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "image/*": { "schema": { "type": "string", "format": "binary" } } } } } }, "delete": { "tags": [ "dms-versions-controller" ], "summary": "delete the cached slide rendition for the object version's content", "description": "Deletes the slide rendition for the binary content file that is assigned to the DMS object version from the rendition repository.", "operationId": "deleteRenditionSlideVersion", "parameters": [ { "name": "objectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "versionNr", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/dms/objects/{objectId}/versions/{versionNr}/actions/restore": { "post": { "tags": [ "dms-versions-controller" ], "summary": "restore specified object version", "description": "Restores the old version of a DMS object specified by objectId and versionNr.", "operationId": "restore", "parameters": [ { "name": "objectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "versionNr", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "waitForSearchConsistency", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } }, { "name": "restoreParentId", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } } } } } }, "/api/dms/objects/{objectId}/versions/{versionNr}/actions/validate/digest": { "get": { "tags": [ "dms-versions-controller" ], "summary": "validate the object version content's digest", "description": "validate dms objects content digest with version [versionNr]", "operationId": "validateContentDigestOfVersion", "parameters": [ { "name": "objectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "versionNr", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "type": "object" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/dms/objects/{objectId}/versions/{versionNr}/actions/move/contents/repositories/{repositoryId}": { "post": { "tags": [ "dms-versions-controller" ], "summary": "move content of object", "description": "move content of object[objectId] to repository[repositoryId]", "operationId": "moveContentOfVersion", "parameters": [ { "name": "objectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "versionNr", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "repositoryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DmsApiObjectList" } } } } } } }, "/api/dms/schema/native": { "get": { "tags": [ "dms-schema-controller" ], "summary": "get schema json", "description": "get schema json", "operationId": "getSchemaNativeXml_1", "responses": { "200": { "description": "Successfully", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/Schema" } }, "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ResponseBodyEmitter" }, { "type": "string", "format": "binary" } ] } } } }, "403": { "description": "Forbidden", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "400": { "description": "Bad request", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } } } } }, "/api/dms/schema": { "get": { "tags": [ "dms-schema-controller" ], "summary": "get schema", "description": "get schema", "operationId": "getSchema", "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "type": "string", "format": "binary" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } } } } }, "/api/dms/schema/objecttype/{localname}": { "get": { "tags": [ "dms-schema-controller" ], "summary": "get object type", "description": "get object type", "operationId": "getObjectType", "parameters": [ { "name": "localname", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "type": "string", "format": "binary" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } } } } }, "/api/admin/metrics/{metric}": { "get": { "tags": [ "admin-metrics-controller" ], "operationId": "getMetric_AdminRole", "parameters": [ { "name": "metric", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/ResultContainerDmsObject" } } } } } }, "delete": { "tags": [ "admin-metrics-controller" ], "operationId": "resetMetric_AdminRole", "parameters": [ { "name": "metric", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/admin/permissions": { "get": { "tags": [ "admin-permissions-controller" ], "summary": "get permissions", "description": "get permissions", "operationId": "getPermissions_1", "responses": { "200": { "description": "Successfully", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/roleSet" } } } }, "403": { "description": "Forbidden", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "400": { "description": "Bad request", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } } } }, "post": { "tags": [ "admin-permissions-controller" ], "summary": "post permissions", "description": "post permissions", "operationId": "postPermissions_1", "requestBody": { "description": "roleset xml file", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/roleSet" } } }, "required": true }, "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } } } } }, "/api/admin/permissions/validate": { "post": { "tags": [ "admin-permissions-controller" ], "summary": "validate permissions", "description": "validate permissions", "operationId": "validatePermissions_1", "requestBody": { "description": "roleset xml file", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/roleSet" } } }, "required": true }, "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } } } } }, "/api/admin/schema": { "get": { "tags": [ "admin-schema-controller" ], "summary": "get schema as json", "description": "get schema as json", "operationId": "getSchema_2_1", "responses": { "200": { "description": "Successfully", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/Schema" } }, "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "403": { "description": "Forbidden", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } }, "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "400": { "description": "Bad request", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } }, "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } }, "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } } } }, "post": { "tags": [ "admin-schema-controller" ], "summary": "post schema", "description": "post schema", "operationId": "postSchema_1", "requestBody": { "description": "schema xml file", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/Schema" } } }, "required": true }, "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } } } } }, "/api/admin/schema/validate": { "post": { "tags": [ "admin-schema-controller" ], "summary": "validate schema", "description": "validate schema", "operationId": "validateSchema_1", "requestBody": { "description": "schema xml file", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/Schema" } } }, "required": true }, "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } } } } }, "/api/system/metrics/{metric}": { "get": { "tags": [ "system-metrics-controller" ], "operationId": "getMetric_IntegratorRole", "parameters": [ { "name": "metric", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/ResultContainerDmsObject" } } } } } }, "delete": { "tags": [ "system-metrics-controller" ], "operationId": "resetMetric_IntegratorRole", "parameters": [ { "name": "metric", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/system/permissions": { "get": { "tags": [ "system-permissions-controller" ], "summary": "get permissions", "description": "get permissions", "operationId": "getPermissions", "responses": { "200": { "description": "Successfully", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/roleSet" } } } }, "403": { "description": "Forbidden", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "400": { "description": "Bad request", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } } } }, "post": { "tags": [ "system-permissions-controller" ], "summary": "post permissions", "description": "post permissions", "operationId": "postPermissions", "requestBody": { "description": "roleset xml file", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/roleSet" } } }, "required": true }, "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } } } } }, "/api/system/permissions/validate": { "post": { "tags": [ "system-permissions-controller" ], "summary": "validate permissions", "description": "validate permissions", "operationId": "validatePermissions", "requestBody": { "description": "roleset xml file", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/roleSet" } } }, "required": true }, "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } } } } }, "/api/system/schema": { "get": { "tags": [ "system-schema-controller" ], "summary": "get schema as json", "description": "get schema as json", "operationId": "getSchema_1", "responses": { "200": { "description": "Successfully", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/Schema" } }, "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "403": { "description": "Forbidden", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } }, "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "400": { "description": "Bad request", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } }, "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } }, "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } } } }, "post": { "tags": [ "system-schema-controller" ], "summary": "post schema", "description": "post schema", "operationId": "postSchema", "requestBody": { "description": "schema xml file", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/Schema" } } }, "required": true }, "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } } } } }, "/api/system/schema/validate": { "post": { "tags": [ "system-schema-controller" ], "summary": "validate schema", "description": "validate schema", "operationId": "validateSchema", "requestBody": { "description": "schema xml file", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/Schema" } } }, "required": true }, "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } } } } }, "/api/system/systemhooks": { "get": { "tags": [ "system-systemhooks-controller" ], "summary": "get systemhooks", "description": "get systemhooks", "operationId": "getSystemHooks", "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Schema" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } } } }, "post": { "tags": [ "system-systemhooks-controller" ], "summary": "post systemhooks", "description": "post systemhooks", "operationId": "postSystemHooks", "requestBody": { "description": "systemhooks json file", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemHookConfiguration" } } }, "required": true }, "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } } } } }, "/api/system/systemhooks/validate": { "post": { "tags": [ "system-systemhooks-controller" ], "summary": "validate systemhooks", "description": "validate systemhooks", "operationId": "validateSystemHooks", "requestBody": { "description": "systemhooks json file", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemHookConfiguration" } } }, "required": true }, "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } } } } }, "/api/system/calls": { "get": { "tags": [ "system-tracing-controller" ], "summary": "get currently running calls (requests)", "description": "get currently running calls (requests)", "operationId": "getCalls", "responses": { "200": { "description": "Successfully", "content": { "application/json": { } } }, "304": { "description": "Not Modified", "content": { "application/hal+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RequestTraceObject" } } } } }, "401": { "description": "Unauthorized", "content": { "application/hal+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RequestTraceObject" } } } } }, "422": { "description": "Unprocessable entity", "content": { "application/hal+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RequestTraceObject" } } } } } } } }, "/api/system/calls/{traceId}": { "get": { "tags": [ "system-tracing-controller" ], "summary": "get currently running calls for specific traceId", "description": "get currently running calls for specific traceId", "operationId": "getCallsWithSpecificTraceId", "parameters": [ { "name": "traceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully", "content": { "application/json": { } } }, "304": { "description": "Not Modified", "content": { "application/hal+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RequestTraceObject" } } } } }, "401": { "description": "Unauthorized", "content": { "application/hal+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RequestTraceObject" } } } } }, "422": { "description": "Unprocessable entity", "content": { "application/hal+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RequestTraceObject" } } } } } } } }, "/api/system/apps": { "get": { "tags": [ "system-apps-controller" ], "summary": "get all existing apps in the system", "description": "get all existing apps in the system", "operationId": "getApps", "parameters": [ { "name": "verbose", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Successfully", "content": { "application/json": { } } } } } }, "/api/system/apps/{app}": { "get": { "tags": [ "system-apps-controller" ], "summary": "get information on an existing app", "description": "get information on an existing app", "operationId": "getApp", "parameters": [ { "name": "app", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "verbose", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Successfully", "content": { "application/json": { } } } } } }, "/api/system/apps/{app}/permissions": { "get": { "tags": [ "system-apps-controller" ], "summary": "get app permissions", "description": "get app permissions", "operationId": "getAppPermissions", "parameters": [ { "name": "app", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/roleSet" } } } }, "403": { "description": "Forbidden", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "400": { "description": "Bad request", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } } } }, "post": { "tags": [ "system-apps-controller" ], "summary": "post app permissions", "description": "post app permissions", "operationId": "postAppPermissions", "parameters": [ { "name": "app", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "roleset xml file", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/roleSet" } } }, "required": true }, "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } } } } }, "/api/system/apps/{app}/permissions/validate": { "post": { "tags": [ "system-apps-controller" ], "summary": "validate app permissions", "description": "validate app permissions", "operationId": "validateAppPermissions", "parameters": [ { "name": "app", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "roleset xml file", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/roleSet" } } }, "required": true }, "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } } } } }, "/api/system/apps/{app}/schema": { "get": { "tags": [ "system-apps-controller" ], "summary": "get app schema as json", "description": "get app schema as json", "operationId": "getAppSchema_1", "parameters": [ { "name": "app", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/Schema" } }, "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "403": { "description": "Forbidden", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } }, "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "400": { "description": "Bad request", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } }, "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } }, "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } } } }, "post": { "tags": [ "system-apps-controller" ], "summary": "post app schema", "description": "post app schema", "operationId": "postAppSchema", "parameters": [ { "name": "app", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "schema xml file", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/Schema" } } }, "required": true }, "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } } } } }, "/api/system/apps/{app}/schema/validate": { "post": { "tags": [ "system-apps-controller" ], "summary": "validate app schema", "description": "validate app schema", "operationId": "validateAppSchema", "parameters": [ { "name": "app", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "schema xml file", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/Schema" } } }, "required": true }, "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } } } } }, "/api/system/apps/{app}/systemhooks": { "get": { "tags": [ "system-apps-controller" ], "summary": "get systemhooks", "description": "get systemhooks", "operationId": "getSystemHooks_1", "parameters": [ { "name": "app", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Schema" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } } } }, "post": { "tags": [ "system-apps-controller" ], "summary": "post app systemhooks", "description": "post app systemhooks", "operationId": "postSystemHooks_1", "parameters": [ { "name": "app", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "systemhooks json file", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemHookConfiguration" } } }, "required": true }, "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } } } } }, "/api/system/apps/{app}/systemhooks/validate": { "post": { "tags": [ "system-apps-controller" ], "summary": "validate app systemhooks", "description": "validate app systemhooks", "operationId": "validateSystemHooks_1", "parameters": [ { "name": "app", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "systemhooks json file", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemHookConfiguration" } } }, "required": true }, "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } } } } }, "/api/system/tenants/{tenant}/apps": { "get": { "tags": [ "system-tenants-controller" ], "summary": "get tenant app allocations", "description": "get tenant app allocations", "operationId": "getTenantApps", "parameters": [ { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/AppConfiguration" } } } }, "403": { "description": "Forbidden", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "400": { "description": "Bad request", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } } } }, "post": { "tags": [ "system-tenants-controller" ], "summary": "post app allocations", "description": "post app allocations", "operationId": "postTenantApps", "parameters": [ { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "apps xml file", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/AppConfiguration" } } }, "required": true }, "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } } } } }, "/api/system/tenants/{tenant}/apps/validate": { "post": { "tags": [ "system-tenants-controller" ], "summary": "validate tenant app allocations", "description": "validate tenant app allocations", "operationId": "validateTenantApps", "parameters": [ { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "apps xml file", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/AppConfiguration" } } }, "required": true }, "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } } } } }, "/api/system/tenants/{tenant}/apps/{app}/state/{state}": { "post": { "tags": [ "system-tenants-controller" ], "summary": "changes the state of an app for a specified tenant", "description": "enable or disable an app for a tenant", "operationId": "setAppState", "parameters": [ { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "app", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "state", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationResult" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } } } } }, "/api/system/tenants/{tenant}/apps/{app}/state/{state}/validate": { "post": { "tags": [ "system-tenants-controller" ], "summary": "validates a change of the state of an app for a specified tenant", "description": "validates the enable or disable action of an app for a tenant", "operationId": "setAppStateValidate", "parameters": [ { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "app", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "state", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationResult" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } } } } }, "/api/system/tenants/{tenant}/metrics/{metric}": { "get": { "tags": [ "system-tenants-controller" ], "operationId": "getMetricForTenant_IntegratorRole", "parameters": [ { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "metric", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/ResultContainerDmsObject" } } } } } }, "delete": { "tags": [ "system-tenants-controller" ], "operationId": "resetMetricForTenant_IntegratorRole", "parameters": [ { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "metric", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/system/tenants/{tenant}/permissions": { "get": { "tags": [ "system-tenants-controller" ], "summary": "get tenant permissions xml", "description": "get tenant permissions xml", "operationId": "tenantPermissonsGet", "parameters": [ { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/roleSet" } } } }, "403": { "description": "Forbidden", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "400": { "description": "Bad request", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } } } }, "post": { "tags": [ "system-tenants-controller" ], "summary": "post tenant permissions", "description": "post tenant permissions", "operationId": "tenantPermissionsPost", "parameters": [ { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "roleset xml file", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/roleSet" } } }, "required": true }, "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } } } } }, "/api/system/tenants/{tenant}/permissions/validate": { "post": { "tags": [ "system-tenants-controller" ], "summary": "validate tenant permissions", "description": "validate tenant permissions", "operationId": "tenantPermissionsValidatePost", "parameters": [ { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "permissions xml file", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/roleSet" } } }, "required": true }, "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } } } } }, "/api/system/tenants/{tenant}/renditions": { "delete": { "tags": [ "system-tenants-controller" ], "summary": "delete all renditions for the tenant", "description": "Deletes all renditions that are stored for the tenant in the rendition repository.", "operationId": "tenantRenditionsDelete", "parameters": [ { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } } } } }, "/api/system/tenants/{tenant}/schema": { "get": { "tags": [ "system-tenants-controller" ], "summary": "get tenant schema as json", "description": "get tenant schema as json", "operationId": "tenantSchemaSchemaGet_1", "parameters": [ { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/Schema" } }, "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "403": { "description": "Forbidden", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } }, "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "400": { "description": "Bad request", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } }, "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } }, "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } } } }, "post": { "tags": [ "system-tenants-controller" ], "summary": "post tenant schema", "description": "post tenant schema", "operationId": "tenantSchemaSchemaPost", "parameters": [ { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "schema xml file", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/Schema" } } }, "required": true }, "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } } } } }, "/api/system/tenants/{tenant}/schema/validate": { "post": { "tags": [ "system-tenants-controller" ], "summary": "validate tenant schema", "description": "validate tenant schema", "operationId": "tenantSchemaValidatePost", "parameters": [ { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "schema xml file", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/Schema" } } }, "required": true }, "responses": { "200": { "description": "Successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBodyEmitter" } } } } } } } }, "components": { "schemas": { "AmqpDefinition": { "type": "object", "properties": { "type": { "type": "string" }, "enable": { "type": "boolean" }, "predicate": { "type": "string" }, "url": { "type": "string" }, "user": { "type": "string" }, "password": { "type": "string" }, "queue": { "type": "string" }, "bulkSize": { "type": "integer", "format": "int32" } } }, "ApiSearchQuery": { "required": [ "statement" ], "type": "object", "properties": { "statement": { "type": "string", "description": "Parameter for specifying an SQL-Query", "example": "SELECT * FROM system:object" }, "skipCount": { "type": "integer", "description": "skip the first <skipCount> elements.", "format": "int64", "example": 100 }, "maxItems": { "type": "integer", "description": "max size of result list", "format": "int64", "example": 50 }, "handleDeletedDocuments": { "type": "string", "description": "handling of deleted documents (DELETED_DOCUMENTS_INCLUDE | DELETED_DOCUMENTS_ONLY | DELETED_DOCUMENTS_EXCLUDE, Default: DELETED_DOCUMENTS_EXCLUDE)", "example": "DELETED_DOCUMENTS_EXCLUDE" }, "options": { "type": "object", "case_sensitivity": { "type": "string", "description": "options can be used to define options for execution of search query.", "example": "case_insensitive" } } }, "description": "Query object" }, "App": { "required": [ "name", "state" ], "type": "object", "properties": { "name": { "type": "string" }, "state": { "type": "string", "enum": [ "ENABLED", "DISABLED" ] } } }, "AppConfiguration": { "type": "object", "properties": { "app": { "type": "array", "items": { "$ref": "#/components/schemas/App" } } } }, "DmsAllowedChildObjectType": { "type": "object", "properties": { "maxCount": { "type": "integer", "format": "int32" } } }, "DmsApiObject": { "required": [ "properties" ], "type": "object", "properties": { "properties": { "type": "object", "properties": { "locale": { "type": "object", "properties": { "language": { "type": "string" }, "displayName": { "type": "string" }, "country": { "type": "string" }, "variant": { "type": "string" }, "script": { "type": "string" }, "extensionKeys": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "unicodeLocaleAttributes": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "unicodeLocaleKeys": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "iso3Language": { "type": "string" }, "iso3Country": { "type": "string" }, "displayLanguage": { "type": "string" }, "displayScript": { "type": "string" }, "displayCountry": { "type": "string" }, "displayVariant": { "type": "string" } } }, "empty": { "type": "boolean" } }, "description": "properties of dms object", "example": " { \"system:objectId\": {\n \"value\": \"cdc7095f-a5ce-486d-92a7-6d0955d969ee\"\n },\n \"system:baseTypeId\": {\n \"value\": \"system:document\"\n },\n \"system:objectTypeId\": {\n \"value\": \"appEmail:email\"\n },\n \"system:createdBy\": {\n \"value\": \"0d7fd0be-6a0b-4d3b-933c-25e0c4c5d794\"\n },\n \"system:creationDate\": {\n \"value\": \"2018-01-26T15:21:170Z\"\n },\n \"system:lastModifiedBy\": {\n \"value\": \"0d7fd0be-6a0b-4d3b-933c-25e0c4c5d794\"\n },\n \"system:lastModificationDate\": {\n \"value\": \"2018-01-30T11:53:227Z\"\n },\n \"system:versionNumber\": {\n \"value\": 3\n },\n \"system:tenant\": {\n \"value\": \"tenant1\"\n },\n \"system:traceId\": {\n \"value\": \"97a35859dbb4c435\"\n },\n \"appEmail:from\": {\n \"value\": \"Garco Meissler \"\n },\n \"appEmail:to\": {\n \"value\": [\"Dudreas Annkel \"]\n },\n \"appEmail:subject\": {\n \"value\": \"again updated Bewerbungsunterlagen\"\n }} " } }, "description": "list of dms objects" }, "DmsApiObjectPatch": { "required": [ "properties" ], "type": "object", "properties": { "properties": { "type": "object", "properties": { "locale": { "type": "object", "properties": { "language": { "type": "string" }, "displayName": { "type": "string" }, "country": { "type": "string" }, "variant": { "type": "string" }, "script": { "type": "string" }, "extensionKeys": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "unicodeLocaleAttributes": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "unicodeLocaleKeys": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "iso3Language": { "type": "string" }, "iso3Country": { "type": "string" }, "displayLanguage": { "type": "string" }, "displayScript": { "type": "string" }, "displayCountry": { "type": "string" }, "displayVariant": { "type": "string" } } }, "empty": { "type": "boolean" } }, "description": "properties of dms object", "example": " { \"system:objectId\": {\n \"value\": \"cdc7095f-a5ce-486d-92a7-6d0955d969ee\"\n },\n \"appEmail:subject\": {\n \"value\": \"again updated Bewerbungsunterlagen\"\n }} " } }, "description": "list of dms objects" }, "DmsApiObjectList": { "required": [ "objects" ], "type": "object", "properties": { "objects": { "type": "array", "description": "list of dms objects", "items": { "$ref": "#/components/schemas/DmsApiObject" } } } }, "DmsApiObjectListPatch": { "required": [ "objects" ], "type": "object", "properties": { "objects": { "type": "array", "description": "list of dms objects", "items": { "$ref": "#/components/schemas/DmsApiObjectPatch" } } } }, "DmsQueryResultList": { "required": [ "objects" ], "type": "object", "properties": { "objects": { "type": "array", "description": "list of dms objects", "items": { "$ref": "#/components/schemas/DmsApiObject" } }, "numItems": { "type": "integer", "format": "int64" }, "hasMoreItems": { "type": "boolean" }, "totalNumItems": { "type": "integer", "format": "int64" } } }, "DmsApiSearchQuery": { "required": [ "query" ], "type": "object", "properties": { "query": { "$ref": "#/components/schemas/ApiSearchQuery" } } }, "DmsContentStream": { "type": "object", "properties": { "cid": { "type": "string" }, "length": { "type": "integer", "format": "int64" }, "mimeType": { "type": "string" }, "fileName": { "type": "string" }, "digest": { "type": "string" }, "contentStreamId": { "type": "string" }, "repositoryId": { "type": "string" }, "range": { "type": "string" }, "archivePath": { "type": "string" } } }, "DmsObject": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DmsObjectProperty" } }, "options": { "type": "object", "additionalProperties": { "type": "object" } }, "contentStreams": { "type": "array", "items": { "$ref": "#/components/schemas/DmsContentStream" } }, "allowedChildObjectTypeIds": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DmsAllowedChildObjectType" } }, "renditions": { "type": "array", "items": { "$ref": "#/components/schemas/DmsRendition" } }, "permissions": { "$ref": "#/components/schemas/DmsPermissions" } } }, "DmsObjectProperty": { "type": "object", "properties": { "columnNames": { "type": "array", "items": { "type": "string" } }, "value": { "type": "object" } } }, "DmsPermissions": { "type": "object", "properties": { "read": { "type": "array", "items": { "type": "string", "enum": [ "metadata", "content", "object" ] } }, "write": { "type": "array", "items": { "type": "string", "enum": [ "metadata", "content", "object" ] } }, "delete": { "type": "array", "items": { "type": "string", "enum": [ "metadata", "content", "object" ] } } } }, "DmsRendition": { "type": "object", "properties": { "streamId": { "type": "string" }, "mimeType": { "type": "string" }, "lenght": { "type": "integer", "format": "int32" }, "title": { "type": "string" }, "kind": { "type": "string" }, "width": { "type": "integer", "format": "int32" }, "height": { "type": "integer", "format": "int32" }, "contentStream": { "$ref": "#/components/schemas/DmsContentStream" } } }, "InitMultipartUploadResult": { "type": "object", "properties": { "uploadId": { "type": "string" }, "serviceInstanceUrl": { "type": "string" } } }, "Lifecycle": { "type": "object", "properties": { "type": { "type": "string" }, "enable": { "type": "boolean" }, "predicate": { "type": "string" }, "tagname": { "type": "string" }, "tagstate": { "type": "integer", "format": "int32" } } }, "ListMultipartUploadsResult": { "type": "object", "properties": { "uploads": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/MultipartUpload" } } } }, "MultipartUpload": { "type": "object", "properties": { "uploadId": { "type": "string" }, "parts": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Part" } }, "finished": { "type": "boolean" }, "contentType": { "type": "string" }, "filename": { "type": "string" }, "serviceInstanceUrl": { "type": "string" }, "lastUpdated": { "type": "integer", "format": "int64" } } }, "Part": { "type": "object", "properties": { "partNumber": { "type": "integer", "format": "int32" }, "length": { "type": "integer", "format": "int64" }, "digest": { "type": "string" } } }, "Permission": { "required": [ "action" ], "type": "object", "properties": { "action": { "type": "array", "items": { "type": "string", "enum": [ "create", "read", "write", "delete", "tag" ] } }, "condition": { "type": "string" } } }, "PropertyDefinitionType": { "required": [ "cardinality", "id", "propertyType" ], "type": "object", "properties": { "id": { "type": "string" }, "localNamespace": { "type": "string" }, "description": { "type": "string" }, "propertyType": { "type": "string", "enum": [ "BOOLEAN", "ID", "INTEGER", "DATETIME", "DECIMAL", "STRING", "TABLE", "STRUCTUREDDATA" ] }, "cardinality": { "type": "string", "enum": [ "SINGLE", "MULTI" ], "default": "single" }, "required": { "type": "boolean", "default": false }, "queryable": { "type": "boolean", "default": true }, "classification": { "type": "array", "items": { "type": "string" } }, "defaultValue": { "type": "array", "items": { "type": "object" } } } }, "PropertyReference": { "type": "object", "properties": { "value": { "type": "string" }, "required": { "type": "boolean", "xml": { "attribute": true } }, "classifications": { "type": "array", "items": { "type": "string" } } } }, "RenditionChildrenInfo": { "type": "object", "properties": { "id": { "type": "string" }, "length": { "type": "integer", "format": "int64" }, "mimeType": { "type": "string" }, "fileName": { "type": "string" } } }, "RenditionInfo": { "type": "object", "properties": { "status": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "pageCount": { "type": "integer", "format": "int64" }, "id": { "type": "string" }, "length": { "type": "integer", "format": "int64" }, "fileName": { "type": "string" }, "mimeType": { "type": "string" }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/RenditionChildrenInfo" } } } }, "RenditionInfoStatus": { "type": "object", "properties": { "pdf": { "$ref": "#/components/schemas/RenditionInfo" }, "thumbnail": { "$ref": "#/components/schemas/RenditionInfo" }, "web": { "$ref": "#/components/schemas/RenditionInfo" }, "document": { "$ref": "#/components/schemas/RenditionInfo" } } }, "RequestTraceObject": { "type": "object", "properties": { "traceId": { "type": "string" }, "type": { "type": "string" }, "tenant": { "type": "string" }, "method": { "type": "string" }, "request": { "type": "string" }, "starttime": { "type": "integer", "format": "int64" } } }, "ResponseBodyEmitter": { "type": "object", "properties": { "timeout": { "type": "integer", "format": "int64" } } }, "ResultContainerDmsObject": { "type": "object", "properties": { "objects": { "type": "array", "items": { "$ref": "#/components/schemas/DmsObject" } }, "numItems": { "type": "integer", "format": "int32" }, "hasMoreItems": { "type": "boolean" }, "totalNumItems": { "type": "integer", "format": "int64" } } }, "Role": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "permission": { "type": "array", "items": { "$ref": "#/components/schemas/Permission" } } } }, "roleSet": { "type": "object", "properties": { "xmlns": { "type": "string", "xml": { "attribute": true }, "example": "http://optimal-systems.org/ns/dmscloud/roleset/" }, "role": { "type": "array", "items": { "$ref": "#/components/schemas/Role" } } } }, "Schema": { "type": "object", "properties": { "version": { "type": "integer", "format": "int32" }, "lastModificationDate": { "type": "string", "format": "date-time" }, "label": { "type": "string" }, "systemVersion": { "type": "string" }, "propertyDefinition": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyDefinitionType" } }, "typeDocumentDefinition": { "type": "array", "items": { "$ref": "#/components/schemas/TypeDocumentDefinitionType" } }, "typeFolderDefinition": { "type": "array", "items": { "$ref": "#/components/schemas/TypeFolderDefinitionType" } }, "typeSecondaryDefinition": { "type": "array", "items": { "$ref": "#/components/schemas/TypeSecondaryDefinitionType" } } } }, "SecondaryObjectTypeId": { "type": "object", "properties": { "value": { "type": "string" }, "static": { "type": "boolean" } } }, "SystemHookConfiguration": { "type": "object", "properties": { "systemhooks": { "$ref": "#/components/schemas/SystemHooks" } } }, "SystemHooks": { "type": "object", "properties": { "amqp": { "type": "array", "items": { "$ref": "#/components/schemas/AmqpDefinition" } }, "lifecycle": { "type": "array", "items": { "$ref": "#/components/schemas/Lifecycle" } }, "webhooks": { "type": "array", "items": { "$ref": "#/components/schemas/WebHook" } } } }, "TypeDocumentDefinitionType": { "required": [ "baseId", "contentStreamAllowed", "id" ], "type": "object", "properties": { "id": { "type": "string" }, "localNamespace": { "type": "string" }, "description": { "type": "string" }, "baseId": { "type": "string", "enum": [ "SYSTEM_DOCUMENT", "SYSTEM_FOLDER", "SYSTEM_SECONDARY" ] }, "propertyReference": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyReference" } }, "classification": { "type": "array", "items": { "type": "string" } }, "contentStreamAllowed": { "type": "string", "enum": [ "NOTALLOWED", "ALLOWED", "REQUIRED" ], "default": "allowed" }, "secondaryObjectTypeId": { "type": "array", "items": { "$ref": "#/components/schemas/SecondaryObjectTypeId" } } } }, "TypeFolderDefinitionType": { "required": [ "baseId", "id" ], "type": "object", "properties": { "id": { "type": "string" }, "localNamespace": { "type": "string" }, "description": { "type": "string" }, "baseId": { "type": "string", "enum": [ "SYSTEM_DOCUMENT", "SYSTEM_FOLDER", "SYSTEM_SECONDARY" ] }, "propertyReference": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyReference" } }, "classification": { "type": "array", "items": { "type": "string" } }, "secondaryObjectTypeId": { "type": "array", "items": { "$ref": "#/components/schemas/SecondaryObjectTypeId" } }, "contentStreamAllowed": { "type": "string", "enum": [ "NOTALLOWED", "ALLOWED", "REQUIRED" ] } } }, "TypeSecondaryDefinitionType": { "required": [ "baseId", "id" ], "type": "object", "properties": { "id": { "type": "string" }, "localNamespace": { "type": "string" }, "description": { "type": "string" }, "baseId": { "type": "string", "enum": [ "SYSTEM_DOCUMENT", "SYSTEM_FOLDER", "SYSTEM_SECONDARY" ] }, "propertyReference": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyReference" } }, "classification": { "type": "array", "items": { "type": "string" } }, "contentStreamAllowed": { "type": "string", "enum": [ "NOTALLOWED", "ALLOWED", "REQUIRED" ], "default": "allowed" }, "secondaryObjectTypeId": { "type": "array", "items": { "$ref": "#/components/schemas/SecondaryObjectTypeId" } } } }, "ValidationError": { "type": "object", "properties": { "message": { "type": "string" }, "serviceErrorCode": { "type": "integer", "format": "int32" } } }, "ValidationResult": { "type": "object", "properties": { "validationErrors": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationError" } } } }, "WebHook": { "type": "object", "properties": { "enable": { "type": "boolean" }, "predicate": { "type": "string" }, "type": { "type": "string" }, "url": { "type": "string" }, "useDiscovery": { "type": "boolean" } } } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } } }