Digital LOA API | Equinix Product Documentation

Loa

Operations

Create Digital LOA document

Request

Creates a Digital LOA document.

Security

BearerAuth

Bodyapplication/jsonrequired

productsArray of objects, non-empty(CreateProduct)required

Specification of services that the given LOA document is valid for.

requestorobject(Party)required

providerobject(PartyContacts)required

Party contacts

notesstring

Additional information, added to the Digital LOA document, that should be taken under consideration.

Example:"Rack access: weekdays - 18:00 to 22:00 CET; Saturday - 10:00 to 14:00 CET."

expiryDateTimestring, (date-time)

Digital LOA expiration date.

Example:"2022-11-17T22:59:59.999Z"

Payload

{
  "products": [
    { … }
  ],
  "requestor": {
    "type": "NEW_RELATIONSHIP",
    "email": "kyle@mail.com",
    "name": "XYZ Inc."
  },
  "provider": {
    "contacts": [ … ]
  },
  "notes": "Rack access: weekdays - 18:00 to 22:00 CET; Saturday - 10:00 to 14:00 CET.",
  "expiryDateTime": "2022-11-17T22:59:59.999Z"
}

Responses

Created Digital Loa UUID

Headers

Locationstring

response header - location of a resource

Example:"diloa/v1/digitalLoas/402cbf99-97d7-440f-8291-1a4b9639154a"

Bodyapplication/json

tokenstring

User-friendly Digital LOA document identifier.

Example:"REDF-4R56"

uuidstring, (uuid)

Digital LOA document identifier.

Example:"079dc798-05e8-11ed-b939-0242ac120002"

statestring(State)

Digital LOA document status.

Enum:"READY_FOR_USE""LOCKED""USED""CANCELLED""EXPIRED""PENDING_REQUESTOR_ACCEPTANCE""PENDING_PROVIDER_AUTHORIZATION"

Example:"USED"

draftboolean

Default: false

Example:false

changeLogobject(ChangeLog)

Change interface

linksArray of objects, >= 0 items(Links)

HATEOAS links specifying possible follow-up interactions.

changeobject(Change)

Change interface

expiryDateTimestring, (date-time)

Digital LOA document expiration date.

Example:"2022-11-17T22:59:59.999Z"

hrefstring

Digital LOA document URI.

Example:"diloa/v1/digitalLoas/402cbf99-97d7-440f-8291-1a4b9639154a"

Response

{
  "token": "REDF-4R56",
  "uuid": "079dc798-05e8-11ed-b939-0242ac120002",
  "state": "USED",
  "draft": false,
  "changeLog": {
    "createdDateTime": "2022-11-17T22:59:59.999Z"
  },
  "links": [
    { … }
  ],
  "change": {
    "uuid": "079dc798-05e8-11ed-b939-0242ac120002",
    "href": "diloa/v1/digitalLoas/402cbf99-97d7-440f-8291-1a4b9639154a",
    "type": "LOA_UPDATE"
  },
  "expiryDateTime": "2022-11-17T22:59:59.999Z",
  "href": "diloa/v1/digitalLoas/402cbf99-97d7-440f-8291-1a4b9639154a"
}