Workgroups
Quick Navigation
GET Workgroups
Purpose
Returns a list of Workgroups to which the current user has permission.
Request Body
None.
Response Body
Content-Type: application/json
[ { OrganizationID : string, ID : int, Name : string }, … ]
Response Codes
200 – Request successful. Workgroups in the response body.
For more information, please see Common Response Codes.
GET Workgroups/{id}
Purpose
Returns a Workgroup by ID.
Required Permissions
- Current user has permission to the Workgroup Organization.
- Asset Management (Read) or Scan Management (Read/Write).
Query Parameters
id: ID of the Workgroup.
Request Body
None.
Response Body
Content-Type: application/json
{ OrganizationID : string, ID : int, Name : string }
Response Codes
200 – Request successful. Workgroups in the response body.
For more information, please see Common Response Codes.
GET Workgroups?name={name}
Purpose
Returns a Workgroup by name.
Required Permissions
Current user has permission to the Workgroup Organization. Asset Management (Read) or Scan Management (Read/Write).
Query Parameters
name: Name of the Workgroup.
Request Body
None.
Response Body
Content-Type: application/json
{ OrganizationID : string, ID : int, Name : string }
Response Codes
200 – Request successful. Workgroups in the response body.
For more information, please see Common Response Codes.
POST Workgroups
Purpose
Creates a Workgroup.
Required Permissions
Asset Management (Read/Write).
Request Body
Content-Type: application/json
{ OrganizationID: string, Name : string }
Request Body Details
- Organization ID: (optional) The ID of the organization in which to place the new Workgroup. If empty, the Workgroup is placed in the default organization.
- Name: The name of the Workgroup. Max string length is 256.
Response Body
Content-Type: application/json
{ OrganizationID : string, ID : int, Name : string }
Response Codes
201 – Request successful. Workgroups in the response body.
For more information, please see Common Response Codes.