APapicurio
Search
Groups

Search for groups

Changed on

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)
get/search/groups

Request

  • The document declares no server URL.
  • Auth
    none declared

Query parameters

offsetinteger

The number of artifacts to skip before starting to collect the result set. Defaults to 0.

limitinteger

The number of artifacts to return. Defaults to 20.

order'asc' | 'desc'

Sort order, ascending (asc) or descending (desc).

orderby'groupId' | 'createdOn' | 'modifiedOn'

The field to sort by. Can be one of:

  • name
  • createdOn
labelsstring[]

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).

descriptionstring

Filter by description.

groupIdstring

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.

countinteger required

The total number of groups that matched the query that produced the result set (may be more than the number of groups in the result set).

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"
    }
  ]
}

Changes

  • ff9684af2aadRevision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • f17f5df4e79cRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status