Versions Compared

Old Version 3

changes.mady.by.user Technische Redaktion

Saved on

compared with

New Version Current

changes.mady.by.user Technische Redaktion

Saved on

Key

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


Page Properties
hiddentrue
idrLANG

Product Version2021 Summer
Report Note
AssigneeAntje

Resources & Remarks

Modification History

NameDateProduct VersionAction
Antje&Nils*-28 APR 20212021 SummerContent written, rDOC, rDEV.
Agnieszka29 APR 20212021 SummerrLANG



As of Versionproduct version 2021 summer Summer | component version 2021 summerSummer
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 app set for the specified tenant.
This


The request body contains the XML configuration to be stored as app set for the tenant in the corresponding apps.xml file.

The call 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 request 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 have not been 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'."
        }
    ]
}


...