POST /api/system/apps/{app}/schema

Owned by Team Oktopus
Last updated: May 12, 2022 by Technische Redaktion
2 min read
As of Versionproduct version 2019 Winter | component version 2019 Winter
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 application schema matching with the {app} path parameter. Similar to other schema update endpoints in yuuvis®, this infers a schema validation and returns its result to the user, performing the schema update only after successful validation.
>> Apps | Schema - Defining Object Types
Request HeadersContent-Type: application/xml
Request Example
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 'appEmail:email' must be 'system:document', but it is 'system:folder'.",
            "serviceErrorCode": 2131
        },
        {
            "message": "Invalid property reference 'fromm' in type definition 'appEmail:email'.",
            "serviceErrorCode": 2132
        },
        {
            "message": "Invalid property reference 'ccd' in type definition 'appEmail:email'.",
            "serviceErrorCode": 2132
        }
    ]
}