Skip to content

Lists features of a product with pagination, sorting, and filtering options.

GET
/api/v1/provision/admin/products/{productId}/features
curl --request GET \
--url https://example.com/api/v1/provision/admin/products/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/features
productId
required
string format: uuid

The unique identifier of the product.

pageNumber
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/

The page number to retrieve.

pageSize
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/

The number of items per page.

sortOrder
string

The sort order of the items.

filter
string

The filter criteria for the items.

Returns a paginated list of product features.

Serializable IPaginatedList<T> implementation used to deserialize paged API responses. int PaginatedListDto<T>.TotalPages, bool PaginatedListDto<T>.HasPreviousPage, and bool PaginatedListDto<T>.HasNextPage are computed from the other properties.

object
pageNumber

The 1-based index of this page within the full result set.

integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
pageSize

The maximum number of items per page that was requested.

integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
totalCount

The total number of items across all pages.

integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
items

The items on this page.

Array<object>

A feature as defined on a product: default value, enablement, trial/grace availability, license-token inclusion, and metering configuration. Entitlements inherit these defaults.

object
id
string format: uuid
featureCatalogId
null | string format: uuid
featureCode
string
featurePath
null | string
moduleName
null | string
name
string
description
null | string
usageMetric
null | string
units
null | string
featureType

Data type of a feature’s value; determines how Value strings are interpreted and enforced.

Allowed values: Boolean Numeric Text Enumeration Metered JsonField
enumOptions
Array<object>

One allowed value of an Enumeration-typed feature.

object
value
string
description
null | string
value
null | string
version
null | string
isEnabled
boolean
includeInLicenseToken
boolean
isAvailableDuringTrialPeriod
boolean
isAvailableDuringGracePeriod
boolean
isPaidFeature

When true, the feature is withheld for the duration of a trial even if enabled.

boolean
canModifyValueOnEntitlement
boolean
meterAggregationType
One of:
null
visibility

Who can see a feature.

Allowed values: Public Internal
sortOrder

Where the feature appears among the product’s features. The vendor sets it; every list of a product’s features is ordered by it, so the screens agree with each other.

integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
isDeleted
boolean
creationTimeStamp
string format: date-time
lastUpdateTimeStamp
null | string format: date-time
revisionNumber
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
totalPages

The total number of pages, computed from int PaginatedListDto<T>.TotalCount and int PaginatedListDto<T>.PageSize; 0 when int PaginatedListDto<T>.PageSize is not positive.

integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
hasPreviousPage

Whether a page precedes this one (int PaginatedListDto<T>.PageNumber is greater than 1).

boolean
hasNextPage

Whether a page follows this one (int PaginatedListDto<T>.PageNumber is less than int PaginatedListDto<T>.TotalPages).

boolean