Skip to content

Lists features on the entitlement, with pagination/sorting/filtering.

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

Target entitlement.

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

1-based page index.

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

Page size.

sortOrder
string

Optional sort expression.

filter
string

Optional filter expression.

OK

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 granted on a specific entitlement: the product feature definition plus the entitlement-level value, enablement, and expiration overrides.

object
id
string format: uuid
featureCode
string
productId
string format: uuid
moduleName
null | string
featurePath
null | string
name
string
description
null | string
value
null | string
version
null | string
isEnabled
boolean
isAvailableDuringTrialPeriod
boolean
isAvailableDuringGracePeriod
boolean
isPaidFeature

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

boolean
canModifyValueOnEntitlement

True when the product allows this feature’s value to be overridden per entitlement.

boolean
meteredAssetId

Monitored asset backing a metered feature; Guid.Empty when the feature is not metered.

string format: uuid
featureExpiration

When this individual feature stops being available; null follows the entitlement’s expiration.

null | string format: date-time
catalogLifecycleStatus
One of:
null
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

Not Found

object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string