6d091bc86a33
Find assets
Returns assets matching the given search criteria. Only parameters that are specified in this request and have not null values are used for filtering. All other parameters are ignored. By default a result containing 1000 assets is returned.
For fetching large numbers of assets consider using the async methods of Output Module REST API instead, which allow fetching all needed data in one call and eliminate the risk of timing out. Additionally, consider the CSV endpoint of the Output Module REST API for particularly large result sets, as it's more memory efficient.
Searching for assets by name can be slow so check the Search REST API and the Knowledge Graph API for alternatives if applicable to your use case, as the Search API returns only a subset of asset fields that are available here.
Query parameters
The first result to retrieve. If not set (offset = <code>0</code>), results will be retrieved starting from row <code>0</code>. Cursor should be preferred over offset for better performance and stable results. It is forbidden to use both in the same request.
The maximum number of results to retrieve. If not set (limit = <code>0</code>), the default limit will be used. The maximum allowed limit is 1000.
Allows to limit the number of elements that will be counted. -1 will count everything and 0 will cause the count to be skipped. For cursor pagination this parameter is ignored and count is skipped.
Cursor for the current page of results. To retrieve the first page with cursor pagination you need to pass this parameter with an empty value (must be non-null). For the next pages, the value must be taken from the response (<code>nextCursor</code> property).
The name of the asset to search for (either display name or full name).
The match mode used to compare <code>name</code>. If the match mode is <code>EXACT</code> the search is case-sensitive, otherwise the search is case-insensitive.
The ID of the domain to find the assets in.
The ID of the community to find the assets in.
The list of IDs of the asset types. The returned assets are of one of types specified by this parameter.
The list of IDs of the asset public types. The returned assets are of one of types specified by this parameter.
The list of IDs of the asset types. The returned assets are of one of types specified by this parameter. Deprecated in favour of 'typeIds'
The list of IDs of the statuses. The returned assets have one of statuses specified by this parameter.
The list of IDs of the statuses. The returned assets have one of statuses specified by this parameter. Deprecated in favour of 'statusIds'.
The list of names of tags. The returned assets have one of tags with names specified by this parameter.
Whether the type inheritance for the asset type filtering should be applied or not.
The exclude meta flag. If this is set to true then the assets from meta domains will not be returned (meta domains are the domains which were not created by the user manually).
The field on which the results are sorted.
The sorting order.
Response
OK - The request has succeeded.