GSD REST API Serialization API documentation

General

Field

Type

Pattern

Possible

Default

getSize?

boolean

false

If set on true, the document size is returned.

securityRights?

boolean

false

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

Full

Type of serialization. Default DOCUframe serialization.

Field

Type

Pattern

Possible

Default

getSize?

boolean

false

If set on true, the document size is returned.

securityRights?

boolean

false

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

type

string

full

Examples

1
2
3

{
  "type": "full"
}

Empty

Type of serialization. Only OID and class.

Field

Type

Pattern

Possible

Default

getSize?

boolean

false

If set on true, the document size is returned.

securityRights?

boolean

false

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

type

string

empty

Examples

{
  "type": "empty",
  "getSize": true
}

Oid

Type of serialization. Only OID.

Field

Type

Pattern

Possible

Default

getSize?

boolean

false

If set on true, the document size is returned.

securityRights?

boolean

false

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

type

string

oid

Examples

1
2
3

{
  "type": "oid"
}

Macro

Type of serialization

Field

Type

Pattern

Possible

Default

getSize?

boolean

false

If set on true, the document size is returned.

securityRights?

boolean

false

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

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

type

string

macro

Examples

{
  "type": "macro",
  "macro": "SerializationEventMacro",
  "macroLevel": 1
}

Class

Type of serialization

Field

Type

Pattern

Possible

Default

getSize?

boolean

false

If set on true, the document size is returned.

securityRights?

boolean

false

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

type

string

class

style

string

preview,detailview

//

Class name

－ type

string

－ inherit

boolean

－ merge

boolean

Examples

{
  "type": "class",
  "style": "detailview",
  "Vorgang": {
    "type": "full",
    "inherit": true,
    "merge": true
  }
}

Custom

Type of serialization.

Field	Type	Pattern	Possible	Default
type	string		custom
custom	CustomSerialization

Examples

{
  "type": "custom",
  "getSize": true,
  "custom": {
    "type": "empty",
    "fieldList": [
      "Name1",
      "Name2"
    ]
  }
}

{
  "type": "custom",
  "custom": {
    "type": "empty",
    "fieldList": [
      "Name1",
      "Name2",
      "ActivityLog"
    ],
    "fieldCustom": {
      "ActivityLog": {
        "page": 0,
        "perPage": 5
      }
    }
  }
}

Docs

Type of serialization.

Field	Type	Possible
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
query?	object
Query which will filter found documents.
custom?	DocsSerialization
DocsSerialization[] - array

Examples

{
  "type": "docs",
  "getSize": true
}

{
  "type": "docs",
  "path": "",
  "deep": true,
  "getSize": true,
  "custom": [
    {
      "oid": "45TU",
      "path": "Folder",
      "deep": false
    },
    {
      "oid": "45TW",
      "path": "Folder",
      "deep": true
    }
  ],
  "page": 0,
  "perPage": 10
}

Table

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

[
  {
    "type": "custom",
    "getSize": true,
    "custom": {
      "type": "empty",
      "fieldList": [
        "Name1",
        "Name2"
      ]
    }
  },
  {
    "type": "macro",
    "macro": "SerializationEventMacro",
    "macroLevel": 1
  }
]

CustomSerialization

Field	Type	Possible
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

FieldCustomObject

Field	Type	Pattern	Possible	Default
//?	FieldCustom

FieldCustom

Field	Type	Default
page?	integer	0
Page number."
perPage?	integer	10
The number of items displayed per page.
serialization?	object
Full \| Empty \| Oid \| Macro \| Custom \| Docs - Type of serialization.

DocsSerialization

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.

SecurityRgh

Field

Type

Pattern

Possible

Default

getSize?

boolean

false

If set on true, the document size is returned.

securityRights?

boolean

false

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

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

Pages

Field	Type	Default
page?	integer	0
Page number."
perPage?	integer	10
The number of items displayed per page.

MacroAndGeneral

Field

Type

Pattern

Possible

Default

getSize?

boolean

false

If set on true, the document size is returned.

securityRights?

boolean

false

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

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