REST API Reference for Launch Cloud Service

Create or update an entitlement

put

https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/entitlement/{id}

Request

Path Parameters

id(required): string

The unique identifier of the resource item.

Supported Media Types

application/json

Root Schema : EntitlementOracle

Type: object

Title: EntitlementOracle

Show Source

@baseType: string

Immediate base (class) type of the object
@schemaLocation: string

A link to the schema describing this object
@type: string

Indicates the type of resource. Here can be entitlement
associatedProducts(required): array associatedProducts
benefits: array benefits
created: string (date-time)

Date and time of the creation
createdBy: string

name of the person who created item
description: string

Description of entitlement
entitlementType: string

Allowed Values: [ "ENTITLEMENT_PRICING", "ENTITLEMENT_SERVICE" ]

entitlememt type
href: string

Hypertext Reference of the entitlement.
id: string

Maximum Length: 30

Unique identifier of the entitlement
lastUpdate: string (date-time)

Latest update date of entitlement
lastUpdatedBy: string

name of the person who updated item
lifecycleStatus: string

Status of entitlement
metrics: array metrics
name: string

Name of entitlement
pricelist: array pricelist
priority: number

Priority of this entitlement in relation to other entitlement assosiatedto the project.
project: object ProjectRef

Title: ProjectRef

Project Reference
quantity: object EntitlementQuantityOracle

Title: EntitlementQuantityOracle

A number and unit representing entitlement unit
validFor: object TimePeriod

Title: TimePeriod

The period for which the productOffering is valid
version: string

Promotion version
versionState: number

Version state of the entitlement

{
    "title":"EntitlementOracle",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"Unique identifier of the entitlement"
        },
        "href":{
            "type":"string",
            "description":"Hypertext Reference of the entitlement."
        },
        "name":{
            "type":"string",
            "description":"Name of entitlement"
        },
        "description":{
            "type":"string",
            "description":"Description of entitlement"
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"Latest update date of entitlement"
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Status of entitlement"
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "@type":{
            "type":"string",
            "description":"Indicates the type of resource. Here can be entitlement"
        },
        "@baseType":{
            "type":"string",
            "description":"Immediate base (class) type of the object"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this object"
        },
        "project":{
            "$ref":"#/components/schemas/ProjectRef"
        },
        "version":{
            "type":"string",
            "description":"Promotion version"
        },
        "entitlementType":{
            "type":"string",
            "description":"entitlememt type",
            "enum":[
                "ENTITLEMENT_PRICING",
                "ENTITLEMENT_SERVICE"
            ]
        },
        "pricelist":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PriceListRefOracle"
            }
        },
        "metrics":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/EntitlementMetricsOracle"
            }
        },
        "quantity":{
            "$ref":"#/components/schemas/EntitlementQuantityOracle"
        },
        "priority":{
            "type":"number",
            "description":"Priority of this entitlement in relation to other entitlement assosiatedto the project."
        },
        "associatedProducts":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AssociatedProductsEntitlementsOracle"
            }
        },
        "benefits":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/EntitlementsBenefitsOracle"
            }
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the creation"
        },
        "createdBy":{
            "type":"string",
            "description":"name of the person who created item"
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"name of the person who updated item"
        },
        "versionState":{
            "type":"number",
            "description":"Version state of the entitlement"
        }
    },
    "required":[
        "associatedProducts"
    ]
}

Nested Schema : associatedProducts

Type: array

Show Source

Array of: object AssociatedProductsEntitlementsOracle

Title: AssociatedProductsEntitlementsOracle

The products which are assosiated to entitlement, benefit or conditions

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AssociatedProductsEntitlementsOracle"
    }
}

Nested Schema : benefits

Type: array

Show Source

Array of: object EntitlementsBenefitsOracle

Title: EntitlementsBenefitsOracle

Entitlement benefits.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/EntitlementsBenefitsOracle"
    }
}

Nested Schema : metrics

Type: array

Show Source

Array of: object EntitlementMetricsOracle

Title: EntitlementMetricsOracle

Entitlement Metrics

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/EntitlementMetricsOracle"
    }
}

Nested Schema : pricelist

Type: array

Show Source

Array of: object PriceListRefOracle

Title: PriceListRefOracle

Pricelist reference.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PriceListRefOracle"
    }
}

Nested Schema : ProjectRef

Type: object

Title: ProjectRef

Project Reference

Show Source

href: string

Unique reference of the project
id(required): string

Unique identifier of the project
name: string

Name of the project
version: string

Version of the project

{
    "title":"ProjectRef",
    "type":"object",
    "description":"Project Reference",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the project"
        },
        "href":{
            "type":"string",
            "description":"Unique reference of the project"
        },
        "name":{
            "type":"string",
            "description":"Name of the project"
        },
        "version":{
            "type":"string",
            "description":"Version of the project"
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : EntitlementQuantityOracle

Type: object

Title: EntitlementQuantityOracle

A 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.

{
    "title":"EntitlementQuantityOracle",
    "description":"A number and unit representing entitlement unit",
    "type":"object",
    "properties":{
        "amount":{
            "type":"number",
            "description":"A quantity of something, typically the total of a thing or things in number."
        },
        "units":{
            "type":"string",
            "description":"The unit of measure for the quantity.",
            "enum":[
                "ENTL_UNIT_ORDERS",
                "ENTL_UNIT_SERREQ"
            ]
        }
    },
    "required":[
        "units",
        "amount"
    ]
}

Nested Schema : TimePeriod

Type: object

Title: TimePeriod

The period for which the productOffering is valid

Show Source

endDateTime: string (date-time)

An instant of time, ending at the TimePeriod.
startDateTime: string (date-time)

An instant of time, starting at the TimePeriod

{
    "title":"TimePeriod",
    "description":"The period for which the productOffering is valid",
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, starting at the TimePeriod"
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, ending at the TimePeriod."
        }
    }
}

Nested Schema : AssociatedProductsEntitlementsOracle

Type: object

Title: AssociatedProductsEntitlementsOracle

The products which are assosiated to entitlement, benefit or conditions

Show Source

@baseType: string

Immediate base (class) type of the object
@referredType: string

Type of the referred entity
@schemaLocation: string

A link to the schema describing this object
@type: string

Class type of the object
actionObjectType: string

Allowed Values: [ "PRODUCT_OFFERING", "PRODUCT_OFFERING_PRICE", "PRODUCTLINE", "CATEGORY", "PRODUCT_SPECIFICATION" ]

Type of the assosiated product
id(required): string
name: string

Name of the assosiated product

{
    "type":"object",
    "title":"AssociatedProductsEntitlementsOracle",
    "description":"The products which are assosiated to entitlement, benefit or conditions",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string",
            "description":"Name of the assosiated product"
        },
        "actionObjectType":{
            "type":"string",
            "description":"Type of the assosiated product",
            "enum":[
                "PRODUCT_OFFERING",
                "PRODUCT_OFFERING_PRICE",
                "PRODUCTLINE",
                "CATEGORY",
                "PRODUCT_SPECIFICATION"
            ]
        },
        "@type":{
            "type":"string",
            "description":"Class type of the object"
        },
        "@baseType":{
            "type":"string",
            "description":"Immediate base (class) type of the object"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this object"
        },
        "@referredType":{
            "type":"string",
            "description":"Type of the referred entity"
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : EntitlementsBenefitsOracle

Type: object

Title: EntitlementsBenefitsOracle

Entitlement benefits.

Show Source

@baseType: string

Immediate base (class) type of the object
@schemaLocation: string

A link to the schema describing this object
@type: string

Indicates the type of resource.
benefitType: string

Allowed Values: [ "ENTL_BFT_TYP_DSNT" ]

Benifit type
description: string

Description of entitlements benefit
entitlementConditionsGroup: array entitlementConditionsGroup
id: string

Maximum Length: 30

Unique identifier of the benifit
name: string

Name of entitlement benifit
priority: number

Piority of this benifit
productOfferingPrice(required): array productOfferingPrice
products(required): array products
relationShipAmongGroup: string

Allowed Values: [ "ENTL_BFT_CND_REL_ALL", "ENTL_BFT_CND_REL_ANY" ]

Condition relationship for the benfit
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" ]

Allows to define the benifit schedule
status: string

Allowed Values: [ "ENTL_BFT_STS_ACTV", "ENTL_BFT_STS_CNCLD", "ENTL_BFT_STS_EXHSTD", "ENTL_BFT_STS_NEW", "ENTL_BFT_STS_ONHOLD" ]

Signifies the current status of the benefit

{
    "title":"EntitlementsBenefitsOracle",
    "type":"object",
    "description":"Entitlement benefits.",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"Unique identifier of the benifit"
        },
        "name":{
            "type":"string",
            "description":"Name of entitlement benifit"
        },
        "description":{
            "type":"string",
            "description":"Description of entitlements benefit"
        },
        "products":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AssociatedProductsEntitlementsOracle"
            }
        },
        "priority":{
            "type":"number",
            "description":"Piority of this benifit"
        },
        "benefitType":{
            "type":"string",
            "description":"Benifit type",
            "enum":[
                "ENTL_BFT_TYP_DSNT"
            ]
        },
        "productOfferingPrice":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductOfferingPriceRefOracle"
            }
        },
        "schedule":{
            "type":"string",
            "description":"Allows to define the benifit schedule",
            "enum":[
                "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"
            ]
        },
        "status":{
            "type":"string",
            "description":"Signifies the current status of the benefit",
            "enum":[
                "ENTL_BFT_STS_ACTV",
                "ENTL_BFT_STS_CNCLD",
                "ENTL_BFT_STS_EXHSTD",
                "ENTL_BFT_STS_NEW",
                "ENTL_BFT_STS_ONHOLD"
            ]
        },
        "relationShipAmongGroup":{
            "type":"string",
            "description":"Condition relationship for the benfit",
            "enum":[
                "ENTL_BFT_CND_REL_ALL",
                "ENTL_BFT_CND_REL_ANY"
            ]
        },
        "entitlementConditionsGroup":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/EntitlementConditionsGroupOracle"
            }
        },
        "@type":{
            "type":"string",
            "description":"Indicates the type of resource."
        },
        "@baseType":{
            "type":"string",
            "description":"Immediate base (class) type of the object"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this object"
        }
    },
    "required":[
        "products",
        "productOfferingPrice"
    ]
}

Nested Schema : entitlementConditionsGroup

Type: array

Show Source

Array of: object EntitlementConditionsGroupOracle

Title: EntitlementConditionsGroupOracle

The group of the condition for the entitlement.The logical relationship between different groups is decided by the ???relationTypeInGroup???.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/EntitlementConditionsGroupOracle"
    }
}

Nested Schema : productOfferingPrice

Type: array

Show Source

Array of: ProductOfferingPriceRefOracle

Title: ProductOfferingPriceRefOracle

ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProductOfferingPriceRefOracle"
    }
}

Nested Schema : products

Type: array

Show Source

Array of: object AssociatedProductsEntitlementsOracle

Title: AssociatedProductsEntitlementsOracle

The products which are assosiated to entitlement, benefit or conditions

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AssociatedProductsEntitlementsOracle"
    }
}

Nested Schema : EntitlementConditionsGroupOracle

Type: object

Title: EntitlementConditionsGroupOracle

The group of the condition for the entitlement.The logical relationship between different groups is decided by the ???relationTypeInGroup???.

Show Source

@baseType: string

Immediate base (class) type of the object
@schemaLocation: string

A link to the schema describing this object
@type: string

Class type of the object
condition: array condition
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" ]

Signifies the condition timing , weather its Annually , weekly etc.
groupName: string

Name of the entitlement condition group
id: string

Maximum Length: 30

Unique identifier of the entitlement condition group
order: number

Seqeunce number for this condition
products(required): array products
relationTypeInGroup : string

Allowed Values: [ "AND", "OR" ]

The logical relation type amongst the entitlement condition group.AND logical relation,OR logical relation
status: string

Allowed Values: [ "ENT_CND_STA_ACTV", "ENT_CND_STA_CNCLD", "ENT_CND_STA_EXHSTD", "ENT_CND_STA_NEW", "ENT_CND_STA_ONHLD" ]

status

{
    "title":"EntitlementConditionsGroupOracle",
    "type":"object",
    "description":"The group of the condition for the entitlement.The logical relationship between different groups is decided by the ???relationTypeInGroup???.",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"Unique identifier of the entitlement condition group"
        },
        "groupName":{
            "type":"string",
            "description":"Name of the entitlement condition group"
        },
        "relationTypeInGroup ":{
            "type":"string",
            "description":"The logical relation type amongst the entitlement condition group.AND logical relation,OR logical relation",
            "enum":[
                "AND",
                "OR"
            ]
        },
        "order":{
            "type":"number",
            "description":"Seqeunce number for this condition"
        },
        "status":{
            "type":"string",
            "description":"status",
            "enum":[
                "ENT_CND_STA_ACTV",
                "ENT_CND_STA_CNCLD",
                "ENT_CND_STA_EXHSTD",
                "ENT_CND_STA_NEW",
                "ENT_CND_STA_ONHLD"
            ]
        },
        "conditionTiming":{
            "type":"string",
            "description":"Signifies the condition timing , weather its Annually , weekly etc.",
            "enum":[
                "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"
            ]
        },
        "products":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AssociatedProductsEntitlementsOracle"
            }
        },
        "@type":{
            "type":"string",
            "description":"Class type of the object"
        },
        "@baseType":{
            "type":"string",
            "description":"Immediate base (class) type of the object"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this object"
        },
        "condition":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/EntitlementConditionOracle"
            }
        }
    },
    "required":[
        "products"
    ]
}

Nested Schema : condition

Type: array

Show Source

Array of: object EntitlementConditionOracle

Title: EntitlementConditionOracle

Condition of the entitlement.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/EntitlementConditionOracle"
    }
}

Nested Schema : products

Type: array

Show Source

Array of: object AssociatedProductsEntitlementsOracle

Title: AssociatedProductsEntitlementsOracle

The products which are assosiated to entitlement, benefit or conditions

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AssociatedProductsEntitlementsOracle"
    }
}

Nested Schema : EntitlementConditionOracle

Type: object

Title: EntitlementConditionOracle

Condition of the entitlement.

Show Source

@baseType: string

Immediate base (class) type of the object
@schemaLocation: string

A link to the schema describing this object
@type: string

Class type of the object
conditionType: string

Allowed Values: [ "ENTL_COND_TYP_VOL" ]

condition type, shows the conditons being created, defaulted to volume
conditionValue: string

Condition value
id: string

Maximum Length: 30

Unique identifier 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.
unitOfMeasure: string

Allowed Values: [ "ENT_CND_UOM_ORDRS" ]

Unit of measure to satisfy the condition

{
    "title":"EntitlementConditionOracle",
    "type":"object",
    "description":"Condition of the entitlement.",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"Unique identifier of the entitlement condition"
        },
        "conditionType":{
            "type":"string",
            "description":"condition type, shows the conditons being created, defaulted to volume",
            "enum":[
                "ENTL_COND_TYP_VOL"
            ]
        },
        "conditionValue":{
            "type":"string",
            "description":"Condition value"
        },
        "unitOfMeasure":{
            "type":"string",
            "description":"Unit of measure to satisfy the condition",
            "enum":[
                "ENT_CND_UOM_ORDRS"
            ]
        },
        "operator":{
            "type":"string",
            "description":"The logic expression including parameter and operator.",
            "enum":[
                "EQUALS",
                "GREATER_THAN",
                "LESS_THAN",
                "GREATER_THAN_OR_EQUALS",
                "LESS_THAN_OR_EQUALS",
                "NOT_EQUALS"
            ]
        },
        "@type":{
            "type":"string",
            "description":"Class type of the object"
        },
        "@baseType":{
            "type":"string",
            "description":"Immediate base (class) type of the object"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this object"
        }
    }
}

Nested Schema : ProductOfferingPriceRefOracle

Title: ProductOfferingPriceRefOracle

ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased

Match All

ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased

Show Source

object ProductOfferingPriceRef

Title: ProductOfferingPriceRef

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]

{
    "title":"ProductOfferingPriceRefOracle",
    "description":"ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased",
    "allOf":[
        {
            "$ref":"#/components/schemas/ProductOfferingPriceRef"
        },
        {
            "type":"object",
            "properties":{
                "appliesTo":{
                    "type":"string",
                    "description":"Bring in a open ended definition of alteration that specifies how price plan applicable to the offer",
                    "enum":[
                        "ALL",
                        "ONE_TIME",
                        "RECURRING",
                        "USAGE"
                    ]
                },
                "isBundlePrice":{
                    "type":"boolean",
                    "description":"Used to indicate whether the referred price is the flat price for a bundle (true) or not(false)."
                }
            }
        }
    ]
}

Nested Schema : ProductOfferingPriceRef

Type: object

Title: ProductOfferingPriceRef

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

When sub-classing, this defines the super-class
@referredType(required): string

The actual type of the target instance when needed for disambiguation.
@schemaLocation: string (uri)

A URI to a JSON-Schema file that defines additional attributes and relationships
@type(required): string

When sub-classing, this defines the sub-class entity name
href: string

Reference of the related entity.
id(required): string

Unique identifier of a related entity.
name: string

Name of the related entity.
refId: string

Unique identifier of the reference object.
refName: string

Name of the reference object.
version: string

version of a related entity.
versionState: number

To hold the version state of reference

{
    "title":"ProductOfferingPriceRef",
    "type":"object",
    "description":"ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased",
    "properties":{
        "refId":{
            "type":"string",
            "description":"Unique identifier of the reference object."
        },
        "refName":{
            "type":"string",
            "description":"Name of the reference object."
        },
        "id":{
            "type":"string",
            "description":"Unique identifier of a related entity."
        },
        "version":{
            "type":"string",
            "description":"version of a related entity."
        },
        "href":{
            "type":"string",
            "description":"Reference of the related entity."
        },
        "name":{
            "type":"string",
            "description":"Name of the related entity."
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class"
        },
        "@schemaLocation":{
            "type":"string",
            "format":"uri",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name"
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        },
        "versionState":{
            "type":"number",
            "description":"To hold the version state of reference"
        }
    },
    "required":[
        "id",
        "@referredType",
        "@type"
    ]
}

Nested Schema : ProductOfferingPriceRefOracle-allOf[1]

Type: object

Show Source

appliesTo: string

Allowed Values: [ "ALL", "ONE_TIME", "RECURRING", "USAGE" ]

Bring in a open ended definition of alteration that specifies how price plan applicable to the offer
isBundlePrice: boolean

Used to indicate whether the referred price is the flat price for a bundle (true) or not(false).

{
    "type":"object",
    "properties":{
        "appliesTo":{
            "type":"string",
            "description":"Bring in a open ended definition of alteration that specifies how price plan applicable to the offer",
            "enum":[
                "ALL",
                "ONE_TIME",
                "RECURRING",
                "USAGE"
            ]
        },
        "isBundlePrice":{
            "type":"boolean",
            "description":"Used to indicate whether the referred price is the flat price for a bundle (true) or not(false)."
        }
    }
}

Nested Schema : EntitlementMetricsOracle

Type: object

Title: EntitlementMetricsOracle

Entitlement Metrics

Show Source

description: string

Description of Entitlement Metrics
id: string

Maximum Length: 30

Unique identifier of the entitlement metrics
metricsQuantity: object EntitlementMetricsQuantityOracle

Title: EntitlementMetricsQuantityOracle

A 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" ]

description
name: string

Name of Entitlement Metrics
priority: number

Piority of this Metrics

{
    "title":"EntitlementMetricsOracle",
    "type":"object",
    "description":"Entitlement Metrics",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"Unique identifier of the entitlement metrics"
        },
        "name":{
            "type":"string",
            "description":"Name of Entitlement Metrics"
        },
        "description":{
            "type":"string",
            "description":"Description of Entitlement Metrics"
        },
        "priority":{
            "type":"number",
            "description":"Piority of this Metrics"
        },
        "metricsType":{
            "type":"string",
            "description":"description",
            "enum":[
                "ENTL_MET_RESP_TIME",
                "ENTL_MET_SERV_AVAIL",
                "ENTL_MET_RESL_TIME",
                "ENTL_MET_ESCL_TIME"
            ]
        },
        "metricsQuantity":{
            "$ref":"#/components/schemas/EntitlementMetricsQuantityOracle",
            "description":"name of the person who updated item"
        }
    }
}

Nested Schema : EntitlementMetricsQuantityOracle

Type: object

Title: EntitlementMetricsQuantityOracle

A 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.

{
    "title":"EntitlementMetricsQuantityOracle",
    "description":"A number and unit representing entitlement metrics quantity",
    "type":"object",
    "properties":{
        "amount":{
            "type":"number",
            "description":"A quantity of something, typically the total of a thing or things in number."
        },
        "units":{
            "type":"string",
            "description":"The unit of measure for the quantity.",
            "enum":[
                "ENTL_MTCS_UNT_PRCT",
                "ENTL_MTCS_UNT_HRS",
                "ENTL_MTCS_UNT_MTS",
                "ENTL_MTCS_UNT_PNTS",
                "ENTL_MTCS_UNT_DAYS",
                "ENTL_MTCS_UNT_SCDS"
            ]
        }
    },
    "required":[
        "units",
        "amount"
    ]
}

Nested Schema : PriceListRefOracle

Type: object

Title: PriceListRefOracle

Pricelist reference.

Show Source

@baseType: string

Indicates the base (class) type of this REST resource
@referredType(required): string

The Class type of referred Price List
@schemaLocation: string

This field provides a link to the schema describing this REST resource
@type(required): string

Indicates the (class) type of PricelistRef.
href: string

Unique reference of the Pricelist
id(required): string

Unique identifier of the Pricelist
name: string

Name of the Pricelist
version: string

Version of the Pricelist
versionState: number

To hold the version state of reference

{
    "title":"PriceListRefOracle",
    "type":"object",
    "description":"Pricelist reference.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the Pricelist"
        },
        "href":{
            "type":"string",
            "description":"Unique reference of the Pricelist"
        },
        "version":{
            "type":"string",
            "description":"Version of the Pricelist"
        },
        "name":{
            "type":"string",
            "description":"Name of the Pricelist"
        },
        "@type":{
            "type":"string",
            "description":"Indicates the (class) type of PricelistRef."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"This field provides a link to the schema describing this REST resource"
        },
        "@baseType":{
            "type":"string",
            "description":"Indicates<b> the base (class) type of this REST resource"
        },
        "@referredType":{
            "type":"string",
            "description":"The Class type of  referred Price List"
        },
        "versionState":{
            "type":"number",
            "description":"To hold the version state of reference"
        }
    },
    "required":[
        "id",
        "@type",
        "@referredType"
    ]
}

Response

Supported Media Types

application/json

200 Response

Root Schema : EntitlementOracle

Type: object

Title: EntitlementOracle

Show Source

@baseType: string

Immediate base (class) type of the object
@schemaLocation: string

A link to the schema describing this object
@type: string

Indicates the type of resource. Here can be entitlement
associatedProducts(required): array associatedProducts
benefits: array benefits
created: string (date-time)

Date and time of the creation
createdBy: string

name of the person who created item
description: string

Description of entitlement
entitlementType: string

Allowed Values: [ "ENTITLEMENT_PRICING", "ENTITLEMENT_SERVICE" ]

entitlememt type
href: string

Hypertext Reference of the entitlement.
id: string

Maximum Length: 30

Unique identifier of the entitlement
lastUpdate: string (date-time)

Latest update date of entitlement
lastUpdatedBy: string

name of the person who updated item
lifecycleStatus: string

Status of entitlement
metrics: array metrics
name: string

Name of entitlement
pricelist: array pricelist
priority: number

Priority of this entitlement in relation to other entitlement assosiatedto the project.
project: object ProjectRef

Title: ProjectRef

Project Reference
quantity: object EntitlementQuantityOracle

Title: EntitlementQuantityOracle

A number and unit representing entitlement unit
validFor: object TimePeriod

Title: TimePeriod

The period for which the productOffering is valid
version: string

Promotion version
versionState: number

Version state of the entitlement

{
    "title":"EntitlementOracle",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"Unique identifier of the entitlement"
        },
        "href":{
            "type":"string",
            "description":"Hypertext Reference of the entitlement."
        },
        "name":{
            "type":"string",
            "description":"Name of entitlement"
        },
        "description":{
            "type":"string",
            "description":"Description of entitlement"
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"Latest update date of entitlement"
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Status of entitlement"
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "@type":{
            "type":"string",
            "description":"Indicates the type of resource. Here can be entitlement"
        },
        "@baseType":{
            "type":"string",
            "description":"Immediate base (class) type of the object"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this object"
        },
        "project":{
            "$ref":"#/components/schemas/ProjectRef"
        },
        "version":{
            "type":"string",
            "description":"Promotion version"
        },
        "entitlementType":{
            "type":"string",
            "description":"entitlememt type",
            "enum":[
                "ENTITLEMENT_PRICING",
                "ENTITLEMENT_SERVICE"
            ]
        },
        "pricelist":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PriceListRefOracle"
            }
        },
        "metrics":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/EntitlementMetricsOracle"
            }
        },
        "quantity":{
            "$ref":"#/components/schemas/EntitlementQuantityOracle"
        },
        "priority":{
            "type":"number",
            "description":"Priority of this entitlement in relation to other entitlement assosiatedto the project."
        },
        "associatedProducts":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AssociatedProductsEntitlementsOracle"
            }
        },
        "benefits":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/EntitlementsBenefitsOracle"
            }
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the creation"
        },
        "createdBy":{
            "type":"string",
            "description":"name of the person who created item"
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"name of the person who updated item"
        },
        "versionState":{
            "type":"number",
            "description":"Version state of the entitlement"
        }
    },
    "required":[
        "associatedProducts"
    ]
}

Nested Schema : associatedProducts

Type: array

Show Source

Array of: object AssociatedProductsEntitlementsOracle

Title: AssociatedProductsEntitlementsOracle

The products which are assosiated to entitlement, benefit or conditions

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AssociatedProductsEntitlementsOracle"
    }
}

Nested Schema : benefits

Type: array

Show Source

Array of: object EntitlementsBenefitsOracle

Title: EntitlementsBenefitsOracle

Entitlement benefits.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/EntitlementsBenefitsOracle"
    }
}

Nested Schema : metrics

Type: array

Show Source

Array of: object EntitlementMetricsOracle

Title: EntitlementMetricsOracle

Entitlement Metrics

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/EntitlementMetricsOracle"
    }
}

Nested Schema : pricelist

Type: array

Show Source

Array of: object PriceListRefOracle

Title: PriceListRefOracle

Pricelist reference.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PriceListRefOracle"
    }
}

Nested Schema : ProjectRef

Type: object

Title: ProjectRef

Project Reference

Show Source

href: string

Unique reference of the project
id(required): string

Unique identifier of the project
name: string

Name of the project
version: string

Version of the project

{
    "title":"ProjectRef",
    "type":"object",
    "description":"Project Reference",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the project"
        },
        "href":{
            "type":"string",
            "description":"Unique reference of the project"
        },
        "name":{
            "type":"string",
            "description":"Name of the project"
        },
        "version":{
            "type":"string",
            "description":"Version of the project"
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : EntitlementQuantityOracle

Type: object

Title: EntitlementQuantityOracle

A 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.

{
    "title":"EntitlementQuantityOracle",
    "description":"A number and unit representing entitlement unit",
    "type":"object",
    "properties":{
        "amount":{
            "type":"number",
            "description":"A quantity of something, typically the total of a thing or things in number."
        },
        "units":{
            "type":"string",
            "description":"The unit of measure for the quantity.",
            "enum":[
                "ENTL_UNIT_ORDERS",
                "ENTL_UNIT_SERREQ"
            ]
        }
    },
    "required":[
        "units",
        "amount"
    ]
}

Nested Schema : TimePeriod

Type: object

Title: TimePeriod

The period for which the productOffering is valid

Show Source

endDateTime: string (date-time)

An instant of time, ending at the TimePeriod.
startDateTime: string (date-time)

An instant of time, starting at the TimePeriod

{
    "title":"TimePeriod",
    "description":"The period for which the productOffering is valid",
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, starting at the TimePeriod"
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, ending at the TimePeriod."
        }
    }
}

Nested Schema : AssociatedProductsEntitlementsOracle

Type: object

Title: AssociatedProductsEntitlementsOracle

The products which are assosiated to entitlement, benefit or conditions

Show Source

@baseType: string

Immediate base (class) type of the object
@referredType: string

Type of the referred entity
@schemaLocation: string

A link to the schema describing this object
@type: string

Class type of the object
actionObjectType: string

Allowed Values: [ "PRODUCT_OFFERING", "PRODUCT_OFFERING_PRICE", "PRODUCTLINE", "CATEGORY", "PRODUCT_SPECIFICATION" ]

Type of the assosiated product
id(required): string
name: string

Name of the assosiated product

{
    "type":"object",
    "title":"AssociatedProductsEntitlementsOracle",
    "description":"The products which are assosiated to entitlement, benefit or conditions",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string",
            "description":"Name of the assosiated product"
        },
        "actionObjectType":{
            "type":"string",
            "description":"Type of the assosiated product",
            "enum":[
                "PRODUCT_OFFERING",
                "PRODUCT_OFFERING_PRICE",
                "PRODUCTLINE",
                "CATEGORY",
                "PRODUCT_SPECIFICATION"
            ]
        },
        "@type":{
            "type":"string",
            "description":"Class type of the object"
        },
        "@baseType":{
            "type":"string",
            "description":"Immediate base (class) type of the object"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this object"
        },
        "@referredType":{
            "type":"string",
            "description":"Type of the referred entity"
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : EntitlementsBenefitsOracle

Type: object

Title: EntitlementsBenefitsOracle

Entitlement benefits.

Show Source

@baseType: string

Immediate base (class) type of the object
@schemaLocation: string

A link to the schema describing this object
@type: string

Indicates the type of resource.
benefitType: string

Allowed Values: [ "ENTL_BFT_TYP_DSNT" ]

Benifit type
description: string

Description of entitlements benefit
entitlementConditionsGroup: array entitlementConditionsGroup
id: string

Maximum Length: 30

Unique identifier of the benifit
name: string

Name of entitlement benifit
priority: number

Piority of this benifit
productOfferingPrice(required): array productOfferingPrice
products(required): array products
relationShipAmongGroup: string

Allowed Values: [ "ENTL_BFT_CND_REL_ALL", "ENTL_BFT_CND_REL_ANY" ]

Condition relationship for the benfit
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" ]

Allows to define the benifit schedule
status: string

Allowed Values: [ "ENTL_BFT_STS_ACTV", "ENTL_BFT_STS_CNCLD", "ENTL_BFT_STS_EXHSTD", "ENTL_BFT_STS_NEW", "ENTL_BFT_STS_ONHOLD" ]

Signifies the current status of the benefit

{
    "title":"EntitlementsBenefitsOracle",
    "type":"object",
    "description":"Entitlement benefits.",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"Unique identifier of the benifit"
        },
        "name":{
            "type":"string",
            "description":"Name of entitlement benifit"
        },
        "description":{
            "type":"string",
            "description":"Description of entitlements benefit"
        },
        "products":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AssociatedProductsEntitlementsOracle"
            }
        },
        "priority":{
            "type":"number",
            "description":"Piority of this benifit"
        },
        "benefitType":{
            "type":"string",
            "description":"Benifit type",
            "enum":[
                "ENTL_BFT_TYP_DSNT"
            ]
        },
        "productOfferingPrice":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductOfferingPriceRefOracle"
            }
        },
        "schedule":{
            "type":"string",
            "description":"Allows to define the benifit schedule",
            "enum":[
                "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"
            ]
        },
        "status":{
            "type":"string",
            "description":"Signifies the current status of the benefit",
            "enum":[
                "ENTL_BFT_STS_ACTV",
                "ENTL_BFT_STS_CNCLD",
                "ENTL_BFT_STS_EXHSTD",
                "ENTL_BFT_STS_NEW",
                "ENTL_BFT_STS_ONHOLD"
            ]
        },
        "relationShipAmongGroup":{
            "type":"string",
            "description":"Condition relationship for the benfit",
            "enum":[
                "ENTL_BFT_CND_REL_ALL",
                "ENTL_BFT_CND_REL_ANY"
            ]
        },
        "entitlementConditionsGroup":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/EntitlementConditionsGroupOracle"
            }
        },
        "@type":{
            "type":"string",
            "description":"Indicates the type of resource."
        },
        "@baseType":{
            "type":"string",
            "description":"Immediate base (class) type of the object"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this object"
        }
    },
    "required":[
        "products",
        "productOfferingPrice"
    ]
}

Nested Schema : entitlementConditionsGroup

Type: array

Show Source

Array of: object EntitlementConditionsGroupOracle

Title: EntitlementConditionsGroupOracle

The group of the condition for the entitlement.The logical relationship between different groups is decided by the ???relationTypeInGroup???.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/EntitlementConditionsGroupOracle"
    }
}

Nested Schema : productOfferingPrice

Type: array

Show Source

Array of: ProductOfferingPriceRefOracle

Title: ProductOfferingPriceRefOracle

ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProductOfferingPriceRefOracle"
    }
}

Nested Schema : products

Type: array

Show Source

Array of: object AssociatedProductsEntitlementsOracle

Title: AssociatedProductsEntitlementsOracle

The products which are assosiated to entitlement, benefit or conditions

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AssociatedProductsEntitlementsOracle"
    }
}

Nested Schema : EntitlementConditionsGroupOracle

Type: object

Title: EntitlementConditionsGroupOracle

The group of the condition for the entitlement.The logical relationship between different groups is decided by the ???relationTypeInGroup???.

Show Source

@baseType: string

Immediate base (class) type of the object
@schemaLocation: string

A link to the schema describing this object
@type: string

Class type of the object
condition: array condition
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" ]

Signifies the condition timing , weather its Annually , weekly etc.
groupName: string

Name of the entitlement condition group
id: string

Maximum Length: 30

Unique identifier of the entitlement condition group
order: number

Seqeunce number for this condition
products(required): array products
relationTypeInGroup : string

Allowed Values: [ "AND", "OR" ]

The logical relation type amongst the entitlement condition group.AND logical relation,OR logical relation
status: string

Allowed Values: [ "ENT_CND_STA_ACTV", "ENT_CND_STA_CNCLD", "ENT_CND_STA_EXHSTD", "ENT_CND_STA_NEW", "ENT_CND_STA_ONHLD" ]

status

{
    "title":"EntitlementConditionsGroupOracle",
    "type":"object",
    "description":"The group of the condition for the entitlement.The logical relationship between different groups is decided by the ???relationTypeInGroup???.",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"Unique identifier of the entitlement condition group"
        },
        "groupName":{
            "type":"string",
            "description":"Name of the entitlement condition group"
        },
        "relationTypeInGroup ":{
            "type":"string",
            "description":"The logical relation type amongst the entitlement condition group.AND logical relation,OR logical relation",
            "enum":[
                "AND",
                "OR"
            ]
        },
        "order":{
            "type":"number",
            "description":"Seqeunce number for this condition"
        },
        "status":{
            "type":"string",
            "description":"status",
            "enum":[
                "ENT_CND_STA_ACTV",
                "ENT_CND_STA_CNCLD",
                "ENT_CND_STA_EXHSTD",
                "ENT_CND_STA_NEW",
                "ENT_CND_STA_ONHLD"
            ]
        },
        "conditionTiming":{
            "type":"string",
            "description":"Signifies the condition timing , weather its Annually , weekly etc.",
            "enum":[
                "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"
            ]
        },
        "products":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AssociatedProductsEntitlementsOracle"
            }
        },
        "@type":{
            "type":"string",
            "description":"Class type of the object"
        },
        "@baseType":{
            "type":"string",
            "description":"Immediate base (class) type of the object"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this object"
        },
        "condition":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/EntitlementConditionOracle"
            }
        }
    },
    "required":[
        "products"
    ]
}

Nested Schema : condition

Type: array

Show Source

Array of: object EntitlementConditionOracle

Title: EntitlementConditionOracle

Condition of the entitlement.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/EntitlementConditionOracle"
    }
}

Nested Schema : products

Type: array

Show Source

Array of: object AssociatedProductsEntitlementsOracle

Title: AssociatedProductsEntitlementsOracle

The products which are assosiated to entitlement, benefit or conditions

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AssociatedProductsEntitlementsOracle"
    }
}

Nested Schema : EntitlementConditionOracle

Type: object

Title: EntitlementConditionOracle

Condition of the entitlement.

Show Source

@baseType: string

Immediate base (class) type of the object
@schemaLocation: string

A link to the schema describing this object
@type: string

Class type of the object
conditionType: string

Allowed Values: [ "ENTL_COND_TYP_VOL" ]

condition type, shows the conditons being created, defaulted to volume
conditionValue: string

Condition value
id: string

Maximum Length: 30

Unique identifier 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.
unitOfMeasure: string

Allowed Values: [ "ENT_CND_UOM_ORDRS" ]

Unit of measure to satisfy the condition

{
    "title":"EntitlementConditionOracle",
    "type":"object",
    "description":"Condition of the entitlement.",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"Unique identifier of the entitlement condition"
        },
        "conditionType":{
            "type":"string",
            "description":"condition type, shows the conditons being created, defaulted to volume",
            "enum":[
                "ENTL_COND_TYP_VOL"
            ]
        },
        "conditionValue":{
            "type":"string",
            "description":"Condition value"
        },
        "unitOfMeasure":{
            "type":"string",
            "description":"Unit of measure to satisfy the condition",
            "enum":[
                "ENT_CND_UOM_ORDRS"
            ]
        },
        "operator":{
            "type":"string",
            "description":"The logic expression including parameter and operator.",
            "enum":[
                "EQUALS",
                "GREATER_THAN",
                "LESS_THAN",
                "GREATER_THAN_OR_EQUALS",
                "LESS_THAN_OR_EQUALS",
                "NOT_EQUALS"
            ]
        },
        "@type":{
            "type":"string",
            "description":"Class type of the object"
        },
        "@baseType":{
            "type":"string",
            "description":"Immediate base (class) type of the object"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this object"
        }
    }
}

Nested Schema : ProductOfferingPriceRefOracle

Title: ProductOfferingPriceRefOracle

ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased

Match All

ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased

Show Source

object ProductOfferingPriceRef

Title: ProductOfferingPriceRef

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]

{
    "title":"ProductOfferingPriceRefOracle",
    "description":"ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased",
    "allOf":[
        {
            "$ref":"#/components/schemas/ProductOfferingPriceRef"
        },
        {
            "type":"object",
            "properties":{
                "appliesTo":{
                    "type":"string",
                    "description":"Bring in a open ended definition of alteration that specifies how price plan applicable to the offer",
                    "enum":[
                        "ALL",
                        "ONE_TIME",
                        "RECURRING",
                        "USAGE"
                    ]
                },
                "isBundlePrice":{
                    "type":"boolean",
                    "description":"Used to indicate whether the referred price is the flat price for a bundle (true) or not(false)."
                }
            }
        }
    ]
}

Nested Schema : ProductOfferingPriceRef

Type: object

Title: ProductOfferingPriceRef

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

When sub-classing, this defines the super-class
@referredType(required): string

The actual type of the target instance when needed for disambiguation.
@schemaLocation: string (uri)

A URI to a JSON-Schema file that defines additional attributes and relationships
@type(required): string

When sub-classing, this defines the sub-class entity name
href: string

Reference of the related entity.
id(required): string

Unique identifier of a related entity.
name: string

Name of the related entity.
refId: string

Unique identifier of the reference object.
refName: string

Name of the reference object.
version: string

version of a related entity.
versionState: number

To hold the version state of reference

{
    "title":"ProductOfferingPriceRef",
    "type":"object",
    "description":"ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased",
    "properties":{
        "refId":{
            "type":"string",
            "description":"Unique identifier of the reference object."
        },
        "refName":{
            "type":"string",
            "description":"Name of the reference object."
        },
        "id":{
            "type":"string",
            "description":"Unique identifier of a related entity."
        },
        "version":{
            "type":"string",
            "description":"version of a related entity."
        },
        "href":{
            "type":"string",
            "description":"Reference of the related entity."
        },
        "name":{
            "type":"string",
            "description":"Name of the related entity."
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class"
        },
        "@schemaLocation":{
            "type":"string",
            "format":"uri",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name"
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        },
        "versionState":{
            "type":"number",
            "description":"To hold the version state of reference"
        }
    },
    "required":[
        "id",
        "@referredType",
        "@type"
    ]
}

Nested Schema : ProductOfferingPriceRefOracle-allOf[1]

Type: object

Show Source

appliesTo: string

Allowed Values: [ "ALL", "ONE_TIME", "RECURRING", "USAGE" ]

Bring in a open ended definition of alteration that specifies how price plan applicable to the offer
isBundlePrice: boolean

Used to indicate whether the referred price is the flat price for a bundle (true) or not(false).

{
    "type":"object",
    "properties":{
        "appliesTo":{
            "type":"string",
            "description":"Bring in a open ended definition of alteration that specifies how price plan applicable to the offer",
            "enum":[
                "ALL",
                "ONE_TIME",
                "RECURRING",
                "USAGE"
            ]
        },
        "isBundlePrice":{
            "type":"boolean",
            "description":"Used to indicate whether the referred price is the flat price for a bundle (true) or not(false)."
        }
    }
}

Nested Schema : EntitlementMetricsOracle

Type: object

Title: EntitlementMetricsOracle

Entitlement Metrics

Show Source

description: string

Description of Entitlement Metrics
id: string

Maximum Length: 30

Unique identifier of the entitlement metrics
metricsQuantity: object EntitlementMetricsQuantityOracle

Title: EntitlementMetricsQuantityOracle

A 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" ]

description
name: string

Name of Entitlement Metrics
priority: number

Piority of this Metrics

{
    "title":"EntitlementMetricsOracle",
    "type":"object",
    "description":"Entitlement Metrics",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"Unique identifier of the entitlement metrics"
        },
        "name":{
            "type":"string",
            "description":"Name of Entitlement Metrics"
        },
        "description":{
            "type":"string",
            "description":"Description of Entitlement Metrics"
        },
        "priority":{
            "type":"number",
            "description":"Piority of this Metrics"
        },
        "metricsType":{
            "type":"string",
            "description":"description",
            "enum":[
                "ENTL_MET_RESP_TIME",
                "ENTL_MET_SERV_AVAIL",
                "ENTL_MET_RESL_TIME",
                "ENTL_MET_ESCL_TIME"
            ]
        },
        "metricsQuantity":{
            "$ref":"#/components/schemas/EntitlementMetricsQuantityOracle",
            "description":"name of the person who updated item"
        }
    }
}

Nested Schema : EntitlementMetricsQuantityOracle

Type: object

Title: EntitlementMetricsQuantityOracle

A 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.

{
    "title":"EntitlementMetricsQuantityOracle",
    "description":"A number and unit representing entitlement metrics quantity",
    "type":"object",
    "properties":{
        "amount":{
            "type":"number",
            "description":"A quantity of something, typically the total of a thing or things in number."
        },
        "units":{
            "type":"string",
            "description":"The unit of measure for the quantity.",
            "enum":[
                "ENTL_MTCS_UNT_PRCT",
                "ENTL_MTCS_UNT_HRS",
                "ENTL_MTCS_UNT_MTS",
                "ENTL_MTCS_UNT_PNTS",
                "ENTL_MTCS_UNT_DAYS",
                "ENTL_MTCS_UNT_SCDS"
            ]
        }
    },
    "required":[
        "units",
        "amount"
    ]
}

Nested Schema : PriceListRefOracle

Type: object

Title: PriceListRefOracle

Pricelist reference.

Show Source

@baseType: string

Indicates the base (class) type of this REST resource
@referredType(required): string

The Class type of referred Price List
@schemaLocation: string

This field provides a link to the schema describing this REST resource
@type(required): string

Indicates the (class) type of PricelistRef.
href: string

Unique reference of the Pricelist
id(required): string

Unique identifier of the Pricelist
name: string

Name of the Pricelist
version: string

Version of the Pricelist
versionState: number

To hold the version state of reference

{
    "title":"PriceListRefOracle",
    "type":"object",
    "description":"Pricelist reference.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the Pricelist"
        },
        "href":{
            "type":"string",
            "description":"Unique reference of the Pricelist"
        },
        "version":{
            "type":"string",
            "description":"Version of the Pricelist"
        },
        "name":{
            "type":"string",
            "description":"Name of the Pricelist"
        },
        "@type":{
            "type":"string",
            "description":"Indicates the (class) type of PricelistRef."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"This field provides a link to the schema describing this REST resource"
        },
        "@baseType":{
            "type":"string",
            "description":"Indicates<b> the base (class) type of this REST resource"
        },
        "@referredType":{
            "type":"string",
            "description":"The Class type of  referred Price List"
        },
        "versionState":{
            "type":"number",
            "description":"To hold the version state of reference"
        }
    },
    "required":[
        "id",
        "@type",
        "@referredType"
    ]
}

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: object

Title: Error

Show Source

@schemaLocation: string

it provides a link to the schema describing a REST resource.
@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

Text that provide more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

Text that explains the reason for error. This can be shown to a client user.
referenceError: string

url pointing to documentation describing the error
status: string

http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"it provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

401 Response

Your request isn't authorized. The authentication credentials included with this request are missing or invalid.

Root Schema : Error

Type: object

Title: Error

Show Source

@schemaLocation: string

it provides a link to the schema describing a REST resource.
@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

Text that provide more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

Text that explains the reason for error. This can be shown to a client user.
referenceError: string

url pointing to documentation describing the error
status: string

http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"it provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

404 Response

Your request includes a resource URI that doesn't exist.

Root Schema : Error

Type: object

Title: Error

Show Source

@schemaLocation: string

it provides a link to the schema describing a REST resource.
@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

Text that provide more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

Text that explains the reason for error. This can be shown to a client user.
referenceError: string

url pointing to documentation describing the error
status: string

http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"it provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

405 Response

HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.

Root Schema : Error

Type: object

Title: Error

Show Source

@schemaLocation: string

it provides a link to the schema describing a REST resource.
@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

Text that provide more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

Text that explains the reason for error. This can be shown to a client user.
referenceError: string

url pointing to documentation describing the error
status: string

http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"it provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

500 Response

The server encountered something unexpected that prevented it from completing the request.

Root Schema : Error

Type: object

Title: Error

Show Source

@schemaLocation: string

it provides a link to the schema describing a REST resource.
@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

Text that provide more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

Text that explains the reason for error. This can be shown to a client user.
referenceError: string

url pointing to documentation describing the error
status: string

http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"it provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

Examples

The following example shows how to create or update an entitlement by submitting a put request on the REST resource using cURL.

cURL Command

curl -u username:password -X PUT \ '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.

{
    "id": "PS_111119",
    "name": "SalesEntitlement1001",
    "description": "Entitlement",
    "version": "1.0",
    "lifecycleStatus": "In design",
    "@type": "EntitlementOracle",
    "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"
    },
    "validFor": {
        "startDateTime": "2021-01-01T00:00:00.000Z"
    },
    "entitlementType": "ENTITLEMENT_PRICING",
    "quantity": {
        "amount": 11,
        "units": "ENTL_UNIT_ORDERS"
    },
    "priority": 1,
    "pricelist": [
        {
            "id": "US_PRICE_LIST_Auto",
            "name": "US_PRICE_LIST_Auto",
            "@type": "PriceListRefOracle",
            "@referredType": "PricelistOracle"
        }
    ],
    "associatedProducts": [
        {
            "id": "Auto-PO-26112021",
            "name": "Auto-PO-26112021",
            "actionObjectType": "PRODUCT_OFFERING",
            "@type" : "AssociatedProductsEntitlementsOracle",
            "@referredType": "ProductOfferingOracle"
        }
    ],
    "benefits": [
        {
            "id": "Benefit0232d",
            "name": "Benefit0224",
            "description": "Benefit0224",
            "@type" : "EntitlementsBenefitsOracle",
            "products": [
                {
                    "id": "Auto-PO-26112021",
                    "name": "Auto-PO-26112021",
                    "actionObjectType": "PRODUCT_OFFERING",
                    "@type" : "AssociatedProductsEntitlementsOracle",
                    "@referredType": "ProductOfferingOracle"
                }
            ],
            "priority": 1,
            "benefitType": "ENTL_BFT_TYP_DSNT",
            "productOfferingPrice": [
                {
                    "id": "TestPOP2911",
                    "name": "TestPOP2911",
                    "@type": "ProductOfferingPriceRefOracle",
                    "appliesTo": "ALL",
                    "@referredType": "ProductOfferPriceAlterationOracle"
                }
            ],
            "schedule": "ENTL_BFT_SCDL_WEKLY",
            "status": "ENTL_BFT_STS_ACTV",
            "relationshipAmongGroup": "ENTL_BFT_CND_REL_ALL",
            "entitlementConditionsGroup": [
                {
                    "id": "ConditionGroup1",
                    "groupName": "ConditionGroup1",
                    "relationTypeInGroup": "AND",
                    "order": 1,
                    "status": "ENT_CND_STA_ACTV",
                    "conditionTiming": "ENT_CND_TMG_WEKLY",
                    "@type" : "EntitlementConditionsGroupOracle",
                    "products": [
                        {
                            "id": "Common-PS-26112021",
                            "name": "Common-PS-26112021",
                            "actionObjectType": "PRODUCT_SPECIFICATION",
                            "@type" : "AssociatedProductsEntitlementsOracle",
                            "@referredType": "ProductSpecificationOracle"
                        }
                    ],
                    "condition": [
                        {
                            "id": "condt-2621961148-1641464904",
                            "conditionType": "ENTL_COND_TYP_VOL",
                            "conditionValue": "100",
                            "unitOfMeasure": "ENT_CND_UOM_ORDRS",
                            "operator": "EQUALS",
                            "@type" : "EntitlementConditionOracle"
                        }
                    ]
                }
            ]
        }
    ]
}

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "lastUpdate": "2025-02-19T16:15:04.182Z",
    "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": "Entitlement",
    "@type": "EntitlementOracle",
    "version": "1.0",
    "validFor": {
        "startDateTime": "2021-01-01T00: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",
                    "@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"
                        }
                    ]
                }
            ]
        }
    ]
}