Get all entitlement plans
get
/crmRestApi/resources/11.13.18.05/subscriptionEntitlementPlans
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- EntitlementPlanAltKey Finds the subscription entitlement plans with the specified alternate key.
Finder Variables- EntitlementPlanNumber; string; The unique entitlement plan number of the subscription entitlement plans for entitlement plan alternate key.
- PrimaryKey Finds the subscription entitlement plans with the specified primary key.
Finder Variables- EntitlementPlanId; integer; The unique entitlement plan identifier of the subscription entitlement plans used to find it.
- EntitlementPlanAltKey Finds the subscription entitlement plans with the specified alternate key.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- BalanceProfileId; integer; The balance profile identifier of the subscription entitlement plan.
- BalanceProfileName; string; The balance profile name of the subscription entitlement plan.
- BalanceProfileNumber; string; The balance profile number of the subscription entitlement plan.
- CreatedBy; string; The user who created the subscription entitlement plan.
- CreationDate; string; The date of creation of the subscription entitlement plan.
- EntitlementPlanDescription; string; The description of the subscription entitlement plan.
- EntitlementPlanId; integer; The unique identifier of the subscription entitlement plan.
- EntitlementPlanName; string; The unique name of the subscription entitlement plan.
- EntitlementPlanNumber; string; The unique number of the subscription entitlement plan.
- EntitlementPlanStatus; string; The status of the subscription entitlement plan.
- EventType; string; The type of the event.
- EventTypeId; integer; The unique identifier of the event of an event type.
- LastUpdateDate; string; The date when the subscription entitlement plan was last updated.
- LastUpdateLogin; string; The login of the user who last updated the subscription entitlement plan.
- LastUpdatedBy; string; The user who has last updated the subscription entitlement plan.
- ObjectVersionNumber; integer; The version number of subscription entitlement plan.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : subscriptionEntitlementPlans
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionEntitlementPlans-item-response
Type:
Show Source
object
-
BalanceProfileId: integer
(int64)
The balance profile identifier of the subscription entitlement plan.
-
BalanceProfileName: string
Title:
Name
Maximum Length:120
The balance profile name of the subscription entitlement plan. -
BalanceProfileNumber: string
Title:
Number
Maximum Length:120
The balance profile number of the subscription entitlement plan. -
commitments: array
Subscription Entitlement Plan Commitments
Title:
Subscription Entitlement Plan Commitments
The commitments resource is used to create a entitlement plan based on commitments. These records can be created only for those balance codes which have the commitment flag enabled. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the subscription entitlement plan. -
CreationDate: string
(date-time)
Read Only:
true
The date of creation of the subscription entitlement plan. -
EntitlementPlanDescription: string
Title:
Description
Maximum Length:300
The description of the subscription entitlement plan. -
EntitlementPlanId: integer
(int64)
The unique identifier of the subscription entitlement plan.
-
EntitlementPlanName: string
Title:
Name
Maximum Length:120
The unique name of the subscription entitlement plan. -
EntitlementPlanNumber: string
Title:
Number
Maximum Length:120
The unique number of the subscription entitlement plan. -
EntitlementPlanStatus: string
Title:
Status
Maximum Length:30
Default Value:ORA_OSS_DRAFT
The status of the subscription entitlement plan. -
estimates: array
Subscription Entitlement Plan Estimates
Title:
Subscription Entitlement Plan Estimates
The estimates resource is used to create a entitlement plan based on estimates. These records can be created only for those balance codes which have the estimates flag enabled. -
EventType: string
Title:
Event Type
Maximum Length:30
The type of the event. -
EventTypeId: integer
(int64)
The unique identifier of the event of an event type.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the subscription entitlement plan was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who has last updated the subscription entitlement plan. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the subscription entitlement plan. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
The version number of subscription entitlement plan.
-
subscriptionEntitlementPlanDetails: array
Subscription Entitlement Plan Details
Title:
Subscription Entitlement Plan Details
The subscription entitlement plan details resource is used to view, create, update, and delete an entitlement plan detail.
Nested Schema : Subscription Entitlement Plan Commitments
Type:
array
Title:
Subscription Entitlement Plan Commitments
The commitments resource is used to create a entitlement plan based on commitments. These records can be created only for those balance codes which have the commitment flag enabled.
Show Source
Nested Schema : Subscription Entitlement Plan Estimates
Type:
array
Title:
Subscription Entitlement Plan Estimates
The estimates resource is used to create a entitlement plan based on estimates. These records can be created only for those balance codes which have the estimates flag enabled.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Subscription Entitlement Plan Details
Type:
array
Title:
Subscription Entitlement Plan Details
The subscription entitlement plan details resource is used to view, create, update, and delete an entitlement plan detail.
Show Source
Nested Schema : subscriptionEntitlementPlans-commitments-item-response
Type:
Show Source
object
-
Amount: number
Title:
Amount
The amount of the subscription entitlement plan commitments. -
BalanceCode: string
Title:
Balance Code
Maximum Length:30
The balance code of the subscription entitlement plan commitments. -
BalanceCodeId: integer
(int64)
The unique identifier of balance code of the subscription entitlement plan commitments.
-
ChargeDefinitionCode: string
Maximum Length:
30
The charge definition code of the subscription entitlement plan commitments. -
ChargeDefinitionId: integer
(int64)
The unique identifier of charge definition of the subscription entitlement plan commitments.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the subscription entitlement plan commitments. -
CreationDate: string
(date-time)
Read Only:
true
The date of creation of the subscription entitlement plan commitments. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The currency code of the subscription entitlement plan commitments. -
EntitlementPlanCommitmentId: integer
(int64)
The unique identifier of entitlement plan commitments.
-
EntitlementPlanCommitmentNumber: string
Maximum Length:
120
The unique number of entitlement plan commitments. -
EntitlementPlanId: integer
(int64)
The unique identifier of entitlement plan of the subscription entitlement plan commitments.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the subscription entitlement plan commitments was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the subscription entitlement plan commitments. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the subscription entitlement plan commitments. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
The version number of the subscription entitlement plan commitments. -
Period: string
Title:
Periodicity
The period of the subscription entitlement plan commitments. -
Quantity: number
Title:
Quantity
The quantity of the subscription entitlement plan commitments. -
RelatedChargeDefinitionCode: string
Maximum Length:
30
The charge definition code of the related charge identifier. -
RelatedChargeDefinitionId: integer
(int64)
The unique identifier of charge definition of the related charge.
-
RelatedPeriod: string
Title:
Related Charge Periodicity
The related period of the related charge. Indicates the related charge name from which the estimates or commitments are granted. -
RoundedQuantity: number
Title:
Rounded Quantity
The rounded quantity of the subscription entitlement plan commitments. -
SubscriptionProductId: integer
(int64)
The unique identifier of subscription product of the subscription entitlement plan commitments.
-
UnitOfMeasure: string
Title:
UOM
Maximum Length:3
The unit of measure of the subscription entitlement plan commitments.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : subscriptionEntitlementPlans-estimates-item-response
Type:
Show Source
object
-
Amount: number
Title:
Amount
The amount of the subscription entitlement plan estimates. -
BalanceCode: string
Title:
Balance Code
Maximum Length:30
The balance code of the subscription entitlement plan estimates. -
BalanceCodeId: integer
(int64)
The unique identifier of balance code of the subscription entitlement plan estimates.
-
ChargeDefinitionCode: string
Maximum Length:
30
The charge definition code of the subscription entitlement plan estimates. -
ChargeDefinitionId: integer
(int64)
The unique identifier of charge definition of the subscription entitlement plan estimates.
-
ChargePeriod: string
Title:
Estimate Period
The estimate period of the subscription entitlement plan estimates. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the subscription entitlement plan estimates. -
CreationDate: string
(date-time)
Read Only:
true
The date when the subscription entitlement plan estimates was created. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The currency code of the subscription entitlement plan estimates. -
EnableRolloverFlag: boolean
Title:
Enable rollover
Maximum Length:1
Default Value:false
Indicates whether the rollover is enabled for the subscription entitlement plan estimates. -
EntitlementPlanEstimateId: integer
(int64)
The unique identifier of the subscription entitlement plan estimates.
-
EntitlementPlanEstimateNumber: string
Maximum Length:
120
The unique number of entitlement plan estimates. -
EntitlementPlanId: integer
(int64)
The unique identifier of entitlement plan of the subscription entitlement plan estimates.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the subscription entitlement plan estimates was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who has last updated the subscription entitlement plan estimates. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the subscription entitlement plan estimates. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
The version number of the subscription entitlement plan estimates. -
Period: string
Title:
Periodicity
The period of the subscription entitlement plan estimates. -
Quantity: number
Title:
Quantity
The quantity of the subscription entitlement plan estimates. -
RelatedChargeDefinitionCode: string
Maximum Length:
30
The charge definition code of the related charge identifier. -
RelatedChargeDefinitionId: integer
(int64)
The unique identifier of charge definition of the related charge.
-
RelatedPeriod: string
Title:
Related Charge Periodicity
The related period of the related charge. Indicates the related charge name from which the estimates or commitments are granted. -
RolloverPeriod: integer
Title:
Rollover Period
The rollover period of the subscription entitlement plan estimates. -
RolloverPeriodUnitOfMeasure: string
Title:
Rollover Period UOM
Maximum Length:3
The rollover period unit of measure of the subscription entitlement plan estimates. -
RoundedQuantity: number
Title:
Rounded Quantity
The rounded quantity of the subscription entitlement plan estimates. -
SubscriptionProductId: integer
(int64)
The unique identifier of subscription product of the subscription entitlement plan estimates.
-
TrueupOverageFlag: boolean
Title:
True-up overage
Maximum Length:1
Default Value:true
Indicates whether a overage is enabled for a given usage charge. -
TrueupShortageFlag: boolean
Title:
True-up shortage
Maximum Length:1
Default Value:true
Indicates whether a shortage is enabled for a given usage charge. -
UnitOfMeasure: string
Title:
UOM
Maximum Length:3
The unit of measure of the subscription entitlement plan estimates.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionEntitlementPlans-subscriptionEntitlementPlanDetails-item-response
Type:
Show Source
object
-
AllowancePeriodicity: string
Title:
Periodicity
Maximum Length:30
The periodicity factor of allowance under subscription entitlement plan details. -
AllowanceQuantity: number
Title:
Quantity
The allowance quantity under subscription entitlement plan details. -
AllowanceRolloverPeriod: integer
Title:
Rollover Period
The allowance rollover period under subscription entitlement plan details. -
AllowanceRolloverPeriodUnitOfMeasure: string
Title:
Rollover Period UOM
Maximum Length:3
The unit of measure of allowance rollover under subscription entitlement plan details. -
AllowanceUnitOfMeasure: string
Title:
UOM
Maximum Length:3
The unit of measure of allowance under subscription entitlement plan details. -
AllowanceValidityPeriod: integer
Title:
Validity Period
The allowance validity period under subscription entitlement plan details. -
AllowanceValidityPeriodUnitOfMeasure: string
Title:
Validity Period UOM
Maximum Length:3
The unit of measure of allowance validity under subscription entitlement plan details. -
Amount: number
Title:
Amount
The amount under subscription entitlement plan details. -
BalanceCode: string
Title:
Balance Code
Maximum Length:30
The balance code of subscription entitlement plan details. -
BalanceCodeDescription: string
Title:
Name
Read Only:true
Maximum Length:120
The description of balance code under subscription entitlement plan details. -
BalanceCodeId: integer
(int64)
The unique identifier of balance code under subscription entitlement plan details.
-
ChargeDefinitionCode: string
Maximum Length:
30
The charge definition code under subscription entitlement plan details. -
ChargeDefinitionId: integer
(int64)
The unique identifier for charge definition under subscription entitlement plan details.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the subscription entitlement plan details. -
CreationDate: string
(date-time)
Read Only:
true
The date of creation of the subscription entitlement plan details. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code of amount type balance code under subscription entitlement plan details. -
EntitlementPlanDetailId: integer
(int64)
The unique identifier of subscription entitlement plan details.
-
EntitlementPlanDetailNumber: string
Maximum Length:
120
The unique number of subscription entitlement plan details. -
EntitlementPlanId: integer
(int64)
The unique identifier of subscription entitlement plan.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the subscription entitlement plan details was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who has last updated the subscription entitlement plan details. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the subscription entitlement plan details. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
The version number of subscription entitlement plan details.
-
PrecisionFactor: number
Title:
Rounding Factor
Read Only:true
The precision factor of subscription entitlement plan details. -
PrecisionType: string
Title:
Rounding Type
Read Only:true
Maximum Length:30
The precision type of subscription entitlement plan details. -
SubscriptionProductId: integer
(int64)
The subscription product identifier of subscription entitlement plan details.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source