GSD REST API Actions API documentation

Action

Field Type Pattern Possible Default
when? string Any,A,Success,S,Error,E,ErrorError,EE Success
default Success – field describes when action should be performed
 Success – previous operation (create, modification, delete of object) was a success
 Error – previous operation ended with an error
 Any – action is always called
 ErrorError – when an action ends with error, then the ErrorError actions are performed"

ActionField

For the add and remove action the action object must by type of class Action_Field. The action allows to set or remove the object on another object field.

Field Type Pattern Possible Default
when? string Any,A,Success,S,Error,E,ErrorError,EE Success
default Success – field describes when action should be performed
 Success – previous operation (create, modification, delete of object) was a success
 Error – previous operation ended with an error
 Any – action is always called
 ErrorError – when an action ends with error, then the ErrorError actions are performed"
type string add,remove
Type of action - add / remove.
object string
Object OID on which the operation will be performed.
field string
Field name on which the operation will be performed
operation? string add,addobject add
add - This operation will not add duplicates to the array. addobject - This operation will add duplicates to the array.
class? string
Additional field for validation if the given object is of class.

Examples

1
2
3
4
5
{
  "type": "add",
  "object": "OID77",
  "field": "Adresse"
}

ActionFieldv2

For the addv2 and removev2 action the action object must by type of class Action_Fieldv2. The action allows to set or remove the object or objects on another object field.

Field Type Pattern Possible Default
when? string Any,A,Success,S,Error,E,ErrorError,EE Success
default Success – field describes when action should be performed
 Success – previous operation (create, modification, delete of object) was a success
 Error – previous operation ended with an error
 Any – action is always called
 ErrorError – when an action ends with error, then the ErrorError actions are performed"
type string addv2,removev2
Type of action - addv2 / removev2.
objects array
Object OID or list of OIDs which will be added/removed to/from the field.
field string
Field name on which the operation will be performed.
operation? string add,addobject add
add - This operation will not add duplicates to the array. addobject - This operation will add duplicates to the array.

Examples

1
2
3
4
5
6
7
8
{
  "type": "addv2",
  "objects": [
    "OID77",
    "OID78"
  ],
  "field": "Adresse"
}

ActionSendObject

The action sends the object to another user.

Field Type Pattern Possible Default
when? string Any,A,Success,S,Error,E,ErrorError,EE Success
default Success – field describes when action should be performed
 Success – previous operation (create, modification, delete of object) was a success
 Error – previous operation ended with an error
 Any – action is always called
 ErrorError – when an action ends with error, then the ErrorError actions are performed"
type string sendObject
Type of action - sendObject.
toUser? string
User to whom the message with note is to be sent.
toUsers? array
string[] - List of user to whom the message with note is to be sent.
text string
Message text.
cc? array
string[] - List of user to whom the copy of message with note is to be sent.
public? boolean
Allows to mark annotation as Public.

Examples

1
2
3
4
5
{
  "type": "sendObject",
  "toUser": "user1",
  "text": "Hello world"
}

1
2
3
4
5
6
7
8
{
  "type": "sendObject",
  "toUsers": [
    "user1",
    "user2"
  ],
  "text": "Hello world"
}

ActionMessageObject

For the sendMessage action the action object must by type of class Action_MessageObject. The action sends a message to another user.

Field Type Pattern Possible Default
when? string Any,A,Success,S,Error,E,ErrorError,EE Success
default Success – field describes when action should be performed
 Success – previous operation (create, modification, delete of object) was a success
 Error – previous operation ended with an error
 Any – action is always called
 ErrorError – when an action ends with error, then the ErrorError actions are performed"
type string sendMessage
toUser? string
User to whom the message is to be sent.
toUsers? array
string[] - List of user to whom the message is to be sent.
text string
Message text.
name? string
Message name.
description? string
Description of the message.

Examples

1
2
3
4
5
{
  "type": "sendMessage",
  "toUser": "user1",
  "text": "Hello world"
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "type": "sendMessage",
  "toUsers": [
    "user1",
    "user2"
  ],
  "name": "Message name",
  "text": "Hello world",
  "description": "Message description"
}

ActionMacro

For the macro action the action object must by type of class Action_Macro. The action performs a macro.

Field Type Pattern Possible Default
when? string Any,A,Success,S,Error,E,ErrorError,EE Success
default Success – field describes when action should be performed
 Success – previous operation (create, modification, delete of object) was a success
 Error – previous operation ended with an error
 Any – action is always called
 ErrorError – when an action ends with error, then the ErrorError actions are performed"
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

1
2
3
4
5
{
  "type": "macro",
  "macro": "ActionEventMacroName",
  "macroLevel": 1
}

ActionAssign

For the macro action the action object must by type of class Action_Macro. The action performs a macro.

Field Type Pattern Possible Default
when? string Any,A,Success,S,Error,E,ErrorError,EE Success
default Success – field describes when action should be performed
 Success – previous operation (create, modification, delete of object) was a success
 Error – previous operation ended with an error
 Any – action is always called
 ErrorError – when an action ends with error, then the ErrorError actions are performed"
type string assign
object string
Object oid on which will be performed the operation.
path? string
Folder name.
class? string
Additional field for validation if the given object is of class.

Examples

1
2
3
4
{
  "type": "assign",
  "object": "OID77"
}

ActionAddToFolder

Adds objects to the folder specified in action

Field Type Pattern Possible Default
when? string Any,A,Success,S,Error,E,ErrorError,EE Success
default Success – field describes when action should be performed
 Success – previous operation (create, modification, delete of object) was a success
 Error – previous operation ended with an error
 Any – action is always called
 ErrorError – when an action ends with error, then the ErrorError actions are performed"
type string addToFolder
sourceType string type,path,oid
A string representing how to look for the destination folder
folder string
Folder type/path/oid (depends on given sourceType)

Examples

1
2
3
4
5
{
  "type": "addToFolder",
  "sourceType": "type",
  "folder": "personalIncoming"
}

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

Actions

Field Type Pattern Possible Default
when? string Any,A,Success,S,Error,E,ErrorError,EE Success
default Success – field describes when action should be performed
 Success – previous operation (create, modification, delete of object) was a success
 Error – previous operation ended with an error
 Any – action is always called
 ErrorError – when an action ends with error, then the ErrorError actions are performed"

MacroAndActions

Field Type Pattern Possible Default
when? string Any,A,Success,S,Error,E,ErrorError,EE Success
default Success – field describes when action should be performed
 Success – previous operation (create, modification, delete of object) was a success
 Error – previous operation ended with an error
 Any – action is always called
 ErrorError – when an action ends with error, then the ErrorError actions are performed"
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