1. REST API Reference for Launch Cloud Service
  2. Tasks
  3. Entitlements

Get all entitlements

get

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

Request

Query Parameters
  • The description of the resource.
  • The comma-separated field names that are returned in the response. The field names are the names that you specify when you create or retrieve a resource.
  • The unique identifier of the resource item.
  • The current lifecycle status of the resource.
  • The number of resources to be returned in the response. The minimum value that can be specified is 1, and the maximum value that can be specified is 100,000. If the specified value is greater than 100,000, then it defaults to 100,000.
  • The name of the resource.
  • The record number from which the retrieval starts. The default value is zero. If no value is specified, then it defaults to zero. The value zero indicates that the retrieval will start from the beginning of the collection.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : EntitlementOracle
Type: object
Title: EntitlementOracle
Show Source
Nested Schema : associatedProducts
Type: array
Show Source
Nested Schema : benefits
Type: array
Show Source
Nested Schema : metrics
Type: array
Show Source
Nested Schema : pricelist
Type: array
Show Source
Nested Schema : ProjectRef
Type: object
Title: ProjectRef
Project Reference
Show Source
Nested Schema : EntitlementQuantityOracle
Type: object
Title: EntitlementQuantityOracle
A number and unit representing entitlement unit
Show Source
Nested Schema : TimePeriod
Type: object
Title: TimePeriod
The period for which the productOffering is valid
Show Source
Nested Schema : AssociatedProductsEntitlementsOracle
Type: object
Title: AssociatedProductsEntitlementsOracle
The products which are assosiated to entitlement, benefit or conditions
Show Source
Nested Schema : EntitlementsBenefitsOracle
Type: object
Title: EntitlementsBenefitsOracle
Entitlement benefits.
Show Source
Nested Schema : entitlementConditionsGroup
Type: array
Show Source
Nested Schema : productOfferingPrice
Type: array
Show Source
  • ProductOfferingPriceRefOracle
    Title: ProductOfferingPriceRefOracle
    ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased
Nested Schema : products
Type: array
Show Source
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
Nested Schema : condition
Type: array
Show Source
Nested Schema : products
Type: array
Show Source
Nested Schema : EntitlementConditionOracle
Type: object
Title: EntitlementConditionOracle
Condition of the entitlement.
Show Source
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
ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased
Show Source
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
Nested Schema : ProductOfferingPriceRefOracle-allOf[1]
Type: object
Show Source
  • Allowed Values: [ "ALL", "ONE_TIME", "RECURRING", "USAGE" ]
    Bring in a open ended definition of alteration that specifies how price plan applicable to the offer
  • 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
Nested Schema : EntitlementMetricsQuantityOracle
Type: object
Title: EntitlementMetricsQuantityOracle
A number and unit representing entitlement metrics quantity
Show Source
  • A quantity of something, typically the total of a thing or things in number.
  • 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.
Nested Schema : PriceListRefOracle
Type: object
Title: PriceListRefOracle
Pricelist reference.
Show Source

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.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

401 Response

Your request isn't authorized. The authentication credentials included with this request are missing or invalid.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

404 Response

Your request includes a resource URI that doesn't exist.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

405 Response

HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

500 Response

The server encountered something unexpected that prevented it from completing the request.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source
Back to Top

Examples

The following example shows how to get all entitlements by submitting a get request on the REST resource using cURL.

cURL Command

curl -u username:password -X GET 'https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/entitlement' \ -H 'Content-Type: application/json'

Example of Response Body

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

[
    {
        "lastUpdate": "2022-04-28T13:28:28.309Z",
        "lastUpdatedBy": "booth",
        "created": "2022-04-13T07:55:59.000Z",
        "createdBy": "anonymous",
        "id": "Oracle_XL53HHEY",
        "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/entitlement/Oracle_XL53HHEY",
        "name": "Names_H6ZPOV1SO",
        "description": "Entitlement",
        "@type": "EntitlementOracle",
        "version": "1.0",
        "validFor": {
            "startDateTime": "2021-01-01T00:00:00.000Z"
        },
        "project": {
            "id": "AutomationProject",
            "name": "AutomationProject",
            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/AutomationProject"
        },
        "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"
            }
        ],
        "associatedProducts": [
            {
                "id": "Auto-PO-26112021",
                "name": "Auto-PO-26112021",
                "actionObjectType": "PRODUCT_OFFERING",
                "@referredType": "ProductOfferingOracle"
            }
        ],
        "benefits": [
            {
                "id": "Benefit0232d",
                "name": "Benefit0224",
                "description": "Benefit0224",
                "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"
                    }
                ],
                "productOfferingPrice": [
                    {
                        "id": "TestPOP2911",
                        "name": "TestPOP2911",
                        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productOfferingPrice/TestPOP2911",
                        "@referredType": "ProductOfferPriceAlterationOracle",
                        "@type": "ProductOfferingPriceRefOracle",
                        "appliesTo": "ALL"
                    }
                ],
                "entitlementConditionsGroup": [
                    {
                        "id": "ConditionGroup1",
                        "groupName": "ConditionGroup1",
                        "relationTypeInGroup": "AND",
                        "order": 1,
                        "status": "ENT_CND_STA_ACTV",
                        "conditionTiming": "ENT_CND_TMG_WEKLY",
                        "condition": [
                            {
                                "id": "condt-2621961148-1641464904",
                                "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"
                            }
                        ]
                    }
                ]
            }
        ]
    },.....
]
Back to Top