Page Comparison

...

As of Version product version 2021 summer | component version 2021 summer

Request Method POST

Response Format JSON

Description

This endpoint is used to validate app allocations Validates the app set for the specified tenant.

The validation includes dependencies between apps or dependencies between the tenant and apps. For instance if app 'invoice' depends on app 'client' of the app set considers dependencies between different app and tenant schemata via property references or secondary object type references. If the schema of an app is referenced by the global or the corresponding tenant schema, the app cannot be disabled for the specified tenant. For instance if app invoice depends on app client, it is not possible to enable 'invoice' and disable 'client'. An app or the tenant itself can be dependent on another app via property references or secondary object type references between their schemas.

There is no validation for the existence of apps with the specified names.

Request Headers Content-Type: application/xml

Request Example

XML configuration in the response body.

Code Block

<?xml version="1.0" encoding="utf-8"?>
<apps xmlns="http://optimal-systems.org/ns/yuuvis/apps/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://optimal-systems.org/ns/yuuvis/apps/ yuuvis-core-apps.xsd">
    <app>
        <name>clientsystem</name>
        <state>enabled</state>
    </app>
    <app>
        <name>client</name>
        <state>enabled</state>
    </app>
    <app>
        <name>email</name>
        <state>disabled</state>
    </app>
    <app>
        <name>acl</name>
        <state>disabled</state>
    </app>
</apps>

Response Example

(1) Successful update: The result is a JSON structure containing a validationErrors list, which could be an empty list.

Code Block

title	200 - no validation errors, the role set has been updated

{
    "validationErrors": []
}

(2) Unsuccessful: Example error message.

Code Block

title	422 - there were validation errors, the role set was not updated

{
    "validationErrors": [
        {
            "message": "Unable to disable app 'client' and enable app 'invoice'. There are references from the schema of app 'invoice' to the schema of app 'client'."
        }
    ]
}

...

Versions Compared

Old Version 2

New Version 3

Key