Make a GET request to this resource to retrieve a list of groups associated with the selected inventory.

The resulting data structure contains:

{
    "count": 99,
    "next": null,
    "previous": null,
    "results": [
        ...
    ]
}

The count field indicates the total number of groups found for the given query. The next and previous fields provides links to additional results if there are more than will fit on a single page. The results list contains zero or more group records.

Results

Each group data structure includes the following fields:

• id: Database ID for this group. (integer)
• type: Data type for this group. (choice)
• url: URL for this group. (string)
• related: Data structure with URLs of related resources. (object)
• summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
• created: Timestamp when this group was created. (datetime)
• modified: Timestamp when this group was last modified. (datetime)
• name: Name of this group. (string)
• description: Optional description of this group. (string)
• inventory: (id)
• variables: Group variables in JSON or YAML format. (json)

Sorting

To specify that groups are returned in a particular order, use the order_by query string parameter on the GET request.

?order_by=name

Prefix the field name with a dash - to sort in reverse:

?order_by=-name

Multiple sorting fields may be specified by separating the field names with a comma ,:

?order_by=name,some_other_field

Pagination

Use the page_size query string parameter to change the number of results returned for each request. Use the page query string parameter to retrieve a particular page of results.

?page_size=100&page=2

The previous and next links returned with the results will set these query string parameters automatically.

Searching

Use the search query string parameter to perform a case-insensitive search within all designated text fields of a model.

?search=findme

(Added in Oracle Linux Automation Manaer) Search across related fields:

?related__search=findme