Versions Compared

Key

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


As of Versionproduct version 2021 summer | component version 2021 summer
Request MethodPOST
Response FormatJSON
Description
This endpoint is used to update app allocations
Updates the app set for the specified tenant. This infers a validation and returns its result to the user, performing the update only after successful validation.
Request HeadersContent-Type: application/xml
Request Example

XML configuration in the response body.

Code Block
languagexml
<?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
title200 - no validation errors, the apps for the tenant have been updated
{
    "validationErrors": []
}

(2) Unsuccessful: Example error message.

Code Block
title422 - there were validation errors, the apps were 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'."
        }
    ]
}