Retrieve an entitlement
GET /accounts/{account_id}/core/v1/entitlements/{entitlement_id}
Returns the stored Entitlement API resource in the JSON response body.
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
account_id |
string |
path |
True |
ID of the containing account resource
|
entitlement_id |
string |
path |
True |
ID of the entitlement collection to list |
Response
Status: 200, Returns the stored Entitlement API resource in the JSON response body.
Name | Type | Required | Description |
---|---|---|---|
type |
string |
True |
Media type of the resource. Defined values are:
|
version |
string |
True |
Version of the resource. Defined values are:
|
id |
string |
True |
Globally unique identifier of the resource. Defined values are:
|
allocation |
string |
False |
JSON string containing the ID of the object that the entitlement is allocated to. Only present when the entitlement is allocated. String contents not validated by the schema. |
product |
string |
False |
JSON string containing the product string extracted from the license or subscription. String contents not validated by the schema. |
productVersion |
string |
False |
JSON string containing the version string extracted from the license or subscription. String contents not validated by the schema. |
entitlementType |
string |
True |
JSON string containing the type of the entitlement. This is extracted from the license or subscription. String contents not validated by the schema. |
entitlementValue |
string |
True |
JSON string containing the capacity associated with the entitlement. String contents not validated by the schema. |
entitlementConsumption |
string |
False |
JSON string containing the amount of the capacity associated with the entitlement that is currently in use. String contents not validated by the schema. |
sourceLicense |
string |
False |
JSON string containing the license object ID that the entitlement is sourced from. Defined values are:
|
sourceSubscription |
string |
False |
JSON string containing the ID of the subscription object that the entitlement is sourced from. Defined values are:
|
validFromTimestamp |
string |
False |
JSON string containing a timestamp indicating when the entitlement becomes valid. Defined values are:
|
validUntilTimestamp |
string |
False |
JSON string containing a timestamp indicating when the entitlement is no longer valid. Defined values are:
|
metadata |
True |
Client and service-specified metadata associated with the resource. Defined values are:
|
Example response
Response
Status: 401, Unauthorized
Name | Type | Required | Description |
---|---|---|---|
type |
string |
True |
|
title |
string |
True |
|
detail |
string |
False |
|
status |
string |
True |
|
correlationID |
string |
False |
Example response
Response
Status: 400, Bad request
Name | Type | Required | Description |
---|---|---|---|
type |
string |
True |
|
title |
string |
True |
|
detail |
string |
False |
|
status |
string |
True |
|
correlationID |
string |
False |
|
invalidParams |
array[invalidParams] |
False |
List of invalid query parameters |
Example response
Response
Status: 403, Forbidden
Name | Type | Required | Description |
---|---|---|---|
type |
string |
True |
|
title |
string |
True |
|
detail |
string |
False |
|
status |
string |
True |
|
correlationID |
string |
False |
Example response
Error
Status: 404, Not found
Name | Type | Required | Description |
---|---|---|---|
type |
string |
True |
|
title |
string |
True |
|
detail |
string |
False |
|
status |
string |
True |
|
correlationID |
string |
False |
Example error response
Definitions
See Definitions
type_astra_label
Name | Type | Required | Description |
---|---|---|---|
name |
string |
True |
|
value |
string |
True |
type_astra_metadata
Client and service-specified metadata associated with the resource. Defined values are:
-
Conforms to the Astra Metadata Schema
Name | Type | Required | Description |
---|---|---|---|
labels |
array[type_astra_label] |
True |
|
creationTimestamp |
string |
True |
|
modificationTimestamp |
string |
True |
|
createdBy |
string |
True |
|
modifiedBy |
string |
False |
invalidParams
Name | Type | Required | Description |
---|---|---|---|
name |
string |
True |
Name of the invalid query parameter |
reason |
string |
True |
Reason why the query parameter is invalid |