Valid for: versions 3.3 and 4.0 or higher

This document describes how to call views using the client URL with parameters.

Opening an Object View Depending on the Type

Use in version 3.3

You can open a document object using its ID, for example:

http://<domain>/client/index.html#/dms/7A241428D3164044AB98533A70A382D4?type=idpicture

You can open a folder object using the following URL:

http://<domain>/client/index.html#/folder/7A241428D3164044AB98533A70A382D2?type=personalfile

'type' is the object type as configured in designer. Its value is the technical name.

Use in version 4.0 or higher

In version 4.0, only one state is used to open an object:

http://<domain>/enaio/client/object/7A241428D3164044AB98533A70A382D4?type=idpicture

Opening the Result List View Using the Search API Syntax

If some values of an object are known, you can use the search API to request the client.

Example 1: Index data search

The following example shows how to search index data. This example uses a folder with the following data:

• the technical name of the object type is 'register'
• the object type's 'title' field has the value "application"
• and where its context folder of the type 'personalfile' has in its 'name' field the value 'moneypenny'.

Step 1: Building the request string in JSON format

{"limit":1000,"filters":{,"metadata":{"register.title":"application",
"personalfile.name":"moneypenny"},"contextfoldertypes":["personalfile"],"types":["register"]}}

Step 2: Encoding the request string for use in the client URL

%7B%22limit%22%3A1000%2C%22filters%22%3A%7B%2C%22metadata%22%3A%7B%22
register.title%22%3A%22application%22%2C%22personalfile.name%22%3A%22
moneypenny%22%7D%2C%22contextfoldertypes%22%3A%5B%22
personalfile%22%5D%2C%22types%22%3A%5B%22register%22%5D%7D%7D

Note: To perform a manual test, you can use public encoders such as http://meyerweb.com/eric/tools/dencoder/

Step 3: Building the client URL to open the resultlist state

Append the encoded search string to the resultlist state URL of the client as reachable in a domain.

Version 3.3:

http://<domain>/client/index.html#/resultlist/%7B%22limit%22%3A1000%2C%22filters%22%3A%7B%2C%22
metadata%22%3A%7B%22register.title%22%3A%22application%22%2C%22personalfile.name%22%3A%22
moneypenny%22%7D%2C%22contextfoldertypes%22%3A%5B%22personalfile%22%5D%2C%22
types%22%3A%5B%22register%22%5D%7D%7D

Version 4.0:

http://<domain>/enaio/client/result?query=%7B%22limit%22%3A1000%2C%22filters%22%3A%7B%2C%22
metadata%22%3A%7B%22register.title%22%3A%22application%22%2C%22personalfile.name%22%3A%22
moneypenny%22%7D%2C%22contextfoldertypes%22%3A%5B%22personalfile%22%5D%2C%22
types%22%3A%5B%22register%22%5D%7D%7D

To open a single found object directly in its details view, append '&open=true' to the URL.

Example 2: Full-text Search

The following example shows how to search for a term that might be located in several fields. The search term is 'optimal', the technical name of the object type is 'email', and the fields are 'email.to', 'email.from' and 'email.cc'.

Step 1: Building the request string in JSON format

{"limit":1000,"term":"optimal","termfields":["email.to", "email.from", "email.cc"],"filters": 
{"types":["email"]},"options":{"searchmode":"fts"}}

Note: Here, 'searchmode' is set to 'fts' because 'optimal' could be part of the field value. To find the exact value of a 'term', set 'searchmode' to 'idxs' (default).

Step 2 and 3:

Use in version 3.3:

http://<domain>/client/index.html#/resultlist/%7B%22limit%22%3A1000%2C%22term%22%3A%22
chameleon%22%2C%22termfields%22%3A%5B%22email.von%22%2C%20%22email.an%22%2C%20%22
email.cc%22%5D%2C%22filters%22%3A%20%7B%22types%22%3A%5B%22email%22%5D%7D%2C%22
options%22%3A%7B%22searchmode%22%3A%22fts%22%7D%7D

Use in version 4.0:

http://<domain>/enaio/client/result?query=%7B%22limit%22%3A1000%2C%22term%22%3A%22
chameleon%22%2C%22termfields%22%3A%5B%22email.von%22%2C%20%22email.an%22%2C%20%22
email.cc%22%5D%2C%22filters%22%3A%20%7B%22types%22%3A%5B%22email%22%5D%7D%2C%22
options%22%3A%7B%22searchmode%22%3A%22fts%22%7D%7D

Here, the 'filter' part 'types' is set to one value, 'email'. In this case, the result list uses the configuration for this object type. Otherwise, the result list uses the configuration for mixed lists.