queryDocuments

get

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

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 6 moths ago to a week ago (relativeFrom = "-6 MONTHS", relativeTo = "-1 WEEKS")
Filter with absolute date-time values, see field examples

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

referenceType

string

Document reference type (only exact match)

documentType

string

Document type (only exact match)

referenceNumberPattern

string

Document reference number pattern (can contain wildcards)

referenceNumber

array of strings

length ≤ 1000

deprecated

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

Consider using /documentByRef instead.

referenceNumber

documentId

array of strings

length ≤ 1000

deprecated

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

Consider using /documentById instead.

documentId

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 value maxResults

maxResults

int32

Defines how many documents will be returned. Default value: 30, maximum value: 100

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:

relativeFromValue

int32

Relative time range, from

relativeFromUnit

string

enum

Relative time range, from

Allowed:

relativeToValue

int32

Relative time range, to

relativeToUnit

string

enum

Relative time range, to

Allowed:

absoluteFrom

date-time

Specific day/time for filtering, from

absoluteTo

date-time

Specific day/time for filtering, to

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

defaultdefault response