GET Method

The GET HTTPS method is used to read data or retrieve information about a resource.

For example, to retrieve a collection of all backup jobs, send the request of the following type:

GET https://<hostname>:<Port>/v8/Jobs

In case of success, the GET HTTPS method returns the HTTP response code 200 OK. In the response body, the method returns a representation of a resource.

Querying Objects

You can use request parameters to query objects that the server will return in response. Using query, you can do the following:

  • Filter results by defined criteria.

You can use wildcard characters * and ? when specifying values for the Name and displayName parameters.

  • Define pagination.

For more information about pagination, see Pagination.

Consider the following when using wildcard characters:

  • ABC* — returns all objects with the name or display name started with ABC.
  • ?ABC — returns all objects that contain the specified keyword with any symbol in the first position.

For example, to retrieve a collection of organization groups with the display name started with ABC, send the request of the following type:

GET https://abc.tech.local:4443/v8/Organizations/{organizationId}/Groups?limit=10&offset=19&displayName=ABC*

Page updated 8/8/2024

Page content applies to build 8.0.4.29