GSD REST API Serialization API documentation
Field |
Type |
Pattern |
Possible |
Default |
getSize? |
boolean
|
|
|
false |
If set on true, the document size is returned. |
getSecurity? |
enums.securityRights
|
|
|
|
Type of serialization. Default DOCUframe serialization.
Field |
Type |
Pattern |
Possible |
Default |
type |
string
|
|
full |
|
Examples
Type of serialization. Only OID and class.
Field |
Type |
Pattern |
Possible |
Default |
type |
string
|
|
empty |
|
Examples
| {
"type": "empty",
"getSize": true
}
|
Type of serialization. Only OID.
Field |
Type |
Pattern |
Possible |
Default |
type |
string
|
|
oid |
|
Examples
Type of serialization
Field |
Type |
Pattern |
Possible |
Default |
type |
string
|
|
macro |
|
macro |
string
|
|
|
|
Name of macro which is handling serialization |
macroLevel? |
enums.macroLevel
|
|
|
|
Examples
| {
"type": "macro",
"macro": "SerializationEventMacro",
"macroLevel": 1
}
|
Type of serialization
Field |
Type |
Pattern |
Possible |
Default |
type |
string
|
|
class |
|
style |
string
|
|
preview,detailview |
|
// |
object
|
|
|
|
Class name |
- type |
string |
|
|
|
- inherit |
boolean |
|
|
|
- merge |
boolean |
|
|
|
Examples
| {
"type": "class",
"style": "detailview",
"Vorgang": {
"type": "full",
"inherit": true,
"merge": true
}
}
|
Type of serialization.
Examples
| {
"type": "custom",
"getSize": true,
"custom": {
"type": "empty",
"fieldList": [
"Name1",
"Name2"
]
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17 | {
"type": "custom",
"custom": {
"type": "empty",
"fieldList": [
"Name1",
"Name2",
"ActivityLog"
],
"fieldCustom": {
"ActivityLog": {
"page": 0,
"perPage": 5
}
}
}
}
|
Type of serialization.
Field |
Type |
Pattern |
Possible |
Default |
type |
string
|
|
docs |
|
path? |
string
|
|
|
|
Default path for all objects. |
deep? |
boolean
|
|
|
|
Indicates whether search in subfolders of given path, or just on the path level |
page? |
enums.page
|
|
|
|
perPage? |
enums.perPage
|
|
|
|
query? |
object
|
|
|
|
Query which will filter found documents. |
custom? |
DocsSerialization
|
|
|
|
DocsSerialization[] - array |
Examples
| {
"type": "docs",
"getSize": true
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20 | {
"type": "docs",
"path": "",
"deep": true,
"getSize": true,
"custom": [
{
"oid": "45TU",
"path": "Folder",
"deep": false
},
{
"oid": "45TW",
"path": "Folder",
"deep": true
}
],
"page": 0,
"perPage": 10
}
|
Since DOCUframe module version 1.1.0.68
Type that allows to combine serializers. It is an array of serializers. If the second serializer sets the same field as the first, the data will be overwritten.
Field |
Type |
Pattern |
Possible |
Default |
- |
array |
|
|
|
Examples
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18 | [
{
"type": "custom",
"getSize": true,
"custom": {
"type": "empty",
"fieldList": [
"Name1",
"Name2"
]
}
},
{
"type": "macro",
"macro": "SerializationEventMacro",
"macroLevel": 1
}
]
|
Field |
Type |
Pattern |
Possible |
Default |
type |
string
|
|
empty,full,oid |
|
Full - all fields are added to JSON, fields from fieldList are excluded. Empty – only fields in fieldList are added to JSON. Oid - only Oids in fieldList are added to JSON |
fieldList? |
array
|
|
|
|
string[] - List of field names. |
fieldCustom? |
FieldCustomObject
|
|
|
|
Field |
Type |
Pattern |
Possible |
Default |
page? |
enums.page
|
|
|
|
perPage? |
enums.perPage
|
|
|
|
serialization? |
[object Object]
|
|
|
|
Definition of path depth and query for specific object in which documents should be searched for.
Field |
Type |
Pattern |
Possible |
Default |
oid |
string
|
|
|
|
OID of the object. |
path? |
string
|
|
|
|
Path for the object. |
deep? |
boolean
|
|
|
|
Indicates whether search in subfolders of given path, or just on the path level. |
query? |
string
|
|
|
|
Query which will filter found documents. |
Page number.
Field |
Type |
Pattern |
Possible |
Default |
- |
integer |
|
|
0 |
The number of items displayed per page.
Field |
Type |
Pattern |
Possible |
Default |
- |
integer |
|
|
10 |
The information about security right for an object is stored in a number. The individual bits of this number correspond to the set or unset rights. Bit | Area | Description |
1 | Object | Read |
2 | Object | Write |
3 | Object | Create |
4 | Object | Delete |
5 | | Change security |
6 | | - |
7 | | - |
8 | | - |
9 | Content | Read |
10 | Content | Write |
11 | Content | Insert |
12 | Content | Remove |
Field |
Type |
Pattern |
Possible |
Default |
- |
boolean |
|
|
false |
Event macro level. Value | DOCUframe Constant | Description |
-1 | UL_NOOVERRIDE | No overwrite |
0 | UL_ENDUSER | End user |
1 | UL_OEMPARTNER | OEM-Partner |
2 | UL_GSD | GSD |
Field |
Type |
Pattern |
Possible |
Default |
- |
integer |
|
-1,0,1,2 |
2 |