Update an entitlement
patch
https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/entitlement/{id}
Updates the n entitlement that matches the specified ID using the supplied request payload.
Request
Path Parameters
-
id(required): string
The ID of the resource item.
Supported Media Types
- application/json
Root Schema : EntitlementOracle
Type:
objectTitle:
EntitlementOracleThe entitlement resource.
Show Source
-
@baseType: string
The base type of the entitlement.
-
@schemaLocation: string
The URI of the schema that defines the entitlement.
-
@type: string
The class type of the entitlement.
-
associatedProducts(required): array
associatedProducts
A list of associated products associated with the entitlement.
-
benefits: array
benefits
A list of benefits associated with the entitlement.
-
created: string
(date-time)
The date and time of the creation.
-
createdBy: string
The name of the person who created item.
-
description: string
The description of entitlement.
-
entitlementType: string
Allowed Values:
[ "ENTITLEMENT_PRICING", "ENTITLEMENT_SERVICE" ]The type or classification of the entitlement. Valid values are ENTITLEMENT_PRICING, and ENTITLEMENT_SERVICE. -
href: string
The hyperlink reference to the entitlement.
-
id: string
Maximum Length:
30The ID of the entitlement. -
lastUpdate: string
(date-time)
The date and time when the entitlement was last updated.
-
lastUpdatedBy: string
The name of the person who updated item.
-
lifecycleStatus: string
The status of the entitlement.
-
metrics: array
metrics
A list of metrics associated with the entitlement.
-
name: string
The name of the entitlement.
-
pricelist: array
pricelist
A list of pricelists associated with the entitlement.
-
priority: number
The priority of this entitlement in relation to other entitlement associatedto the project.
-
project: object
ProjectRef
Title:
ProjectRefThe project reference resource. -
quantity: object
EntitlementQuantityOracle
Title:
EntitlementQuantityOracleA number and unit representing entitlement unit. -
validFor: object
TimePeriod
Title:
TimePeriodThe period for which the productOffering is valid. -
version: string
The promotion version.
-
versionState: number
The version state of the entitlement.
Nested Schema : associatedProducts
Type:
arrayA list of associated products associated with the entitlement.
Show Source
-
Array of:
object AssociatedProductsEntitlementsOracle
Title:
AssociatedProductsEntitlementsOracleThe products which are associated to entitlement, benefit or conditions.
Nested Schema : benefits
Type:
arrayA list of benefits associated with the entitlement.
Show Source
-
Array of:
object EntitlementsBenefitsOracle
Title:
EntitlementsBenefitsOracleThe entitlement benefits.
Nested Schema : metrics
Type:
arrayA list of metrics associated with the entitlement.
Show Source
-
Array of:
object EntitlementMetricsOracle
Title:
EntitlementMetricsOracleThe entitlement metric resource.
Nested Schema : pricelist
Type:
arrayA list of pricelists associated with the entitlement.
Show Source
-
Array of:
object PriceListRefOracle
Title:
PriceListRefOracleThe pricelist reference.
Nested Schema : ProjectRef
Type:
objectTitle:
ProjectRefThe project reference resource.
Show Source
-
href: string
The hyperlink reference to the project reference.
-
id(required): string
The ID of the project reference.
-
name: string
The name of the project reference.
-
version: string
The version of the project.
Nested Schema : EntitlementQuantityOracle
Type:
objectTitle:
EntitlementQuantityOracleA number and unit representing entitlement unit.
Show Source
-
amount(required): number
A quantity of something, typically the total of a thing or things in number.
-
units(required): string
Allowed Values:
[ "ENTL_UNIT_ORDERS", "ENTL_UNIT_SERREQ" ]The unit of measure for the quantity. Valid values are ENTL_UNIT_ORDERS, and ENTL_UNIT_SERREQ.
Nested Schema : TimePeriod
Type:
objectTitle:
TimePeriodThe period for which the productOffering is valid.
Show Source
-
endDateTime: string
(date-time)
The end date and time of the time period.
-
startDateTime: string
(date-time)
The start date and time of the time period.
Nested Schema : AssociatedProductsEntitlementsOracle
Type:
objectTitle:
AssociatedProductsEntitlementsOracleThe products which are associated to entitlement, benefit or conditions.
Show Source
-
@baseType: string
The base type of the associated products entitlement.
-
@referredType: string
The type of the referred associated products entitlement.
-
@schemaLocation: string
The URI of the schema that defines the associated products entitlement.
-
@type: string
The class type of the associated products entitlement.
-
actionObjectType: string
Allowed Values:
[ "PRODUCT_OFFERING", "PRODUCT_OFFERING_PRICE", "PRODUCTLINE", "CATEGORY", "PRODUCT_SPECIFICATION" ]The type or classification of the associated products entitlement. Valid values are PRODUCT_OFFERING, PRODUCT_OFFERING_PRICE, PRODUCTLINE, CATEGORY, and PRODUCT_SPECIFICATION. -
id(required): string
The ID of the associated products entitlement.
-
name: string
The name of the associated products entitlement.
Nested Schema : EntitlementsBenefitsOracle
Type:
objectTitle:
EntitlementsBenefitsOracleThe entitlement benefits.
Show Source
-
@baseType: string
The base type of the entitlements benefit.
-
@schemaLocation: string
The URI of the schema that defines the entitlements benefit.
-
@type: string
The class type of the entitlements benefit.
-
benefitType: string
Allowed Values:
[ "ENTL_BFT_TYP_DSNT" ]The type or classification of the entitlements benefit. Valid values are ENTL_BFT_TYP_DSNT. -
description: string
The description of entitlements benefit.
-
entitlementConditionsGroup: array
entitlementConditionsGroup
A list of entitlement conditions groups associated with the entitlements benefit.
-
id: string
Maximum Length:
30The ID of the entitlements benefit. -
name: string
The name of the entitlements benefit.
-
priority: number
The piority of this benifit.
-
productOfferingPrice(required): array
productOfferingPrice
A list of product offering prices associated with the entitlements benefit.
-
products(required): array
products
A list of products associated with the entitlements benefit.
-
relationShipAmongGroup: string
Allowed Values:
[ "ENTL_BFT_CND_REL_ALL", "ENTL_BFT_CND_REL_ANY" ]The condition relationship for the benfit. Valid values are ENTL_BFT_CND_REL_ALL, and ENTL_BFT_CND_REL_ANY. -
schedule: string
Allowed Values:
[ "ENTL_BFT_SCDL_MNTLY", "ENTL_BFT_SCDL_ANLY", "ENTL_BFT_SCDL_ASINRD", "ENTL_BFT_SCDL_BIANLY", "ENTL_BFT_SCDL_CTRTRM", "ENTL_BFT_SCDL_CTRYR", "ENTL_BFT_SCDL_QRTLY", "ENTL_BFT_SCDL_WEKLY" ]The allows to define the benifit schedule. Valid values are ENTL_BFT_SCDL_MNTLY, ENTL_BFT_SCDL_ANLY, ENTL_BFT_SCDL_ASINRD, ENTL_BFT_SCDL_BIANLY, ENTL_BFT_SCDL_CTRTRM, ENTL_BFT_SCDL_CTRYR, ENTL_BFT_SCDL_QRTLY, and ENTL_BFT_SCDL_WEKLY. -
status: string
Allowed Values:
[ "ENTL_BFT_STS_ACTV", "ENTL_BFT_STS_CNCLD", "ENTL_BFT_STS_EXHSTD", "ENTL_BFT_STS_NEW", "ENTL_BFT_STS_ONHOLD" ]The status of the entitlements benefit.
Nested Schema : entitlementConditionsGroup
Type:
arrayA list of entitlement conditions groups associated with the entitlements benefit.
Show Source
-
Array of:
object EntitlementConditionsGroupOracle
Title:
EntitlementConditionsGroupOracleThe group of the condition for the entitlement.The logical relationship between different groups is decided by the ???relationTypeInGroup???.
Nested Schema : productOfferingPrice
Type:
arrayA list of product offering prices associated with the entitlements benefit.
Show Source
-
Array of:
ProductOfferingPriceRefOracle
Title:
ProductOfferingPriceRefOracle
Nested Schema : products
Type:
arrayA list of products associated with the entitlements benefit.
Show Source
-
Array of:
object AssociatedProductsEntitlementsOracle
Title:
AssociatedProductsEntitlementsOracleThe products which are associated to entitlement, benefit or conditions.
Nested Schema : EntitlementConditionsGroupOracle
Type:
objectTitle:
EntitlementConditionsGroupOracleThe group of the condition for the entitlement.The logical relationship between different groups is decided by the ???relationTypeInGroup???.
Show Source
-
@baseType: string
The base type of the entitlement conditions group.
-
@schemaLocation: string
The URI of the schema that defines the entitlement conditions group.
-
@type: string
The class type of the entitlement conditions group.
-
condition: array
condition
A list of conditions associated with the entitlement conditions group.
-
conditionTiming: string
Allowed Values:
[ "ENT_CND_TMG_ANLY", "ENT_CND_TMG_BIANLY", "ENT_CND_TMG_CTRTRM", "ENT_CND_TMG_CTRYR", "ENT_CND_TMG_MTLY", "ENT_CND_TMG_QRTLY", "ENT_CND_TMG_WEKLY" ]The condition timing, whether it is annually, weekly, or another supported interval. Valid values are ENT_CND_TMG_ANLY, ENT_CND_TMG_BIANLY, ENT_CND_TMG_CTRTRM, ENT_CND_TMG_CTRYR, ENT_CND_TMG_MTLY, ENT_CND_TMG_QRTLY, and ENT_CND_TMG_WEKLY. -
groupName: string
The name of the group associated with the entitlement conditions group.
-
id: string
Maximum Length:
30The ID of the entitlement conditions group. -
order: number
The seqeunce number for this condition.
-
products(required): array
products
A list of products associated with the entitlement conditions group.
-
relationTypeInGroup : string
Allowed Values:
[ "AND", "OR" ]The logical relation type among the entitlement condition group. Valid values are AND and OR. -
status: string
Allowed Values:
[ "ENT_CND_STA_ACTV", "ENT_CND_STA_CNCLD", "ENT_CND_STA_EXHSTD", "ENT_CND_STA_NEW", "ENT_CND_STA_ONHLD" ]The status of the entitlement conditions group.
Nested Schema : condition
Type:
arrayA list of conditions associated with the entitlement conditions group.
Show Source
-
Array of:
object EntitlementConditionOracle
Title:
EntitlementConditionOracleThe condition of the entitlement.
Nested Schema : products
Type:
arrayA list of products associated with the entitlement conditions group.
Show Source
-
Array of:
object AssociatedProductsEntitlementsOracle
Title:
AssociatedProductsEntitlementsOracleThe products which are associated to entitlement, benefit or conditions.
Nested Schema : EntitlementConditionOracle
Type:
objectTitle:
EntitlementConditionOracleThe condition of the entitlement.
Show Source
-
@baseType: string
The base type of the entitlement condition.
-
@schemaLocation: string
The URI of the schema that defines the entitlement condition.
-
@type: string
The class type of the entitlement condition.
-
conditionType: string
Allowed Values:
[ "ENTL_COND_TYP_VOL" ]The type or classification of the entitlement condition. Valid values are ENTL_COND_TYP_VOL. -
conditionValue: string
The value assigned to the entitlement condition.
-
id: string
Maximum Length:
30The ID of the entitlement condition. -
operator: string
Allowed Values:
[ "EQUALS", "GREATER_THAN", "LESS_THAN", "GREATER_THAN_OR_EQUALS", "LESS_THAN_OR_EQUALS", "NOT_EQUALS" ]The logic expression including parameter and operator. Valid values are EQUALS, GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUALS, LESS_THAN_OR_EQUALS, and NOT_EQUALS. -
unitOfMeasure: string
Allowed Values:
[ "ENT_CND_UOM_ORDRS" ]The unit of measure to satisfy the condition. Valid values are ENT_CND_UOM_ORDRS.
Nested Schema : ProductOfferingPriceRefOracle
Title:
ProductOfferingPriceRefOracleMatch All
Show Source
-
object
ProductOfferingPriceRef
Title:
ProductOfferingPriceRefThe productPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased. -
object
ProductOfferingPriceRefOracle-allOf[1]
Nested Schema : ProductOfferingPriceRef
Type:
objectTitle:
ProductOfferingPriceRefThe productPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased.
Show Source
-
@baseType: string
The base type of the product offering price reference.
-
@referredType(required): string
The actual type of the target instance when needed for disambiguation.
-
@schemaLocation: string
(uri)
The URI of the schema that defines the product offering price reference.
-
@type(required): string
The class type of the product offering price reference.
-
href: string
The hyperlink reference to the product offering price reference.
-
id(required): string
The ID of the product offering price reference.
-
name: string
The name of the product offering price reference.
-
refId: string
The ID of the ref associated with the product offering price reference.
-
refName: string
The name of the ref associated with the product offering price reference.
-
version: string
The version of a related entity.
-
versionState: number
The version state of the reference.
Nested Schema : ProductOfferingPriceRefOracle-allOf[1]
Type:
Show Source
object-
appliesTo: string
Allowed Values:
[ "ALL", "ONE_TIME", "RECURRING", "USAGE" ]The bring in a open ended definition of alteration that specifies how price plan applicable to the offer. Valid values are ALL, ONE_TIME, RECURRING, and USAGE. -
isBundlePrice: boolean
Whether the product offering price reference is bundle price.
Nested Schema : EntitlementMetricsOracle
Type:
objectTitle:
EntitlementMetricsOracleThe entitlement metric resource.
Show Source
-
description: string
The description of entitlement metrics.
-
id: string
Maximum Length:
30The ID of the entitlement metric. -
metricsQuantity: object
EntitlementMetricsQuantityOracle
Title:
EntitlementMetricsQuantityOracleA number and unit representing entitlement metrics quantity. -
metricsType: string
Allowed Values:
[ "ENTL_MET_RESP_TIME", "ENTL_MET_SERV_AVAIL", "ENTL_MET_RESL_TIME", "ENTL_MET_ESCL_TIME" ]The type or classification of the entitlement metric. Valid values are ENTL_MET_RESP_TIME, ENTL_MET_SERV_AVAIL, ENTL_MET_RESL_TIME, and ENTL_MET_ESCL_TIME. -
name: string
The name of the entitlement metric.
-
priority: number
The piority of this metrics.
Nested Schema : EntitlementMetricsQuantityOracle
Type:
objectTitle:
EntitlementMetricsQuantityOracleA number and unit representing entitlement metrics quantity.
Show Source
-
amount(required): number
A quantity of something, typically the total of a thing or things in number.
-
units(required): string
Allowed Values:
[ "ENTL_MTCS_UNT_PRCT", "ENTL_MTCS_UNT_HRS", "ENTL_MTCS_UNT_MTS", "ENTL_MTCS_UNT_PNTS", "ENTL_MTCS_UNT_DAYS", "ENTL_MTCS_UNT_SCDS" ]The unit of measure for the quantity. Valid values are ENTL_MTCS_UNT_PRCT, ENTL_MTCS_UNT_HRS, ENTL_MTCS_UNT_MTS, ENTL_MTCS_UNT_PNTS, ENTL_MTCS_UNT_DAYS, and ENTL_MTCS_UNT_SCDS.
Nested Schema : PriceListRefOracle
Type:
objectTitle:
PriceListRefOracleThe pricelist reference.
Show Source
-
@baseType: string
The base type of the price list reference.
-
@referredType(required): string
The type of the referred price list reference.
-
@schemaLocation: string
The URI of the schema that defines the price list reference.
-
@type(required): string
The class type of the price list reference.
-
href: string
The hyperlink reference to the price list reference.
-
id(required): string
The ID of the price list reference.
-
name: string
The name of the price list reference.
-
version: string
The version of the pricelist.
-
versionState: number
The version state of the reference.
Response
Supported Media Types
- application/json
200 Response
The entitlement was updated successfully.
Root Schema : EntitlementOracle
Type:
objectTitle:
EntitlementOracleThe entitlement resource.
Show Source
-
@baseType: string
The base type of the entitlement.
-
@schemaLocation: string
The URI of the schema that defines the entitlement.
-
@type: string
The class type of the entitlement.
-
associatedProducts(required): array
associatedProducts
A list of associated products associated with the entitlement.
-
benefits: array
benefits
A list of benefits associated with the entitlement.
-
created: string
(date-time)
The date and time of the creation.
-
createdBy: string
The name of the person who created item.
-
description: string
The description of entitlement.
-
entitlementType: string
Allowed Values:
[ "ENTITLEMENT_PRICING", "ENTITLEMENT_SERVICE" ]The type or classification of the entitlement. Valid values are ENTITLEMENT_PRICING, and ENTITLEMENT_SERVICE. -
href: string
The hyperlink reference to the entitlement.
-
id: string
Maximum Length:
30The ID of the entitlement. -
lastUpdate: string
(date-time)
The date and time when the entitlement was last updated.
-
lastUpdatedBy: string
The name of the person who updated item.
-
lifecycleStatus: string
The status of the entitlement.
-
metrics: array
metrics
A list of metrics associated with the entitlement.
-
name: string
The name of the entitlement.
-
pricelist: array
pricelist
A list of pricelists associated with the entitlement.
-
priority: number
The priority of this entitlement in relation to other entitlement associatedto the project.
-
project: object
ProjectRef
Title:
ProjectRefThe project reference resource. -
quantity: object
EntitlementQuantityOracle
Title:
EntitlementQuantityOracleA number and unit representing entitlement unit. -
validFor: object
TimePeriod
Title:
TimePeriodThe period for which the productOffering is valid. -
version: string
The promotion version.
-
versionState: number
The version state of the entitlement.
Nested Schema : associatedProducts
Type:
arrayA list of associated products associated with the entitlement.
Show Source
-
Array of:
object AssociatedProductsEntitlementsOracle
Title:
AssociatedProductsEntitlementsOracleThe products which are associated to entitlement, benefit or conditions.
Nested Schema : benefits
Type:
arrayA list of benefits associated with the entitlement.
Show Source
-
Array of:
object EntitlementsBenefitsOracle
Title:
EntitlementsBenefitsOracleThe entitlement benefits.
Nested Schema : metrics
Type:
arrayA list of metrics associated with the entitlement.
Show Source
-
Array of:
object EntitlementMetricsOracle
Title:
EntitlementMetricsOracleThe entitlement metric resource.
Nested Schema : pricelist
Type:
arrayA list of pricelists associated with the entitlement.
Show Source
-
Array of:
object PriceListRefOracle
Title:
PriceListRefOracleThe pricelist reference.
Nested Schema : ProjectRef
Type:
objectTitle:
ProjectRefThe project reference resource.
Show Source
-
href: string
The hyperlink reference to the project reference.
-
id(required): string
The ID of the project reference.
-
name: string
The name of the project reference.
-
version: string
The version of the project.
Nested Schema : EntitlementQuantityOracle
Type:
objectTitle:
EntitlementQuantityOracleA number and unit representing entitlement unit.
Show Source
-
amount(required): number
A quantity of something, typically the total of a thing or things in number.
-
units(required): string
Allowed Values:
[ "ENTL_UNIT_ORDERS", "ENTL_UNIT_SERREQ" ]The unit of measure for the quantity. Valid values are ENTL_UNIT_ORDERS, and ENTL_UNIT_SERREQ.
Nested Schema : TimePeriod
Type:
objectTitle:
TimePeriodThe period for which the productOffering is valid.
Show Source
-
endDateTime: string
(date-time)
The end date and time of the time period.
-
startDateTime: string
(date-time)
The start date and time of the time period.
Nested Schema : AssociatedProductsEntitlementsOracle
Type:
objectTitle:
AssociatedProductsEntitlementsOracleThe products which are associated to entitlement, benefit or conditions.
Show Source
-
@baseType: string
The base type of the associated products entitlement.
-
@referredType: string
The type of the referred associated products entitlement.
-
@schemaLocation: string
The URI of the schema that defines the associated products entitlement.
-
@type: string
The class type of the associated products entitlement.
-
actionObjectType: string
Allowed Values:
[ "PRODUCT_OFFERING", "PRODUCT_OFFERING_PRICE", "PRODUCTLINE", "CATEGORY", "PRODUCT_SPECIFICATION" ]The type or classification of the associated products entitlement. Valid values are PRODUCT_OFFERING, PRODUCT_OFFERING_PRICE, PRODUCTLINE, CATEGORY, and PRODUCT_SPECIFICATION. -
id(required): string
The ID of the associated products entitlement.
-
name: string
The name of the associated products entitlement.
Nested Schema : EntitlementsBenefitsOracle
Type:
objectTitle:
EntitlementsBenefitsOracleThe entitlement benefits.
Show Source
-
@baseType: string
The base type of the entitlements benefit.
-
@schemaLocation: string
The URI of the schema that defines the entitlements benefit.
-
@type: string
The class type of the entitlements benefit.
-
benefitType: string
Allowed Values:
[ "ENTL_BFT_TYP_DSNT" ]The type or classification of the entitlements benefit. Valid values are ENTL_BFT_TYP_DSNT. -
description: string
The description of entitlements benefit.
-
entitlementConditionsGroup: array
entitlementConditionsGroup
A list of entitlement conditions groups associated with the entitlements benefit.
-
id: string
Maximum Length:
30The ID of the entitlements benefit. -
name: string
The name of the entitlements benefit.
-
priority: number
The piority of this benifit.
-
productOfferingPrice(required): array
productOfferingPrice
A list of product offering prices associated with the entitlements benefit.
-
products(required): array
products
A list of products associated with the entitlements benefit.
-
relationShipAmongGroup: string
Allowed Values:
[ "ENTL_BFT_CND_REL_ALL", "ENTL_BFT_CND_REL_ANY" ]The condition relationship for the benfit. Valid values are ENTL_BFT_CND_REL_ALL, and ENTL_BFT_CND_REL_ANY. -
schedule: string
Allowed Values:
[ "ENTL_BFT_SCDL_MNTLY", "ENTL_BFT_SCDL_ANLY", "ENTL_BFT_SCDL_ASINRD", "ENTL_BFT_SCDL_BIANLY", "ENTL_BFT_SCDL_CTRTRM", "ENTL_BFT_SCDL_CTRYR", "ENTL_BFT_SCDL_QRTLY", "ENTL_BFT_SCDL_WEKLY" ]The allows to define the benifit schedule. Valid values are ENTL_BFT_SCDL_MNTLY, ENTL_BFT_SCDL_ANLY, ENTL_BFT_SCDL_ASINRD, ENTL_BFT_SCDL_BIANLY, ENTL_BFT_SCDL_CTRTRM, ENTL_BFT_SCDL_CTRYR, ENTL_BFT_SCDL_QRTLY, and ENTL_BFT_SCDL_WEKLY. -
status: string
Allowed Values:
[ "ENTL_BFT_STS_ACTV", "ENTL_BFT_STS_CNCLD", "ENTL_BFT_STS_EXHSTD", "ENTL_BFT_STS_NEW", "ENTL_BFT_STS_ONHOLD" ]The status of the entitlements benefit.
Nested Schema : entitlementConditionsGroup
Type:
arrayA list of entitlement conditions groups associated with the entitlements benefit.
Show Source
-
Array of:
object EntitlementConditionsGroupOracle
Title:
EntitlementConditionsGroupOracleThe group of the condition for the entitlement.The logical relationship between different groups is decided by the ???relationTypeInGroup???.
Nested Schema : productOfferingPrice
Type:
arrayA list of product offering prices associated with the entitlements benefit.
Show Source
-
Array of:
ProductOfferingPriceRefOracle
Title:
ProductOfferingPriceRefOracle
Nested Schema : products
Type:
arrayA list of products associated with the entitlements benefit.
Show Source
-
Array of:
object AssociatedProductsEntitlementsOracle
Title:
AssociatedProductsEntitlementsOracleThe products which are associated to entitlement, benefit or conditions.
Nested Schema : EntitlementConditionsGroupOracle
Type:
objectTitle:
EntitlementConditionsGroupOracleThe group of the condition for the entitlement.The logical relationship between different groups is decided by the ???relationTypeInGroup???.
Show Source
-
@baseType: string
The base type of the entitlement conditions group.
-
@schemaLocation: string
The URI of the schema that defines the entitlement conditions group.
-
@type: string
The class type of the entitlement conditions group.
-
condition: array
condition
A list of conditions associated with the entitlement conditions group.
-
conditionTiming: string
Allowed Values:
[ "ENT_CND_TMG_ANLY", "ENT_CND_TMG_BIANLY", "ENT_CND_TMG_CTRTRM", "ENT_CND_TMG_CTRYR", "ENT_CND_TMG_MTLY", "ENT_CND_TMG_QRTLY", "ENT_CND_TMG_WEKLY" ]The condition timing, whether it is annually, weekly, or another supported interval. Valid values are ENT_CND_TMG_ANLY, ENT_CND_TMG_BIANLY, ENT_CND_TMG_CTRTRM, ENT_CND_TMG_CTRYR, ENT_CND_TMG_MTLY, ENT_CND_TMG_QRTLY, and ENT_CND_TMG_WEKLY. -
groupName: string
The name of the group associated with the entitlement conditions group.
-
id: string
Maximum Length:
30The ID of the entitlement conditions group. -
order: number
The seqeunce number for this condition.
-
products(required): array
products
A list of products associated with the entitlement conditions group.
-
relationTypeInGroup : string
Allowed Values:
[ "AND", "OR" ]The logical relation type among the entitlement condition group. Valid values are AND and OR. -
status: string
Allowed Values:
[ "ENT_CND_STA_ACTV", "ENT_CND_STA_CNCLD", "ENT_CND_STA_EXHSTD", "ENT_CND_STA_NEW", "ENT_CND_STA_ONHLD" ]The status of the entitlement conditions group.
Nested Schema : condition
Type:
arrayA list of conditions associated with the entitlement conditions group.
Show Source
-
Array of:
object EntitlementConditionOracle
Title:
EntitlementConditionOracleThe condition of the entitlement.
Nested Schema : products
Type:
arrayA list of products associated with the entitlement conditions group.
Show Source
-
Array of:
object AssociatedProductsEntitlementsOracle
Title:
AssociatedProductsEntitlementsOracleThe products which are associated to entitlement, benefit or conditions.
Nested Schema : EntitlementConditionOracle
Type:
objectTitle:
EntitlementConditionOracleThe condition of the entitlement.
Show Source
-
@baseType: string
The base type of the entitlement condition.
-
@schemaLocation: string
The URI of the schema that defines the entitlement condition.
-
@type: string
The class type of the entitlement condition.
-
conditionType: string
Allowed Values:
[ "ENTL_COND_TYP_VOL" ]The type or classification of the entitlement condition. Valid values are ENTL_COND_TYP_VOL. -
conditionValue: string
The value assigned to the entitlement condition.
-
id: string
Maximum Length:
30The ID of the entitlement condition. -
operator: string
Allowed Values:
[ "EQUALS", "GREATER_THAN", "LESS_THAN", "GREATER_THAN_OR_EQUALS", "LESS_THAN_OR_EQUALS", "NOT_EQUALS" ]The logic expression including parameter and operator. Valid values are EQUALS, GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUALS, LESS_THAN_OR_EQUALS, and NOT_EQUALS. -
unitOfMeasure: string
Allowed Values:
[ "ENT_CND_UOM_ORDRS" ]The unit of measure to satisfy the condition. Valid values are ENT_CND_UOM_ORDRS.
Nested Schema : ProductOfferingPriceRefOracle
Title:
ProductOfferingPriceRefOracleMatch All
Show Source
-
object
ProductOfferingPriceRef
Title:
ProductOfferingPriceRefThe productPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased. -
object
ProductOfferingPriceRefOracle-allOf[1]
Nested Schema : ProductOfferingPriceRef
Type:
objectTitle:
ProductOfferingPriceRefThe productPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased.
Show Source
-
@baseType: string
The base type of the product offering price reference.
-
@referredType(required): string
The actual type of the target instance when needed for disambiguation.
-
@schemaLocation: string
(uri)
The URI of the schema that defines the product offering price reference.
-
@type(required): string
The class type of the product offering price reference.
-
href: string
The hyperlink reference to the product offering price reference.
-
id(required): string
The ID of the product offering price reference.
-
name: string
The name of the product offering price reference.
-
refId: string
The ID of the ref associated with the product offering price reference.
-
refName: string
The name of the ref associated with the product offering price reference.
-
version: string
The version of a related entity.
-
versionState: number
The version state of the reference.
Nested Schema : ProductOfferingPriceRefOracle-allOf[1]
Type:
Show Source
object-
appliesTo: string
Allowed Values:
[ "ALL", "ONE_TIME", "RECURRING", "USAGE" ]The bring in a open ended definition of alteration that specifies how price plan applicable to the offer. Valid values are ALL, ONE_TIME, RECURRING, and USAGE. -
isBundlePrice: boolean
Whether the product offering price reference is bundle price.
Nested Schema : EntitlementMetricsOracle
Type:
objectTitle:
EntitlementMetricsOracleThe entitlement metric resource.
Show Source
-
description: string
The description of entitlement metrics.
-
id: string
Maximum Length:
30The ID of the entitlement metric. -
metricsQuantity: object
EntitlementMetricsQuantityOracle
Title:
EntitlementMetricsQuantityOracleA number and unit representing entitlement metrics quantity. -
metricsType: string
Allowed Values:
[ "ENTL_MET_RESP_TIME", "ENTL_MET_SERV_AVAIL", "ENTL_MET_RESL_TIME", "ENTL_MET_ESCL_TIME" ]The type or classification of the entitlement metric. Valid values are ENTL_MET_RESP_TIME, ENTL_MET_SERV_AVAIL, ENTL_MET_RESL_TIME, and ENTL_MET_ESCL_TIME. -
name: string
The name of the entitlement metric.
-
priority: number
The piority of this metrics.
Nested Schema : EntitlementMetricsQuantityOracle
Type:
objectTitle:
EntitlementMetricsQuantityOracleA number and unit representing entitlement metrics quantity.
Show Source
-
amount(required): number
A quantity of something, typically the total of a thing or things in number.
-
units(required): string
Allowed Values:
[ "ENTL_MTCS_UNT_PRCT", "ENTL_MTCS_UNT_HRS", "ENTL_MTCS_UNT_MTS", "ENTL_MTCS_UNT_PNTS", "ENTL_MTCS_UNT_DAYS", "ENTL_MTCS_UNT_SCDS" ]The unit of measure for the quantity. Valid values are ENTL_MTCS_UNT_PRCT, ENTL_MTCS_UNT_HRS, ENTL_MTCS_UNT_MTS, ENTL_MTCS_UNT_PNTS, ENTL_MTCS_UNT_DAYS, and ENTL_MTCS_UNT_SCDS.
Nested Schema : PriceListRefOracle
Type:
objectTitle:
PriceListRefOracleThe pricelist reference.
Show Source
-
@baseType: string
The base type of the price list reference.
-
@referredType(required): string
The type of the referred price list reference.
-
@schemaLocation: string
The URI of the schema that defines the price list reference.
-
@type(required): string
The class type of the price list reference.
-
href: string
The hyperlink reference to the price list reference.
-
id(required): string
The ID of the price list reference.
-
name: string
The name of the price list reference.
-
version: string
The version of the pricelist.
-
versionState: number
The version state of the reference.
400 Response
Your request couldn't be processed because it contains missing or invalid information, such as a validation error on an input field, a missing required value, and so forth.
Root Schema : Error
Type:
objectTitle:
ErrorThe error resource.
Show Source
-
@schemaLocation: string
The URI of the schema that defines the error.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list).
-
message: string
The text that provides more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
The text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
The URL pointing to documentation describing the error.
-
status: string
The status of the error.
401 Response
Your request isn't authorized. The authentication credentials included with this request are missing or invalid.
Root Schema : Error
Type:
objectTitle:
ErrorThe error resource.
Show Source
-
@schemaLocation: string
The URI of the schema that defines the error.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list).
-
message: string
The text that provides more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
The text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
The URL pointing to documentation describing the error.
-
status: string
The status of the error.
404 Response
The resource with the specified URI couldn't be found.
Root Schema : Error
Type:
objectTitle:
ErrorThe error resource.
Show Source
-
@schemaLocation: string
The URI of the schema that defines the error.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list).
-
message: string
The text that provides more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
The text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
The URL pointing to documentation describing the error.
-
status: string
The status of the error.
405 Response
HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.
Root Schema : Error
Type:
objectTitle:
ErrorThe error resource.
Show Source
-
@schemaLocation: string
The URI of the schema that defines the error.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list).
-
message: string
The text that provides more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
The text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
The URL pointing to documentation describing the error.
-
status: string
The status of the error.
500 Response
The server encountered something unexpected that prevented it from completing the request.
Root Schema : Error
Type:
objectTitle:
ErrorThe error resource.
Show Source
-
@schemaLocation: string
The URI of the schema that defines the error.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list).
-
message: string
The text that provides more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
The text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
The URL pointing to documentation describing the error.
-
status: string
The status of the error.
Examples
The following example shows how to update an entitlement by submitting a patch request on the REST resource using cURL.
cURL Command
curl -u username:password -X PATCH
'https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/entitlement' -H 'Content-Type: application/json' -D @entitlement_update.json | json_pp
Example of Request Body
The following shows an example of the request body in JSON format.
{
"description" : "Sales Entitlement 1009 2025",
"validFor": {
"startDateTime": "2024-08-09T00:00:00.000Z",
"endDateTime": "2028-08-09T00:00:00.000Z"
}
}
Example of Response Body
The following shows an example of the response body in JSON format.
{
"lastUpdate": "2025-03-10T10:03:02.304Z",
"lastUpdatedBy": "booth",
"created": "2025-02-19T16:11:47.000Z",
"createdBy": "booth",
"id": "PS_111119",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/entitlement/PS_111119",
"name": "SalesEntitlement1001",
"description": "Sales Entitlement 1009 2025",
"@type": "EntitlementOracle",
"version": "1.0",
"validFor": {
"startDateTime": "2024-08-09T00:00:00.000Z",
"endDateTime": "2028-08-09T00:00:00.000Z"
},
"project": {
"id": "DBE_RI_ProdModel_PreSeed_PSP",
"name": "DBE RI Product Model Preseed",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/DBE_RI_ProdModel_PreSeed_PSP",
"version": "1.0",
"@referredType": "ProjectOracle"
},
"lifecycleStatus": "In design",
"entitlementType": "ENTITLEMENT_PRICING",
"priority": 1,
"quantity": {
"amount": 11,
"units": "ENTL_UNIT_ORDERS"
},
"pricelist": [
{
"id": "US_PRICE_LIST_Auto",
"name": "US_PRICE_LIST_Auto",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/pricelist/US_PRICE_LIST_Auto",
"@referredType": "PricelistOracle",
"@type": "PriceListRefOracle"
}
],
"associatedProducts": [
{
"id": "Auto-PO-26112021",
"name": "Auto-PO-26112021",
"actionObjectType": "PRODUCT_OFFERING",
"@referredType": "ProductOfferingOracle",
"@type": "AssociatedProductsEntitlementsOracle"
}
],
"benefits": [
{
"id": "Benefit0232d",
"name": "Benefit0224",
"description": "Benefit0224",
"@type": "EntitlementsBenefitsOracle",
"priority": 1,
"benefitType": "ENTL_BFT_TYP_DSNT",
"status": "ENTL_BFT_STS_ACTV",
"schedule": "ENTL_BFT_SCDL_WEKLY",
"relationshipAmongGroup": "ENTL_BFT_CND_REL_ALL",
"products": [
{
"id": "Auto-PO-26112021",
"name": "Auto-PO-26112021",
"actionObjectType": "PRODUCT_OFFERING",
"@referredType": "ProductOfferingOracle",
"@type": "AssociatedProductsEntitlementsOracle"
}
],
"productOfferingPrice": [
{
"id": "TestPOP2911",
"name": "TestPOP2911",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/productOfferingPrice/TestPOP2911",
"@referredType": "ProductOfferPriceAlterationOracle",
"@type": "ProductOfferingPriceRefOracle",
"appliesTo": "ALL"
}
],
"entitlementConditionsGroup": [
{
"id": "ConditionGroup1",
"groupName": "ConditionGroup1",
"@type": "EntitlementConditionsGroupOracle",
"relationTypeInGroup": "AND",
"order": 1,
"status": "ENT_CND_STA_ACTV",
"conditionTiming": "ENT_CND_TMG_WEKLY",
"condition": [
{
"id": "condt-2621961148-1641464904",
"@type": "EntitlementConditionOracle",
"unitOfMeasure": "ENT_CND_UOM_ORDRS",
"conditionValue": "100",
"conditionType": "ENTL_COND_TYP_VOL",
"operator": "EQUALS"
}
],
"products": [
{
"id": "Common-PS-26112021",
"name": "Common-PS-26112021",
"actionObjectType": "PRODUCT_SPECIFICATION",
"@referredType": "ProductSpecificationOracle",
"@type": "AssociatedProductsEntitlementsOracle"
}
]
}
]
}
]
}