POST /api/system/tenants/{tenant}/schema

Owned by Technische Redaktion
Dec 01, 2022
As of Versionproduct version 2021 Autumn | component version 2021 Autumn
Request MethodPOST
Response FormatJSON
Required Permission

available if listed in authorization.accesses in authentication-prod.yml and the specified access condition is matched.

>> AUTHENTICATION Service
Description

Updates the tenant schema stored for the tenant specified by the {tenant} path parameter.

Similar to other schema update endpoints in yuuvis® Momentum, this infers a schema validation and returns its result to the user, performing the schema update only after successful validation.

Request HeadersContent-Type: application/xml
Response Example

The result is a JSON structure containing a validationErrors list, which could be an empty list.

200 - no validation errors, the schema has been updated
{
    "validationErrors": []
}
422 - there were validation errors, the schema was not updated
{
    "validationErrors": [
        {
            "message": "Wrong base id. The base id of the system:document type definition 'tenTenant1:email' must be 'system:document', but it is 'system:folder'.",
            "serviceErrorCode": 2131
        },
        {
            "message": "Invalid property reference 'fromm' in type definition 'tenTenant1:email'.",
            "serviceErrorCode": 2132
        },
        {
            "message": "Invalid property reference 'ccd' in type definition 'tenTenant1:email'.",
            "serviceErrorCode": 2132
        }
    ]
}