Class Index

Classes


GroupManager_GET

Collects Group info
Defined in: groupManager.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
GroupManager_GET(id, name, pretty)
GET /wf/restapi/v2/admin/groupManager: This endpoint can collect all groups info or a specific groups info given the "id" or "name"
Class Detail
GroupManager_GET(id, name, pretty)
GET /wf/restapi/v2/admin/groupManager: This endpoint can collect all groups info or a specific groups info given the "id" or "name"
Parameters:
id Optional
search for a specific group by group id
name Optional
search for a specific group by name
pretty Optional, Default: false
format the response to be human readable?
GET /wf/restapi/v2/admin/groupManager
Response:

 [
  {
    "loadingDockType": 0,
    "hidden": false,
    "description": "all of the system users",
    "priority": 1,
    "editLevel": 5,
    "loginText": "",
    "viewLevel": 5,
    "name": "users",
    "id": 6,
    "acls": [
      "0_6_FDD90A54-82B2-4257-AC4B-A8BBCAC939EF",
      "0_6_E0AA2BEC-0557-4417-A545-F67C0F51BA27"
    ],
    "users": [
      1
    ]
  },
  {
    "loadingDockType": 0,
    "hidden": false,
    "description": "A group for testing",
    "ldapDn": "",
    "priority": 1,
    "editLevel": 5,
    "loginText": "",
    "viewLevel": 5,
    "name": "Testing",
    "id": 8,
    "acls": [
      "0_8_56AB9B61-ACEC-4039-A626-9309CE2A8C7C"
    ],
    "users": [
      1
    ]
  }
 ]
GET /wf/restapi/v2/admin/groupManager?name=Testing
Response:

 [
  {
    "loadingDockType": 0,
    "hidden": false,
    "description": "A group for testing",
    "ldapDn": "",
    "priority": 1,
    "editLevel": 5,
    "loginText": "",
    "viewLevel": 5,
    "name": "Testing",
    "id": 8,
    "acls": [
      "0_8_56AB9B61-ACEC-4039-A626-9309CE2A8C7C"
    ],
    "users": [
      1
    ]
  }
 ]
GET /wf/restapi/v2/admin/groupManager?id=6
Response:

 [
  {
    "loadingDockType": 0,
    "hidden": false,
    "description": "all of the system users",
    "priority": 1,
    "editLevel": 5,
    "loginText": "",
    "viewLevel": 5,
    "name": "users",
    "id": 6,
    "acls": [
      "0_6_FDD90A54-82B2-4257-AC4B-A8BBCAC939EF",
      "0_6_E0AA2BEC-0557-4417-A545-F67C0F51BA27"
    ],
    "users": [
      1
    ]
  }
 ]

Documentation generated by JsDoc Toolkit 2.4.0 on Fri Dec 15 2023 01:44:02 GMT-0600 (CST)