Digital LOA API | Equinix Product Documentation

Retrieve Digital LOA Documents

Request

Returns Digital LOA documents that match the specified criteria.

Security

BearerAuth

Query

offsetinteger, >= 0

Index of the first item returned in the response.

Default:0

Example:offset=0

limitinteger, >= 1

Maximum number of items returned per page.

Default:20

Example:limit=20

sortArray of strings

Search results sorting settings:

/ - Ascending, i.e. '/expiryDateTime'
-/ - Descending, i.e. '-/expiryDateTime'

Items Enum:"/changeLog/createdDateTime""-/changeLog/createdDateTime""/expiryDateTime""-/expiryDateTime""/products/zSide/patchPanel/location/ibx""-/products/zSide/patchPanel/location/ibx"

Example:sort=/expiryDateTime

Bodyapplication/jsonrequired

filterobject(LoaSearchItem)required

Search criteria body

Payload

{
  "filter": {
    "and": [ … ]
  }
}

Responses

List of Digital LOA documents related with user organization

Bodyapplication/json

paginationobject(Pagination)required

Pagination

sortArray of objects(Sort)required

Search results sorting settings.

dataArray of objects(Loa)required

Data set containing Digital LOA documents.

Response

{
  "pagination": {
    "offset": 0,
    "limit": 500,
    "total": 900,
    "next": "/diloa/v1/digitalLoas?offset=10&limit=20",
    "previous": "/diloa/v1/digitalLoas?offset=0&limit=20"
  },
  "sort": [
    { … }
  ],
  "data": [
    { … }
  ]
}