Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

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


Excerpt
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


The new schema is passed in the request body in XML format and is validated before the update is executed. Thus, it is not possible to introduce an invalid schema via this endpoint.

For details and examples regarding request and response please visit Schema - Defining Object Types.

Request HeadersContent-Type: application/xmlResponse Example
Code Block
title200 - no validation errors, the schema has been updated
{
    "validationErrors": []
}
Code Block
title422 - 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 } ] }