Usage SPECIFICATION ResourceUsageSpecification: A detailed description of a usage event that are of interest to the business and can have charges applied to it. It is comprised of characteristics, which define all attributes known for a particular type of usage. Below is a representation of the UsageSpecification resource in JSON format for cloud (CPU rated). { "id": "234", "href": "http://serverlocation:port/usageManagement/usageSpecification/234", "name": "cloudCpuSpec", "description": "Spec for cloud CPU usage", "validFor": { "startDateTime": "2013-04-19T16:42:23-04:00", "endDateTime": "2099-06-19T00:00:00-04:00" }, "usageSpecCharacteristic": [ { "name": "poolNumber", "description": "the number of the pool", "configurable": "true", "usageSpecCharacteristicValue": [ { "valueType": "number", "default": "false", "value": "", "valueFrom": "0", "valueTo": "" } ] }, { "name": "characteristicType", "description": "sub-type of the characteristic", "configurable": "true", "usageSpecCharacteristicValue": [ { "valueType": "string", "default": "false", "value": "Reserved", "valueFrom": "", "valueTo": "" }, { "valueType": "string", "default": "false", "value": "Reserved Gold", "valueFrom": "", "valueTo": "" }, { "valueType": "string", "default": "false", "value": "Reserved Silver", "valueFrom": "", "valueTo": "" }, { "valueType": "string", "default": "false", "value": "Reserved Bronze", "valueFrom": "", "valueTo": "" }, { "valueType": "string", "default": "false", "value": "Burst", "valueFrom": "", "valueTo": "" } ] }, { "name": "value", "description": "value of the usage specified by the unit", "configurable": "true", "usageSpecCharacteristicValue": [ { "valueType": "number", "default": "false", "value": "", "valueFrom": "0", "valueTo": "" } ] }, { "name": "unit", "description": "unit of measure", "configurable": "true", "usageSpecCharacteristicValue": [ { "valueType": "string", "default": "false", "value": "GHz", "valueFrom": "", "valueTo": "" }, { "valueType": "string", "default": "false", "value": "Number of vCPU", "valueFrom": "", "valueTo": "" } ] } ] } |
JSON representation of the usage specification for voice:
{ "id": "22", "href": "http://serverlocation:port/usageManagement/usageSpecification/22", "name": "VoiceSpec", "description": "Spec for voice calls usage", "validFor": { "startDateTime": "2013-04-19T16:42:23-04:00", "endDateTime": "2099-06-19T00:00:00-04:00" }, "usageSpecCharacteristic": [ { "name": "originatingCountryCode", "description": "country code of the caller", "configurable": "true", "usageSpecCharacteristicValue": [ { "valueType": "number", "default": "false", "value": "", "valueFrom": "", "valueTo": "" } ] }, { "name": "originatingNumber", "description": "phone number of the caller", "configurable": "true", "usageSpecCharacteristicValue": [ { "valueType": "string", "default": "false", "value": "", "valueFrom": "", "valueTo": "" } ] }, { "name": "destinationCountryCode", "description": "country code of the called party", "configurable": "true", "usageSpecCharacteristicValue": [ { "valueType": "number", "default": "false", "value": "", "valueFrom": "", "valueTo": "" } ] }, { "name": "destinationNumber", "description": "phone number of the called party", "configurable": "true", "usageSpecCharacteristicValue": [ { "valueType": "string", "default": "false", "value": "", "valueFrom": "", "valueTo": "" } ] }, { "name": "duration", "description": "duration of the call", "configurable": "true", "usageSpecCharacteristicValue": [ { "valueType": "number", "default": "false", "value": "", "valueFrom": "0", "valueTo": "" } ] }, { "name": "unit", "description": "unit of the duration", "configurable": "true", "usageSpecCharacteristicValue": [ { "valueType": "number", "default": "false", "value": "SEC", "valueFrom": "", "valueTo": "" } ] }, { "name": "startDateTime", "description": "startdate and starttime of the call", "configurable": "true", "usageSpecCharacteristicValue": [ { "valueType": "dateTime", "default": "false", "value": "", "valueFrom": "", "valueTo": "" } ] }, { "name": "endDateTime", "description": "enddate and endtime of the call", "configurable": "true", "usageSpecCharacteristicValue": [ { "valueType": "dateTime", "default": "false", "value": "", "valueFrom": "", "valueTo": "" } ] } ] } |
Field Descriptions : RatedProductUsage: An occurrence of employing a product for its intended purpose with all rating details.
Field | Description | bucketValueConvertedInAmount | Monetary value of bucket | currencyCode | A string used as a code for specifying the currency associated to the given amounts. The ISO4217 norm uses 3 letters to define the currency (for example USD for US dollar or EUR for Euro) | isBilled | Boolean indicating if usage have been billed or not | isTaxExempt | Indicates if the rated amount is exempt of tax | offerTariffType | Type of tariff applied | productRef | Reference of product specification | ratingAmountType | Type of amount | ratingDate | Date of usage rating | taxExcludedRatingAmount | All taxes excluded rated amount | taxIncludedRatingAmount | All taxes included rated amount | taxRate | Tax rate | usageRatingTag | Tag value : 'usage' : the usage is always rated outside a usage bundle 'included usage' : the usage is rated inside a usage bundle 'non included usage' : the usage bundle is exhausted. The usage is rated outside the usage bundle |
RelatedParty: Defines party or partyRole linked to a specific entity.
Field | Description | href | Reference of the relatedParty, could be a party reference or a partyRole reference | Id | Unique identifier of the related party | name | Name of the related party | role | Role of the related party | validFor | The period for which the related party is linked to the entity |
Usage:An occurrence of employing a Product, Service, or Resource for its intended purpose, which is of interest to the business and can have charges applied to it. It is comprised of characteristics, which represent attributes of usage.
Field | Description | date | Date of usage | description | Description of usage | href | Reference of usage | id | Usage unique identifier | status | Status of usage | type | Type of usage |
UsageCharacteristic: Provides the value of a given characteristic.
Field | Description | name | The name of the usage characteristic. | value | A discrete value that the characteristic can take on. |
UsageSpecification: A detailed description of a usage event that are of interest to the business and can have charges applied to it. It is comprised of characteristics, which define all attributes known for a particular type of usage.
Field | Description | description | A narrative that explains in detail what the usage specification is | href | Reference of usage specification | id | Usage specification unique identifier | name | The name of the usage specification. | validFor | The period for which the usage specification is valid |
UsageSpecCharacteristic: A detailed description of an attribute that defines a particular type of usage, described by its name, category, type, presence and a set of allowed values
Field | Description | configurable | Boolean indicating if usageSpecCharacteristic is configurable or not | description | A narrative that explains in detail what the usage specification characteristic is | name | The name of the usage specification characteristic |
UsageSpecCharacteristicValue: A value that can be assigned to a UsageSpecCharacteristic.
Field | Description | default | Indicates if the value is the default value for a characteristic | value | A narrative that explains in detail what the usage specification characteristic is | valueType | A kind of value that the characteristic can take on, such as numeric, text, and so forth. | valueFrom | The low range value that a characteristic can take on | valueTo | The upper range value that a characteristic can take on. |
UML model: Image Modified Figure 2 Usage resource model Image Modified Figure 3 UsageSpecification resource model
|