Workgroups

Quick Navigation

GET Workgroups

Returns a list of Workgroups to which the current user has permission.

None

Content-Type: application/json

[
    {
        OrganizationID : string, ID : int,
        Name : string
    },
    …
]

200 – Request successful. Workgroups in the response body.

For more information, please see Common Response Codes.

GET Workgroups/{id}

Returns a Workgroup by ID.

  • Current user has permission to the Workgroup Organization.
  • Asset Management (Read) or Scan Management (Read/Write)

id: ID of the Workgroup.

None

Content-Type: application/json

{
    OrganizationID : string,
    ID : int,
    Name : string
}

200 – Request successful. Workgroups in the response body.

For more information, please see Common Response Codes.

GET Workgroups?name={name}

Returns a Workgroup by name.

Current user has permission to the Workgroup Organization. Asset Management (Read) or Scan Management (Read/Write)

name: Name of the Workgroup.

None

Content-Type: application/json

{
    OrganizationID : string,
    ID : int,
    Name : string
}

200 – Request successful. Workgroups in the response body.

For more information, please see Common Response Codes.

POST Workgroups

Creates a Workgroup.

Asset Management (Read/Write)

Content-Type: application/json

{
    OrganizationID: string,
    Name : string
}
  • 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.

Content-Type: application/json

{
    OrganizationID : string,
    ID : int,
    Name : string
}

201 – Request successful. Workgroups in the response body.

For more information, please see Common Response Codes.