Install Bases Asset API (1.0.0)

Download OpenAPI specification:Download

URL: https://docs.equinix.com/api-support.htm Terms of Service

Assets are all the products and equipment belonging to your organization that are installed in Equinix's IBXs. These assets can be viewed by users with the appropriate permissions. Assets can be searched by a filter criterion, or the details of an individual asset can be looked up by its asset ID.

Assets

Search permissible assets

The POST assets API returns all assets for a specific asset from search form. The authorization token and content-type are the only headers that are passed to this API and a response is received based on the values passed.

query Parameters

sorts	Array of strings Items Enum: "SERIAL_NUMBER" "ORDER_NUMBER" "PRODUCT_TYPE" "PRODUCT_NAME" "CAGE" "IBX" "PRODUCT_DESCRIPTION" "ACCOUNT_NUMBER" "INSTALLED_DATE" "ASSET_NUMBER" "-SERIAL_NUMBER" "-ORDER_NUMBER" "-PRODUCT_TYPE" "-PRODUCT_NAME" "-CAGE" "-IBX" "-PRODUCT_DESCRIPTION" "-ACCOUNT_NUMBER" "-INSTALLED_DATE" "-ASSET_NUMBER" Sort fields
source	Array of strings Items Enum: "LEGACY_CAGE" "LEGACY_CABINET" "LEGACY_PATCH_PANEL" "LEGACY_SALES_ORDER" "BILLING_AGREEMENT" "CAGE" "CABINET" "PATCH_PANEL" "ASSET_NUMBER" "CUSTOMER_INTERNAL_REFERENCE" "SALES_ORDER_NUMBER" "CABLE_ID" "CARRIER_CIRCUIT_ID" "SERIAL_NUMBER" "EXTERNAL_REFERENCE_NUMBER" "ACCOUNT_NUMBER" "q" parameter will be searched in these fields, by default search will performed on all fields
q	string To support add a keyword, free text search on source fields. Min 3 character for efficient search results.
exactMatch	boolean flag determines the q should be Exact match or partial match, By default flag is false
offset	integer >= 0 The start index from which the list is created.
limit	integer [ 1 .. 100 ] Number of entries in response.

header Parameters

Authorization

required

string

Specify the Access token with prefix 'Bearer '.

Request Body schema: application/json

object

assets search filter.

ibxs

Array of strings

List of IBX to be filtered.

cages

Array of strings

List of cages to be filtered.

productTypes

Array of strings

Items Enum: "ACCESSORIES" "CABINET" "CAGE" "CROSS_CONNECT" "CROSS_CONNECT_Z_SIDE" "EQUINIX_ETHERNET_EXCHANGE" "EQUINIX_CLOUD_EXCHANGE" "PATCH_PANEL" "POWER" "IBX_SMARTVIEW" "OTHERS" "VIRTUAL_CIRCUIT" "BCTR_BCS_ROOM" "EQUINIX_CONNECT"

List of product types to be filtered.

object

Date range filter. The installed date should be within this data range.

fromDate required	string <date-time> Start date to filter the installed date.
toDate required	string <date-time> End date to filter the installed date.

Responses

Response Schema: application/json

Array of objects (AssetsSummary)

Array

assetNumber	string Asset number.
serialNumber	string Serial number of the asset.
orderNumber	string Order number associated with the asset/service.
productName	string Product type.
ibx	string Ibx of the location.
cage	string Cage of the location.
productDescription	string Product description.
accountNumber	string Account number of the product/services belongs to.
accountName	string Account name of the product/services.
installationDate	string <date-time> Date time of the product or service is purchased/installed.
customerReferenceNumber	string Customer reference number.
status	string Enum: "ACTIVE" "INACTIVE"
	object (AdditionalDetails) These are additional details specific to the asset

object (PageInfo)

limit	integer Starting count based on offset.
offset	integer Limit count per page.
total	integer Matching record count / total number records matched with filter.
sorts	Array of strings Items Enum: "SERIAL_NUMBER" "-SERIAL_NUMBER" "ORDER_NUMBER" "-ORDER_NUMBER" "PRODUCT_TYPE" "-PRODUCT_TYPE" "CAGE" "-CAGE" "IBX" "-IBX" "PRODUCT_DESCRIPTION" "-PRODUCT_DESCRIPTION" "ACCOUNT_NUMBER" "-ACCOUNT_NUMBER" "INSTALLED_DATE" "-INSTALLED_DATE"

object (_links)

object (ReferenceLink)

href

required

string

object (ReferenceLink)

href

required

string

object (ReferenceLink)

href

required

string

Request samples

Payload

Content type

application/json

{"filter": {"ibxs": ["AM5"
],
"cages": ["AM5:01:000Z3C"
],
"productTypes": ["ACCESSORIES"
],
"dateRange": {"fromDate": "2019-08-24T14:15:22Z",
"toDate": "2019-08-24T14:15:22Z"
}
}
}

Response samples

Content type

application/json

{"data": [{"assetNumber": "4-123456789",
"serialNumber": "123456-A",
"orderNumber": "1-123456789",
"productName": "CROSS_CONNECT",
"ibx": "AB1",
"cage": "ACB1:01:001AB1",
"productDescription": "Network Cable Connection",
"accountNumber": "123456",
"accountName": "Equinix customer",
"installationDate": "2017-08-24T17:46:35Z",
"customerReferenceNumber": "ABZ-12345",
"status": "ACTIVE",
"additionalDetails": {"cabinetNumber": "ACB1:01:001AB1:1234",
"customerOrCarrierCircuitID": "121513A"
}
},
{"assetNumber": "4-123456789",
"serialNumber": "123456-A",
"orderNumber": "1-123456789",
"productName": "CROSS_CONNECT",
"ibx": "AB1",
"cage": "ACB1:01:001AB1",
"productDescription": "Network Cable Connection",
"accountNumber": "123456",
"accountName": "Equinix customer",
"installationDate": "2017-08-24T17:46:35Z",
"customerReferenceNumber": "ABZ-12345",
"status": "ACTIVE",
"additionalDetails": {"cabinetNumber": "ACB1:01:001AB1:1234",
"customerOrCarrierCircuitID": "121513A"
}
}
],
"page": {"total": 20,
"limit": 2,
"offset": 0,
"sorts": ["ASSET_NUMBER"
]
},
"_links": {"self": {"href": "/assets/search?limit=2&exactMatch=true&offset=0&sorts=ASSET_NUMBER"
},
"next": {"href": "/assets/search?limit=2&exactMatch=true&offset=2&sorts=ASSET_NUMBER"
},
"previous": {"href": "/assets/search?limit=2&exactMatch=true&offset=0&sorts=ASSET_NUMBER"
}
}
}

Get details of an asset

The Get assets by Id API returns all details for a specific asset from its identification number. The authorization token and content-type are the only headers that are passed to this API and a response is received based on the values passed.

path Parameters

assetId

required

string

{assetId} identification number

header Parameters

Authorization

required

string

Specify the Access token with prefix 'Bearer '.

Responses

Response Schema: application/json

assetNumber

string

Asset number.

serialNumber

string

Serial number of the asset.

orderNumber

string

Order number associated with the asset/service.

productName

string

Product type.

ibx

string

Ibx of the location.

cage

string

Cage of the location.

productDescription

string

Product description.

accountNumber

string

Account number of the product/services belongs to.

accountName

string

Account name of the product/services.

installationDate

string <date-time>

Date time of the product or service is purchased/installed.

customerReferenceNumber

string

Customer reference number.

status

string

Enum: "ACTIVE" "INACTIVE"

Array of objects (AssetsProperty)

key/value pairs of product details.

Array

key required	string Key of the property.
value required	string Value of the property.
tag	string Stands for a logical grouping on where the asset belogs to for a particular product. e.g - A-SIDE for Cross Connect.

Response samples

Content type

application/json

{"data": [{"assetNumber": "4-123456789",
"serialNumber": "123456-A",
"orderNumber": "1-123456789",
"productName": "CROSS_CONNECT",
"ibx": "AB1",
"cage": "ACB1:01:001AB1",
"productDescription": "Network Cable Connection",
"accountNumber": "123456",
"accountName": "Equinix customer",
"installationDate": "2017-08-24T17:46:35Z",
"customerReferenceNumber": "ABZ-12345",
"status": "ACTIVE",
"productDetails": [{"key": "ACCOUNT",
"value": "Equinix customer",
"Tag": "HEADER"
},
{"key": "A-SIDE-Customer",
"value": "A-side-customer",
"Tag": "A_SIDE_INFORMATION"
},
{"key": "Z-SIDE-Customer",
"value": "Z-side-customer",
"Tag": "Z_SIDE_INFORMATION"
}
]
}
]
}