latestOpenAPI 3.0.32026-08-10119559584.8 KB

6d091bc86a33

Attributes

Find attributes

Returns attributes 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. The returned attributes satisfy all constraints that are specified in this search criteria. By default a result containing 1000 attributes is returned.

For fetching large numbers of attributes or attributes of multiple assets consider using the async methods of Output Module REST API instead, which allow getting attributes for multiple assets 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.

get/attributes

Query parameters

offsetinteger

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.

limitinteger

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.

countLimitinteger

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.

cursorstring

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).

typeIdsstring[]

The list of IDs of the attribute types the found attributes should have, or null or empty if no type filtering should be applied.

assetIdstring uuid

The ID of the asset to find the attributes in, or null if no asset filtering should be applied.

sortOrder'ASC' | 'DESC'

The sorting order.

sortField'CREATED_BY' | 'CREATED_ON' | 'LAST_MODIFIED' | 'ID' required

The field on which the results are sorted.

typePublicIdsstring[]

The list of public IDs of the attribute types the found attributes should have, or null or empty if no type filtering should be applied.

Response

OK - The request has succeeded.

totalinteger

The total number of results. -1 when cursor pagination is used.

offsetinteger

The offset for the results. -1 when cursor pagination is used.

limitinteger

The maximum number of results to be returned.

nextCursorstring

Cursor value to be passed in next request to retrieve next page of results. Not returned on last page or when offset pagination is used.