Find all entitlements for catalog item

Retrieve all entitlements for a CatalogItem and the service to which the catalog item belongs.If the service identifier is not supplied while making the API call ; it is computed on the server side.
Here are some common OData properties to use for $filter or $orderby
name - filter based off the entitlement's name
description - filter based off entitlement's description
status - filter based off entitlement's status (e.g.: DRAFT, ACTIVE, INACTIVE)
organization/subTenant/id - filter based off entitlement's business group id (which can be found in entitlement payload under organization -> subtenantRef)
organization/subTenant/name - filter based off entitlement's business group name (which can be found in entitlement payload under organization -> subtenantLabel)
Request
URI
GET
https://{api_host}/catalog-service/api/catalogItems/{catalogItemId}/entitlements
COPY
Path Parameters
string
catalogItemId
Required
The catalog item Id for which all the entitlements have to be returned.
Query Parameters
string
serviceId
Optional
The service Id for which all the entitlements have to be returned.This is an optional parameter
integer
page
Optional
Page Number
integer
limit
Optional
Number of entries per page
string
$orderby
Optional
Multiple comma-separated properties sorted in ascending or descending order
integer
$top
Optional
Sets the number of returned entries from the top of the response (total number per page in relation to skip)
integer
$skip
Optional
Sets how many entries you would like to skip
string
$filter
Optional
Boolean expression for whether a particular entry should be included in the response
Responses
200
successful operation
Returns PageEntitlement of type(s) */*
{
    "number": 0,
    "size": 0,
    "last": false,
    "numberOfElements": 0,
    "totalPages": 0,
    "content": [
        {
            "lastUpdatedBy": "string",
            "entitledServices": [
                {
                    "active": false,
                    "approvalPolicyId": "string",
                    "serviceRef": {
                        "iconId": {
                            "image": [
                                "string"
                            ],
                            "fileName": "string",
                            "id": "string",
                            "contentType": "string"
                        },
                        "owner": {
                            "ref": "string",
                            "lastSync": "string",
                            "expired": false,
                            "tenantName": "string",
                            "name": "string",
                            "id": "string",
                            "type": "string"
                        },
                        "lastUpdatedBy": "string",
                        "hours": {
                            "startTime": "string",
                            "endTime": "string"
                        },
                        "description": "string",
                        "supportTeam": {
                            "ref": "string",
                            "lastSync": "string",
                            "expired": false,
                            "tenantName": "string",
                            "name": "string",
                            "id": "string",
                            "type": "string"
                        },
                        "version": 0,
                        "lastUpdatedDate": "string",
                        "changeWindow": {
                            "hours": {
                                "startTime": "string",
                                "endTime": "string"
                            },
                            "dayOfWeek": "string"
                        },
                        "name": "string",
                        "statusName": "string",
                        "newDuration": {
                            "unit": "string",
                            "amount": 0
                        },
                        "id": "string",
                        "status": "string"
                    }
                }
            ],
            "allUsers": false,
            "entitledCatalogItems": [
                {
                    "hidden": false,
                    "catalogItemRequestable": false,
                    "active": false,
                    "catalogItemRef": {
                        "iconId": {
                            "image": [
                                "string"
                            ],
                            "fileName": "string",
                            "id": "string",
                            "contentType": "string"
                        },
                        "isNoteworthy": false,
                        "providerBinding": {
                            "providerRef": {
                                "name": "string",
                                "providerTypeId": {
                                    "name": "string",
                                    "id": "string"
                                },
                                "id": "string"
                            },
                            "bindingId": "string"
                        },
                        "callbacks": {
                            "rollback": false,
                            "itemInitialize": false,
                            "itemInformation": false,
                            "validate": false
                        },
                        "description": "string",
                        "serviceRef": {
                            "iconId": {
                                "image": [
                                    "string"
                                ],
                                "fileName": "string",
                                "id": "string",
                                "contentType": "string"
                            },
                            "owner": {
                                "ref": "string",
                                "lastSync": "string",
                                "expired": false,
                                "tenantName": "string",
                                "name": "string",
                                "id": "string",
                                "type": "string"
                            },
                            "lastUpdatedBy": "string",
                            "hours": {
                                "startTime": "string",
                                "endTime": "string"
                            },
                            "description": "string",
                            "supportTeam": {
                                "ref": "string",
                                "lastSync": "string",
                                "expired": false,
                                "tenantName": "string",
                                "name": "string",
                                "id": "string",
                                "type": "string"
                            },
                            "version": 0,
                            "lastUpdatedDate": "string",
                            "changeWindow": {
                                "hours": {
                                    "startTime": "string",
                                    "endTime": "string"
                                },
                                "dayOfWeek": "string"
                            },
                            "name": "string",
                            "statusName": "string",
                            "newDuration": {
                                "unit": "string",
                                "amount": 0
                            },
                            "id": "string",
                            "status": "string"
                        },
                        "version": 0,
                        "lastUpdatedDate": "string",
                        "dateCreated": "string",
                        "catalogItemTypeRef": {
                            "iconId": {
                                "image": [
                                    "string"
                                ],
                                "fileName": "string",
                                "id": "string",
                                "contentType": "string"
                            },
                            "requestSchema": {
                                "classId": "string",
                                "typeFilter": "string"
                            },
                            "description": "string",
                            "callbacks": {
                                "rollback": false,
                                "itemInitialize": false,
                                "itemInformation": false,
                                "validate": false
                            },
                            "outputResourceTypeId": {
                                "iconId": {
                                    "image": [
                                        "string"
                                    ],
                                    "fileName": "string",
                                    "id": "string",
                                    "contentType": "string"
                                },
                                "schema": {
                                    "classId": "string",
                                    "typeFilter": "string"
                                },
                                "pluralizedName": "string",
                                "parentTypeId": "ResourceType Object",
                                "callbacks": {
                                    "details": false,
                                    "list": false
                                },
                                "costFeatures": {
                                    "leaseCost": false,
                                    "lease": false
                                },
                                "description": "string",
                                "deleteIfNoChildren": false,
                                "listView": {
                                    "columns": [
                                        {
                                            "filterable": false,
                                            "permissibleValues": {
                                                "customAllowed": false
                                            },
                                            "displayAdvice": "string",
                                            "dataType": {
                                                "typeId": "string"
                                            },
                                            "isMultiValued": false,
                                            "description": "string",
                                            "orderIndex": 0,
                                            "id": "string",
                                            "label": "string",
                                            "state": {
                                                "dependencies": [
                                                    "string"
                                                ],
                                                "facets": [
                                                    {}
                                                ]
                                            },
                                            "sortable": false
                                        }
                                    ],
                                    "defaultSequence": [
                                        "string"
                                    ]
                                },
                                "name": "string",
                                "providerTypeId": {
                                    "name": "string",
                                    "id": "string"
                                },
                                "id": "string",
                                "forms": {
                                    "catalogResourceInfoHidden": false
                                },
                                "listDescendantTypesSeparately": false,
                                "primary": false,
                                "showChildrenOutsideParent": false,
                                "status": "string"
                            },
                            "createCustomApprovalTypes": false,
                            "itemSchema": {
                                "classId": "string",
                                "typeFilter": "string"
                            },
                            "providerId": {
                                "name": "string",
                                "providerTypeId": {
                                    "name": "string",
                                    "id": "string"
                                },
                                "id": "string"
                            },
                            "name": "string",
                            "providerTypeId": {
                                "name": "string",
                                "id": "string"
                            },
                            "id": "string",
                            "requestable": false,
                            "forms": {
                                "requestFormScale": "string",
                                "catalogRequestInfoHidden": false
                            }
                        },
                        "outputResourceTypeRef": {
                            "iconId": {
                                "image": [
                                    "string"
                                ],
                                "fileName": "string",
                                "id": "string",
                                "contentType": "string"
                            },
                            "schema": {
                                "classId": "string",
                                "typeFilter": "string"
                            },
                            "pluralizedName": "string",
                            "parentTypeId": "ResourceType Object",
                            "callbacks": {
                                "details": false,
                                "list": false
                            },
                            "costFeatures": {
                                "leaseCost": false,
                                "lease": false
                            },
                            "description": "string",
                            "deleteIfNoChildren": false,
                            "listView": {
                                "columns": [
                                    {
                                        "filterable": false,
                                        "permissibleValues": {
                                            "customAllowed": false
                                        },
                                        "displayAdvice": "string",
                                        "dataType": {
                                            "typeId": "string"
                                        },
                                        "isMultiValued": false,
                                        "description": "string",
                                        "orderIndex": 0,
                                        "id": "string",
                                        "label": "string",
                                        "state": {
                                            "dependencies": [
                                                "string"
                                            ],
                                            "facets": [
                                                {}
                                            ]
                                        },
                                        "sortable": false
                                    }
                                ],
                                "defaultSequence": [
                                    "string"
                                ]
                            },
                            "name": "string",
                            "providerTypeId": {
                                "name": "string",
                                "id": "string"
                            },
                            "id": "string",
                            "forms": {
                                "catalogResourceInfoHidden": false
                            },
                            "listDescendantTypesSeparately": false,
                            "primary": false,
                            "showChildrenOutsideParent": false,
                            "status": "string"
                        },
                        "quota": 0,
                        "name": "string",
                        "statusName": "string",
                        "id": "string",
                        "requestable": false,
                        "forms": {
                            "requestFormScale": "string",
                            "catalogRequestInfoHidden": false
                        },
                        "status": "string"
                    },
                    "approvalPolicyId": "string"
                }
            ],
            "description": "string",
            "principals": [
                {
                    "ref": "string",
                    "lastSync": "string",
                    "expired": false,
                    "tenantName": "string",
                    "name": "string",
                    "id": "string",
                    "type": "string"
                }
            ],
            "version": 0,
            "priorityOrder": 0,
            "expiryDate": "string",
            "lastUpdatedDate": "string",
            "name": "string",
            "statusName": "string",
            "id": "string",
            "entitledResourceOperations": [
                {
                    "targetResourceTypeRef": {
                        "iconId": {
                            "image": [
                                "string"
                            ],
                            "fileName": "string",
                            "id": "string",
                            "contentType": "string"
                        },
                        "schema": {
                            "classId": "string",
                            "typeFilter": "string"
                        },
                        "pluralizedName": "string",
                        "parentTypeId": "ResourceType Object",
                        "callbacks": {
                            "details": false,
                            "list": false
                        },
                        "costFeatures": {
                            "leaseCost": false,
                            "lease": false
                        },
                        "description": "string",
                        "deleteIfNoChildren": false,
                        "listView": {
                            "columns": [
                                {
                                    "filterable": false,
                                    "permissibleValues": {
                                        "customAllowed": false
                                    },
                                    "displayAdvice": "string",
                                    "dataType": {
                                        "typeId": "string"
                                    },
                                    "isMultiValued": false,
                                    "description": "string",
                                    "orderIndex": 0,
                                    "id": "string",
                                    "label": "string",
                                    "state": {
                                        "dependencies": [
                                            "string"
                                        ],
                                        "facets": [
                                            {}
                                        ]
                                    },
                                    "sortable": false
                                }
                            ],
                            "defaultSequence": [
                                "string"
                            ]
                        },
                        "name": "string",
                        "providerTypeId": {
                            "name": "string",
                            "id": "string"
                        },
                        "id": "string",
                        "forms": {
                            "catalogResourceInfoHidden": false
                        },
                        "listDescendantTypesSeparately": false,
                        "primary": false,
                        "showChildrenOutsideParent": false,
                        "status": "string"
                    },
                    "active": false,
                    "externalId": "string",
                    "approvalPolicyId": "string",
                    "resourceOperationType": "string",
                    "resourceOperationRef": {
                        "iconId": {
                            "image": [
                                "string"
                            ],
                            "fileName": "string",
                            "id": "string",
                            "contentType": "string"
                        },
                        "name": "string",
                        "targetResourceTypeRef": {
                            "iconId": {
                                "image": [
                                    "string"
                                ],
                                "fileName": "string",
                                "id": "string",
                                "contentType": "string"
                            },
                            "schema": {
                                "classId": "string",
                                "typeFilter": "string"
                            },
                            "pluralizedName": "string",
                            "parentTypeId": "ResourceType Object",
                            "callbacks": {
                                "details": false,
                                "list": false
                            },
                            "costFeatures": {
                                "leaseCost": false,
                                "lease": false
                            },
                            "description": "string",
                            "deleteIfNoChildren": false,
                            "listView": {
                                "columns": [
                                    {
                                        "filterable": false,
                                        "permissibleValues": {
                                            "customAllowed": false
                                        },
                                        "displayAdvice": "string",
                                        "dataType": {
                                            "typeId": "string"
                                        },
                                        "isMultiValued": false,
                                        "description": "string",
                                        "orderIndex": 0,
                                        "id": "string",
                                        "label": "string",
                                        "state": {
                                            "dependencies": [
                                                "string"
                                            ],
                                            "facets": [
                                                {}
                                            ]
                                        },
                                        "sortable": false
                                    }
                                ],
                                "defaultSequence": [
                                    "string"
                                ]
                            },
                            "name": "string",
                            "providerTypeId": {
                                "name": "string",
                                "id": "string"
                            },
                            "id": "string",
                            "forms": {
                                "catalogResourceInfoHidden": false
                            },
                            "listDescendantTypesSeparately": false,
                            "primary": false,
                            "showChildrenOutsideParent": false,
                            "status": "string"
                        },
                        "entitleable": false,
                        "externalId": "string",
                        "description": "string",
                        "id": "string",
                        "status": "string"
                    }
                }
            ],
            "localScopeForActions": false,
            "status": "string"
        }
    ],
    "first": false,
    "totalElements": 0
}
integer As int32 As int32
number
Optional
number
integer As int32 As int32
size
Optional
size
boolean
last
Optional
last