Unsupported content This version of the product has reached end of support. The documentation is available for your convenience. However, you must be logged in to access it. You will not be able to leave comments.

AddOnContractLine class


The AddOnContractLine class represents a contract line for an add-on.

AddOnContractLine class APIs

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

Basic APIs

Name

HTTP
method

URI

Description

get

GET

Retrieves a AddOnContractLine object.

search

POST

Searches for AddOnContractLine objects.

Operation APIs

The AddOnContractLine class has no operation APIs.

Relationship APIs

Name

HTTP
method

URI

Description

relation

GET

Retrieves the requestableOffering relationship.

relation

GET

Retrieves the selectedOptionContractLine relationship.

relation

GET

Retrieves the serviceOfferingContractLine relationship.

relation

GET

Retrieves the contract relationship.

relation

GET

Retrieves the price relationship.

relation

GET

Retrieves the serviceOffering relationship.

relation

GET

Retrieves the serviceOfferingInstance relationship.

relation

GET

Retrieves the storageResource relationship.

relation

GET

Retrieves the tickets relationship.

relation

GET

Retrieves the provider relationship.

relation

GET

Retrieves the tags relationship.

AddOnContractLine class relationships and attributes

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

Relationships

Name

Type

Multi-
plicity

Description

requestableOffering

1

 

selectedOptionContractLine

0..*

Contract lines for the selected options

serviceOfferingContractLine

1

Contract line for the associated service offering

contract

1

Contract associated with the contract line

price

0..*

Prices associated with the contract line

serviceOffering

0..1

Service offering referenced by the contract line

serviceOfferingInstance

0..1

Service offering instance referenced by the contract line

storageResource

0..1

Storage resource referenced by the contract line

tickets

0..*

 

cloudClass

1

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

provider

1

Provider that created the object

tags

0..*

Tags associated with the object

Attributes

Name

Type

Multi-
plicity

Description

endDate

0..1

End date

executionDate

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

0..1

Start date

status
String

0..1

Status of the contract line

terminationDate

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

0..1

Date the Cloudobject was modified

name
String

1

Human-readable name of the object

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*