Chapter 6. Filtering in the API
Chapter 6. Filtering in the API The system recognizes a collection as a "queryset". You can filter this by using various operators. Procedure To find groups that contain the name "foo", use the following: http://<controller server name>/api/v2/groups/?name__contains=foo To find an exact match, use the following: http://<controller server name>/api/v2/groups/?name=foo If a resource is of an integer type, you must add \_\_int to the end to cast your string input value to an integer, such as the following: http://<controller server name>/api/v2/arbitrary_resource/?x__int=5 You can query related resources with the following: http://<controller server name>/api/v2/users/?first_name__icontains=kim This returns all users with names that include the string "Kim" in them. You can also filter against many fields at once: http://<controller server name>/api/v2/groups/?name__icontains=test&has_active_failures=false This finds all groups containing the name "test" that have no active failures. Additional resources For more information about what types of operators are available, see QuerySet API reference . Note You can also watch the API as the UI is being used to see how it is filtering on various criteria. 6.1. Advanced queries in the API You can use additional query string parameters used to filter the list of results returned to those matching a given value. You can only use fields and relations that exist in the database for filtering. Ensure that any special characters in the specified value are URL-encoded. For example: ?field=value%20xyz Fields can also span relations, only for fields and relationships defined in the database: ?other__field=value To exclude results matching certain criteria, prefix the field parameter with not__ : ?not__field=value By default, all query string filters are AND'ed together, so only the results matching all filters are returned. To combine results matching any one of multiple criteria, prefix each query string parameter with or__ : ?or__field=value&or__field=othervalue ?or__not__field=value&or__field=othervalue The default AND filtering applies all filters simultaneously to each related object being filtered across database relationships. The chain filter instead applies filters separately for each related object. To use this, prefix the query string parameter with chain__ : ?chain__related__field=value&chain__related__field2=othervalue ?chain__not__related__field=value&chain__related__field2=othervalue If you write the first query as ?related field=value&related field2=othervalue , it returns only the primary objects where the same related object satisfied both conditions. As written by using the chain filter, it would return the intersection of primary objects matching each condition. 6.2. Field lookups You can use field lookups for more advanced queries, by appending the lookup to the field name: ?field__lookup=value The following field lookups are supported: exact: Exact match (default lookup if not specified, see the following note for more information). iexact: Case-insensitive version of exact. contains: Field contains value. icontains: Case-insensitive version of contains. startswith: Field starts with value. istartswith: Case-insensitive version of startswith. endswith: Field ends with value. iendswith: Case-insensitive version of endswith. regex: Field matches the given regular expression. iregex: Case-insensitive version of regular expression. gt: Greater than comparison. gte: Greater than or equal to comparison. lt: Less than comparison. lte: Less than or equal to comparison. isnull: Check whether the given field or related object is null; expects a boolean value. in: Check whether the given field's value is present in the list provided; expects a list of items. You can specify boolean values as True or 1 for true, False or 0 for false (both case-insensitive). For example, ?created__gte=2023-01-01 provides a list of items created after 1/1/2023. You can specify null values as None or Null (both case-insensitive), though we recommend using the isnull lookup to explicitly check for null values. You can specify lists (for the in lookup) as a comma-separated list of values. Filtering based on the requesting user's level of access by query string parameter: role_level : Level of role to filter on, such as admin_role Note Earlier releases of Ansible Automation Platform returned queries with _exact results by default. As a workaround, set the limit to ?limit_exact for the default filter. For example, /api/v2/jobs/?limit_exact=example.domain.com results in: { "count": 1, "": null, "": null, "results": [ ...
http://<controller server name>/api/v2/groups/?name__contains=foo http://<controller server name>/api/v2/groups/?name=foo http://<controller server name>/api/v2/arbitrary_resource/?x__int=5 http://<controller server name>/api/v2/users/?first_name__icontains=kim http://<controller server name>/api/v2/groups/?name__icontains=test&has_active_failures=false ?field=value%20xyz ?other__field=value ?not__field=value ?or__field=value&or__field=othervalue ?or__not__field=value&or__field=othervalue ?chain__related__field=value&chain__related__field2=othervalue ?chain__not__related__field=value&chain__related__field2=othervalue ?field__lookup=value { "count": 1, "next": null, "previous": null, "results": [