Documentation

Overview

List of all schemas	`GET /api/content/schemas`
Information about a specific schema	`GET /api/content/schemas/{schemaName`}

Descriptions

List of all schemas

GET /api/content/schemas

Shows list of all schemas.

Request

Query Parameters

Parameter Name	Type	Required	Description
logout	Boolean	false	Logs out the user and ends the session.

Response

Returns

http 200 - OK, call successful.
http 401 - Unauthorized if the authentication process has failed.

Data structure

Property	Type	Description
items	Array
......displayName	String	The display name of the schema.
......name	String	The technical name of the schema.
......description	String	An optional description of the document schema.

Example (schemas)

{
    "_links": {
        "self": {
            "rel": "self",
            "href": "http://127.0.0.1:9090/api/content/schemas"
        }
    },
    "items": [
        {
            "_links": {
                "self": {
                    "rel": "self",
                    "href": "http://127.0.0.1:9090/api/content/schemas/ADAPTIVE"
                }
            },
            "name": "ADAPTIVE",
            "displayName": "Adaptive",
            "description": "The 'Adaptive' schema supports unstructured storage and search."
        },
        {
            "_links": {
                "self": {
                    "rel": "self",
                    "href": "http://127.0.0.1:9090/api/content/schemas/DefaultScheme"
                }
            },
            "name": "DefaultScheme",
            "displayName": "DefaultScheme"
        }
    ]
}

Information about a specific schema

GET /api/content/schemas/{schemaName}

Provides information about the specified schema.

Request

Query Parameter

Parameter Name	Type	Required	Description
logout	Boolean	false	Logs out the user and ends the session.

Response

Returns

http 200 - OK, call successful.
http 401 - Unauthorized if the authentication process has failed.
http 404 - Will be returned if the schema (specified by its name) does not exist.

Data structure

Property	Type	Description
displayName	String	The localized display name of the schema.
name	String	The technical name of the schema.
attributes	Array	All attribute fields of the schema. System fields are not displayed.
....name	String	The technical name of the attribute field.
....displayName	String	The localized display name of the attribute field.
....required	Boolean	Specifies, whether this field is mandatory.
....searchable	Boolean	Specifies, whether the content of the field is also stored in full text.
....hitlistField	Boolean	Specifies, whether the field is displayed in the hitlist.
....dataTypes	Array	Specifies the valid data types of the field content.
....rawAllowedValues	Object	Lists the allowed values for the field. The list consists of allowed field values and their dependent localized display names. The localized display names are of the locale which is specified by the header parameter "Accept-Language" of the GET request. If the header parameter "Accept-Language" is missing or if the specified locale is not configured in the easy archive server, English is used as default.
....primaryIndex	Boolean	Specifies, whether the content of the field is to be included in the database or primary table of the document schema (DOCx). The contents are stored in a separate column (FLDx) in the table, and can therefore be quickly searched. Note If the content is to be included in the database, the following restrictions will apply: If the field is of the Text data type, the content of the field may not contain more than 255 characters. Only a maximum number of one of the field is allowed because the content can be included only once in the separate column.
....fulltextIndex	Boolean	Specifies, whether the contents of the field are also to be stored in full text. For fields of the File, Date, Note and Text data type, full text storage is enabled, but it can also be subsequently turned off.
....fieldType	String	Specifies the type of the field (NamedDV, SimpleContent, ...).
....renditions	Array	Specifies the renditions of the field. Each entry in the array contains one rendition.

Example

{
    "_links": {
        "self": {
            "rel": "self",
            "href": "https://127.0.0.1:9090/api/content/schemas/Invoice"
        }
    },
    "name": "Invoice",
    "displayName": "Invoice",
    "attributes": [
        {
            "name": "iNumber",
            "displayName": "invoiceNumber",
            "required": false,
            "searchable": true,
            "hitlistField": true,
            "dataTypes": [
                "number"
            ],
            "primaryIndex": true,
            "fulltextIndex": false,
            "fieldType": "NamedDV"
        },
        {
            "name": "status",
            "displayName": "status",
            "required": false,
            "searchable": true,
            "hitlistField": true,
            "dataTypes": [
                "text"
            ],
            "rawAllowedValues": {
                "waiting": "yellow",
                "approved": "green",
                "denied": "red"
             },
            "primaryIndex": false,
            "fulltextIndex": true,
            "fieldType": "NamedDV"
        },
        {
            "name": "Date",
            "displayName": "Date",
            "required": false,
            "searchable": true,
            "hitlistField": true,
            "dataTypes": [
                "datetime"
            ],
            "primaryIndex": false,
            "fulltextIndex": false,
            "fieldType": "NamedDV"
        },
        {
            "name": "Inhalt",
            "displayName": "Inhalt",
            "required": false,
            "searchable": true,
            "hitlistField": false,
            "dataTypes": [
                "text"
            ],
            "primaryIndex": false,
            "fulltextIndex": true,
            "fieldType": "SimpleContent",
            "renditions": [
                "Condition=zwei,Rendition=BackGround,Size=12,H=-1,OutputFormat=JPG,Image=MyEnglish2.JPG,Font=Courier New,Type=RGB,Quality=90,W=-1,X=0,Y=0,Y2=0,X2=0,LineFeed=1.0",
                "Rendition=BackGround,Size=12,H=-1,OutputFormat=JPG,Image=MyEnglish.JPG,Font=Courier New,Type=RGB,Quality=90,W=-1,X=0,Y=0,Y2=0,X2=0,LineFeed=1.0"
            ]
        }
    ]
}