Search for groups
Returns a paginated list of all groups that match the provided filter criteria.
This operation can fail for the following reasons:
- A server error occurred (HTTP error 500)
Query parameters
The number of artifacts to skip before starting to collect the result set. Defaults to 0.
The number of artifacts to return. Defaults to 20.
Sort order, ascending (asc) or descending (desc).
The field to sort by. Can be one of:
- name
- createdOn
Filter by one or more name/value label. Separate each name/value pair using a colon, which splits on the last colon (e.g. labels=foo:bar matches key foo and value bar). Note: the key:value query treats the last colon as the delimiter, so values containing colons cannot be matched via this syntax (they remain matchable via key-only queries).
Filter by description.
Filter by group name.
Response
On a successful response, returns a result set of groups - one for each group in the registry that matches the criteria.
Example response
{
"groups": [
{
"groupId": "My-Group",
"name": "Group Name",
"description": "Description of the group",
"owner": "user1",
"createdOn": "2019-03-22T12:51:19Z",
"modifiedBy": "user1",
"modifiedOn": "2019-03-22T12:51:19Z"
}
]
}