Group

The Group API allows you to list, create, update, search by ID, and delete groups.

List groups

Endpoints

GET notificationsvc/api/v1/group

Request

Request body

Parameter	Type	Description	Required
_nsFilter	String	Event filter to apply	Optional
_count	Integer	Number of groups to be listed. Default is 10.	Required
_offset	Integer	Position in list of groups to begin listing	Required
_externalId	String	ID of group	Required
_name	String	Name of group	Required
_namespace	String	Project namespace	Optional

Request body example

None

Response

Codes

Code	Description
200	Success
400	Bad Request
404	Not Found

Response

{
  _offset?: integer
  _pageSize?: integer
  _total?: integer
  _list: {
    _id?: string
    _namespaces?: string[]
    _createdAt?: string
    _updatedAt?: string
    _version?: integer
    _name: string
    _description?: string
  }[]
}

Create group

Endpoints

POST notificationsvc/api/v1/group

Request

Request body

Parameter	Type	Description	Required
_nsFilter	String	Event filter to apply	Optional

Request body example

{
  _description?: string
  _namespaces?: string[]
  _name: string
}

Response

Codes

Code	Description
200	Success
400	Bad Request
404	Not Found

Response

{
  _id?: string
  _namespaces?: string[]
  _createdAt?: string
  _updatedAt?: string
  _version?: integer
  _name: string
  _description?: string
}

Get group by ID

Endpoints

GET notificationsvc/api/v1/group/{id}

Request

Request body

Parameter	Type	Description	Required
_nsFilter	String	Event filter to apply	Optional

Request body example

None

Response

Codes

Code	Description
200	Success
400	Bad Request
404	Not Found

Response

{
  _id?: string
  _namespaces?: string[]
  _createdAt?: string
  _updatedAt?: string
  _version?: integer
  _name: string
  _description?: string
}

Update group by ID

Endpoints

PUT notificationsvc/api/v1/group/{id}

Request

Request body

Parameter	Type	Description	Required
_nsFilter	String	Event filter to apply	Optional
_version	Integer	Version of group	Optional

Request body example

{
  _description?: string
}

Response

Codes

Code	Description
200	Success
400	Bad Request
404	Not Found

Response

{
  _id?: string
  _namespaces?: string[]
  _createdAt?: string
  _updatedAt?: string
  _version?: integer
  _name: string
  _description?: string
}

Delete group by ID

Endpoints

DELETE notificationsvc/api/v1/group/{id}

Request

Request body

Parameter	Type	Description	Required
_nsFilter	String	Event filter to apply	Optional
_version	String	Version to apply

Request body example

Response

Codes

Code	Description
200	Success
400	Bad Request
404	Not Found

Response