Digital LOA API | Equinix Product Documentation

Modify a Digital LOA document

Request

Modifies a given Digital LOA document.

Security

BearerAuth

Path

uuidstringrequired

Digital LOA document identifier.

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

Bodyapplication/jsonrequired

Array [

opstringrequired

The operation to be performed

Enum:"add""remove""replace""move""copy""test"

Example:"replace"

pathstringrequired

A path to property being patched

Enum:"/state""/requestor/contacts"

Example:"/state"

valueobject

The value to be used within the operations.

fromstring

A string containing a JSON Pointer value.

Example:"READY_FOR_USE"

]

Payload

[
  {
    "op": "replace",
    "path": "/state",
    "value": {},
    "from": "READY_FOR_USE"
  }
]

Responses

Successful operation

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"

productsArray of objects, non-empty(Product)

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

requestorobject(Party)

providerobject(Party)

changeLogobject(ChangeLog)

Change interface

linksArray of objects, >= 0 items(Links)

HATEOAS links specifying possible follow-up interactions.

notesstring

Additional information to be considered.

Example:"Please contact me"

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",
  "products": [
    { … }
  ],
  "requestor": {
    "type": "NEW_RELATIONSHIP",
    "email": "kyle@mail.com",
    "name": "XYZ Inc."
  },
  "provider": {
    "type": "NEW_RELATIONSHIP",
    "email": "kyle@mail.com",
    "name": "XYZ Inc."
  },
  "changeLog": {
    "createdDateTime": "2022-11-17T22:59:59.999Z"
  },
  "links": [
    { … }
  ],
  "notes": "Please contact me",
  "expiryDateTime": "2022-11-17T22:59:59.999Z",
  "href": "diloa/v1/digitalLoas/402cbf99-97d7-440f-8291-1a4b9639154a"
}