TM Forum Ecosystem API Portal

Space shortcuts

Page tree

Versions Compared

Old Version 1

changes.mady.by.user Unknown User ([email protected])

Saved on

compared with

New Version 2

changes.mady.by.user Unknown User ([email protected])

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Anchor
_Toc405208276
_Toc405208276
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

Anchor
_Toc405208277
_Toc405208277
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": "15", "href": " http://serverlocation:port/usageManagement/usage/15", "date": "2013-04-19T16:42:23-04:00", "type": "CloudCpuUsage", "description": "Description for individual usage content", "status": "rated", "usageSpecification": { "id": "234", "href": "http://serverlocation:port/usageManagement/usageSpecification/234", "name": "Cloud CPU usage specification" }, "usageCharacteristic": [ { "name": "poolNumber", "value": "1" }, { "name": "characteristicType", "value": "Reserved" }, { "name": "value", "value": "2" }, { "name": "unit", "value": "GHZ" } ], "relatedParty": [{ "role": "customer", "id": "1", "href": "http://serverlocation:port/partyManagement/organization/1" }], "ratedProductUsage": [ { "ratingDate": "2013-04-19T16:42:23-04:00", "usageRatingTag": "Usage", "isBilled": "False", "ratingAmountType": "Total", "taxIncludedRatingAmount": "12.00", "taxExcludedRatingAmount": "10.00", "taxRate": "20", "isTaxExempt": "false", "offerTariffType": "Normal", "bucketValueConvertedInAmount": "", "currencyCode": "EUR", "productRef": "http://serverlocation:port/catalogManagement/productSpecification/345" } ] }


Below is a representation of the Usage resource in JSON format (voice 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" } ] }

 

Anchor
_Toc405208278
_Toc405208278
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).

{ "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": "" } ] } ] }

...


UML model:

Figure 2 Usage resource model

Figure 3 UsageSpecification resource model

Anchor
_Toc271830691
_Toc271830691
Anchor
_Toc404174498
_Toc404174498
Anchor
_Toc405208279
_Toc405208279
Export Job Resource

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)
"query": "type=usage &version=2.0"

path

URL of the root resource acting as the source for streaming content to the file specified by the ExportJob
../partyManagement/individual

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
a file URL, which is of the form

file://host/path


where host is the fully qualified domain name of the system on which the path is accessible, and path is a hierarchical directory path of the form directory/directory/.../name

completionDate

Date at which the Job was completed.

creationDate

Date at which the Job was created.

errorLog

Reason for Failure

...

{ "id": "54", "href": "http:/api/usageManagement/exportJob/54", "status": "running", "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
_Toc271830692
_Toc271830692
Anchor
_Toc404174499
_Toc404174499
Anchor
_Toc405208280
_Toc405208280
Import Job Resource

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
../partyManagement/individual

status

notstarted, running, succeeded, failed

url

URL of the File containing the data to be imported
a file URL, which is of the form

file://host/path


where host is the fully qualified domain name of the system on which the path is accessible, and path is a hierarchical directory path of the form directory/directory/.../name

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
_Toc405208281
_Toc405208281
Notification Resource Models


Anchor
OLE_LINK4
OLE_LINK4
Anchor
_Toc203490678
_Toc203490678
Anchor
_Toc223843133
_Toc223843133
Anchor
_Toc225613409
_Toc225613409
Anchor
_Ref225602564
_Ref225602564
Anchor
_Ref225602608
_Ref225602608
Anchor
_Toc225603198
_Toc225603198
Anchor
_Ref226276288
_Ref226276288
Anchor
_Ref226276315
_Ref226276315
Anchor
_Ref226276328
_Ref226276328
2 notification event types are defined :

...


UML Model:

Event: ExportJobCompletionNotification

{ "eventType": "ExportJobCompletionNotification", "eventTime": "2014-09-27T05:46:25.0Z", "eventId": "1154278", "event": {"exportJob": { "id": "54", "href": "http:/api/usageManagement/exportJob/54", "status": "succeeded", "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/usageManagement/54.json" }} }




Event: ImportJobCompletionNotification

{ "eventType": "ImportJobCompletionNotification", "eventTime": "2014-09-27T05:46:25.0Z", "eventId": "1154278", "event": {

"importJob": { "id": "54", "href": "http:/api/usageManagement/importJob/54", "status": "succeeded", "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/usageManagement/54.json" }} }

 

© TM Forum 2015. All Rights Reserved.