Skip to content
Oclavex is in private preview, available to selected users. Public signup is blocked. Request access at [email protected].

Lists the devices pre-registered or blocked on the entitlement, with pagination, sorting, and filtering.

GET
/api/v1/provision/operational/entitlements/{entitlementId}/devices
curl --request GET \
--url 'https://example.com/api/v1/provision/operational/entitlements/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/devices?pageNumber=1&pageSize=100'
entitlementId
required
string format: uuid

The entitlement.

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

1-based page number to return.

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

Maximum number of items per page.

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 device the vendor listed on an entitlement: pre-registered, so an activation code that requires a pre-configured device admits it, or blocked, so no activation admits it.

object
id

The entry’s id, used to unblock or unregister the device.

string format: uuid
entitlementId

The entitlement the device is listed on.

string format: uuid
fingerprint

The device fingerprint the application sends when it activates.

string
deviceName

A name to recognize the device by.

null | string
isPreRegistered

The device may activate under an activation code that requires a pre-configured device.

boolean
isBlocked

The device may not activate this entitlement.

boolean
blockedAt

When the device was blocked; null while it is not blocked.

null | string format: date-time
lastActivatedAt

When the device last activated as a pre-registered device; null if it never did.

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