Price class

The Price class represents information about the cost of a service offering.

Price class APIs

The following tables list the basic APIs, operation APIs, and relationship APIs for the Price class.

Basic APIs


 

Name

HTTP
method

URI

Description

create

POST

csm/Price

Creates a Price object.

get

GET

csm/Price/guid

Retrieves a Price object.

search

POST

csm/Price/search

Searches for Price objects.


 

Operation APIs

The Price class has no operation APIs.

Relationship APIs


 

Name

HTTP
method

URI

Description

relation

GET

csm/Price/guid/cartView

Retrieves the cartView relationship.

relation

GET

csm/Price/guid/contractLine

Retrieves the contractLine relationship.

relation

GET

csm/Price/guid/optionChoice

Retrieves the optionChoice relationship.

relation

GET

csm/Price/guid/requestableOffering

Retrieves the requestableOffering relationship.

relation

GET

csm/Price/guid/serviceOffering

Retrieves the serviceOffering relationship.

relation

GET

csm/Price/guid/tickets

Retrieves the tickets relationship.

relation

GET

csm/Price/guid/provider

Retrieves the provider relationship.

relation

GET

csm/Price/guid/tags

Retrieves the tags relationship.


 

Price class relationships and attributes

The following tables list the relationships and attributes of the Price class.

Relationships


 

Name

Type

Multi-
plicity

Description

cartView

CartView

0..1

 Items in the cart

contractLine

ContractLine

0..1

Associated contract line

optionChoice

OptionChoice

0..1

requestableOffering

RequestableOffering

0..1

Retrieves offering for which this price is applicable.

serviceOffering

ServiceOffering

0..1

Associated service offering

tickets

Ticket

0..*

cloudClass

CloudClass

1

Fully-qualified name of the class to which the object belongs

provider

Provider

1

Provider that created the object

tags

Tag

0..*

Tags associated with the object


 

Attributes


 

Name

Type

Multi-
plicity

Description

amount

String

0..1

Specifies the actual price and the currency in which it is expressed. This amount is in context of the period and the unit of measure (UOM).

period

String

0..1

Used when the cost or price is calculated in terms of a time period, in addition to the unit of measure (UOM). For example, you can incur cost for a Blackberry service as $100 per month or $100 per 10 users per month.

quantity

Integer

0..1

Specifies the unit of quantity against which price is calculated, used in combination with the unit of measure. For example, if the price of a service is calculated as $250 per 25 users per month, the quantity is 25 (users).

status

String

0..1

State of the price, such as Draft or Operational

uom

String

0..1

Unit of measure for the price amount, such as "Users" or "GB RAM"

isOnboarded

Boolean

1

Indicates whether the object is onboarded

externalID

String

0..1

Identifier used for the object by an external provider

owner

String

0..1

Name of the owner of the object

reconciliationID

String

0..1

Reconciliation identity value for the object from the BMC Atrium CMDB

tokenID

String

0..1

Token identifier

description

String

0..1

Text that describes the object

guid

String

1

Globally unique identifier for the object

labels

String

0..*

modifiedDate

Date

0..1

Date the Cloudobject was modified

name

String

1

Human-readable name of the object


 

Was this page helpful? Yes No Submitting... Thank you

Comments