Get catalog items
Retrieve a page of catalog items a catalog consumer is permitted to see. For backward compatible behavior add http header [-H 'version = 6.2'] and refer to 6.2. documentation.
Request
URI
GET
https://{api_host}/catalog-service/api/consumer/catalogItems
COPY
Query Parameters
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 PageCatalogItem of type(s) */*
{
"number": 0,
"numberOfElements": 0,
"last": false,
"size": 0,
"totalPages": 0,
"first": false,
"content": [
{
"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
integer As int32 As int32
size
Optional
size
integer As int32 As int32
totalPages
Optional
totalPages
boolean
first
Optional
first
integer As int64 As int64
totalElements
Optional
totalElements
Catalog Operations
POST
Cancel Request
POST
Create Entitlement
POST
Create Or Update Icon
POST
Create request
POST
Create Service
DELETE
Delete An entitlement
DELETE
Delete An Icon
DELETE
Delete Request
POST
Dismiss Request
GET
Download Icon
GET
Find All Catalog Items For A Service
GET
Find all catalog items with No service association
GET
Find all entitlements for catalog item
GET
Find Entitlements For Operation
GET
Find Operation Icon
GET
Find Catalog Item Icon Admin
GET
Get A Consumer Entitled Catalog Item
GET
Get A Consumer Entitled Catalog Item View
GET
Get A Consumer Entitled Catalog Items
GET
Get Available Resource Operations
GET
Get Catalog filterschema
GET
Get catalog item
GET
Get Catalog Item Provisioning Request Template
GET
Get catalog item types
GET
Get catalog items
GET
Get Catalog Resource Request Template
GET
Get Consumer Catalog Item Views
GET
Get Descendant Resource Type
GET
Get details form
GET
Get Details Form
POST
Get Details Form Element Metadata
POST
Get details form element metadata
POST
Get Details Form Field Values
POST
Get details form field values
GET
Get entitlement
GET
Get Icon
GET
Get Operation
GET
Get Operations
GET
Get Provider Types
GET
Get Providers
GET
Get provisioned resources
GET
Get Request
GET
Get Request Execution Plan
GET
Get request form
POST
Get request form elment metadata
POST
Get request form field value
GET
Get Resource
GET
Get Resource Action Request Form
POST
Get Resource Action Request Form Element State
POST
Get Resource Action Request Form Field Values
GET
Get Resource Action Request Schema
GET
Get Resource Action Request Schema
GET
Get Resource Details Form
POST
Get Resource Details Form Element Values
POST
Get Resource Details Form Element Values
GET
Get Resource Operation
GET
Get Resource Operation Icon
GET
Get Resource Type
GET
Get Resource Types
GET
Get Resource Views
GET
Get Resources By Resource Type
GET
Get Resubmission Form
POST
Get Resubmission Form Element Metadata
POST
Get Resubmission Form Field Values
GET
Get Service
GET
Get Services
GET
Get Services filter values
GET
Get Submission Form
POST
Get Submission Form Element Metadata
POST
Get Submission Form Field Values
GET
Get Subtenants filter values
GET
Get User Friendly Resource Provisioned By Request
GET
Get Catalog Item Can Review
GET
Get Catalog Items For User
GET
Get Services For User
POST
Set the Ordering
POST
Submit Catalog Item Provisioning Request
POST
Submit Catalog Resource Request
PUT
Update Catalog Item
POST
Update request
PUT
Update Resource Operation
PUT
Update Service
PUT
Update Entitlement