Group API

Actions

Create

Create a new group for the user that has authenticated itself.

https://portal.robotsindeklas.nl/API/v1/group/create

Parameter:

name - string: the new name of the group.

Info

Get the document of a particular group.

https://portal.robotsindeklas.nl/API/v1/group/info

Parameter:

group - string: the object id of the group you want the info of.

Copy

Create a copy of an existing group.

https://portal.robotsindeklas.nl/API/v1/group/copy

Parameters:

group - string: the object id of the group you want to copy
name - string - (optional, default: name of the original group): the new name of the copied group

Lock

Lock a group. If a group is locked, users with play or edit share rights will no longer have access to the group.

https://portal.robotsindeklas.nl/API/v1/group/lock

Parameters:

group - string: the object id of the group you want to lock;
lock - boolean - (optional, default: false): lock (true) or unlock (false) this group.

Share a group with a user or group. We define four levels of share rights:

0 (revoked rights): user or group will no longer have access to this group
1 (play rights): user or group is only allowed to use this group to, for example, assign robots to this group.
2 (edit rights): user or group is allowed to assign new users to this group.
3 (admin rights): user or group will be able to play, edit and share this app with other users.

https://portal.robotsindeklas.nl/API/v1/group/share

Parameters:

group - string: the object id of the group you want to share;
level - int: the share level we want to assign to the user or group with this request;
oid - string: the object id of the user or group we want the share this group with.

Trash

Remove a group or bring it back from the trash bin.

https://portal.robotsindeklas.nl/API/v1/group/trash

Parameters:

group - string: the object id of the group we want to trash
del - boolean: delete (true) or restore (false) deleted item.

Response

If the request was successful, you will receive the following response:

Model:

{
  '_id': ObjectId - The id of the group
  'name': String - The name of the group, visible in the portal
  'type':  String - The type of the group (currently not used)
  'tags': Array - An array of tags describing this user (currently not used)
  'owner': ObjectId - The user id of the user who owns this group
  'access': Integer - The access level you have over this group
}

Example:

{
  '_id': {
    '$oid': '60d676f4dbcbca6e332153f5'
  },
  'name': 'Beheerders',
  'type': '',
  'tags': [],
  'owner': {
    '$oid': '60f9d71cd6e5e131a0571b1c'
  },
  'access': 2
}