Shopware icon

Shopware

Shopware

Actions778

Acl Role → Search Acl Role

AI-generated

Overview

This node performs a search operation for ACL (Access Control List) roles within the Shopware system. It allows users to query and retrieve ACL role data based on various search parameters such as pagination, filtering, sorting, and field selection. This is useful for scenarios where you need to manage or audit user permissions and roles programmatically, for example, fetching a list of roles with specific attributes or filtering roles based on certain criteria.

Use Case Examples

  1. Retrieve a paginated list of ACL roles with a limit of 10 roles per page.
  2. Search ACL roles using specific filters to find roles with certain permissions.
  3. Sort ACL roles by name or creation date.
  4. Fetch only specific fields of ACL roles to optimize data transfer.

Properties

Name Meaning
Page The page number of the search results to retrieve, used for pagination.
Limit The number of items to return per page in the search results.
Filter A JSON array of filters to restrict the search results based on specific criteria.
Sort A JSON array defining the sorting order of the search results.
Post Filter A JSON array of filters applied after aggregations, which do not affect aggregation results.
Associations A JSON object defining related entities to include in the search results.
Aggregations A JSON array defining aggregations to perform on the search results.
Grouping A JSON array defining groupings over certain fields in the search results.
Fields A JSON array specifying which fields should be returned in the search results.
Total Count Mode Option to determine how the total number of hits is calculated: none (disabled), exact (slow but accurate), or next-pages (fast for next page only).
Ids A JSON array of specific IDs to search for.
Includes A JSON object specifying fields to be returned for given entities, used to control the response content.
Request Options Settings for request behavior such as batching, SSL certificate validation, proxy usage, and timeout.

Output

JSON

  • data - The array of ACL role objects returned from the search query.
  • total - The total number of ACL roles matching the search criteria, if total count mode is enabled.
  • aggregations - Aggregation results based on the search query, if aggregations are requested.

Dependencies

  • An API key credential for authenticating with the Shopware Admin API

Troubleshooting

  • Ensure the API credentials are correctly configured and have the necessary permissions to access ACL role data.
  • Verify that JSON inputs for filters, sorting, and other parameters are correctly formatted to avoid parsing errors.
  • If the total count mode is set to 'exact', be aware that the query might be slower due to the calculation of the exact total number of hits.
  • Check network settings such as proxy and SSL options if requests fail due to connectivity issues.

Links

Discussion