ContractLine class

The ContractLine class represents a line item in a contract for a specific service offering instance.

ContractLine class APIs

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

Basic APIs

Name

HTTP
method

URI

Description

get

GET

csm/ContractLine/guid

Retrieves a ContractLine object.

search

POST

csm/ContractLine/search

Searches for ContractLine objects.

Operation APIs

The ContractLine class has no operation APIs.

Relationship APIs

Name

HTTP
method

URI

Description

relation

GET

csm/ContractLine/guid/contract

Retrieves the contract relationship.

relation

GET

csm/ContractLine/guid/price

Retrieves the price relationship.

relation

GET

csm/ContractLine/guid/serviceOffering

Retrieves the serviceOffering relationship.

relation

GET

csm/ContractLine/guid/serviceOfferingInstance

Retrieves the serviceOfferingInstance relationship.

relation

GET

csm/ContractLine/guid/storageResource

Retrieves the storageResource relationship.

relation

GET

csm/ContractLine/guid/tickets

Retrieves the tickets relationship.

relation

GET

csm/ContractLine/guid/provider

Retrieves the provider relationship.

relation

GET

csm/ContractLine/guid/tags

Retrieves the tags relationship.

ContractLine class relationships and attributes

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

Relationships

Name

Type

Multi-
plicity

Description

contract

Contract

1

Contract associated with the contract line

price

Price

0..*

Prices associated with the contract line

serviceOffering

ServiceOffering

0..1

Service offering referenced by the contract line

serviceOfferingInstance

ServiceOfferingInstance

0..1

Service offering instance referenced by the contract line

storageResource

StorageResource

0..1

Storage resource referenced by the contract line

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

endDate

Date

0..1

End date

executionDate

Date

0..1

Date when the contract is signed by all parties

lineType

String

1

Type of contract line

priceAmount

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

pricePeriod

String

0..1

Specifies the period for which the price applies, such as per month or per year

priceUOM

String

0..1

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

quantity

Integer

0..1

Quantity of the item ordered

serviceRequestID

String

0..1

Identifier of the SRM service request that created the contract line

startDate

Date

0..1

Start date

status

String

0..1

Status of the contract line

terminationDate

Date

0..1

Date the contract or contract line terminates as per the conditions in the termination clause of the contract

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