The ProductActionResource class provides methods to access the
Action objects for a product.
GenericResource
The ProductVersionResource class provides methods to access the
Version objects for a product.
GenericResource
The ProductConfigurationResource class provides methods to access the
ProductConfiguration objects for a product.
GenericResource
The ProductResource class provides methods to access the products
endpoint of the Cloud Blue Connect API.
The ProductActionResource class provides methods to access the
Action objects for a product.
Kind: global class
Category: Resources
object
Returns the ActionLink object for a product and asset.
Kind: instance method of ProductActionResource
Returns: object
– The ActionLink object.
Param | Type | Description |
---|---|---|
id | string | The unique identifier of the Action. |
assetId | string | The unique identifier of the Asset. |
GenericResource
The ProductVersionResource class provides methods to access the
Version objects for a product.
Kind: global class
Extends: GenericResource
Category: Resources
GenericResource
Creates a new instance of the ProductVersionResource class.
Returns: ProductVersionResource
– An instance of the ProductVersionResource class.
Param | Type | Description |
---|---|---|
client | ConnectClient | An instance of the ConnectClient class. |
baseUri | string | The base uri for this resource. |
ProductActionResource
Returns an instance of the ProductActionResource class
to access the Action objects configured for a specific
version of a Product.
Kind: instance method of ProductVersionResource
Returns: ProductActionResource
– The instance of the ProductActionResource
class for a product/version.
Param | Type | Description |
---|---|---|
id | string | The unique identifier of the Version object for a Product. |
GenericResource
The ProductConfigurationResource class provides methods to access the
ProductConfiguration objects for a product.
Kind: global class
Extends: GenericResource
Category: Resources
GenericResource
The ProductResource class provides methods to access the products
endpoint of the Cloud Blue Connect API.
Kind: global class
Extends: GenericResource
Category: Resources
GenericResource
Creates a new instance of the ProductResource class.
Returns: ProductResource
– An instance of the ProductResource class.
Param | Type | Description |
---|---|---|
client | ConnectClient | An instance of the ConnectClient class. |
ProductActionResource
Returns an instance of the ProductActionResource for a Product.
Kind: instance method of ProductResource
Returns: ProductActionResource
– An instance of the ProductActionResource
for the product.
Param | Type | Description |
---|---|---|
id | string | The unique identifier of the Product. |
ProductVersionResource
Returns an instance of the ProductVersionResource for a Product.
Kind: instance method of ProductResource
Returns: ProductVersionResource
– An instance of the ProductVersionResource
for the product.
Param | Type | Description |
---|---|---|
id | string | The unique identifier of the Product. |
ProductConfigurationResource
Returns an instance of the ProductConfigurationResource for a ProductConfiguration.
Kind: instance method of ProductResource
Returns: ProductConfigurationResource
– An instance of the ProductConfigurationResource
for the product.
Param | Type | Description |
---|---|---|
id | string | The unique identifier of the Product. |
Array
Returns the list of Template objects configured for the Product.
Kind: instance method of ProductResource
Returns: Array
– The list of Template objects.
Param | Type | Description |
---|---|---|
id | string | The unique identifier of the Product. |
Array
Returns the list of Parameter objects configured for the Product.
Kind: instance method of ProductResource
Returns: Array
– The list of Parameter objects.
Param | Type | Description |
---|---|---|
id | string | The unique identifier of the Product. |
Array
Returns the list of ProductItem objects configured for the Product.
Kind: instance method of ProductResource
Returns: Array
– The list of ProductItem objects.
Param | Type | Description |
---|---|---|
id | string | The unique identifier of the Product. |
Array
Returns the list of Connection objects configured for the Product.
Kind: instance method of ProductResource
Returns: Array
– The list of Connection objects.
Param | Type | Description |
---|---|---|
id | string | The unique identifier of the Product. |