Get A Consumer Entitled Catalog Items

Deprecated since version 7.5. Get a ConsumerEntitledCatalogItem by its unique Id.ConsumerEntitledCatalogItem are basically catalog items: - in an active state. - the current user has the right to consume. - the current user is entitled to consume. - associated to a service.

Request

URI

GET

https://{api_host}/catalog-service/api/consumer/entitledCatalogItems

COPY

Query Parameters

string

serviceId

Optional

Optional query parameter to filter the returned Catalog Items by one specific Service.

string

onBehalfOf

Optional

optional query parameter providing the value of the user Id to use when the intention is to request on behalf of someone else

string

subtenantId

Optional

optional query parameter which dictates if the output should be filtered for given subtenant only

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 PageConsumerEntitledCatalogItem of type(s) */*

{
    "number": 0,
    "numberOfElements": 0,
    "last": false,
    "size": 0,
    "totalPages": 0,
    "first": false,
    "content": [
        {
            "entitledOrganizations": [
                {}
            ],
            "catalogItem": {
                "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"
            }
        }
    ],
    "totalElements": 0
}

integer As int32 As int32

number

Optional

number

integer As int32 As int32

numberOfElements

Optional

numberOfElements

boolean

last

Optional

last