Overview

List of all stores

GET /api/content/stores

Information about the store

GET /api/content/stores/{storeid}

Lists documents to a store (filter)

GET /api/content/stores/{storeid}/docs

The previously used x-use.shortreferences header is deprecated, but is still supported for backward compatibility.
Please use 
x-use-shortreferences
instead.

Descriptions


List of all stores

GET /api/content/stores

Shows list of all stores.

Request

Query Parameters

Parameter Name

Type

Required

Description

logout

Boolean

false

Logs out the user and ends the session.

pool

Boolean

false

If set to true, pools will be returned instead of stores.

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 store. This property is always empty for pools.

......name

String

The technical name of the store.

......schemas

Array


............description

String

An optional description of the document schema.

............displayName

String

The display name of the document schema that is associated with this store.

............name

String

The technical name of the document schema that is assoiciated with this store.

......storeId

String

The unique ID for this store to be used in calls to the document resource.

Example (stores)
{
"_links": {
"self": {
"rel": "self",
"href": "http://127.0.0.1:9090/api/content/stores"
}
},
"items": [
{
"_links": {
"query": {
"rel": "related",
"href": "http://127.0.0.1:9090/api/content/stores/EASY/docs"
},
"self": {
"rel": "self",
"href": "http://127.0.0.1:9090/api/content/stores/EASY"
}
},
"name": "EASY",
"displayName": "EASY",
"storeId": ".OCDHDttltzxN0",
"schemas": [
{
"_links": {
"self": {
"rel": "self",
"href": "http://127.0.0.1:9090/api/content/schemas/EASY"
}
},
"name": "EASY",
"displayName": "EASY"
}
]
},
{
"_links": {
"query": {
"rel": "related",
"href": "http://127.0.0.1:9090/api/content/stores/Store01/docs"
},
"self": {
"rel": "self",
"href": "http://127.0.0.1:9090/api/content/stores/Store01"
}
},
"name": "Store01",
"displayName": "Store01",
"storeId": ".OCDMDYt9tGtctQNEvN0",
"schemas": [
{
"_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": {
"query": {
"rel": "related",
"href": "http://127.0.0.1:9090/api/content/stores/Store02/docs"
},
"self": {
"rel": "self",
"href": "http://127.0.0.1:9090/api/content/stores/Store02"
}
},
"name": "Store02",
"displayName": "Store02",
"storeId": ".OCDMDYt9tGtctQNWvN0",
"schemas": [
{
"_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."
}
]
}
]
}


Example (pools)
{
"_links": {
"self": {
"rel": "self",
"href": "http://127.0.0.1:9090/api/content/stores"
}
},
"items": [
{
"_links": {
"query": {
"rel": "related",
"href": "http://127.0.0.1:9090/api/content/stores/.NCDDDWtutQtYtytAjXnxeEFNZOTVN0/docs"
},
"self": {
"rel": "self",
"href": "http://127.0.0.1:9090/api/content/stores/.NCDDDWtutQtYtytAjXnxeEFNZOTVN0"
}
},
"name": "Default/Adaptive/Adaptive01",
"displayName": "",
"storeId": ".NCDDDWtutQtYtytAjXnxeEFNZOTVN0",
"schemas": [
{
"_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": {
"query": {
"rel": "related",
"href": "http://127.0.0.1:9090/api/content/stores/.NCDDDWtutQtYtytAjXnxeEFNZNzVN0/docs"
},
"self": {
"rel": "self",
"href": "http://127.0.0.1:9090/api/content/stores/.NCDDDWtutQtYtytAjXnxeEFNZNzVN0"
}
},
"name": "Default/Adaptive/Adaptive02",
"displayName": "",
"storeId": ".NCDDDWtutQtYtytAjXnxeEFNZNzVN0",
"schemas": [
{
"_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": {
"query": {
"rel": "related",
"href": "http://127.0.0.1:9090/api/content/stores/.NCDDDWtutQtYtytAjXMN0/docs"
},
"self": {
"rel": "self",
"href": "http://127.0.0.1:9090/api/content/stores/.NCDDDWtutQtYtytAjXMN0"
}
},
"name": "Default/Adaptive",
"displayName": "",
"storeId": ".NCDDDWtutQtYtytAjXMN0"
},
{
"_links": {
"query": {
"rel": "related",
"href": "http://127.0.0.1:9090/api/content/stores/.NCDRDbtft8fLVVTHPnD0/docs"
},
"self": {
"rel": "self",
"href": "http://127.0.0.1:9090/api/content/stores/.NCDRDbtft8fLVVTHPnD0"
}
},
"name": "Default/DEMO/EASY",
"displayName": "",
"storeId": ".NCDRDbtft8fLVVTHPnD0",
"schemas": [
{
"_links": {
"self": {
"rel": "self",
"href": "http://127.0.0.1:9090/api/content/schemas/EASY"
}
},
"name": "EASY",
"displayName": "EASY"
}
]
},
{
"_links": {
"query": {
"rel": "related",
"href": "http://127.0.0.1:9090/api/content/stores/.NCDRDbtft8xN0/docs"
},
"self": {
"rel": "self",
"href": "http://127.0.0.1:9090/api/content/stores/.NCDRDbtft8xN0"
}
},
"name": "Default/DEMO",
"displayName": "",
"storeId": ".NCDRDbtft8xN0",
"schemas": [
{
"_links": {
"self": {
"rel": "self",
"href": "http://127.0.0.1:9090/api/content/schemas/DefaultScheme"
}
},
"name": "DefaultScheme",
"displayName": "DefaultScheme"
}
]
},
{
"_links": {
"query": {
"rel": "related",
"href": "http://127.0.0.1:9090/api/content/stores/.NCDWD9zNhjQWt5iNytB3xN0/docs"
},
"self": {
"rel": "self",
"href": "http://127.0.0.1:9090/api/content/stores/.NCDWD9zNhjQWt5iNytB3xN0"
}
},
"name": "Default/Root/Logging",
"displayName": "",
"storeId": ".NCDWD9zNhjQWt5iNytB3xN0",
"schemas": [
{
"_links": {
"self": {
"rel": "self",
"href": "http://127.0.0.1:9090/api/content/schemas/Logging"
}
},
"name": "Logging",
"displayName": "Logging"
}
]
},
{
"_links": {
"query": {
"rel": "related",
"href": "http://127.0.0.1:9090/api/content/stores/.NCDWD9zNhD0/docs"
},
"self": {
"rel": "self",
"href": "http://127.0.0.1:9090/api/content/stores/.NCDWD9zNhD0"
}
},
"name": "Default/Root",
"displayName": "",
"storeId": ".NCDWD9zNhD0"
},
{
"_links": {
"query": {
"rel": "related",
"href": "http://127.0.0.1:9090/api/content/stores/.NCDSDctgtQxN0/docs"
},
"self": {
"rel": "self",
"href": "http://127.0.0.1:9090/api/content/stores/.NCDSDctgtQxN0"
}
},
"name": "Default/Temp",
"displayName": "",
"storeId": ".NCDSDctgtQxN0"
}
]
}


Information about the store

GET /api/content/stores/{storeid}

Provides information about the specified store.

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 store (specified by its reference) does not exist.

Data structure

Property

Type

Description

displayName

String

The display name of the store.

name

String

The technical name of the store.

Example
{
"_links": {
"self": {
"rel": "self",
"href": "http://127.0.0.1:9091/api/content/stores/EASY"
}
},
"name": "EASY",
"displayName": "EASY"
}

Lists documents to a store (filter)

GET /api/content/stores/{storeid}/docs

Lists documents of the specified store. It is possible to filter the resultset by following the extended syntax: /{storeid}/docs?$<fieldname>=<filterterm>.

It is possible to define more than one filterterm (see following example). All specified filters will match on each document in the result.

Example: /{storeid}/docs?$customername=bond&$type=billing&$paid=true

It is not possible to look for date values. In that case, please use /api/content/search endpoint.

Request

Query Parameters

Parameter Name

Short Name

Type

Required

Default

Description

types


Boolean

false


Determines whether the field types will also be returned or not.

maxhits

mh

number

false


Defines the maximum hit list size.

pagesize

ps

number

false


Defines the size of the hits per hit list page.

textmarker

tm

Boolean

false


Determines whether textmarkers will be returned in the result set.

fulltext

ft

String

false


Defines the full text search term for the search.

operator

op

String

false

and

Defines the type of concatenation of all search terms.

newestversion

nv

Boolean

false

false

Determines whether hitlist will return newest version of each document only.

//$


String

false


The field value term to filter the results. The parameter has to be prefixed with "$". Example: $fieldname=filterterm

If no value is specified, the field will be added to the result columns.

logout


Boolean

false


Logs out the user and ends the session.

Response

Returns

http 200 - OK, call successful.
http 204 - No content if no hits have been found.
http 401 - Unauthorized if the authentication process has failed.
http 404 - Will be returned if the store (specified by its reference) does not exist.

Data structure

Property

Type

Description

queryId

String

Unique ID of the query.

items

Array

List of documents.

......location

String

The document's store location.

......schema

String

The document's schema name.

......fields

Object

The fields of a document.

............//

String | Number | Boolean | String[] | Number[]| Boolean[] | Object

The field's name and value pair.

......types

Object

The types of the document fields.

............//

String | String[]

Field name and field type as a key/value pair.

......version

String

The document's version number.

......id

String

The document's unique ID.

......createUsername

String

The name of the user who created the document.

......modifyUsername

String

The name of the last user who modified the document.

......createDate

DateTime

Document creation date.

......modifyDate

DateTime

Document modification date.

......versions

Array

An array of document version information.

......attachments

Array

An array of attachments containing each attachment's meta information.

......textMarker

Object

Describes the position(s) of the found search term per field.

............//

Array

An array of text markers for a single field.


Example
{
"_links": {
"self": {
"rel": "self",
"href": "http://127.0.0.1:9091/api/content/docs"
}
},
"items": [
{
"_links": {
"self": {
"rel": "self",
"href": "http://127.0.0.1:9091/api/content/docs/Unit%3DDefault%2FInstance%3DDefault%2FPool%3DEASY%2FDocument%3DEASY.BDCD9A455BD111E79BEA0A0027000004"
}
},
"fields": {
"Mitglied": true,
"Beschreibung": "Hans ist Schalke-Fan.",
"Geburtsdatum": "1980-06-28T00:00:00+02:00",
"Text": "Hans liebt blaue Trikots.",
"Alter": 37
},
"types": {
"Geburtsdatum": "DATETIME"
},
"textMarker": {
"Text": [
{
"start": 11,
"end": 16
},
{
"start": 21,
"end": 26
}
],
"Beschreibung": [
{
"start": 1,
"end": 9
}
]
},
"id": "Unit=Default/Instance=Default/Pool=EASY/Document=EASY.BDCD9A455BD111E79BEA0A0027000004"
},
{
"_links": {
"self": {
"rel": "self",
"href": "http://127.0.0.1:9091/api/content/docs/Unit%3DDefault%2FInstance%3DDefault%2FPool%3DEASY%2FDocument%3DEASY.F3AB74B75BCE11E79BEA0A0027000004"
}
},
"fields": {
"Mitglied": true,
"Beschreibung": "Lisa ist BVB-Fan.",
"Geburtsdatum": "1970-06-28T09:05:03+02:00",
"Text": "Lisa liebt gelbe Trikots.",
"Alter": 47
},
"types": {
"Geburtsdatum": "DATETIME"
},
"id": "Unit=Default/Instance=Default/Pool=EASY/Document=EASY.F3AB74B75BCE11E79BEA0A0027000004"
}
],
"queryId": "e252b7e018650a5de2d279e38f14cb34"
}