SoftLayer Product Item
From SoftLayer Development Network Wiki
Contents |
Overview
The SoftLayer_Product_Item data type contains general information relating to a single SoftLayer product.
| Warning! Even though our API is object based, XML-RPC can only return data as array values. The SOAP implementation treats data as object properties. |
Local Properties
capacity
Some Product Items have capacity information such as RAM and bandwidth, and others. This provides the numerical representation of the capacity given in the description of this product item.
- Type: decimal
- Length: 15 digits before the decimal point
description
A product's description
- Type: string
- Length: 200 characters
id
A product's internal identification number
- Type: integer
softwareDescriptionId
The unique identifier of the SoftLayer_Software_Description tied to this item.
- Type: integer
- Length: 10 digits
upgradeItemId
A products upgrade item's internal identification number
- Type: integer
- Length: 10 digits
Relational Properties
bundle
An item's included products. Some items have other items included in them that we specifically detail. They are here called Bundled Items. An example is Plesk unlimited. It as a bundled item labeled 'SiteBuilder'
bundle can be queried by object mask.
conflicts
An item's conflicts. For example, McAfee LinuxShield cannot be ordered with Windows. It was not meant for that operating system and as such is a conflict.
conflicts can be queried by object mask.
downgradeItem
Some product items have a downgrade path. This is the first product item in the downgrade path.
downgradeItem can be queried by object mask.
downgradeItem must be a unique value.
- Type: SoftLayer_Product_Item
downgradeItems
Some product items have a downgrade path. These are those product items.
downgradeItems can be queried by object mask.
- Type: SoftLayer_Product_ItemArray
packages
A collection of all the SoftLayer_Product_Package(s) in which this item exists.
packages can be queried by object mask.
prices
A product item's prices.
prices can be queried by object mask.
requirements
If an item must be ordered with another item, it will have a requirement item here.
requirements can be queried by object mask.
softwareDescription
The SoftLayer_Software_Description tied to this item. This will only be populated for software items.
softwareDescription can be queried by object mask.
softwareDescription must be a unique value.
upgradeItem
Some product items have an upgrade path. This is the next product item in the upgrade path.
upgradeItem can be queried by object mask.
upgradeItem must be a unique value.
- Type: SoftLayer_Product_Item
upgradeItems
Some product items have an upgrade path. These are those upgrade product items.
upgradeItems can be queried by object mask.
- Type: SoftLayer_Product_ItemArray
Count Properties
bundleCount
A count of an item's included products. Some items have other items included in them that we specifically detail. They are here called Bundled Items. An example is Plesk unlimited. It as a bundled item labeled 'SiteBuilder'
bundleCount must be a unique value.
- Type: unsigned long
conflictCount
A count of an item's conflicts. For example, McAfee LinuxShield cannot be ordered with Windows. It was not meant for that operating system and as such is a conflict.
conflictCount must be a unique value.
- Type: unsigned long
downgradeItemCount
A count of some product items have a downgrade path. These are those product items.
downgradeItemCount must be a unique value.
- Type: unsigned long
packageCount
A count of a collection of all the SoftLayer_Product_Package(s) in which this item exists.
packageCount must be a unique value.
- Type: unsigned long
priceCount
A count of a product item's prices.
priceCount must be a unique value.
- Type: unsigned long
requirementCount
A count of if an item must be ordered with another item, it will have a requirement item here.
requirementCount must be a unique value.
- Type: unsigned long
upgradeItemCount
A count of some product items have an upgrade path. These are those upgrade product items.
upgradeItemCount must be a unique value.
- Type: unsigned long
