Unsupported content

 

This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

Location class

The Location class represents a physical location.

Location class APIs

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

Basic APIs

Name

HTTP
method

URI

Description

get

GET

csm/Location/guid

Retrieves a Location object.

search

POST

csm/Location/search

Searches for Location objects.

Operation APIs

The Location class has no operation APIs.

Relationship APIs

Name

HTTP
method

URI

Description

relation

GET

csm/Location/guid/pods

Retrieves the pods relationship.

relation

GET

csm/Location/guid/provider

Retrieves the provider relationship.

relation

GET

csm/Location/guid/tags

Retrieves the tags relationship.

Location class relationships and attributes

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

Relationships

Name

Type

Multi-
plicity

Description

pods

Pod

0..*

Pods at the location

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

address

String

0..1

Address of the location

addressLine2

String

0..1

Additional address line for the location

city

String

0..1

Name of the city

country

String

0..1

Country in which the physical element is located. Use this attribute only when the value of the CountryCode attribute is set to Other.

countryCode

String

0..1

Attribute that specifies a selection list specifying the country in which the element is located. The selection list maps each country code to the country's full name; Syntax: ISO 3166-1 alpha-3.

faxNumber

String

0..1

Fax number

mailStop

String

0..1

Mail stop

phoneNumber

String

0..1

Telephone number

postalCode

String

0..1

Postal code

stateOrProvince

String

0..1

Name of the state or province for the location

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

name

String

1

Human-readable name of the object

This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

Comments