Catalog Service:Create Catalog Service

Search (SHIFT+S)

API Reference


Create Catalog Service

POST /catalog/services

Creates a new catalog service


Required Roles

  • TENANT_ADMIN

Request Payload

All parameters are required unless otherwise stated.

Field Description Type Notes
<catalog_service_create>
<catalog_category> URI
<title> String Valid Values:
  •  Length: 2..128
<description> String Valid Values:
  •  Length: 0..255
<image> String Valid Values:
  •  Length: 0..255
<approval_required> Boolean
<execution_window_required> Boolean
<default_execution_window> URI
<base_service> String Valid Values:
  •  Length: 0..255
<max_size> Integer
<name> String
<catalog_service_fields>     0-* Elements
<name> String
<value> String
<override> Boolean
</catalog_service_fields>      
</catalog_service_create>

Response Body

None

Field Description Type Notes
<catalog_service>
<title> String
<description> String
<image> String
<default_execution_window>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</default_execution_window>      
<base_service> String
<max_size> Integer
<catalog_category>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</catalog_category>      
<catalog_service_fields>     0-* Elements
<value> String
<override> Boolean
<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
<link> A hyperlink to the details for this resource
<creation_time> A timestamp that shows when this resource was created in ViPR DateTime
<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
<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
</catalog_service_fields>      
<service_descriptor>    
<service_id> String
<category> String
<title> String
<descriptor> String
<role> String 0-* Elements
<items>
<items>     0-* Elements
<name> String
<label> String
<type> String
<description> String
</items>      
</items>
</service_descriptor>      
<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
<link> A hyperlink to the details for this resource
<creation_time> A timestamp that shows when this resource was created in ViPR DateTime
<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
<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
</catalog_service>
Notes: