You can use the REST API catalog service to locate a catalog item in the service catalog.

Input

Use the input parameters to control the command output.

Parameter

Description

URL

https://$host/catalog-service/api/consumer/entitledCatalogItems?$filter=name+eq+%27my+custom+blueprint%27

$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.

$catalogItemId

Specifies the ID of a catalog item.

Output

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

Property

Description

Links

Specifies an array of link objects, each of which contains the following parts:

  • rel

    Specifies the name of the link.

    • Self refers to the object that was returned or requested.

    • First, Previous, Next, and Last refer to corresponding pages of pageable lists.

    • Specifies the application or service that determines the other names.

  • href

    Specifies the URL that produces the result.

Content

Specifies an array of data rows, each of which represents one of the tenant objects returned in a pageable list. Each tenant object can contain the following information:

  • @type:

    entitledCatalogItem

  • Id:

    Specifies the unique tenant identifier.

  • version:

    Displays the object version number.

  • Name:

    Specifies the name of the tenant for display purposes.

  • description:

    Specifies the long description of the tenant.

  • status:

    Specifies the life cycle stage of this catalog item.

  • organization:

    Business group or tenant to which this item belongs.

    • tenantRef:

      ID of the tenant.

    • tenantLabel:

      Name of the tenant.

    • subtenantRef:

      ID of the business group.

    • subtenantLabel:

      Name of the business group.

  • providerBinding:

    Provider side identifier of this item.

    • bindingId:

      binding ID.

    • providerRef:

      Provider.

  • forms:

    A specification for the various forms associated with catalog items of this type.

  • callbacks:

    A specification for the various call-backs to the provider supported by this catalog item.

  • isNoteworthy:

    Flag indicating that this catalog item should be highlighted to users for a period of time.

  • dateCreated:

    Date this item was created in catalog.

  • lastUpdatedDate:

    Date this item was last updated in catalog.

  • iconId:

    Associated icon representing this item.

  • catalogItemTypeRef:

    Type of the catalog item.

  • serviceRef:

    Catalog service that contains this catalog item.

  • outputResourceTypeRef:

    Type of the resource resulting from requesting this catalog item.

Metadata

Specifies the paging-related data:

  • Size:

    Specifies the maximum number of rows per page.

  • totalElements:

    Specifies the number of rows returned.

  • totalPages:

    Specifies the total number of pages of data available.

  • Number:

    Specifies the current page number.

  • Offset:

    Specifies the number of rows skipped.

curl Command

The following example command retrieves all allowed 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
  }
}