You can use the REST API catalog service to retrieve a list of all shared viewable catalog items. Shared catalog items do not belong to a specific business group. Also, this service retrieves a list of all shared and private catalog items that can be viewed, including their business groups.

Input

Use the supported input parameters to control the command output.

Parameter

Description

URL

https://$host/catalog-service/api/consumer/catalogItems

$host

Specifies the host name and fully qualified domain name or IP address of the vRealize Automation identity server.

$token

Specifies a valid HTTP bearer token with necessary credentials.

Output

The command output contains property names and values based on the command input parameters.

Property

Description

version

id

Specifies the UUID Identifier of the object. Specifies the property type is string.

outputResourceTypeRef

Specifies the type of the resource that results from requesting the catalog item.

name

Specifies the user friendly name of the catalog item. Specifies the property type is string.

description

Specifies a short description of the catalog item. Specifies the property type is string.

status

Specifies the life cycle stage of the catalog item.

statusName

Specifies the life cycle status name, such as Active.

catalogItemTypeRef

Specifies the type of the catalog item.

serviceRef

Specifies the catalog service that contains the catalog item.

iconId

Specifies the associated icon representing this item.

organization

Specifies the subtenant and/or tenant to which this item belongs

providerBinding

Specifies the provider side identifier of this item.

forms

Specifies the forms that are associated with catalog items of this type.

callbacks

Specifies the call-backs to the provider that are supported by this catalog item.

isNoteworthy

Specifies if the catalog item should be highlighted to users for a period of time.

dateCreated

Specifies the date that this item was created in the catalog.

lastUpdatedDate

Specifies the date that this item was last updated in the catalog.

entitledOrganizations

Specifies the organizations in which the catalog item can be consumed by the current user.

catalogItem

Specifies the catalog item value.

YouCommand

The following example command retrieves information about all the available shared catalog items.

curl --insecure -H "Content-Type: application/json" 
-H "Authorization: Bearer $token” 
https://$host/catalog-service/api/consumer/entitledCatalogItems

JSON Output

The following JSON output is returned based on the command input.

{
  "links" : [ ],
  "content" : [ {
    "@type" : "entitledCatalogItem",
    "id" : "65fbca06-a28e-46f3-bced-c6e5fb3a66f9",
    "version" : 1,
    "name" : "RHEL 6-vsphere",
    "description" : "",
    "status" : "PUBLISHED",
    "organization" : {
      "tenantRef" : "MYCOMPANY",
      "tenantLabel" : "ABTenant",
      "subtenantRef" : "cccd7a7e-5283-416b-beb0-45eb4e924dcb",
      "subtenantLabel" : "MyTestAgentBusinessGroup"
    },
    "providerBinding" : {
      "bindingId" : "e16edcf9-6a10-4bc7-98e2-a33361aeb857",
      "providerRef" : {
        "id" : "c6fb1980-75b4-4adc-ac71-020d75f61978",
        "label" : "iaas-service"
      }
    },
    "forms" : null,
    "callbacks" : null,
    "isNoteworthy" : true,
    "dateCreated" : "2014-02-14T21:53:39.072Z",
    "lastUpdatedDate" : "2014-02-14T21:54:07.756Z",
    "iconId" : "cafe_default_icon_genericCatalogItem",
    "catalogItemTypeRef" : {
      "id" : "Infrastructure.Virtual",
      "label" : "Virtual Machine"
    },
    "serviceRef" : {
      "id" : "e90847d7-03e1-45a9-8377-be77be03af6f",
      "label" : "Tyler's Service"
    },
    "outputResourceTypeRef" : {
      "id" : "Infrastructure.Virtual",
      "label" : "Virtual Machine"
    }
  } ],
  "metadata" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 1,
    "offset" : 0
  }
}