Catalog Category:Get Catalog Category

Search (SHIFT+S)



New in this release

Get Catalog Category

GET /catalog/categories/{id}

Get info for catalog category

idthe URN of a Catalog Category

Required Roles

This call has no restrictions.


Response Body

Catalog Category details

Field Description Type Notes
<catalog_category>
<tenant>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</tenant>      
<catalog_category>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</catalog_category>      
<title> Catalog Category's title String
<description> Catalog Category's description String
<image> Catalog Category's image url String
<version> Catalog Category's version. Used when preforming catalog upgrades. String
<sorted_index> Sorted index. Used to determine the display order Integer
<name> The name assigned to this resource in ViPR. The resource name is set by a user and can be changed at any time. It is not a unique identifier. String
<id> An identifier that is generated by ViPR when the resource is created. The resource ID is guaranteed to be unique and immutable across all virtual data centers for all time. URI Valid Values:
  •  urn:storageos:resource-type:UUID:
<link> A hyperlink to the details for this resource
<creation_time> A timestamp that shows when this resource was created in ViPR DateTime Valid Values:
  •  YYYY-MM-DDTHH:mm:ssZ
<tags> Keywords and labels that can be added by a user to a resource to make it easy to find when doing a search.
<tag> String 0-* Elements
</tags>
<inactive> Whether or not the resource is inactive. When a user removes a resource, the resource is put in this state before it is removed from the ViPR database. Boolean Valid Values:
  •  true
  •  false
<global> Boolean
<remote> Boolean
<vdc>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</vdc>      
<internal> Whether or not the resource is an internal resource. Boolean Valid Values:
  •  true
  •  false
</catalog_category>
Notes: