openStagedDocumentSearch

Get URL to search document

Returns document search link.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

The user of the new session.
It is not required, that this user is a valid user name of the client. However: Such a user may have granted only the role "I_EVERYONE" unless XNSG is configured to use e.g. an LDAP server and the user can be found in the LDAP server with some roles granted to the user.
No password is required because other servers which contact over the business facade will be trusted to have checked the users access rights. This enables a kind of "single sign on" between different e.g. XNSG servers.

string

The two letter ISO code of the language of the new session. Currently "de" and "en" are supported.

string

Criteria for the document ID of the document. Only documents that exactly match the ID pattern will be returned.

string

Criteria for the reference type of the documents. Only documents that exactly match the reference type pattern will be returned.

string

Criteria for the reference number of the documents. The criteria can contain wildcards.

string

Criteria for the document type of the document. Only documents that exactly match the document type pattern will be returned.

int32

Relative time range, from

string
enum

Relative time range, from

Allowed:
int32

Relative time range, to

string
enum

Relative time range, to

Allowed:
date-time

Specific day/time for filtering, from

date-time

Specific day/time for filtering, to

boolean

If set to 'true', the generated URI is returned in the 'Location' header of a SEE OTHER (303) response.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

303

Redirected to a URI generated in call response

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here!