How do I activate and use the Named EBIS End User License?

Use of the Content Web Service requires an EBIS End User license. Users logging in via CWS must have previously been assigned to the Named EBIS User license.

Possible error message: The maximum number of existing 'EBIS_END_USER' licenses is '0'.

Do all user accounts from the leading application have to be stored in easy archive?

This is not necessary. A technical user can be logged in via the CWS.
When logging in via the CWS, the additional data of the "real" user account can be entered.

Prerequisite: The "External system account" property must be active in the technical user account (here an example).

If a document is to be stored via the CWS and the "real" user name is to be used, two additional parameters must be specified in the header of the REST call.

x-login-externaluser: j.doe
x-login-externaluser-fullname: Doe, John

This information is written to the relevant archive system fields during archiving.


The previously x-login.externaluser and x-login.externaluser.fullname headers are deprecated, but are still supported for backward compatibility. Please use 
x-login-externaluser
x-login-externaluser-fullname
instead.

How do I pass names that contain umlauts?

The names must be passed in url encoded form.
i.e.

x-login-externaluser: Jürgen.Maßner

the value has to be encoded first:

x-login-externaluser: J%C3%BCrgen.Ma%C3%9Fner


HTTP parameter values that contain umlauts must be url encoded first.

Login via 'Trusted User'

CWS supports the "trusted user" concept of EBIS.
The parameter

x-credential-login-runonbehalfof: <archive user>

can be used to specify the archive user in whose name the called archive operation is to be performed.
The prerequisite is that the 'technical' user specified for authentication has been assigned the 'trusted_server' role.
 

The previously x-credential-login.runonbehalfof header is deprecated, but is still supported for backward compatibility.
Please use 
x-credential-login-runonbehalfof
instead.

How can I retrieve localized content?

By default, each request to the Content Web Service interface is executed in the English context.
If you want the system to return different localized content, you will have to specify the following HTTP header parameters in the request:

Accept-Language : de

x-localized-values : true

How do I get the full reference to a document, pool, or store?

By default, the shorter resource reference is output.
By specifying the following HTTP header parameter and setting the value to false, the full reference to a resource can be obtained:

x-use-shortreferences: false


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

How to get a localized hitlist?

Sending a search via the Content Web Service interface the response will be not localized. To get the localized display names for all columns the resultInfo GET request has to be made.
Therefore follow the related link in the hitlist response. A different way to get the localized values is to POST a search or GET a stores docs with the query parameter firstpage=false.


How to get a localized document?

After a GET request on /api/content/docs/<docId> the content is not localized. It is neccessary to follow the schema link to get all attribute names with its localized displaynames.
If no schema is set in the document response, there are no displaynames for the document.


How can I determine the interface version?

Case: /api/content

See also GET / in the API reference.


How can I get information about the user?

Case: /api/content/user

See also GET /user in the API reference.


How can I query a specific document?

Case: /api/content/docs/{DokumentReferenz}

See also GET /docs in the API reference.


How can I query a specific attachment?

Case: /api/content/docs/{DokumentReferenz}/attachment/{id}

See also GET /docs in the API reference. 


How can I conduct a full text search?

Case: /api/content/search

See Request-Body in the API reference.


How can I perform a field search?

Case: /api/content/search

See Request-Body in the API reference.


How can I perform an AND search?

Case: /api/content/search

Search expressions are generally always linked with AND unless you specify other operators (see below). See Request-Body in the API reference.


How can I perform an OR search?

Case: /api/content/search

See Request-Body in the API reference.


How can I perform a NOT search?

Case: /api/content/search

See Request-Body in the API reference.

Which date formats are valid?

Dates to be used must match the following formats:

  • YYYY-MM-ddThh:mm:ss
  • YYYY-MM-dd

Example:

  • 2017-12-01T00:00:00
  • 2017-11-01T14:48:11
  • 2017-11-02

How can I use pools instead of stores in queries?

Case: /api/content/stores

The store resource supports an optional query parameter:  pool=true.

If this is set, a query of the stores will return a list of the pools with their respective unique store ID.

This ID (storeId) can be used as store name in subsequent queries.

See  GET /stores  in the API reference.

Error messages

Error message

Error description

Page number /arg1 is outside the allowed boundaries. The number of pages is /arg2.

Example: Page number 31 is outside the allowed boundaries. The number of pages is 29.

Hit list page 31 was queried using a CWS request via the path parameter path.
However, the search result was a maximum of 29 hit list pages. This is therefore outside the valid hit list page range.

Adding / changing attachment content fields fails:

Attribute xyz is invalid. 
Error: Too many entries for attribute xyz. 
Maximum of 1 allowed..

Please configure the field property "Visible field number" in the document schema:

The subsequent modification of fields in an archived document
leads to an unwanted second document version.

Please check the "Archiving options" field property in the document schema:

With this setting, no further version is created if the field is subsequently changed.