Skip to content

GSD REST API Query API documentation

Query

Field Type Pattern Possible Default
macro? string
Event Macro which is filtering the result set form the query.
macroLevel? number -1,0,1,2 2
Value DOCUframe Constant Description
-1 UL_NOOVERRIDE No overwrite
0 UL_ENDUSER End user
1 UL_OEMPARTNER OEM-Partner
2 UL_GSD GSD

String

Field Type Pattern Possible Default
macro? string
Event Macro which is filtering the result set form the query.
macroLevel? number -1,0,1,2 2
Value DOCUframe Constant Description
-1 UL_NOOVERRIDE No overwrite
0 UL_ENDUSER End user
1 UL_OEMPARTNER OEM-Partner
2 UL_GSD GSD
queryString string
Query on allset - standard DOCUframe query.

Examples

1
2
3
4
5
{
  "queryString": "query Nummer = \"ABC123\";",
  "macro": "QueryEventMacro",
  "macroLevel": 0
}

SortIndex

Field Type Pattern Possible Default
macro? string
Event Macro which is filtering the result set form the query.
macroLevel? number -1,0,1,2 2
Value DOCUframe Constant Description
-1 UL_NOOVERRIDE No overwrite
0 UL_ENDUSER End user
1 UL_OEMPARTNER OEM-Partner
2 UL_GSD GSD
sortIndex string
Sorts allset by index with usage SortByIndex. It is very important that you need to have an existing index on that class.

Examples

1
2
3
{
  "sortIndex": "!Datum"
}

FolderPath

Field Type Pattern Possible Default
macro? string
Event Macro which is filtering the result set form the query.
macroLevel? number -1,0,1,2 2
Value DOCUframe Constant Description
-1 UL_NOOVERRIDE No overwrite
0 UL_ENDUSER End user
1 UL_OEMPARTNER OEM-Partner
2 UL_GSD GSD
folderPath string
Path to the folder.

Examples

1
2
3
{
  "folderPath": "\\\\User\\GSDWebService\\Eingang"
}

FolderType

Field Type Pattern Possible Default
macro? string
Event Macro which is filtering the result set form the query.
macroLevel? number -1,0,1,2 2
Value DOCUframe Constant Description
-1 UL_NOOVERRIDE No overwrite
0 UL_ENDUSER End user
1 UL_OEMPARTNER OEM-Partner
2 UL_GSD GSD
folderType string home,global,globalIncoming,personal,personalNew,personalIncoming,personalOutgoing,personalRecycler,favorite,history
Type of the folder.

Examples

1
2
3
{
  "folderType": "home"
}

FolderOid

Field Type Pattern Possible Default
macro? string
Event Macro which is filtering the result set form the query.
macroLevel? number -1,0,1,2 2
Value DOCUframe Constant Description
-1 UL_NOOVERRIDE No overwrite
0 UL_ENDUSER End user
1 UL_OEMPARTNER OEM-Partner
2 UL_GSD GSD
folderOid string
OID of the folder

Examples

1
2
3
{
  "folderOid": "2B9W"
}

Object

Field Type Pattern Possible Default
query QueryObject
Query on allset in format of object.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
{
  "query": {
    "sort": [
      {
        "field": "Telefon"
      }
    ],
    "parts": [
      {
        "field": "Name1",
        "value": "Bob",
        "bindingOperator": "||"
      },
      {
        "field": "Name1",
        "value": "John"
      }
    ]
  }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
  "query": {
    "parts": [
      {
        "field": "ActivityLog",
        "count": 10,
        "countOperator": ">="
      }
    ]
  }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
{
  "query": {
    "parts": [
      {
        "parts": [
          {
            "field": "Name1",
            "value": "Bob",
            "bindingOperator": "&&"
          },
          {
            "field": "Name2",
            "value": "Marley"
          }
        ],
        "bindingOperator": "||"
      },
      {
        "parts": [
          {
            "field": "Name1",
            "value": "John",
            "bindingOperator": "&&"
          },
          {
            "field": "Name2",
            "value": "Doe"
          }
        ]
      }
    ]
  }
}

OID

Field Type Pattern Possible Default
macro? string
Event Macro which is filtering the result set form the query.
macroLevel? number -1,0,1,2 2
Value DOCUframe Constant Description
-1 UL_NOOVERRIDE No overwrite
0 UL_ENDUSER End user
1 UL_OEMPARTNER OEM-Partner
2 UL_GSD GSD
oids array
string[] - List of oids.

Examples

1
2
3
4
5
6
7
{
  "oids": [
    "OID001",
    "OID002",
    "OID003"
  ]
}

FullText

Field Type Pattern Possible Default
macro? string
Event Macro which is filtering the result set form the query.
macroLevel? number -1,0,1,2 2
Value DOCUframe Constant Description
-1 UL_NOOVERRIDE No overwrite
0 UL_ENDUSER End user
1 UL_OEMPARTNER OEM-Partner
2 UL_GSD GSD
fullText? string
Text value that would be searched in the object
textContent? string
Text value that would be searched in the content
seQuery? object
Object that allows to pass all parameter to DOCUframe query function
－ textContentStem? boolean
－ sortByScore? boolean
－ textContentTypo? boolean
－ fullTextTypo? boolean
－ maxHits? integer
－ fullTextConcept? integer 0,1,2,3 0
－ fullTextStem? boolean
－ from? string
－ fullTextCombineAnd? boolean
－ textContent? string
－ fullText? string
－ textContentConcept? integer 0,1,2,3 0
－ to? string

Examples

1
2
3
{
  "textContent": "Example text that will be searched in objects content"
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "fullText": "GSD-Dav Workshop",
  "seQuery": {
    "fullTextConcept": 2,
    "fullTextStem": false,
    "fullTextTypo": true,
    "sortByScore": true,
    "maxHits": 10,
    "from": "20200101T000000+02:00",
    "to": "20201231T235959+02:00"
  }
}

QueryObject

Field Type Pattern Possible Default
sort? QuerySortPart
QuerySortPart[] - array
parts? array
QueryObjectBrackets | QueryObjectField | QueryObjectCount | QueryObjectCountSet | QueryObjectCountFields

QueryObjectPart

Field Type Pattern Possible Default
bindingOperator string ||,&& &&

QueryObjectBrackets

Field Type Pattern Possible Default
bindingOperator string ||,&& &&
parts? array
QueryObjectBrackets | QueryObjectField | QueryObjectCount | QueryObjectCountSet | QueryObjectCountFields

QueryObjectField

Field Type Pattern Possible Default
bindingOperator string ||,&& &&
field string
value string
operator? string ==|!=|<=|>=|<|>|=~|=[+-][+-][+-~][+-] ==

QueryObjectCount

Field Type Pattern Possible Default
bindingOperator string ||,&& &&
field string
count integer
countOperator? string ==|!=|<=|>=|<|> ==

QueryObjectCountSet

Field Type Pattern Possible Default
bindingOperator string ||,&& &&
field string
count integer
countOperator? string ==|!=|<=|>=|<|> ==
value string
operator? string ==|!=|<=|>=|<|>|=~|=[+-][+-][+-~][+-] ==

QueryObjectCountFields

Field Type Pattern Possible Default
bindingOperator string ||,&& &&
field string
count integer
countOperator? string ==|!=|<=|>=|<|> ==
parts? array
QueryObjectBrackets | QueryObjectField | QueryObjectCount | QueryObjectCountSet | QueryObjectCountFields

QuerySortPart

Field Type Pattern Possible Default
field string
The field after which the query results will be sorted.
order? string asc,desc asc
Type of sorting - ascending (ASC) / descending (DESC).

Macro

Field Type Pattern Possible Default
macro? string
Event Macro which is filtering the result set form the query.
macroLevel? number -1,0,1,2 2
Value DOCUframe Constant Description
-1 UL_NOOVERRIDE No overwrite
0 UL_ENDUSER End user
1 UL_OEMPARTNER OEM-Partner
2 UL_GSD GSD