POST /api/admin/schema

Owned by Technische Redaktion
Dec 01, 2022
1 min read
As of Versionproduct version 1.0 | component version 1.0
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
DescriptionThis endpoint is used to update the tenant schema. Similar to other schema update endpoints in yuuvis®, this infers a schema validation and returns its results to the user, performing the schema update only after successful validation.
Request HeadersContent-Type: application/xml
Result Example

The result is a JSON structure containing a validationErrors list, which can also 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": "Ambiguous ids. There are 2 property type definitions with the id 'tenDefault:from'.",
			"serviceErrorCode": 2110
		},
		{
			"message": "Wrong base id. The base id of the system:document type definition 'tenDefault:email' must be 'system:document', but it is 'system:folder'.",
			"serviceErrorCode": 2131
		},
		{
			"message": "Invalid property reference 'fromm' in type definition 'tenDefault:email'.",
			"serviceErrorCode": 2132
		},
		{
			"message": "Invalid secondary object type reference 'appAcl:aclowner' in type definition 'tenDefault:email'.",
			"serviceErrorCode": 2135
		}
	]
}