Released: HTML page

You can use the Search feature to find saved items in the repository, provided that you have the appropriate authorizations. Based on their area of responsibility, users frequently search for the same items, which they can find quickly by using selected properties and categories. You can simplify the search process by providing users with a predefined search operation. In the search operation, you have already defined the values that your users otherwise have to enter repeatedly.

To make a predefined search operation available, transfer the parameters of the URL.

You can call the search operation in two ways:

Searching without specifying a repository

If you want to define the search operation without specifying a repository, proceed as follows:

When you open the URL /dms, you are notified of the URL for the search operation, including the available parameters, with the following HTTP response:

Request

GET /dms
Accept: application/hal+json

The JSON object for the root resource contains the search link relation with placeholders for the values used to perform the search for DMS objects.

Response

{
        _links: {
                search: {
                        href: "/dms/s/{?objectdefinitionids,fulltext,properties,showresultlist,repositoryid}"
                        templated: true
                }
        }
}

Searching in a predefined repository

If you want to define a search operation for a specific repository, you must first determine the URL for the repository. In the chapter Determining a repository, you can learn how to determine the URL for a repository.

Once you have determined the URL for the repository (for example: /dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27) and called the URL using HTTP GET, you receive the following result, which contains the repository-specific URL for the search operation:

Request

GET /dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27
Accept: application/hal+json

The JSON object for the repository contains the search link relation with placeholders for the values used to perform the search for DMS objects.

Response

{
        _links: {
                search: {
                        href: "/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/s/{?objectdefinitionids,fulltext,properties,showresultlist}"
                        templated: true
                }
        },
        id: "dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27"
}

Specifying response control parameters

You control the system response for searching and displaying using the following parameters:

For descriptions of the objectdefinitionids, fulltext and properties parameters, see the Defining the parameters for a search operation chapter.

Opening the URL for the search operation

Once you have created a URL for the search operation, you can then call the results using the corresponding requests.

Request without a repository ID:

Request

GET /dms/s/?objectdefinitionids=["RECH"]&fulltext=Mustermann&properties={"227":["KND001"]}&repoid=dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27
Accept: text/html

Request with a repository ID:

Request

GET /dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/s/?objectdefinitionids=["RECH"]&fulltext=Mustermann&properties={"227":["KND001"]}
Accept: text/html

The search operation in the Search feature is then loaded with the transferred parameters as a result.

Released: HTML page

When defining search operations, you can specify that only the result list is to be displayed. Your users can then view the results of a search directly and no longer have to specify the individual properties. The result list makes it easy for your users to continue their work. However, the users can no longer change the search criteria that led to the result.

To display only the results of a search operation, you must perform the following steps:

Once you have created a mapping for a source, you can also display the results of a search operation in other ways. For additional information see chapter Retrieving and viewing the results of a search operation.

Determining the URL for a repository

In the chapter Determining a repository, you can learn how to determine the URL for a repository.

Determining the link relation for retrieving the results of a search operation

You open the URL for a repository as follows:

Request

GET /dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27
Accept: application/hal+json

The JSON object for the repository contains the searchresult link relation with placeholders for the values used to perform the search for DMS objects.

Response

{
        _links: {
                searchresult: {
                        href: "/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/sr/{?objectdefinitionids,fulltext,properties,propertysort,ascending,showdetails}"
                        templated: true
                }
        },
        id: "dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27"
}

Specifying response control parameters

Use the following parameters to control the system response when viewing the results:

For descriptions of the objectdefinitionids, fulltext and properties parameters, see the Defining the parameters for a search operation chapter.

Opening the URL for the results

Once you have created a URL, you can then open the results as follows:

Request

GET /dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/sr/?objectdefinitionids=["RECH"]&fulltext=Mustermann&properties={"227":["KND001"]}
Accept: text/html

The result of the search operation is then loaded.

As response you will receive the HTML page with the result list. If there is an error, you will receive an HTML page that describes the error in more detail. If errors occur, you must correct the incorrect request.

If, for example, you want to provide your users with a predefined search operation or result list, you can specify a variety of parameters. Usually, the full-text search in a d.3 repository is not specific enough. Therefore, you can restrict the search query by using query parameters.

You must encode the URL parameters (e.g. spaces in %20). The length of the encoded query parameter is limited to 2000 characters.