List Software Releases

get/data-services/v1beta1/software-releases

List multiple Software Releases with filtering, sorting and pagination.

Filtering is supported on the softwareComponent/id and version properties using the eq, in, and and or operators. Sorting is supported on the id and version properties.

Securitybearer
Request
query Parameters
filter
string

An expression to filter list query results. Query result items that match the given filter are returned.

Expressions must be in the format <property> <operator> <value> or <value> <operator> <property>. The available operators are:

  • eq: Test whether a property's value is equal to a literal.
  • in: Test whether a property's value appears in a list of literals.

Literals can be:

  • GUIDs, such as ae09cc99-57e1-4f82-9d80-e68698da641b.
  • Strings, such as 'hello', 'world'.

Expressions can also be joined using the and and or logical operators.

Examples:
filter=softwareComponent/id eq '2f01f86f-4600-4f92-9f72-885b5f7b01c4'
filter=version in ('1.0.0', '1.1.0', '1.2.0')
filter=version eq '1.0.0' or version eq '1.1.0'
filter=softwareComponent/id eq '2f01f86f-4600-4f92-9f72-885b5f7b01c4' and version in ('1.0.0', '1.1.0', '1.2.0')
limit
integer [ 0 .. 100 ]
Default: 100

The number of query results to return. Use limit in conjuction with offset for paging.

Examples:
limit=0
limit=100
offset
integer >= 0
Default: 0

The offset to use for paging through the result set. Use offset in conjunction with limit for paging.

Examples:
offset=0
offset=500
select
Array of strings

Comma separated properties to return in the result. If omitted, all properties will be returned. This is applied to sub-properties of the objects in the items array. Selecting nested properties of an object is not supported.

Examples:
select=id
select=id,name,createdAt,updatedAt,generation
sort
string
Default: "id asc"

One or more properties and directions to sort query results by. A direction is optional and can be either asc or desc for ascending and descending order respectively. If the direction is omitted it defaults to asc.

Examples:
sort=id asc
sort=version desc
sort=version
sort=id asc,version asc
sort=id asc,version desc
Responses
200

A list of Software Releases.

400

Returned when a bad request is provided.

401

Returned when the required authentication was missing or malformed.

500

Returned when an unexpected internal error occurred.

503

Returned when the service was temporarily unavailable to complete the request.

Request samples 
Response samples 
application/json
{
  • "count": 1,
  • "items": [
    ],
  • "offset": 0,
  • "total": 1
}