queryDocumentsById

post

https://rz3.aeb.de/demo1docs/rest/DocumentService/documentById

Query information on existing documents

Executes a search query on the documents stored in the document storage. Only the documents that are visible to the caller (session user and session client) are returned. The results can be sorted by predefined criteria, the limit of the number of results is configurable, too.

Date time interval range filter

Use one of the given attributes to pass the filter. If more than one attribute is filled attributes will be used in the following order: relative interval, absolute interval

Filter relative to current day, e.g: from 2 months ago to a week ago (relativeFrom = "-2 MONTHS", relativeTo = "-1 WEEKS")
Filter with absolute date-time values, see field examples

Body Params

clientSystemId

string

Id of the sending client system.

e.g. Installation ID of the sending host or ERP system.

Maximum length: 20

clientIdentCode

string

Client identification code.

Maximum length: 10

userName

string

User who initiated the request from the client system.

If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.

If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.

Actual authentication is handled separately via the request's headers, so no password is required in the request's data.

resultLanguageIsoCodes

array of strings

2-letter ISO codes of the languages in which texts will be returned.

English ('en') and German ('de') are typically supported by default. Other languages may be supported.

Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.

resultLanguageIsoCodes

createdAtRange

object

Represents a possibility to pass a date time interval range filter. Use one of the given attributes to pass the filter. If more than one attribute is filledthe attributes will be used in the following order: relativeInterval, absoluteInterval

returnTotalCount

boolean

If true, total number of documents found is returned in field totalCount. Total number can be different from number of actually returned documents in case total document count exceeds the value of maxResults

maxResults

int32

Limits how many documents can be returned in a single request.
Minimum: 1
Maximum: 100
Default: 30

skipFirst

int32

If set, defines the number of documents that will be skipped before collecting results. Use this to retrieve further documents if a previous query did not return all required documents. The number must not exceed 10000

orderBy

string

enum

Defines how the requested documents are sorted.

CREATED_AT_ASC : Sorted by date/time of document creation, oldest first.
CREATED_AT_DESC : Sorted by date/time of document creation, newest first.
REFERENCE_NUMBER_ASC : Sorted by document reference number, alphabetically ascending.
REFERENCE_NUMBER_DESC : Sorted by document reference number, alphabetically descending.
REFERENCE_TYPE_ASC : Sorted by document reference type, alphabetically ascending.
REFERENCE_TYPE_DESC : Sorted by document reference type, alphabetically descending.

Allowed:

documentIdInList

array of strings

length ≤ 1000

List of document IDs (max. 1000 elements allowed). Only documents exactly matching these IDs will be returned.

documentIdInList

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

defaultdefault response