Get all entitlements

get

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

Returns a list of entitlements that match the search criteria.

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 ID of the resource item.
  • Filters resources by their last update date and time.
  • 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.
  • The ID of the project for filtering resource results.
  • The project version for filtering entities.
  • The valid for end date time for filtering entities.
  • The valid for start date time for filtering entities.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

The list of entitlements was returned successfully.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : EntitlementOracle
Type: object
Title: EntitlementOracle
The entitlement resource.
Show Source
Nested Schema : associatedProducts
Type: array
A list of associated products associated with the entitlement.
Show Source
Nested Schema : benefits
Type: array
A list of benefits associated with the entitlement.
Show Source
Nested Schema : metrics
Type: array
A list of metrics associated with the entitlement.
Show Source
Nested Schema : pricelist
Type: array
A list of pricelists associated with the entitlement.
Show Source
Nested Schema : ProjectRef
Type: object
Title: ProjectRef
The project reference resource.
Show Source
Nested Schema : EntitlementQuantityOracle
Type: object
Title: EntitlementQuantityOracle
A number and unit representing entitlement unit.
Show Source
  • A quantity of something, typically the total of a thing or things in number.
  • Allowed Values: [ "ENTL_UNIT_ORDERS", "ENTL_UNIT_SERREQ" ]
    The unit of measure for the quantity. Valid values are ENTL_UNIT_ORDERS, and ENTL_UNIT_SERREQ.
Nested Schema : TimePeriod
Type: object
Title: TimePeriod
The period for which the productOffering is valid.
Show Source
Nested Schema : AssociatedProductsEntitlementsOracle
Type: object
Title: AssociatedProductsEntitlementsOracle
The products which are associated to entitlement, benefit or conditions.
Show Source
  • The base type of the associated products entitlement.
  • The type of the referred associated products entitlement.
  • The URI of the schema that defines the associated products entitlement.
  • The class type of the associated products entitlement.
  • Allowed Values: [ "PRODUCT_OFFERING", "PRODUCT_OFFERING_PRICE", "PRODUCTLINE", "CATEGORY", "PRODUCT_SPECIFICATION" ]
    The type or classification of the associated products entitlement. Valid values are PRODUCT_OFFERING, PRODUCT_OFFERING_PRICE, PRODUCTLINE, CATEGORY, and PRODUCT_SPECIFICATION.
  • The ID of the associated products entitlement.
  • The name of the associated products entitlement.
Nested Schema : EntitlementsBenefitsOracle
Type: object
Title: EntitlementsBenefitsOracle
The entitlement benefits.
Show Source
Nested Schema : entitlementConditionsGroup
Type: array
A list of entitlement conditions groups associated with the entitlements benefit.
Show Source
Nested Schema : productOfferingPrice
Type: array
A list of product offering prices associated with the entitlements benefit.
Show Source
Nested Schema : products
Type: array
A list of products associated with the entitlements benefit.
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
  • The base type of the entitlement conditions group.
  • The URI of the schema that defines the entitlement conditions group.
  • The class type of the entitlement conditions group.
  • condition
    A list of conditions associated with the entitlement conditions group.
  • Allowed Values: [ "ENT_CND_TMG_ANLY", "ENT_CND_TMG_BIANLY", "ENT_CND_TMG_CTRTRM", "ENT_CND_TMG_CTRYR", "ENT_CND_TMG_MTLY", "ENT_CND_TMG_QRTLY", "ENT_CND_TMG_WEKLY" ]
    The condition timing, whether it is annually, weekly, or another supported interval. Valid values are ENT_CND_TMG_ANLY, ENT_CND_TMG_BIANLY, ENT_CND_TMG_CTRTRM, ENT_CND_TMG_CTRYR, ENT_CND_TMG_MTLY, ENT_CND_TMG_QRTLY, and ENT_CND_TMG_WEKLY.
  • The name of the group associated with the entitlement conditions group.
  • Maximum Length: 30
    The ID of the entitlement conditions group.
  • The seqeunce number for this condition.
  • products
    A list of products associated with the entitlement conditions group.
  • Allowed Values: [ "AND", "OR" ]
    The logical relation type among the entitlement condition group. Valid values are AND and OR.
  • Allowed Values: [ "ENT_CND_STA_ACTV", "ENT_CND_STA_CNCLD", "ENT_CND_STA_EXHSTD", "ENT_CND_STA_NEW", "ENT_CND_STA_ONHLD" ]
    The status of the entitlement conditions group.
Nested Schema : condition
Type: array
A list of conditions associated with the entitlement conditions group.
Show Source
Nested Schema : products
Type: array
A list of products associated with the entitlement conditions group.
Show Source
Nested Schema : EntitlementConditionOracle
Type: object
Title: EntitlementConditionOracle
The condition of the entitlement.
Show Source
  • The base type of the entitlement condition.
  • The URI of the schema that defines the entitlement condition.
  • The class type of the entitlement condition.
  • Allowed Values: [ "ENTL_COND_TYP_VOL" ]
    The type or classification of the entitlement condition. Valid values are ENTL_COND_TYP_VOL.
  • The value assigned to the entitlement condition.
  • Maximum Length: 30
    The ID of the entitlement condition.
  • Allowed Values: [ "EQUALS", "GREATER_THAN", "LESS_THAN", "GREATER_THAN_OR_EQUALS", "LESS_THAN_OR_EQUALS", "NOT_EQUALS" ]
    The logic expression including parameter and operator. Valid values are EQUALS, GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUALS, LESS_THAN_OR_EQUALS, and NOT_EQUALS.
  • Allowed Values: [ "ENT_CND_UOM_ORDRS" ]
    The unit of measure to satisfy the condition. Valid values are ENT_CND_UOM_ORDRS.
Nested Schema : ProductOfferingPriceRefOracle
Title: ProductOfferingPriceRefOracle
Match All
Show Source
Nested Schema : ProductOfferingPriceRef
Type: object
Title: ProductOfferingPriceRef
The 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" ]
    The bring in a open ended definition of alteration that specifies how price plan applicable to the offer. Valid values are ALL, ONE_TIME, RECURRING, and USAGE.
  • Whether the product offering price reference is bundle price.
Nested Schema : EntitlementMetricsOracle
Type: object
Title: EntitlementMetricsOracle
The entitlement metric resource.
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. Valid values are ENTL_MTCS_UNT_PRCT, ENTL_MTCS_UNT_HRS, ENTL_MTCS_UNT_MTS, ENTL_MTCS_UNT_PNTS, ENTL_MTCS_UNT_DAYS, and ENTL_MTCS_UNT_SCDS.
Nested Schema : PriceListRefOracle
Type: object
Title: PriceListRefOracle
The 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
The error resource.
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
The error resource.
Show Source

404 Response

The resource with the specified URI couldn't be found.
Body ()
Root Schema : Error
Type: object
Title: Error
The error resource.
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
The error resource.
Show Source

500 Response

The server encountered something unexpected that prevented it from completing the request.
Body ()
Root Schema : Error
Type: object
Title: Error
The error resource.
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": "2025-03-10T10:03:02.304Z",
        "lastUpdatedBy": "booth",
        "created": "2025-02-19T16:11:47.000Z",
        "createdBy": "booth",
        "id": "PS_111119",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/entitlement/PS_111119",
        "name": "SalesEntitlement1001",
        "description": "Sales Entitlement 1009 2025",
        "@type": "EntitlementOracle",
        "version": "1.0",
        "validFor": {
            "startDateTime": "2024-08-09T00:00:00.000Z",
            "endDateTime": "2028-08-09T00:00:00.000Z"
        },
        "project": {
            "id": "DBE_RI_ProdModel_PreSeed_PSP",
            "name": "DBE RI Product Model Preseed",
            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/DBE_RI_ProdModel_PreSeed_PSP",
            "version": "1.0",
            "@referredType": "ProjectOracle"
        },
        "lifecycleStatus": "In design",
        "entitlementType": "ENTITLEMENT_PRICING",
        "priority": 1,
        "quantity": {
            "amount": 11,
            "units": "ENTL_UNIT_ORDERS"
        },
        "pricelist": [
            {
                "id": "US_PRICE_LIST_Auto",
                "name": "US_PRICE_LIST_Auto",
                "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/pricelist/US_PRICE_LIST_Auto",
                "@referredType": "PricelistOracle",
                "@type": "PriceListRefOracle"
            }
        ],
        "associatedProducts": [
            {
                "id": "Auto-PO-26112021",
                "name": "Auto-PO-26112021",
                "actionObjectType": "PRODUCT_OFFERING",
                "@referredType": "ProductOfferingOracle",
                "@type": "AssociatedProductsEntitlementsOracle"
            }
        ],
        "benefits": [
            {
                "id": "Benefit0232d",
                "name": "Benefit0224",
                "description": "Benefit0224",
                "@type": "EntitlementsBenefitsOracle",
                "priority": 1,
                "benefitType": "ENTL_BFT_TYP_DSNT",
                "status": "ENTL_BFT_STS_ACTV",
                "schedule": "ENTL_BFT_SCDL_WEKLY",
                "relationshipAmongGroup": "ENTL_BFT_CND_REL_ALL",
                "products": [
                    {
                        "id": "Auto-PO-26112021",
                        "name": "Auto-PO-26112021",
                        "actionObjectType": "PRODUCT_OFFERING",
                        "@referredType": "ProductOfferingOracle",
                        "@type": "AssociatedProductsEntitlementsOracle"
                    }
                ],
                "productOfferingPrice": [
                    {
                        "id": "TestPOP2911",
                        "name": "TestPOP2911",
                        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/productOfferingPrice/TestPOP2911",
                        "@referredType": "ProductOfferPriceAlterationOracle",
                        "@type": "ProductOfferingPriceRefOracle",
                        "appliesTo": "ALL"
                    }
                ],
                "entitlementConditionsGroup": [
                    {
                        "id": "ConditionGroup1",
                        "groupName": "ConditionGroup1",
                        "@type": "EntitlementConditionsGroupOracle",
                        "relationTypeInGroup": "AND",
                        "order": 1,
                        "status": "ENT_CND_STA_ACTV",
                        "conditionTiming": "ENT_CND_TMG_WEKLY",
                        "condition": [
                            {
                                "id": "condt-2621961148-1641464904",
                                "@type": "EntitlementConditionOracle",
                                "unitOfMeasure": "ENT_CND_UOM_ORDRS",
                                "conditionValue": "100",
                                "conditionType": "ENTL_COND_TYP_VOL",
                                "operator": "EQUALS"
                            }
                        ],
                        "products": [
                            {
                                "id": "Common-PS-26112021",
                                "name": "Common-PS-26112021",
                                "actionObjectType": "PRODUCT_SPECIFICATION",
                                "@referredType": "ProductSpecificationOracle",
                                "@type": "AssociatedProductsEntitlementsOracle"
                            }
                        ]
                    }
                ]
            }
        ]
    },
    {
        "lastUpdate": "2025-03-10T10:03:02.304Z",
        "lastUpdatedBy": "booth",
        "created": "2025-02-19T16:11:47.000Z",
        "createdBy": "booth",
        "id": "PS_111118",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/entitlement/PS_111118",
        "name": "SalesEntitlement1008",
        "description": "Sales Entitlement 1008 2025",
        "@type": "EntitlementOracle",
        "version": "1.0",
        "validFor": {
            "startDateTime": "2024-08-09T00:00:00.000Z",
            "endDateTime": "2028-08-09T00:00:00.000Z"
        },
        "project": {
            "id": "DBE_RI_ProdModel_PreSeed_PSP",
            "name": "DBE RI Product Model Preseed",
            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/DBE_RI_ProdModel_PreSeed_PSP",
            "version": "1.0",
            "@referredType": "ProjectOracle"
        },
        "lifecycleStatus": "In design",
        "entitlementType": "ENTITLEMENT_PRICING",
        "priority": 1,
        "quantity": {
            "amount": 11,
            "units": "ENTL_UNIT_ORDERS"
        },
        "pricelist": [
            {
                "id": "US_PRICE_LIST_Auto",
                "name": "US_PRICE_LIST_Auto",
                "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/pricelist/US_PRICE_LIST_Auto",
                "@referredType": "PricelistOracle",
                "@type": "PriceListRefOracle"
            }
        ],
        "associatedProducts": [
            {
                "id": "Auto-PO-26112021",
                "name": "Auto-PO-26112021",
                "actionObjectType": "PRODUCT_OFFERING",
                "@referredType": "ProductOfferingOracle",
                "@type": "AssociatedProductsEntitlementsOracle"
            }
        ],
        "benefits": [
            {
                "id": "Benefit0232d",
                "name": "Benefit0224",
                "description": "Benefit0224",
                "@type": "EntitlementsBenefitsOracle",
                "priority": 1,
                "benefitType": "ENTL_BFT_TYP_DSNT",
                "status": "ENTL_BFT_STS_ACTV",
                "schedule": "ENTL_BFT_SCDL_WEKLY",
                "relationshipAmongGroup": "ENTL_BFT_CND_REL_ALL",
                "products": [
                    {
                        "id": "Auto-PO-26112021",
                        "name": "Auto-PO-26112021",
                        "actionObjectType": "PRODUCT_OFFERING",
                        "@referredType": "ProductOfferingOracle",
                        "@type": "AssociatedProductsEntitlementsOracle"
                    }
                ],
                "productOfferingPrice": [
                    {
                        "id": "TestPOP2911",
                        "name": "TestPOP2911",
                        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/productOfferingPrice/TestPOP2911",
                        "@referredType": "ProductOfferPriceAlterationOracle",
                        "@type": "ProductOfferingPriceRefOracle",
                        "appliesTo": "ALL"
                    }
                ],
                "entitlementConditionsGroup": [
                    {
                        "id": "ConditionGroup1",
                        "groupName": "ConditionGroup1",
                        "@type": "EntitlementConditionsGroupOracle",
                        "relationTypeInGroup": "AND",
                        "order": 1,
                        "status": "ENT_CND_STA_ACTV",
                        "conditionTiming": "ENT_CND_TMG_WEKLY",
                        "condition": [
                            {
                                "id": "condt-2621961148-1641464904",
                                "@type": "EntitlementConditionOracle",
                                "unitOfMeasure": "ENT_CND_UOM_ORDRS",
                                "conditionValue": "100",
                                "conditionType": "ENTL_COND_TYP_VOL",
                                "operator": "EQUALS"
                            }
                        ],
                        "products": [
                            {
                                "id": "Common-PS-26112021",
                                "name": "Common-PS-26112021",
                                "actionObjectType": "PRODUCT_SPECIFICATION",
                                "@referredType": "ProductSpecificationOracle",
                                "@type": "AssociatedProductsEntitlementsOracle"
                            }
                        ]
                    }
                ]
            }
        ]
    }
]
Back to Top