GET /api/system/schema

Owned by Team Oktopus
Last updated: Sept 14, 2021 by Technische Redaktion
1 min read
As of Versionproduct version 1.0 | component version 1.0
Request MethodGET
Response FormatXML, JSON
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 retrieve the global schema of the yuuvis® system.
Request HeadersAccept:[application/xml; application/json]
Response Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<schema xmlns="http://optimal-systems.org/ns/dmscloud/schema/v5.0/">
    <version>4</version>
    <lastModificationDate>2019-09-12T16:53:49.644Z</lastModificationDate>
    <propertyDateTimeDefinition>
        <id>date</id>
        <propertyType>datetime</propertyType>
        <cardinality>single</cardinality>
        <required>false</required>
    </propertyDateTimeDefinition>
    <propertyStringDefinition>
        <id>Name</id>
        <propertyType>string</propertyType>
        <cardinality>single</cardinality>
        <required>false</required>
    </propertyStringDefinition>
    <typeDocumentDefinition>
        <id>document</id>
        <baseId>system:document</baseId>
        <propertyReference>Name</propertyReference>
        <propertyReference>date</propertyReference>
        <contentStreamAllowed>required</contentStreamAllowed>
        <secondaryObjectTypeId>system:rmDestructionRetention</secondaryObjectTypeId>
    </typeDocumentDefinition>
</schema>