Contract class

The Contract class represents a contract for a service offering instance.

Contract class APIs

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

Basic APIs

Name

HTTP
method

URI

Description

get

GET

csm/Contract/guid

Retrieves a Contract object.

search

POST

csm/Contract/search

Searches for Contract objects.

Operation APIs

The Contract class has no operation APIs.

Relationship APIs

Name

HTTP
method

URI

Description

relation

GET

csm/Contract/guid/contractLines

Retrieves the contractLines relationship.

relation

GET

csm/Contract/guid/customer

Retrieves the customer relationship.

relation

GET

csm/Contract/guid/serviceOfferingContractLine

Retrieves the serviceOfferingContractLine relationship.

relation

GET

csm/Contract/guid/supplier

Retrieves the supplier relationship.

relation

GET

csm/Contract/guid/tickets

Retrieves the tickets relationship.

relation

GET

csm/Contract/guid/provider

Retrieves the provider relationship.

relation

GET

csm/Contract/guid/tags

Retrieves the tags relationship.

Contract class relationships and attributes

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

Relationships

Name

Type

Multi-
plicity

Description

contractLines

ContractLine

0..*

Components of the contract

customer

Organization

1

Customer associated with the contract

serviceOfferingContractLine

ServiceOfferingContractLine

0..*

Service offering contract lines that make up the contract

supplier

Organization

1

Contract supplier

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

contractType

String

1

Type of contract

endDate

Date

0..1

Contract end date

executionDate

Date

0..1

Date the contract is signed by all parties

startDate

Date

0..1

Contract start date

status

String

1

Contract status

terminationDate

Date

0..1

Date the contract or contract line is terminated 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