...
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 |
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. |
...
An ExportJob resource represents a TASK used to export resources to a File
The ExportJob resource supports the following properties:
Attribute name | Description |
query | Used to scope the exported data (identical to GET filter construct using target ID as base) |
path | URL of the root resource acting as the source for streaming content to the file specified by the ExportJob |
content-type | The format of the exported data .By default "application/json" |
status | notstarted, running, succeeded, failed |
url | URL of the File containing the data to be exported
|
completionDate | Date at which the Job was completed. |
creationDate | Date at which the Job was created. |
errorLog | Reason for Failure |
...
An ImportJob resource represent a TASK used to import resources from a File
The ImportJob resource supports the following properties:
Attribute name | Description |
content-type | The format of the imported data. By default "application/json" |
path | URL of the root resource where the content of the file specified by the ImportJob must be applied |
status | notstarted, running, succeeded, failed |
url | URL of the File containing the data to be imported
|
completionDate | Date at which the Job was completed. |
creationDate | Date at which the Job was created. |
errorLog | Reason for Failure if status is failed |
...
{ "id": "54", "href": "http:/api/ usageManagement/importJob/54", "status": "completed", "path": "usageManagement/", "content-type": "application/json", "errorLog": "", "creationDate": "2013-04-19T16:42:23-04:00", "completionDate": "2013-04-21T16:42:23-04:00", "url": "ftp://ftp.myUsage.com/usage/54" } |
UML Model:
Anchor | ||||
---|---|---|---|---|
|
...