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 will be performed the operation.
field string
Field name on which will be performed the operation.
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"
}

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.

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
type string macro
macro string
Name of macro which is handling serialization.
macroLevel? integer -1,0,1,2 2
Event macro level.

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"
}