Api Documentation Data Structures
A patch to update attributes for a catalog item
{
"iconId": "string"
}
icon id
Represents a Catalog Item that can eventually be requested by a consumer.
{
"createdAt": "string",
"createdBy": "string",
"description": "string",
"iconId": "string",
"id": "string",
"lastUpdatedAt": "string",
"lastUpdatedBy": "string",
"name": "string",
"projectIds": [
"string"
],
"projects": [
{
"id": "string",
"link": "string",
"name": "string"
}
],
"sourceId": "string",
"sourceName": "string",
"type": {
"id": "string",
"link": "string",
"name": "string"
}
}
Creation time
Created By
CatalogItem description
Icon ID
CatalogItem id
Update time
Updated By
CatalogItem name
Associated project IDs that can be used for requesting
Json schema describing request parameters, a simplified version of http://json-schema.org/latest/json-schema-validation.html#rfc.section.5
LibraryItem source ID.
LibraryItem source name.
A request to create a deployment based on a catalog item
{
"deploymentName": "string",
"projectId": "string",
"reason": "string",
"version": "string"
}
Name of the requested deployment
Input parameters for the request. These must be compliant with the schema of the corresponding catalog item
Project to be used for the request
Reason for request
Version of the catalog item. e.g. v2.0
The blueprint service's response to a deployment request
{
"deploymentId": "string",
"deploymentName": "string"
}
The created deployment's ID
The created deployment's name
A response with upfront price for a resource in given catalog item
{
"dailyAdditionalPrice": "number",
"dailyComputePrice": "number",
"dailyNetworkPrice": "number",
"dailyStoragePrice": "number",
"dailyTotalPrice": "number",
"resourceName": "string",
"resourceType": "string",
"resourceUpfrontPriceId": "string",
"status": "string",
"statusDetails": "string",
"unit": "string"
}
Additional Price incurred for the catalog.
Compute Price of the catalog resource.
Network Price of the catalog resource.
Storage Price of the catalog resource.
Total Price of the catalog resource.
resourceName
resourceType
Id
Upfront price sync status
Upfront price status detail.
Monetary unit.
Represents a type of Catalog Item.
{
"baseUri": "string",
"createdAt": "string",
"createdBy": "string",
"id": "string",
"name": "string"
}
Base callback URI for import operations
Configuration schema for this type, requests to create a source of this type should have a compliant 'config' field
Creation time
Service that created this type
Human-readable unique ID containing only lowercase letters and periods, neither starting nor ending with a period, and never having two consecutive periods
Unique Catalog Item Type name
Represents a version of a Catalog Item that can be requested by a consumer.
{
"createdAt": "string",
"description": "string",
"id": "string"
}
Created At
Description
Version ID
Input Schema
Represents a source of templates from which Catalog Items can be created
{
"createdAt": "string",
"createdBy": "string",
"description": "string",
"global": "boolean",
"id": "string",
"itemsFound": "integer",
"itemsImported": "integer",
"lastImportCompletedAt": "string",
"lastImportErrors": [
"string"
],
"lastImportStartedAt": "string",
"lastUpdatedAt": "string",
"lastUpdatedBy": "string",
"name": "string",
"projectId": "string",
"typeId": "string"
}
Source custom configuration
Creation time
Created By
Catalog Source description
Global flag indicating that all the items can be requested across all projects.
Catalog Source id
Number of items found
Number of items imported.
Last import completion time
Last import error(s)
Last import start time
Update time
Updated By
Catalog Source name
Project id where the source belongs
Type of source, e.g. blueprint, CFT... etc
Represents a catalog item or content source that is linked to a project via an entitlement.
{
"description": "string",
"iconId": "string",
"id": "string",
"name": "string",
"numItems": "integer",
"sourceName": "string",
"sourceType": "string",
"type": "string"
}
Description of either the catalog item or the catalog source
Icon id of associated catalog item (if association is with catalog item)
Id of either the catalog source or catalog item.
Name of either the catalog item or the catalog source
Number of items in the associated catalog source
Catalog source name
Catalog source type
Content definition type
Represents an entitlement that is configured by admins to enforce user access to catalog items, services, etc., within their own organizations.
{
"catalogItemId": "string",
"catalogSourceId": "string",
"definition": {
"description": "string",
"iconId": "string",
"id": "string",
"name": "string",
"numItems": "integer",
"sourceName": "string",
"sourceType": "string",
"type": "string"
},
"id": "string",
"projectId": "string"
}
Catalog item id
Catalog source ID
Entitlement id
Project id
{
"id": "string",
"link": "string",
"name": "string"
}
id
link
name