Managed Entity and Task Resource Models
Status attribute:
The status attribute is used by a state machine through the different lifecycle stages for the usage records. Valid status values are:|
...
Figure 1: State machine diagram for status attribute on usage
Usage Resource
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.
Below is a representation of the Usage resource in JSON format (cloud usage).
...
{
"id": "1234",
"href": " http://serverlocation:port/usageManagement/usage/1234",
"date": "2013-04-19T16:42:23-04:00",
"type": "VOICE",
"description": "Description for individual usage content",
"status": "rated",
"usageSpecification": {
"id": "22",
"href": "http://serverlocation:port/usageManagement/usageSpecification/22",
"name": "Voice usage specification"
},
"usageCharacteristic": [
{
"name": "originatingCountryCode",
"value": "43"
}, {
"name": "originatingNumber",
"value": "676123456789"
}, {
"name": "destinationCountryCode",
"value": "49"
}, {
"name": "destinationNumber",
"value": "170123456789"
}, {
"name": "duration",
"value": "20"
}, {
"name": "unit",
"value": "SEC"
}, {
"name": "startDateTime",
"value": "2013-04-19T16:42:23-04:00"
}, {
"name": "endDateTime",
"value": "2013-04-19T16:42:23-04:00"
}
],
"relatedParty": [
{
"role": "serviceProvider",
"id": "1",
"href": "http://serverlocation:port/partyManagement/organization/1"
}, {
"role": "customer",
"id": "45",
"ref": "http://serverlocation:port/partyManagement/individual/45"
}
],
"ratedProductUsage ": [
{
"ratingDate": "2013-04-19T16:42:23-04:00",
"usageRatingTag": "Usage",
"ratingAmountType": "Total",
"taxIncludedRatingAmount": "12.00",
"taxExcludedRatingAmount": "10.00",
"taxRate": "20",
"isTaxExempt": "false",
"offerTariffType": "Normal",
"bucketValueConvertedInAmount": "",
"currencyCode": "EUR"
}
]
} |
Usage SPECIFICATION Resource
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.
Below is a representation of the UsageSpecification resource in JSON format for cloud (CPU rated).
...
UML model:
Figure 2 Usage resource model
Figure 3 UsageSpecification resource model
Export Job Resource
An ExportJob resource represents a TASK used to export resources to a File
The ExportJob resource supports the following properties:
...
UML Model:
Import Job Resource
An ImportJob resource represent a TASK used to import resources from a File
The ImportJob resource supports the following properties:
...
{
"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:
Notification Resource Models
2 notification event types are defined :
...