Digital LOA Documents

This API enables managing Digital Letter of Authorization (LOA) documents.

For more information, see Digital Letter of Authorization - Overview.

Create Digital LOA Document

POST /diloa/v1/digitalLoas
Method POST
Endpoint /diloa/v1/digitalLoas
Headers Authorization, Content-Type
Path Parameters Not applicable
Query Parameters Not applicable
Body Parameters products, requestor, provider, notes, expiryDateTime

This API request creates a Digital LOA document.

To obtain the Access Token, refer to Requesting Access and Refresh tokens under the Getting Access Token section.


Sample curl request - an existing A-side customer relationship

Copy 
curl -X
POST "https://api.equinix.com/diloa/v1/digitalLoas"
-H "content-type: application/json"
-H "Authorization: Bearer qwErtY8zyW1abcdefGHI"
-d '{
    "products": [
        {
            "type": "CROSS_CONNECT",
            "crossConnect": {
                "connectionService": "Multi-Mode Fiber",
                "mediaType": "62.5 MICRON MULTI-MODE FIBER",
                "protocolType": "100 GIG ETHERNET",
                "zSide": {
                    "connectorType": "ST",
                    "circuitId": "34234535",
                    "patchPanelId": "CP:0218:0102:13008148",
                    "portA": 12,
                    "portB": 13
                    }
                }
            }
        }
    ],
    "requestor": {
        "type": "CUSTOMER_ORGANIZATION",
        "orgIds": [
            "123456",
            "789123"
        ],
        "name": "Jane Umbrella Corp",
        "contacts": [
            {
                "type": "NOTIFICATION",
                "registeredUser": "Registered",
                "firstName": "Jane",
                "lastName": "Doe",
                "timezone": "Australia/Perth",
                "availability": "ANYTIME",
                "details": [
                    {
                        "note": "Work email.",
                        "value": "jane@umbrellacorp.com",
                        "type": "EMAIL"
                    }
                ]
            }
        ]
    },
    "provider": {
        "contacts": [
            {
                "type": "NOTIFICATION",
                "registeredUser": "Registered",
                "firstName": "John",
                "lastName": "Smith",
                "timezone": "Australia/Perth",
                "availability": "ANYTIME",
                "details": [
                    {
                        "note": "new email address",
                        "value": "kyle@mail.com",
                        "type": "EMAIL"
                    }
                ]
            }
        ]
    },
    "notes": "Please contact me",
    "expiryDateTime": "2022-11-17T22:59:59.999Z"
}'

Sample curl request - a new A-side customer relationship

Copy 
curl -X
POST "https://api.equinix.com/diloa/v1/digitalLoas"
-H "content-type: application/json"
-H "Authorization: Bearer qwErtY8zyW1abcdefGHI"
-d '{
    "products": [
        {
            "type": "CROSS_CONNECT",
            "crossConnect": {
                "connectionService": "Multi-Mode Fiber",
                "mediaType": "62.5 MICRON MULTI-MODE FIBER",
                "protocolType": "100 GIG ETHERNET",
                "zSide": {
                    "connectorType": "ST",
                    "circuitId": "34234535",
                    "patchPanelId": "CP:0218:0102:13008148",
                    "portA": 12,
                    "portB": 13
                    }
                }
            }
        }
    ],
    "requestor": {
        "type": "NEW_RELATIONSHIP",
        "email": "jane@umbrella.us",
        "name": "Jane Umbrella Corp"
    },
    "provider": {
        "contacts": [
            {
                "type": "NOTIFICATION",
                "registeredUser": "Registered",
                "firstName": "John",
                "lastName": "Smith",
                "timezone": "Australia/Perth",
                "availability": "ANYTIME",
                "details": [
                    {
                        "note": "new email address",
                        "value": "kyle@mail.com",
                        "type": "EMAIL"
                    }
                ]
            }
        ]
    },
    "notes": "Please contact me",
    "expiryDateTime": "2022-11-17T22:59:59.999Z"
}'

Body parameters

Parameter
Description
products array[object]
REQUIRED		 Specification of services that the given LOA document is valid for.
type string
REQUIRED
 Service instance type.
Applicable values: CROSS_CONNECT
crossConnect object
REQUIRED
 Cross Connect connection specification.
connectionService string
REQUIRED
 Connection service type.
Example: Multi-Mode Fiber
mediaType string
REQUIRED
 Media type.
Example: 62.5 MICRON MULTI-MODE FIBER
protocolType string
REQUIRED
 Protocol type.
Example: 100 GIG ETHERNET
zSide object
REQUIRED
 Z-side connection details.
circuitId string
OPTIONAL
 User-defined Cross Connect circuit identifier.
Example: 34234535
connectorType string
REQUIRED
 Patch panel connector type.
Example: ST
patchPanelId string
REQUIRED
 Patch panel identifier.
Example: CP:0218:0102:13008148
portA integer
REQUIRED
 Port A number.
Example: 12
portB integer
OPTIONAL
 Port B number.
Example: 13
requestor object
REQUIRED		 LOA document requestor information.
type string
REQUIRED
 Party type that specifies if the requestor is a known organization or a new one without previous engagements.
Applicable values:
  • CUSTOMER_ORGANIZATION - A customer organization with known organization identifiers.
  • NEW_RELATIONSHIP - A new customer relationship, where the organization identifier is unknown.
email string
CONDITIONAL
 Customer organization representative's email address. Required if the requestor.type parameter is set to NEW_RELATIONSHIP.
Example: mike@mspc.us
orgIds array[string]
CONDITIONAL
 Customer organization identifiers. Required if the requestor.type parameter is set to CUSTOMER_ORGANIZATION.
Example: 123345
name string
REQUIRED
 Customer organization name.
Example: Solid Snake Inc.
contacts array[object]
REQUIRED
 Service provider contact information.
type string
 Notification messages category relevant to a given contact person.
Possible values:
  • NOTIFICATION - Notifications related to Digital LOA document's lifecycle.
  • TECHNICAL - Contact information for technical inquiries.
registeredUser string
OPTIONAL
 contactId, userId or userKey of a registered user.
firstName string
CONDITIONAL
 Contact person's first name. Required if registeredUser hasn't been provided.
Example: Jane
lastName string
CONDITIONAL
 Contact person's last name. Required if registeredUser hasn't been provided.
Example: Smith
timezone string
OPTIONAL
 Contact person's timezone.
Example: Australia/Perth
availability string
OPTIONAL
 Contact person's availability.
Applicable values:
  • WORK_HOURS - Contact person be reached during working hours.
  • ANYTIME - Contact person can be reached anytime throughout the day.
details array[object]
REQUIRED
 Means of contact.
note string
OPTIONAL
 Additional note applicable to the given contact option.
Example: Not suitable for emergencies.
value string
REQUIRED
 Value specific to the given contact type.
Example: jane@smith.com
type string
REQUIRED
 Means of contact.
Applicable values:
  • EMAIL - Email address.
  • PHONE - Landline phone number.
  • MOBILE - Mobile phone number.
  • SECONDARY_EMAIL - Alternative email address.
provider object Provider details.
contacts array[object]
REQUIRED
 Service provider contact information.
type string
 Notification messages category relevant to a given contact person.
Possible values:
  • NOTIFICATION - Notifications related to Digital LOA document's lifecycle.
  • TECHNICAL - Contact information for technical inquiries.
registeredUser string
OPTIONAL
 contactId, userId or userKey of a registered user.
firstName string
CONDITIONAL
 Contact person's first name. Required if registeredUser hasn't been provided.
Example: Jane
lastName string
CONDITIONAL
 Contact person's last name. Required if registeredUser hasn't been provided.
Example: Smith
timezone string
OPTIONAL
 Contact person's timezone.
Example: Australia/Perth
availability string
OPTIONAL
 Contact person's availability.
Applicable values:
  • WORK_HOURS - Contact person be reached during working hours.
  • ANYTIME - Contact person can be reached anytime throughout the day.
details array[object]
REQUIRED
 Means of contact.
note string
OPTIONAL
 Additional note applicable to the given contact option.
Example: Not suitable for emergencies.
value string
REQUIRED
 Value specific to the given contact type.
Example: jane@smith.com
type string
REQUIRED
 Means of contact.
Applicable values:
  • EMAIL - Email address.
  • PHONE - Landline phone number.
  • MOBILE - Mobile phone number.
  • SECONDARY_EMAIL - Alternative email address.
notes string
REQUIRED		 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.
expiryDateTime string
REQUIRED		 Digital LOA document expiration date.
Example: 2022-11-17T22:59:59.999Z
For more information refer to Internet Date/Time Format.

Sample response - an existing A-side customer relationship

Copy 
{
    "token": "REDF-4R56",
    "uuid": "079dc798-05e8-11ed-b939-0242ac120002",
    "state": "READY_FOR_USE",
    "changeLog": {
        "createdDateTime": 2018-05-24T18:19:59.999Z
    },
    "link": {
        "rel": "info",
        "href": "https://api.equinix.com/diloa/v1/digitalLoas/402cbf99-97d7-440f-8291-1a4b9639154a",
        "method": "GET",
        "contentType": "application/json",
        "authenticate": true
    },
    "expiryDateTime": 2018-06-24T18:19:59.999Z,
    "href": "diloa/v1/digitalLoas/079dc798-05e8-11ed-b939-0242ac120002"
}

Response payload body description

Parameter
Description
token string User-friendly Digital LOA document identifier.
Example: REDF-4R56
uuid string Digital LOA document identifier.
Example: 079dc798-05e8-11ed-b939-0242ac120002
state string Digital LOA document status.
Example: READY_FOR_USE
changeLog object A permanent record of asset creation, modification, or deletion.
createdDateTime string
 Digital LOA document creation date.
Example: 2022-11-17T22:59:59.999Z
For more information refer to Internet Date/Time Format.
link object HATEOAS link specifying possible follow-up interaction.
expiryDateTime string Digital LOA document expiration date.
Example: 2022-11-17T22:59:59.999Z
For more information refer to Internet Date/Time Format.
href string URL that returns the specified Digital LOA document.
Example: diloa/v1/digitalLoas/079dc798-05e8-11ed-b939-0242ac120002

Get Digital LOA Documents

GET /diloa/v1/digitalLoas
Method GET
Endpoint /diloa/v1/digitalLoas
Headers Authorization
Path Parameters Not applicable
Query Parameters party, offset, limit
Body Parameters Not applicable

This method returns a set of LOA documents that have been issued or requested by user's organization.

To obtain the Access Token, refer to Requesting Access and Refresh tokens under the Getting Access Token section.


Sample curl request - A-side Digital LOA documents

Copy 
curl -X
GET "https://api.equinix.com/diloa/v1/digitalLoas?party=PROVIDER&offset=0&limit=500"
-H "Authorization: Bearer qwErtY8zyW1abcdefGHI"

Query parameters

Parameter
Description
party string
OPTIONAL		 Specifies a perspective that allows to retrieve a subset of LOA documents issued or requested by your organization.
Applicable values:
  • PROVIDER - Returns a set of issued LOA documents.
  • REQUESTOR - Returns a set of requested Digital LOA documents.
Default value: PROVIDER
offset integer
OPTIONAL		 Index of the first item returned in the response.
Default value: 0
limit integer
OPTIONAL		 Maximum number of items returned per page.
Default value: 20

Sample response

Copy 
{
    "pagination": {
        "offset": 0,
        "limit": 500,
        "total": 900,
        "next": "https://customerportal.equinix.com/ecp/loa/manager/digitalLoas?offset=10&limit=20",
        "previous": "https://customerportal.equinix.com/ecp/loa/manager/digitalLoas?offset=0&limit=20"
    },
    "data": [
        {
            "token": "REDF-4R56",
            "uuid": "079dc798-05e8-11ed-b939-0242ac120002",
            "state": "USED",
            "products": [
                {
                    "uuid": "079dc798-05e8-11ed-b939-0242ac120002",
                    "type": "CROSS_CONNECT",
                    "crossConnect": {
                        "connectionService": "Multi-Mode Fiber",
                        "mediaType": "62.5 MICRON MULTI-MODE FIBER",
                        "protocolType": "100 GIG ETHERNET",
                        "zSide": {
                            "circuitId": "34234535",
                            "connectorType": "ST",
                            "patchPanelId": "CP:0218:0102:13008148",
                            "portA": 12,
                            "portB": 13
                        }
                    }
                }
            ],
            "requestor": {
                "type": "CUSTOMER_ORGANIZATION",
                "orgIds": [
                    "7367"
                ],
                "name": "Michael Scott Paper Company",
                "contacts": [
                    {
                        "type": "NOTIFICATION",
                        "registeredUser": "Registered",
                        "firstName": "Michael",
                        "lastName": "Scott",
                        "timezone": "Pacific/Midway",
                        "availability": "ANYTIME",
                        "details": [
                            {
                                "notes": "Main LOA Contact",
                                "value": "mike@mspc.com",
                                "type": "EMAIL"
                            }
                        ]
                    }
                ]
            },
            "provider": {
                "type": "CUSTOMER_ORGANIZATION",
                "orgIds": [
                    "8601"
                ],
                "name": "Prince Family Paper",
                "contacts": [
                    {
                        "type": "NOTIFICATION",
                        "firstName": "John",
                        "lastName": "Gates",
                        "timezone": "America/New_York",
                        "details": [
                            {
                                "value": "john@pfp.com",
                                "type": "EMAIL"
                            }
                        ]
                    }
                ]
            },
            "changeLog": {
                "createdDateTime": "2022-09-23T05:10:07.133Z"
            },
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.equinix.com/diloa/v1/digitalLoas/dfd3034f-6692-4a69-84d1-a5f659f0d402",
                    "method": "GET",
                    "authenticate": true
                }
            ],
            "notes": "",
            "expiryDateTime": "2022-09-30T15:59:59.999Z",
            "href": "diloa/v1/digitalLoas/dfd3034f-6692-4a69-84d1-a5f659f0d402"
        }
    ]
}

Response payload body description

Parameter
Description
pagination object Data set pagination information.
offset integer Index of the first item returned in the response.
Example: 0
limit integer Maximum number of items returned per page.
Example: 20
total integer Total number of items returned.
Example: 123
next string Next data page URL.
previous string Previous data page URL.
data array[object] Data set containing Digital LOA documents.
token string Equinix-assigned unique token.
Example: REDF-4R56
uuid string LOA document identifier.
Example: 079dc798-05e8-11ed-b939-0242ac120002
state string LOA document status.
Example: USED
products array[object] Specification of services that the given LOA document is valid for.
uuid string Service instance identifier.
Example: 079dc798-05e8-11ed-b939-0242ac120002
type string Service instance type.
Example: CROSS_CONNECT
crossConnect object Cross Connect connection specification.
connectionService string Service type.
Example: Single-Mode Fiber
mediaType string Media type.
Example: 62.5 MICRON MULTI-MODE FIBER
protocolType string Protocol type.
Example: 100 GIG ETHERNET
zSide object Z-side connection details.
circuitId string Cross Connect circuit identifier.
Example: 34234535
connectorType string Patch panel connector type.
Example: ST
patchPanelId string Patch panel identifier.
Example: CP:0218:0102:13008148
portA integer Port A number.
Example: 12
portB integer Port B number.
Example: 13
requestor object
 LOA document requestor information.
type string
 Party type that specifies if the requestor is a known organization or a new one without previous engagements.
Applicable values:
  • CUSTOMER_ORGANIZATION - A customer organization with known organization identifiers.
  • NEW_RELATIONSHIP - A new customer relationship, where the organization identifier is unknown.
email string
 Customer organization representative's email address. Required if the requestor.type parameter is set to NEW_RELATIONSHIP.
Example: mike@mspc.us
orgIds array[string]
 Customer organization identifiers. Required if the requestor.type parameter is set to CUSTOMER_ORGANIZATION.
Example: 123345
name string
 Customer organization name.
Example: Solid Snake Inc.
contacts array[object]
 Service provider contact information.
type string
 Notification messages category relevant to a given contact person.
Possible values:
  • NOTIFICATION - Notifications related to Digital LOA document's lifecycle.
  • TECHNICAL - Contact information for technical inquiries.
registeredUser string
 contactId, userId or userKey of a registered user.
firstName string
 Contact person's first name. Required if registeredUser hasn't been provided.
Example: Jane
lastName string
 Contact person's last name. Required if registeredUser hasn't been provided.
Example: Smith
timezone string
 Contact person's timezone.
Example: Australia/Perth
availability string
 Contact person's availability.
Possible values:
  • WORK_HOURS - Contact person be reached during working hours.
  • ANYTIME - Contact person can be reached anytime throughout the day.
details array[object]
 Means of contact.
note string
 Additional note applicable to the given contact option.
Example: Not suitable for emergencies.
value string
 Value specific to the given contact type.
Example: jane@smith.com
type string
 Means of contact.
Possible values:
  • EMAIL - Email address.
  • PHONE - Landline phone number.
  • MOBILE - Mobile phone number.
  • SECONDARY_EMAIL - Alternative email address.
provider object
 Provider details.
contacts array[object]
 Service provider contact information.
type string
 Notification messages category relevant to a given contact person.
Possible values:
  • NOTIFICATION - Notifications related to Digital LOA document's lifecycle.
  • TECHNICAL - Contact information for technical inquiries.
registeredUser string
 contactId, userId or userKey of a registered user.
firstName string
 Contact person's first name. Required if registeredUser hasn't been provided.
Example: Jane
lastName string
 Contact person's last name. Required if registeredUser hasn't been provided.
Example: Smith
timezone string
 Contact person's timezone.
Example: Australia/Perth
availability string
 Contact person's availability.
Possible values:
  • WORK_HOURS - Contact person be reached during working hours.
  • ANYTIME - Contact person can be reached anytime throughout the day.
details array[object]
 Means of contact.
note string
 Additional note applicable to the given contact option.
Example: Not suitable for emergencies.
value string
 Value specific to the given contact type.
Example: jane@smith.com
type string
 Means of contact.
Possible values:
  • EMAIL - Email address.
  • PHONE - Landline phone number.
  • MOBILE - Mobile phone number.
  • SECONDARY_EMAIL - Alternative email address.
changelog object
 A permanent record of asset creation, modification, or deletion.
createdDateTime string
 Date and time of LOA creation.
Example: 2022-11-17T22:59:59.999Z
For more information refer to Internet Date/Time Format.
links array[object]
 HATEOAS links specifying possible follow-up interactions.
notes string
 Additional information to be considered.
Example: No additional notes.
expiryDateTime string
 LOA expiration date.
Example: 2022-11-17T22:59:59.999Z
For more information refer to Internet Date/Time Format.
href string
 URL that returns the specified Digital LOA document.
Example: diloa/v1/digitalLoas/079dc798-05e8-11ed-b939-0242ac120002

Get Specified Digital LOA Document

GET /diloa/v1/digitalLoas/{uuid}
Method GET
Endpoint /diloa/v1/digitalLoas/{uuid}
Headers Authorization
Path Parameters uuid
Query Parameters Not applicable
Body Parameters Not applicable

This API request returns details of a specified Digital LOA document.

To obtain the Access Token, refer to Requesting Access and Refresh tokens under the Getting Access Token section.


Sample curl request

Copy 
curl -X
GET "https://api.equinix.com/diloa/v1/digitalLoas/079dc798-05e8-11ed-b939-0242ac120002"
-H "Authorization: Bearer qwErtY8zyW1abcdefGHI"

Path parameters

Parameter
Description
uuid string
REQUIRED		 Digital LOA document identifier.
Example: 079dc798-05e8-11ed-b939-0242ac120002

Sample response

Copy 
{
    "token": "REDF-4R56",
    "uuid": "079dc798-05e8-11ed-b939-0242ac120002",
    "state": "USED",
    "products": [
        {
            "uuid": "079dc798-05e8-11ed-b939-0242ac120002",
            "type": "CROSS_CONNECT",
            "crossConnect": {
                "connectionService": "Multi-Mode Fiber",
                "mediaType": "62.5 MICRON MULTI-MODE FIBER",
                "protocolType": "100 GIG ETHERNET",
                "zSide": {
                    "circuitId": "34234535",
                    "connectorType": "ST",
                    "patchPanelId": "CP:0218:0102:13008148",
                    "portA": 12,
                    "portB": 13
                }
            }
        }
    ],
    "requestor": {
        "type": "CUSTOMER_ORGANIZATION",
        "orgIds": [
            "7367"
        ],
        "name": "Michael Scott Paper Company",
        "contacts": [
            {
                "type": "NOTIFICATION",
                "registeredUser": "Registered",
                "firstName": "Michael",
                "lastName": "Scott",
                "timezone": "Pacific/Midway",
                "availability": "ANYTIME",
                "details": [
                    {
                        "notes": "Main LOA Contact",
                        "value": "mike@mspc.com",
                        "type": "EMAIL"
                    }
                ]
            }
        ]
    },
    "provider": {
        "type": "CUSTOMER_ORGANIZATION",
        "orgIds": [
            "8601"
        ],
        "name": "Prince Family Paper",
        "contacts": [
            {
                "type": "NOTIFICATION",
                "firstName": "John",
                "lastName": "Gates",
                "timezone": "America/New_York",
                "details": [
                    {
                        "value": "john@pfp.com",
                        "type": "EMAIL"
                    }
                ]
            }
        ]
    },
    "changeLog": {
        "createdDateTime": "2022-11-17T22:59:59.999Z"
    },
    "links": [
        {
            "rel": "info",
            "href": "https://api.equinix.com/diloa/v1/digitalLoas/402cbf99-97d7",
            "method": "GET",
            "contentType": "application/json",
            "authenticate": true
        }
    ],
    "notes": "No additional notes",
    "expiryDateTime": "2022-11-17T22:59:59.999Z"
}

Response payload body description

Parameter
Description
token string Equinix-assigned unique token.
Example: REDF-4R56
uuid string LOA document identifier.
Example: 079dc798-05e8-11ed-b939-0242ac120002
state string LOA document status.
Example: USED
products array[object] Specification of services that the given LOA document is valid for.
uuid string
 Service instance identifier.
Example: 079dc798-05e8-11ed-b939-0242ac120002
type string
 Service instance type.
Example: CROSS_CONNECT
crossConnect object
 Cross Connect connection specification.
connectionService string
 Service type.
Example: Single-Mode Fiber
mediaType string
 Media type.
Example: 62.5 MICRON MULTI-MODE FIBER
protocolType string
 Protocol type.
Example: 100 GIG ETHERNET
zSide object
 Z-side connection details.
circuitId string
 Cross Connect circuit identifier.
Example: 34234535
connectorType string
 Patch panel connector type.
Example: ST
patchPanelId string
 Patch panel identifier.
Example: CP:0218:0102:13008148
portA integer
 Port A number.
Example: 12
portB integer
 Port B number.
Example: 13
requestor object
 LOA document requestor information.
type string
 Party type that specifies if the requestor is a known organization or a new one without previous engagements.
Applicable values:
  • CUSTOMER_ORGANIZATION - A customer organization with known organization identifiers.
  • NEW_RELATIONSHIP - A new customer relationship, where the organization identifier is unknown.
email string
 Customer organization representative's email address. Required if the requestor.type parameter is set to NEW_RELATIONSHIP.
Example: mike@mspc.us
orgIds array[string]
 Customer organization identifiers. Required if the requestor.type parameter is set to CUSTOMER_ORGANIZATION.
Example: 123345
name string
 Customer organization name.
Example: Solid Snake Inc.
contacts array[object]
 Service provider contact information.
type string
 Notification messages category relevant to a given contact person.
Possible values:
  • NOTIFICATION - Notifications related to Digital LOA document's lifecycle.
  • TECHNICAL - Contact information for technical inquiries.
registeredUser string
 contactId, userId or userKey of a registered user.
firstName string
 Contact person's first name. Required if registeredUser hasn't been provided.
Example: Jane
lastName string
 Contact person's last name. Required if registeredUser hasn't been provided.
Example: Smith
timezone string
 Contact person's timezone.
Example: Australia/Perth
availability string
 Contact person's availability.
Possible values:
  • WORK_HOURS - Contact person be reached during working hours.
  • ANYTIME - Contact person can be reached anytime throughout the day.
details array[object]
 Means of contact.
note string
 Additional note applicable to the given contact option.
Example: Not suitable for emergencies.
value string
 Value specific to the given contact type.
Example: jane@smith.com
type string
 Means of contact.
Possible values:
  • EMAIL - Email address.
  • PHONE - Landline phone number.
  • MOBILE - Mobile phone number.
  • SECONDARY_EMAIL - Alternative email address.
provider object
 Provider details.
contacts array[object]
 Service provider contact information.
type string
 Notification messages category relevant to a given contact person.
Possible values:
  • NOTIFICATION - Notifications related to Digital LOA document's lifecycle.
  • TECHNICAL - Contact information for technical inquiries.
registeredUser string
 contactId, userId or userKey of a registered user.
firstName string
 Contact person's first name. Required if registeredUser hasn't been provided.
Example: Jane
lastName string
 Contact person's last name. Required if registeredUser hasn't been provided.
Example: Smith
timezone string
 Contact person's timezone.
Example: Australia/Perth
availability string
 Contact person's availability.
Possible values:
  • WORK_HOURS - Contact person be reached during working hours.
  • ANYTIME - Contact person can be reached anytime throughout the day.
details array[object]
 Means of contact.
note string
 Additional note applicable to the given contact option.
Example: Not suitable for emergencies.
value string
 Value specific to the given contact type.
Example: jane@smith.com
type string
 Means of contact.
Possible values:
  • EMAIL - Email address.
  • PHONE - Landline phone number.
  • MOBILE - Mobile phone number.
  • SECONDARY_EMAIL - Alternative email address.
changelog object A permanent record of asset creation, modification, or deletion.
createdDateTime string
 Date and time of LOA creation.
Example: 2022-11-17T22:59:59.999Z
For more information refer to Internet Date/Time Format.
links array[object] HATEOAS links specifying possible follow-up interactions.
notes string Additional information to be considered.
Example: No additional notes.
expiryDateTime string LOA expiration date.
Example: 2022-11-17T22:59:59.999Z
For more information refer to Internet Date/Time Format.

Retrieve Digital LOA Documents

POST /diloa/v1/digitalLoas/search
Method POST
Endpoint /diloa/v1/digitalLoas/search
Headers Authorization, Content-Type
Path Parameters Not applicable
Query Parameters Not applicable
Body Parameters property, operator, value

This API request returns Digital LOA documents that match the specified criteria.

To obtain the Access Token, refer to Requesting Access and Refresh tokens under the Getting Access Token section.


Sample curl request

Copy 
curl -X
POST "https://api.equinix.com/diloa/v1/digitalLoas/search"
-H "content-type: application/json"
-H "Authorization: Bearer qwErtY8zyW1abcdefGHI"
-d '{
    "filter": {
        "and": [
            {
                "or": [
                    {
                        "property": "/products/zSide/patchPanel/location/ibx",
                        "operator": "=",
                        "values": [
                            "WA1"
                        ]
                    },
                    {
                        "property": "/token",
                        "operator": "=",
                        "values": [
                            "REDF-4R56"
                        ]
                    }
                ]
            },
            {
                "property": "/state",
                "operator": "=",
                "values": [
                    "READY_FOR_USE"
                ]
            }
        ]
    }
}'

Body parameters description

Parameter
Description
filter object
REQUIRED		 Object defining search conditions.
and array[object]
REQUIRED
 Array of search parameters.
property string
REQUIRED
 Search field parameter.
Applicable values:
  • /token
  • /products/zSide/patchPanel/location/ibx
  • /state
  • /provider/name
  • /requestor/name
  • /provider/orgIds
  • /requestor/orgIds
operator string
REQUIRED
 Search field parameter operator.
Applicable values:
  • =
  • IN
  • LIKE
  • CONTAINS
values array[string]
REQUIRED
 Search field parameter value.
Example: RE4E-91PA
or array[object]
REQUIRED
 Array of search parameters with OR logical operator applied.
property string
REQUIRED
 Search field parameter.
Applicable values:
  • /token
  • /products/zSide/patchPanel/location/ibx
  • /state
  • /provider/name
  • /requestor/name
  • /provider/orgIds
  • /requestor/orgIds
operator string
REQUIRED
 Search field parameter operator.
Applicable values:
  • =
  • IN
  • LIKE
  • CONTAINS
values array[string]
REQUIRED
 Search field parameter value.
Example: RE4E-91PA
/token Digital LOA document token.
Example:
"property": "/token",
"operator": "=",
"values": [
"RE4E-91PA"
]
operator string
REQUIRED		 Search field parameter operator.
Applicable values:
  • =
  • IN
  • LIKE
values array[string]
REQUIRED		 Search field parameter value.
Example: RE4E-91PA
/products/zSide/patchPanel/location/ibx IBX data center identifier.
Example:
"property": "/products/zSide/patchPanel/location/ibx",
"operator": "IN",
"values": [
"AT1",
"AT2"
]
operator string
REQUIRED		 Search field parameter operator.
Applicable values:
  • =
  • IN
  • LIKE
values array[string]
REQUIRED		 Search field parameter value.
Example: WA1
/state Digital LOA document status.
Example:
"property": "/state",
"operator": "=",
"values": [
"READY_FOR_USE"
]
operator string
REQUIRED		 Search field parameter operator.
Applicable values:
  • =
  • IN
  • LIKE
values array[string]
REQUIRED		 Search field parameter value.
Applicable values:
  • ACCEPTED
  • READY_FOR_USE
  • LOCKED
  • USED
  • CANCELLED
  • REJECTED
  • EXPIRED
  • PENDING_REQUESTOR_ACCEPTANCE
  • PENDING_PROVIDER_AUTHORIZATION
/provider/name Z-side party organization name.
Example:
"property": "/provider/name",
"operator": "LIKE",
"values": [
"Dunder Mifflin"
]
operator string
REQUIRED		 Search field parameter operator.
Applicable values:
  • =
  • IN
  • LIKE
values array[string]
REQUIRED		 Search field parameter value.
Example: Dunder Mifflin
/requestor/name A-side party organization name.
Example:
"property": "/requestor/name",
"operator": "LIKE",
"values": [
"Schrute Farms"
]
operator string
REQUIRED		 Search field parameter operator.
Applicable values:
  • =
  • IN
  • LIKE
values array[string]
REQUIRED		 Search field parameter value.
Example: Schrute Farms
/provider/orgIds Z-side party organization identifier.
Example:
"property": "/provider/orgIds",
"operator": "CONTAINS",
"values": [
"1891204"
]
operator string
REQUIRED		 Search field parameter operator.
Applicable values:
  • CONTAINS
values array[string]
REQUIRED		 Search field parameter value.
Example: 1891204
/requestor/orgIds Z-side party organization identifier.
Example:
"property": "/requestor/orgIds",
"operator": "CONTAINS",
"values": [
"1891204"
]
operator string
REQUIRED		 Search field parameter operator.
Applicable values:
  • CONTAINS
values array[string]
REQUIRED		 Search field parameter value.
Example: 1891204

Sample response:

Copy 
{
    "token": "RE4E-91PA",
    "uuid": "079dc798-05e8-11ed-b939-0242ac120002",
    "state": "READY_FOR_USE",
    "products": [
        {
            "uuid": "079dc798-05e8-11ed-b939-0242ac120002",
            "type": "CROSS_CONNECT",
            "crossConnect": {
                "connectionService": "Multi-Mode Fiber",
                "mediaType": "62.5 MICRON MULTI-MODE FIBER",
                "protocolType": "100 GIG ETHERNET",
                "zSide": {
                    "circuitId": "34234535",
                    "connectorType": "ST",
                    "patchPanelId" : "CP:0218:0102:13008148",
                    "portA": 12,
                    "portB": 13
                    }
                }
            }
        }
    ],
    "requestor": {
        "type": "CUSTOMER_ORGANIZATION",
        "orgIds": [
            "7367"
        ],
        "name": "Michael Scott Paper Company",
        "contacts": [
            {
                "type": "NOTIFICATION",
                "registeredUser": "Registered",
                "firstName": "Michael",
                "lastName": "Scott",
                "timezone": "Pacific/Midway",
                "availability": "ANYTIME",
                "details": [
                    {
                        "notes": "Main LOA Contact",
                        "value": "mike@mspc.com",
                        "type": "EMAIL"
                    }
                ]
            }
        ]
    },
    "provider": {
        "type": "CUSTOMER_ORGANIZATION",
        "orgIds": [
            "8601"
        ],
        "name": "Prince Family Paper",
        "contacts": [
            {
                "type": "NOTIFICATION",
                "firstName": "John",
                "lastName": "Gates",
                "timezone": "America/New_York",
                "details": [
                    {
                        "value": "john@pfp.com",
                        "type": "EMAIL"
                    }
                ]
            }
        ]
    },
    "changeLog": {
        "createdDateTime": "2022-11-17T22:59:59.999Z"
    },
    "links": [
        {
            "rel": "info",
            "href": "https://api.equinix.com/diloa/v1/digitalLoas/402cbf99-97d7",
            "method": "GET",
            "contentType": "application/json",
            "authenticate": true
        }
    ],
    "notes": "No additional notes",
    "expiryDateTime": "2022-11-17T22:59:59.999Z"
}

For payload body parameters descriptions, refer to the Payload body parameters section in Get Specified Digital LOA Document.


Update Digital LOA Document

POST /diloa/v1/digitalLoas/{uuid}/actions
Method PATCH
Endpoint /diloa/v1/digitalLoas/{uuid}/actions
Headers Authorization, Content-Type
Path Parameters uuid
Query Parameters Not applicable
Body Parameters type

This API request updates a given Digital LOA document.

To obtain the Access Token, refer to Requesting Access and Refresh tokens under the Getting Access Token section.


Sample curl request

Copy 
curl -X
PATCH "https://api.equinix.com/diloa/v1/digitalLoas/079dc798-05e8-11ed-b939-0242ac120002"
-H "content-type: application/json"
-H "Authorization: Bearer qwErtY8zyW1abcdefGHI"
-d '[
    {
        "op": "replace",
        "path": "/requestor/contacts",
        "value": [
            {
                "type": "NOTIFICATION",
                "details": [
                    {
                        "value": "john@ltt.com",
                        "type": "EMAIL"
                    }
                ]
            }
        ],
        "from": "string"
    }
]'

Path parameters

Parameter
Description
uuid string
REQUIRED		 Digital LOA document identifier.
Example: 079dc798-05e8-11ed-b939-0242ac120002

Body parameters

Parameter
Description
op string
REQUIRED		 Update request type.
Applicable values: replace
path string
REQUIRED		 Parameter path.
Applicable values:
  • /requestor/contacts - Digital LOA requestor contact information.
  • /state - Digital LOA document status.
value array[object]/string
REQUIRED		 Parameter value. Note that the value's parameter structure depends on the parameter that's being updated.
from string
CONDITIONAL		 JSON pointer to a source element. Applicable to move and copy operations.
/requestor/contacts
value array[object]
REQUIRED		 Digital LOA requestor contact information details.
Example:
[
{
"type": "NOTIFICATION",
"details": [
{
"value": "john@ltt.com",
"type": "EMAIL"
}
]
}
]
/state
value string
REQUIRED		 Digital LOA document status.
Applicable values:
  • READY_FOR_USE

Sample response

Copy 
{
    "token": "WYQ6-XEVN",
    "uuid": "888eb29b-2fd8-4e05-82ec-a28e5faec01a",
    "state": "READY_FOR_USE",
    "products": [
        {
            "uuid": "3ff15157-3f01-4fa9-b2c0-63493772ee8f",
            "type": "CROSS_CONNECT",
            "crossConnect": {
                "connectionService": "Multi-Mode Fiber",
                "mediaType": "62.5 MICRON MULTI-MODE FIBER",
                "protocolType": "STM-16",
                "zSide": {
                    "connectorType": "ST",
                    "patchPanel": {
                        "id": "PP:0103:1260520",
                        "cabinetSpaceId": "MI1:03:131545:0103",
                        "cageSpaceId": "MI1:03:131545",
                        "location": {
                            "ibx": "MI1",
                            "region": "AMER",
                            "metroName": "Miami",
                            "metroCode": "MI",
                            "countryCode": "US",
                            "address": "50 NE 9th Street, 33132 Miami, FL, United States of America"
                        }
                    },
                    "portA": 9,
                    "portB": 10
                }
            }
        },
        {
            "uuid": "680b7115-e474-4517-8b87-02ae5aa4e85e",
            "type": "CROSS_CONNECT",
            "crossConnect": {
                "connectionService": "Multi-Mode Fiber",
                "mediaType": "62.5 MICRON MULTI-MODE FIBER",
                "protocolType": "STM-16",
                "zSide": {
                    "connectorType": "SC",
                    "patchPanel": {
                        "id": "PP:0103:1260520",
                        "cabinetSpaceId": "MI1:03:131545:0103",
                        "cageSpaceId": "MI1:03:131545",
                        "location": {
                            "ibx": "MI1",
                            "region": "AMER",
                            "metroName": "Miami",
                            "metroCode": "MI",
                            "countryCode": "US",
                            "address": "50 NE 9th Street, 33132 Miami, FL, United States of America"
                        }
                    },
                    "portA": 11
                }
            }
        }
    ],
    "requestor": {
        "type": "CUSTOMER_ORGANIZATION",
        "orgIds": [
            "10021"
        ],
        "name": "ADOBE SYSTEMS INCORPORATED-37377",
        "contacts": [
            {
                "type": "NOTIFICATION",
                "registeredUser": "Registered",
                "firstName": "Aakash",
                "lastName": "Setia",
                "timezone": "Asia/Kabul",
                "availability": "ANYTIME",
                "details": [
                    {
                        "notes": "Main LOA Contact",
                        "value": "aakbasdf@adobe.com",
                        "type": "EMAIL"
                    }
                ]
            }
        ]
    },
    "provider": {
        "type": "CUSTOMER_ORGANIZATION",
        "orgIds": [
            "7367"
        ],
        "name": "FASTLY, INC.",
        "contacts": [
            {
                "type": "NOTIFICATION",
                "firstName": "Frank",
                "lastName": "Villa",
                "timezone": "Pacific/Midway",
                "details": [
                    {
                        "value": "frank@fastly.com",
                        "type": "EMAIL"
                    }
                ]
            }
        ]
    },
    "changeLog": {
        "createdDateTime": "2022-09-21T04:16:49.657Z"
    },
    "links": [
        {
            "rel": "self",
            "href": "https://api.equinix.com/diloa/v1/digitalLoas/888eb29b-2fd8-4e05-82ec-a28e5faec01a",
            "method": "GET",
            "authenticate": true
        },
        {
            "rel": "update",
            "href": "https://api.equinix.com/diloa/v1/digitalLoas/888eb29b-2fd8-4e05-82ec-a28e5faec01a",
            "method": "PATCH",
            "contentType": "application/json",
            "authenticate": true
        },
        {
            "rel": "events",
            "href": "https://api.equinix.com/diloa/v1/digitalLoas/888eb29b-2fd8-4e05-82ec-a28e5faec01a/actions",
            "method": "POST",
            "authenticate": true
        },
        {
            "rel": "delete",
            "href": "https://api.equinix.com/diloa/v1/digitalLoas/888eb29b-2fd8-4e05-82ec-a28e5faec01a",
            "method": "DELETE",
            "authenticate": true
        }
    ],
    "notes": "",
    "expiryDateTime": "2022-09-30T15:59:59.999Z",
    "href": "diloa/v1/digitalLoas/888eb29b-2fd8-4e05-82ec-a28e5faec01a"
}

For payload body parameters descriptions, refer to the Payload body parameters section in Get Specified Digital LOA Document.


Perform Action on Digital LOA Document

POST /diloa/v1/digitalLoas/{uuid}/actions
Method POST
Endpoint /diloa/v1/digitalLoas/{uuid}/actions
Headers Authorization, Content-Type
Path Parameters uuid
Query Parameters Not applicable
Body Parameters type

This API request performs an action on a given Digital LOA document.

To obtain the Access Token, refer to Requesting Access and Refresh tokens under the Getting Access Token section.


Sample curl request

Copy 
curl -X
POST "https://api.equinix.com/diloa/v1/digitalLoas/079dc798-05e8-11ed-b939-0242ac120002/actions"
-H "content-type: application/json"
-H "Authorization: Bearer qwErtY8zyW1abcdefGHI"
-d '{
    "type": "ACCEPT"
}'

Path parameters

Parameter
Description
uuid string
REQUIRED		 Digital LOA document identifier.
Example: 079dc798-05e8-11ed-b939-0242ac120002

Body parameters

Parameter
Description
type string
REQUIRED		 Action type performed on a Digital LOA document.
Applicable values:
  • ACCEPT - Accepts LOA Requestor as a valid Equinix customer.
  • AUTHORIZE - Authorizes Requestor as a party of LOA by its Provider.
  • UNAUTHORIZE - Unauthorizes Requestor as a party of LOA by its Provider.
  • SEND_LOA - Send email with Digital LOA document details.

Delete Digital LOA Document

DELETE /diloa/v1/digitalLoas/{uuid}
Method DELETE
Endpoint /diloa/v1/digitalLoas/{uuid}
Headers Authorization
Path Parameters uuid
Query Parameters Not applicable
Body parameters Not applicable

This API request invalidates a specified Digital LOA document and sets its status to CANCELLED.

To obtain the Access Token, refer to Requesting Access and Refresh tokens under the Getting Access Token section.


Sample curl request

Copy 
curl -X
DELETE "https://api.equinix.com/diloa/v1/digitalLoas/079dc798-05e8-11ed-b939-0242ac120002"
-H "Authorization: Bearer qwErtY8zyW1abcdefGHI"

Path parameters

Parameter
Description
uuid string
REQUIRED		 Digital LOA document identifier.
Example: 079dc798-05e8-11ed-b939-0242ac120002

Get All Digital LOA Change Requests

GET /diloa/v1/digitalLoas/{uuid}/changes
Method GET
Endpoint /diloa/v1/digitalLoas/{uuid}/changes
Headers Authorization
Path Parameters uuid
Query Parameters Not applicable
Body Parameters Not applicable

This API request returns all change requests associated with a given Digital LOA document.

To obtain the Access Token, refer to Requesting Access and Refresh tokens under the Getting Access Token section.


Sample curl request

Copy 
curl -X
GET "https://api.equinix.com/diloa/v1/digitalLoas/079dc798-05e8-11ed-b939-0242ac120002/changes"
-H "Authorization: Bearer qwErtY8zyW1abcdefGHI"

Path parameters

Parameter
Description
uuid string
REQUIRED		 Digital LOA document identifier.
Example: 079dc798-05e8-11ed-b939-0242ac120002

Sample response

Copy 
[
    {
        "createdDateTime": "2022-10-11T09:10:52.323Z",
        "updatedDateTime": "2022-10-11T09:10:52.323Z",
        "data": "{\"notes\": \"This is a highly important note\", \"products\": [{\"type\": \"CROSS_CONNECT\", \"crossConnect\": {\"aSide\": null, \"zSide\": {\"portA\": 26, \"portB\": null, \"circuitId\": \"5438aa60-04c2-4c5e-89da-1280eb0124be\", \"patchPanelId\": \"PP:0001:1214680\", \"connectorType\": \"LC\"}, \"mediaType\": \"Single-Mode Fiber\", \"protocolType\": \"GIGABIT ETHERNET\", \"connectionService\": \"Single-Mode Fiber\"}}], \"provider\": {\"contacts\": [{\"type\": \"NOTIFICATION\", \"details\": [{\"type\": \"EMAIL\", \"notes\": \"Main LOA Contact\", \"value\": \"frank@abc.com\"}], \"lastName\": \"Villa\", \"timezone\": \"Asia/Kuala_Lumpur\", \"firstName\": \"Frank\", \"availability\": \"ANYTIME\", \"registeredUser\": \"Registered\"}]}, \"requestor\": {\"name\": \"ASDF Inc.\", \"type\": \"CUSTOMER_ORGANIZATION\", \"orgIds\": [\"8601\"], \"contacts\": [{\"type\": \"NOTIFICATION\", \"details\": [{\"type\": \"EMAIL\", \"notes\": \"Main LOA Contact\", \"value\": \"a_gates@asdf.com\"}], \"lastName\": \"Shrute\", \"timezone\": \"Asia/Dhaka\", \"firstName\": \"Aaron\", \"availability\": \"ANYTIME\", \"registeredUser\": \"Registered\"}]}, \"expiryDateTime\": {\"nano\": 999000000, \"epochSecond\": 1679180399}}",
        "description": "Create Loa",
        "href": "https://api.equinix.com/diloa/v1/digitalLoas/a273a094-603e-48c0-96b0-cf78e6c19723/changes/a273a094-603e-48c0-96b0-cf78e6c19723",
        "links": [
            {
                "rel": "self",
                "href": "https://api.equinix.com/diloa/v1/digitalLoas/1f520de6-f1df-4b7d-aca5-f8ab7d213b30/changes/a273a094-603e-48c0-96b0-cf78e6c19723",
                "method": "GET",
                "authenticate": true
            }
        ],
        "type": "LOA_CREATION",
        "uuid": "a273a094-603e-48c0-96b0-cf78e6c19723",
        "status": "COMPLETED",
        "result": {
            "loa": {
                "state": "READY_FOR_USE"
            }
        }
    },
    {
        "createdDateTime": "2022-10-11T09:10:53.485Z",
        "updatedDateTime": "2022-10-11T09:10:53.485Z",
        "data": "[{\"op\": \"replace\", \"from\": \"LOA_MANAGER\", \"path\": \"/state\", \"value\": \"LOCKED\"}]",
        "description": "Perform Patch Action",
        "href": "https://api.equinix.com/diloa/v1/digitalLoas/2e7cb540-22ae-4e14-a39d-a0db2ba4fa57/changes/2e7cb540-22ae-4e14-a39d-a0db2ba4fa57",
        "links": [
            {
                "rel": "self",
                "href": "https://api.equinix.com/diloa/v1/digitalLoas/1f520de6-f1df-4b7d-aca5-f8ab7d213b30/changes/2e7cb540-22ae-4e14-a39d-a0db2ba4fa57",
                "method": "GET",
                "authenticate": true
            }
        ],
        "type": "LOA_PATCHING",
        "uuid": "2e7cb540-22ae-4e14-a39d-a0db2ba4fa57",
        "status": "COMPLETED",
        "result": {
            "loa": {
                "state": "LOCKED"
            }
        }
    }
]

Response payload body description

Parameter
Description
createdDateTime string
 Date and time of change request creation.
Example: 2022-11-17T22:59:59.999Z
For more information refer to Internet Date/Time Format.
updatedDateTime string
 Date and time of change request update.
Example: 2022-11-17T22:59:59.999Z
For more information refer to Internet Date/Time Format.
data string
 Complete JSON representation of the data associated with the given change.
Example: [{\"op\": \"replace\", \"from\": \"LOA_MANAGER\", \"path\": \"/state\", \"value\": \"LOCKED\"}]
description string
 Additional information on the Digital LOA document change.
Example: Create Loa
href string
 Absolute URL that returns the specified change request.
Example:https://api.equinix.com/diloa/v1/digitalLoas/2e7cb540-22ae-4e14-a39d-a0db2ba4fa57/changes/2e7cb540-22ae-4e14-a39d-a0db2ba4fa57
links array[object]
 HATEOAS links specifying possible follow-up interactions.
type string
 Change request type.
Example: LOA_CREATION
uuid string
 Change request identifier.
Example: a273a094-603e-48c0-96b0-cf78e6c19723
status string
 Change request identifier.
Possible values:
  • REQUESTED - Change request registered, pending execution.
  • COMPLETED - Change request executed successfully.
  • FAILED - Change request execution failed.
result object
 The result of the change request execution on a given Digital LOA document.
loa object
 Digital LOA document details.
status string
 Status of the Digital LOA document after change request completion.
Possible values:
  • DRAFT
  • ACCEPTED
  • READY_FOR_USE
  • LOCKED
  • USED
  • CANCELLED
  • REJECTED
  • EXPIRED
  • PENDING_REQUESTOR_ACCEPTANCE
  • PENDING_PROVIDER_AUTHORIZATION

Get Specified Digital LOA Change Request

GET /diloa/v1/digitalLoas/{uuid}/changes/{changeUuid}
Method GET
Endpoint /diloa/v1/digitalLoas/{uuid}/changes/{changeUuid}
Headers Authorization
Path Parameters uuid, changeUuid
Query Parameters Not applicable
Body Parameters Not applicable

This API request returns a specified change request associated with a given Digital LOA document.

To obtain the Access Token, refer to Requesting Access and Refresh tokens under the Getting Access Token section.


Sample curl request

Copy 
curl -X
GET "https://api.equinix.com/diloa/v1/digitalLoas/079dc798-05e8-11ed-b939-0242ac120002/changes/2e7cb540-22ae-4e14-a39d-a0db2ba4fa57"
-H "Authorization: Bearer qwErtY8zyW1abcdefGHI"

Path parameters

Parameter
Description
uuid string
REQUIRED		 Digital LOA document identifier.
Example: 079dc798-05e8-11ed-b939-0242ac120002
changeUuid string
REQUIRED		 Digital LOA document change request identifier.
Example: 2e7cb540-22ae-4e14-a39d-a0db2ba4fa57

Sample response

Copy 
{
    "createdDateTime": "2022-10-11T09:10:53.485Z",
    "updatedDateTime": "2022-10-11T09:10:53.485Z",
    "data": "[{\"op\": \"replace\", \"from\": \"LOA_MANAGER\", \"path\": \"/state\", \"value\": \"LOCKED\"}]",
    "description": "Perform Patch Action",
    "href": "https://api.equinix.com/diloa/v1/digitalLoas/2e7cb540-22ae-4e14-a39d-a0db2ba4fa57/changes/2e7cb540-22ae-4e14-a39d-a0db2ba4fa57",
    "links": [
        {
            "rel": "self",
            "href": "https://api.equinix.com/diloa/v1/digitalLoas/1f520de6-f1df-4b7d-aca5-f8ab7d213b30/changes/2e7cb540-22ae-4e14-a39d-a0db2ba4fa57",
            "method": "GET",
            "authenticate": true
        }
    ],
    "type": "LOA_PATCHING",
    "uuid": "2e7cb540-22ae-4e14-a39d-a0db2ba4fa57",
    "status": "COMPLETED",
    "result": {
        "loa": {
            "state": "LOCKED"
        }
    }
}

Response payload body description

Parameter
Description
createdDateTime string
 Date and time of change request creation.
Example: 2022-11-17T22:59:59.999Z
For more information refer to Internet Date/Time Format.
updatedDateTime string
 Date and time of change request update.
Example: 2022-11-17T22:59:59.999Z
For more information refer to Internet Date/Time Format.
data string
 Complete JSON representation of the data associated with the given change.
Example: [{\"op\": \"replace\", \"from\": \"LOA_MANAGER\", \"path\": \"/state\", \"value\": \"LOCKED\"}]
description string
 Additional information on the Digital LOA document change.
Example: Create Loa
href string
 Absolute URL that returns the specified change request.
Example:https://api.equinix.com/diloa/v1/digitalLoas/2e7cb540-22ae-4e14-a39d-a0db2ba4fa57/changes/2e7cb540-22ae-4e14-a39d-a0db2ba4fa57
links array[object]
 HATEOAS links specifying possible follow-up interactions.
type string
 Change request type.
Possible values:
  • LOA_CREATION
  • LOA_AUTHORIZATION
  • LOA_CANCELLATION
  • LOA_PATCHING
  • LOA_LOCK_ACQUISITION
  • LOA_LOCK_RELEASE
  • LOA_USAGE
  • LOA_ACCEPTANCE
  • LOA_UNAUTHORIZATION
  • TYPE_UNKNOWN
uuid string
 Change request identifier.
Example: a273a094-603e-48c0-96b0-cf78e6c19723
status string
 Change request identifier.
Possible values:
  • REQUESTED - Change request registered, pending execution.
  • COMPLETED - Change request executed successfully.
  • FAILED - Change request execution failed.
result object
 The result of the change request execution on a given Digital LOA document.
loa object
 Digital LOA document details.
status string
 Status of the Digital LOA document after change request completion.
Possible values:
  • DRAFT
  • ACCEPTED
  • READY_FOR_USE
  • LOCKED
  • USED
  • CANCELLED
  • REJECTED
  • EXPIRED
  • PENDING_REQUESTOR_ACCEPTANCE
  • PENDING_PROVIDER_AUTHORIZATION