Digital LOA API (1.0.0)

Download OpenAPI specification:Download

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

Digital LOA API

Loa

Create Digital LOA document

Creates a Digital LOA document.

Authorizations:

BearerAuth

Request Body schema: application/json
required

required

Array of objects (CreateProduct) non-empty

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

Array (non-empty)

type required	string Value: "CROSS_CONNECT" Product type.
required	object (CreateCrossConnect) Create Cross Connect interface

required

object (Party)

Party interface for Customer Organization

type required	string Party type NEW_RELATIONSHIP
email required	string <email> Organization representative email address.
name required	string Organization name.

required

object (PartyContacts)

Party contacts

required

Array of objects (Contact) non-empty

Organization contact information.

Array (non-empty)

type required	string Enum: "NOTIFICATION" "TECHNICAL" "ORDERING" "RESELLING" "BILLING" Notification messages category relevant to a given contact person.
registeredUser	string Registered user identified by contactId, userId, or userKey. If a registered user is specified, you don't have to provide first name and last name information.
firstName	string Contact person's first name. Required if registeredUser isn't provided.
lastName	string Contact person's last name. Required if registeredUser isn't provided.
timezone	string Contact Timezone
availability	string Enum: "WORK_HOURS" "ANYTIME" Contact person's availability.
required	Array of objects (ContactDetails) non-empty Means of contact.

notes

string

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

expiryDateTime

string <date-time>

Digital LOA expiration date.

Responses

Request samples

Payload

Content type

application/json

{"products": [{"type": "CROSS_CONNECT",
"crossConnect": {"connectionService": "MULTI_MODE_FIBER",
"mediaType": "50_MICRON_MULTI_MODE_FIBER_OM3",
"protocolType": "100_GIG_ETHERNET",
"aSide": {"connectorType": "ST",
"circuitId": "34234535",
"patchPanelId": "CP:0218:0102:13008148",
"portA": 12,
"portB": 13
},
"zSide": {"connectorType": "ST",
"circuitId": "34234535",
"patchPanelId": "CP:0218:0102:13008148",
"portA": 12,
"portB": 13
}
}
}
],
"requestor": {"type": "CUSTOMER_ORGANIZATION"
},
"provider": {"contacts": [{"type": "NOTIFICATION",
"registeredUser": "Registered",
"firstName": "John",
"lastName": "Smith",
"timezone": "Australia/Perth",
"availability": "ANYTIME",
"details": [{"notes": "Do not call me after 6 P.M. CEST",
"value": "kyle@mail.com",
"type": "EMAIL"
}
]
}
]
},
"notes": "Rack access: weekdays - 18:00 to 22:00 CET; Saturday - 10:00 to 14:00 CET.",
"expiryDateTime": "2022-11-17T22:59:59.999Z"
}

Response samples

202
400
401
500

Content type

application/json

{"token": "REDF-4R56",
"uuid": "079dc798-05e8-11ed-b939-0242ac120002",
"state": "USED",
"draft": false,
"changeLog": {"createdDateTime": "2022-11-17T22:59:59.999Z"
},
"links": [{"rel": "info",
"href": "diloa/v1/digitalLoas/{resource-path}",
"method": "GET",
"contentType": "application/json",
"authenticate": true
}
],
"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"
}

Perform action on Digital LOA document.

Performs an action on a given Digital LOA document.

Authorizations:

BearerAuth

path Parameters

uuid

required

string

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

Digital LOA document identifier.

Request Body schema: application/json
required

type

required

string

Action type performed on a Digital LOA document.

ACCEPT - Accepts Digital LOA Requestor as a valid Equinix customer
AUTHORIZE - Authorizes Requestor as a party of Digital LOA by its Provider
UNAUTHORIZE - Unauthorizes Requestor as a party of LOA by its Provider
SEND_LOA - Sends emails with Digital LOA details

ACCEPT

Responses

Response Schema: application/json

token

string

User-friendly Digital LOA document identifier.

uuid

string <uuid>

Digital LOA document identifier.

state

string (State)

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

Digital LOA document status.

Array of objects (Product) non-empty

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

Array (non-empty)

uuid required	string <uuid> Product identifier.
type required	string (ProductType) Value: "CROSS_CONNECT" Product type
required	object (CrossConnect) Cross Connect interface

object (Party)

Party interface for Customer Organization

type required	string Party type NEW_RELATIONSHIP
email required	string <email> Organization representative email address.
name required	string Organization name.

object (Party)

Party interface for Customer Organization

type required	string Party type NEW_RELATIONSHIP
email required	string <email> Organization representative email address.
name required	string Organization name.

object (ChangeLog)

Change interface

createdDateTime

string <date-time>

Date and time of Digital LOA document creation.

Array of objects (Links) >= 0 items

HATEOAS links specifying possible follow-up interactions.

Array (>= 0 items)

rel required	string Enum: "self" "info" "update" "delete" "statistics" "events" Attribute describing the relationship ('rel') of the linked resource to its associated document.
href required	string An absolute URL that is the subject of the link's context, such as a link to a service profile or set of statistics.
method	string Enum: "POST" "GET" "PUT" "DELETE" "PATCH" HTTP method used in the API call to request the specified resource.
contentType	string MIME type indicating the document format. Syntax complies with IETF RFC 6838.
authenticate	boolean Flag showing whether authentication is required to access the linked resource. The default value is false.

notes

string

Additional information to be considered.

expiryDateTime

string <date-time>

Digital LOA document expiration date.

href

string

Digital LOA document URI.

Request samples

Payload

Content type

application/json

Example

ACCEPT

{"type": "ACCEPT"
}

Response samples

200
400
401
404
500

Content type

application/json

{"token": "REDF-4R56",
"uuid": "079dc798-05e8-11ed-b939-0242ac120002",
"state": "USED",
"products": [{"uuid": "535caeaf-bba4-46e0-99bc-bf39c72b275f",
"type": "CROSS_CONNECT",
"crossConnect": {"connectionService": "MULTI_MODE_FIBER",
"mediaType": "50_MICRON_MULTI_MODE_FIBER_OM3",
"protocolType": "100_GIG_ETHERNET",
"aSide": {"circuitId": "34234535",
"connectorType": "ST",
"patchPanel": {"id": "CP:0218:0102:13008148",
"cabinetSpaceId": "TY1:04:000050:1613-S14",
"cageSpaceId": "TY1:04:000050",
"location": {"ibx": "TY1",
"region": "EMEA",
"metroName": "Amsterdam",
"metroCode": "AM",
"countryCode": "NL",
"address": "8 Buckingham Avenue, Slough Trading Estate, SL1 4AX Slough, England"
}
},
"portA": 12,
"portB": 13
},
"zSide": {"circuitId": "34234535",
"connectorType": "ST",
"patchPanel": {"id": "CP:0218:0102:13008148",
"cabinetSpaceId": "TY1:04:000050:1613-S14",
"cageSpaceId": "TY1:04:000050",
"location": {"ibx": "TY1",
"region": "EMEA",
"metroName": "Amsterdam",
"metroCode": "AM",
"countryCode": "NL",
"address": "8 Buckingham Avenue, Slough Trading Estate, SL1 4AX Slough, England"
}
},
"portA": 12,
"portB": 13
}
}
}
],
"requestor": {"type": "CUSTOMER_ORGANIZATION"
},
"provider": {"type": "CUSTOMER_ORGANIZATION"
},
"changeLog": {"createdDateTime": "2022-11-17T22:59:59.999Z"
},
"links": [{"rel": "info",
"href": "diloa/v1/digitalLoas/{resource-path}",
"method": "GET",
"contentType": "application/json",
"authenticate": true
}
],
"notes": "Please contact me",
"expiryDateTime": "2022-11-17T22:59:59.999Z",
"href": "diloa/v1/digitalLoas/402cbf99-97d7-440f-8291-1a4b9639154a"
}

Get specified Digital LOA document.

Returns details of a specified Digital LOA document.

Authorizations:

BearerAuth

path Parameters

uuid

required

string

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

Digital LOA document identifier.

Responses

Response Schema: application/json

token

string

User-friendly Digital LOA document identifier.

uuid

string <uuid>

Digital LOA document identifier.

state

string (State)

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

Digital LOA document status.

Array of objects (Product) non-empty

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

Array (non-empty)

uuid required	string <uuid> Product identifier.
type required	string (ProductType) Value: "CROSS_CONNECT" Product type
required	object (CrossConnect) Cross Connect interface

object (Party)

Party interface for Customer Organization

type required	string Party type NEW_RELATIONSHIP
email required	string <email> Organization representative email address.
name required	string Organization name.

object (Party)

Party interface for Customer Organization

type required	string Party type NEW_RELATIONSHIP
email required	string <email> Organization representative email address.
name required	string Organization name.

object (ChangeLog)

Change interface

createdDateTime

string <date-time>

Date and time of Digital LOA document creation.

Array of objects (Links) >= 0 items

HATEOAS links specifying possible follow-up interactions.

Array (>= 0 items)

rel required	string Enum: "self" "info" "update" "delete" "statistics" "events" Attribute describing the relationship ('rel') of the linked resource to its associated document.
href required	string An absolute URL that is the subject of the link's context, such as a link to a service profile or set of statistics.
method	string Enum: "POST" "GET" "PUT" "DELETE" "PATCH" HTTP method used in the API call to request the specified resource.
contentType	string MIME type indicating the document format. Syntax complies with IETF RFC 6838.
authenticate	boolean Flag showing whether authentication is required to access the linked resource. The default value is false.

notes

string

Additional information to be considered.

expiryDateTime

string <date-time>

Digital LOA document expiration date.

href

string

Digital LOA document URI.

Response samples

200
400
401
404
500

Content type

application/json

{"token": "REDF-4R56",
"uuid": "079dc798-05e8-11ed-b939-0242ac120002",
"state": "USED",
"products": [{"uuid": "535caeaf-bba4-46e0-99bc-bf39c72b275f",
"type": "CROSS_CONNECT",
"crossConnect": {"connectionService": "MULTI_MODE_FIBER",
"mediaType": "50_MICRON_MULTI_MODE_FIBER_OM3",
"protocolType": "100_GIG_ETHERNET",
"aSide": {"circuitId": "34234535",
"connectorType": "ST",
"patchPanel": {"id": "CP:0218:0102:13008148",
"cabinetSpaceId": "TY1:04:000050:1613-S14",
"cageSpaceId": "TY1:04:000050",
"location": {"ibx": "TY1",
"region": "EMEA",
"metroName": "Amsterdam",
"metroCode": "AM",
"countryCode": "NL",
"address": "8 Buckingham Avenue, Slough Trading Estate, SL1 4AX Slough, England"
}
},
"portA": 12,
"portB": 13
},
"zSide": {"circuitId": "34234535",
"connectorType": "ST",
"patchPanel": {"id": "CP:0218:0102:13008148",
"cabinetSpaceId": "TY1:04:000050:1613-S14",
"cageSpaceId": "TY1:04:000050",
"location": {"ibx": "TY1",
"region": "EMEA",
"metroName": "Amsterdam",
"metroCode": "AM",
"countryCode": "NL",
"address": "8 Buckingham Avenue, Slough Trading Estate, SL1 4AX Slough, England"
}
},
"portA": 12,
"portB": 13
}
}
}
],
"requestor": {"type": "CUSTOMER_ORGANIZATION"
},
"provider": {"type": "CUSTOMER_ORGANIZATION"
},
"changeLog": {"createdDateTime": "2022-11-17T22:59:59.999Z"
},
"links": [{"rel": "info",
"href": "diloa/v1/digitalLoas/{resource-path}",
"method": "GET",
"contentType": "application/json",
"authenticate": true
}
],
"notes": "Please contact me",
"expiryDateTime": "2022-11-17T22:59:59.999Z",
"href": "diloa/v1/digitalLoas/402cbf99-97d7-440f-8291-1a4b9639154a"
}

Delete Digital LOA document

Invalidates a specified Digital LOA document and sets its status to CANCELLED.

Authorizations:

BearerAuth

path Parameters

uuid

required

string

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

Digital LOA document identifier.

Responses

Response samples

401
404
500

Content type

application/json

[{"errorCode": "EQ-7200030",
"errorMessage": "Not found",
"details": "Error details",
"correlationId": "Correlation ID to trace the error back",
"help": "URL to a help page for the corresponding errorCode",
"additionalInfo": [{"reason": "missing id",
"property": "id"
}
]
}
]

Modify a Digital LOA document

Modifies a given Digital LOA document.

Authorizations:

BearerAuth

path Parameters

uuid

required

string

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

Digital LOA document identifier.

Request Body schema: application/json
required

Array

op required	string Enum: "add" "remove" "replace" "move" "copy" "test" The operation to be performed
path required	string Enum: "/state" "/requestor/contacts" A path to property being patched
value	object The value to be used within the operations.
from	string A string containing a JSON Pointer value.

Responses

Response Schema: application/json

token

string

User-friendly Digital LOA document identifier.

uuid

string <uuid>

Digital LOA document identifier.

state

string (State)

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

Digital LOA document status.

Array of objects (Product) non-empty

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

Array (non-empty)

uuid required	string <uuid> Product identifier.
type required	string (ProductType) Value: "CROSS_CONNECT" Product type
required	object (CrossConnect) Cross Connect interface

object (Party)

Party interface for Customer Organization

type required	string Party type NEW_RELATIONSHIP
email required	string <email> Organization representative email address.
name required	string Organization name.

object (Party)

Party interface for Customer Organization

type required	string Party type NEW_RELATIONSHIP
email required	string <email> Organization representative email address.
name required	string Organization name.

object (ChangeLog)

Change interface

createdDateTime

string <date-time>

Date and time of Digital LOA document creation.

Array of objects (Links) >= 0 items

HATEOAS links specifying possible follow-up interactions.

Array (>= 0 items)

rel required	string Enum: "self" "info" "update" "delete" "statistics" "events" Attribute describing the relationship ('rel') of the linked resource to its associated document.
href required	string An absolute URL that is the subject of the link's context, such as a link to a service profile or set of statistics.
method	string Enum: "POST" "GET" "PUT" "DELETE" "PATCH" HTTP method used in the API call to request the specified resource.
contentType	string MIME type indicating the document format. Syntax complies with IETF RFC 6838.
authenticate	boolean Flag showing whether authentication is required to access the linked resource. The default value is false.

notes

string

Additional information to be considered.

expiryDateTime

string <date-time>

Digital LOA document expiration date.

href

string

Digital LOA document URI.

Request samples

Payload

Content type

application/json

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

Response samples

200
400
401
404
500

Content type

application/json

{"token": "REDF-4R56",
"uuid": "079dc798-05e8-11ed-b939-0242ac120002",
"state": "USED",
"products": [{"uuid": "535caeaf-bba4-46e0-99bc-bf39c72b275f",
"type": "CROSS_CONNECT",
"crossConnect": {"connectionService": "MULTI_MODE_FIBER",
"mediaType": "50_MICRON_MULTI_MODE_FIBER_OM3",
"protocolType": "100_GIG_ETHERNET",
"aSide": {"circuitId": "34234535",
"connectorType": "ST",
"patchPanel": {"id": "CP:0218:0102:13008148",
"cabinetSpaceId": "TY1:04:000050:1613-S14",
"cageSpaceId": "TY1:04:000050",
"location": {"ibx": "TY1",
"region": "EMEA",
"metroName": "Amsterdam",
"metroCode": "AM",
"countryCode": "NL",
"address": "8 Buckingham Avenue, Slough Trading Estate, SL1 4AX Slough, England"
}
},
"portA": 12,
"portB": 13
},
"zSide": {"circuitId": "34234535",
"connectorType": "ST",
"patchPanel": {"id": "CP:0218:0102:13008148",
"cabinetSpaceId": "TY1:04:000050:1613-S14",
"cageSpaceId": "TY1:04:000050",
"location": {"ibx": "TY1",
"region": "EMEA",
"metroName": "Amsterdam",
"metroCode": "AM",
"countryCode": "NL",
"address": "8 Buckingham Avenue, Slough Trading Estate, SL1 4AX Slough, England"
}
},
"portA": 12,
"portB": 13
}
}
}
],
"requestor": {"type": "CUSTOMER_ORGANIZATION"
},
"provider": {"type": "CUSTOMER_ORGANIZATION"
},
"changeLog": {"createdDateTime": "2022-11-17T22:59:59.999Z"
},
"links": [{"rel": "info",
"href": "diloa/v1/digitalLoas/{resource-path}",
"method": "GET",
"contentType": "application/json",
"authenticate": true
}
],
"notes": "Please contact me",
"expiryDateTime": "2022-11-17T22:59:59.999Z",
"href": "diloa/v1/digitalLoas/402cbf99-97d7-440f-8291-1a4b9639154a"
}

Retrieve Digital LOA Documents

Returns Digital LOA documents that match the specified criteria.

Authorizations:

BearerAuth

query Parameters

offset	integer >= 0 Default: 0 Index of the first item returned in the response.
limit	integer >= 1 Default: 20 Example: limit=20 Maximum number of items returned per page.
sort	Array of strings Items Enum: "/changeLog/createdDateTime" "-/changeLog/createdDateTime" "/expiryDateTime" "-/expiryDateTime" "/products/zSide/patchPanel/location/ibx" "-/products/zSide/patchPanel/location/ibx" Example: sort=/expiryDateTime Search results sorting settings: `/` - Ascending, i.e. '/expiryDateTime' `-/` - Descending, i.e. '-/expiryDateTime'

Request Body schema: application/json
required

required

object (LoaSearchItem)

Search criteria body

required

Array of Expression (object) or LoaCriterion (object) (OrExpressionItem) non-empty

Search criterion list

Array (non-empty)

One of

Array of objects (LoaCriterion)

Search criterion item displaying a record if any of the conditions separated by 'or' is true

Array

property	string Enum: "/token" "/products/zSide/patchPanel/location/ibx" "/state" "/provider/name" "/requestor/name" "/provider/orgIds" "/requestor/orgIds" Search property name
operator	string Enum: "=" "IN" "LIKE" "CONTAINS" Criterion operator
values	Array of strings non-empty Criterion values

Responses

Response Schema: application/json

required

object (Pagination)

Pagination

offset required	integer Index of the first item returned in the response.
limit required	integer Maximum number of items returned per page.
total required	integer Total number of items returned.
next	string Link to the next page of the collection
previous	string Link to the previous page of the collection

required

Array of objects (Sort)

Search results sorting settings.

Array

direction required	string Enum: "ASC" "DESC" Search results sorting direction.
property required	string Enum: "/changeLog/createdDateTime" "/expiryDateTime" "/products/zSide/patchPanel/location/ibx" Search results sorting parameter.

required

Array of objects (Loa)

Data set containing Digital LOA documents.

Array

token	string User-friendly Digital LOA document identifier.
uuid	string <uuid> Digital LOA document identifier.
state	string (State) Enum: "READY_FOR_USE" "LOCKED" "USED" "CANCELLED" "EXPIRED" "PENDING_REQUESTOR_ACCEPTANCE" "PENDING_PROVIDER_AUTHORIZATION" Digital LOA document status.
	Array of objects (Product) non-empty Specification of services that the given LOA document is valid for.
	object (Party) Party interface for Customer Organization
	object (Party) Party interface for Customer Organization
	object (ChangeLog) Change interface
	Array of objects (Links) >= 0 items HATEOAS links specifying possible follow-up interactions.
notes	string Additional information to be considered.
expiryDateTime	string <date-time> Digital LOA document expiration date.
href	string Digital LOA document URI.

Request samples

Payload

Content type

application/json

{"filter": {"and": [{"or": [{"property": "/token",
"operator": "=",
"values": ["RE4E-91PA"
]
}
]
}
]
}
}

Response samples

200
400
401
500

Content type

application/json

{"pagination": {"offset": 0,
"limit": 500,
"total": 900,
"next": "/diloa/v1/digitalLoas?offset=10&limit=20",
"previous": "/diloa/v1/digitalLoas?offset=0&limit=20"
},
"sort": [{"direction": "ASC",
"property": "/expiryDateTime"
}
],
"data": [{"token": "REDF-4R56",
"uuid": "079dc798-05e8-11ed-b939-0242ac120002",
"state": "USED",
"products": [{"uuid": "535caeaf-bba4-46e0-99bc-bf39c72b275f",
"type": "CROSS_CONNECT",
"crossConnect": {"connectionService": "MULTI_MODE_FIBER",
"mediaType": "50_MICRON_MULTI_MODE_FIBER_OM3",
"protocolType": "100_GIG_ETHERNET",
"aSide": {"circuitId": "34234535",
"connectorType": "ST",
"patchPanel": {"id": "CP:0218:0102:13008148",
"cabinetSpaceId": "TY1:04:000050:1613-S14",
"cageSpaceId": "TY1:04:000050",
"location": {"ibx": "TY1",
"region": "EMEA",
"metroName": "Amsterdam",
"metroCode": "AM",
"countryCode": "NL",
"address": "8 Buckingham Avenue, Slough Trading Estate, SL1 4AX Slough, England"
}
},
"portA": 12,
"portB": 13
},
"zSide": {"circuitId": "34234535",
"connectorType": "ST",
"patchPanel": {"id": "CP:0218:0102:13008148",
"cabinetSpaceId": "TY1:04:000050:1613-S14",
"cageSpaceId": "TY1:04:000050",
"location": {"ibx": "TY1",
"region": "EMEA",
"metroName": "Amsterdam",
"metroCode": "AM",
"countryCode": "NL",
"address": "8 Buckingham Avenue, Slough Trading Estate, SL1 4AX Slough, England"
}
},
"portA": 12,
"portB": 13
}
}
}
],
"requestor": {"type": "CUSTOMER_ORGANIZATION"
},
"provider": {"type": "CUSTOMER_ORGANIZATION"
},
"changeLog": {"createdDateTime": "2022-11-17T22:59:59.999Z"
},
"links": [{"rel": "info",
"href": "diloa/v1/digitalLoas/{resource-path}",
"method": "GET",
"contentType": "application/json",
"authenticate": true
}
],
"notes": "Please contact me",
"expiryDateTime": "2022-11-17T22:59:59.999Z",
"href": "diloa/v1/digitalLoas/402cbf99-97d7-440f-8291-1a4b9639154a"
}
]
}

LoaRequests

Loa Requests

Create Digital LOA Request

Creates a Digital LOA request.

Authorizations:

BearerAuth

Request Body schema: application/json
required

ibx

required

string

IBX data center identifier.

requestedNumber

required

integer

Number of requested connections.

required

object (PartyContacts)

Party contacts

required

Array of objects (Contact) non-empty

Organization contact information.

Array (non-empty)

type required	string Enum: "NOTIFICATION" "TECHNICAL" "ORDERING" "RESELLING" "BILLING" Notification messages category relevant to a given contact person.
registeredUser	string Registered user identified by contactId, userId, or userKey. If a registered user is specified, you don't have to provide first name and last name information.
firstName	string Contact person's first name. Required if registeredUser isn't provided.
lastName	string Contact person's last name. Required if registeredUser isn't provided.
timezone	string Contact Timezone
availability	string Enum: "WORK_HOURS" "ANYTIME" Contact person's availability.
required	Array of objects (ContactDetails) non-empty Means of contact.

required

object (Party)

Party interface for Customer Organization

type required	string Party type NEW_RELATIONSHIP
email required	string <email> Organization representative email address.
name required	string Organization name.

notes

string

Additional information to be considered.

Responses

Request samples

Payload

Content type

application/json

{"ibx": "CH1",
"requestedNumber": 2,
"requestor": {"contacts": [{"type": "NOTIFICATION",
"registeredUser": "Registered",
"firstName": "John",
"lastName": "Smith",
"timezone": "Australia/Perth",
"availability": "ANYTIME",
"details": [{"notes": "Do not call me after 6 P.M. CEST",
"value": "kyle@mail.com",
"type": "EMAIL"
}
]
}
]
},
"provider": {"type": "CUSTOMER_ORGANIZATION"
},
"notes": "Please contact me"
}

Response samples

400
401
500

Content type

application/json

[{"errorCode": "EQ-7200030",
"errorMessage": "Not found",
"details": "Error details",
"correlationId": "Correlation ID to trace the error back",
"help": "URL to a help page for the corresponding errorCode",
"additionalInfo": [{"reason": "missing id",
"property": "id"
}
]
}
]

LoaChanges

Loa Changes

Get specified Digital LOA changes

Returns a set of Digital LOA changes.

Authorizations:

BearerAuth

path Parameters

uuid

required

string

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

Digital LOA unique identifier.

Responses

Response Schema: application/json

Array

createdDateTime

string <date-time>

Date and time of Digital LOA change creation.

updatedDateTime

string <date-time>

Date and time of Digital LOA change update.

data

string

Changes to Digital LOA according to JSON representation.

description

string

Additional Digital LOA change information.

href

string

Digital LOA document URI.

Array of objects (Links) >= 0 items

HATEOAS links specifying possible follow-up interactions.

Array (>= 0 items)

rel required	string Enum: "self" "info" "update" "delete" "statistics" "events" Attribute describing the relationship ('rel') of the linked resource to its associated document.
href required	string An absolute URL that is the subject of the link's context, such as a link to a service profile or set of statistics.
method	string Enum: "POST" "GET" "PUT" "DELETE" "PATCH" HTTP method used in the API call to request the specified resource.
contentType	string MIME type indicating the document format. Syntax complies with IETF RFC 6838.
authenticate	boolean Flag showing whether authentication is required to access the linked resource. The default value is false.

type

string

Enum: "LOA_CREATION" "LOA_AUTHORIZATION" "LOA_CANCELLATION" "LOA_PATCHING" "LOA_LOCK_ACQUISITION" "LOA_LOCK_RELEASE" "LOA_USAGE" "LOA_ACCEPTANCE" "LOA_UNAUTHORIZATION" "LOA_EXPIRATION" "TYPE_UNKNOWN"

Digital LOA change type.

uuid

string <uuid>

Digital LOA change unique identifier.

status

string

Enum: "REQUESTED" "COMPLETED" "FAILED"

Digital LOA change status.

object (ChangeResult)

Change result

object (LoaResult)

Digital LOA change result

state

string (State)

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

Digital LOA document status.

Response samples

200
401
404
500

Content type

application/json

[{"createdDateTime": "2021-11-17T22:59:59.999Z",
"updatedDateTime": "2021-11-17T22:59:59.999Z",
"data": "{\"type\": \"ACCEPT\"}",
"description": "Create Loa",
"href": "diloa/v1/digitalLoas/402cbf99-97d7-440f-8291-1a4b9639154a",
"links": [{"rel": "info",
"href": "diloa/v1/digitalLoas/{resource-path}",
"method": "GET",
"contentType": "application/json",
"authenticate": true
}
],
"type": "LOA_CREATION",
"uuid": "4c7d67e2-bbf2-4407-bcff-05a385ed0d4e",
"status": "COMPLETED",
"result": {"loa": {"state": "USED"
}
}
}
]

Get specified Digital LOA change

Returns details of a specified Digital LOA change.

Authorizations:

BearerAuth

path Parameters

uuid required	string Example: 079dc798-05e8-11ed-b939-0242ac120002 Digital LOA unique identifier.
changeUuid required	string Example: 4c7d67e2-bbf2-4407-bcff-05a385ed0d4e Digital LOA change unique identifier.

Responses

Response Schema: application/json

createdDateTime

string <date-time>

Date and time of Digital LOA change creation.

updatedDateTime

string <date-time>

Date and time of Digital LOA change update.

data

string

Changes to Digital LOA according to JSON representation.

description

string

Additional Digital LOA change information.

href

string

Digital LOA document URI.

Array of objects (Links) >= 0 items

HATEOAS links specifying possible follow-up interactions.

Array (>= 0 items)

rel required	string Enum: "self" "info" "update" "delete" "statistics" "events" Attribute describing the relationship ('rel') of the linked resource to its associated document.
href required	string An absolute URL that is the subject of the link's context, such as a link to a service profile or set of statistics.
method	string Enum: "POST" "GET" "PUT" "DELETE" "PATCH" HTTP method used in the API call to request the specified resource.
contentType	string MIME type indicating the document format. Syntax complies with IETF RFC 6838.
authenticate	boolean Flag showing whether authentication is required to access the linked resource. The default value is false.

type

string

Enum: "LOA_CREATION" "LOA_AUTHORIZATION" "LOA_CANCELLATION" "LOA_PATCHING" "LOA_LOCK_ACQUISITION" "LOA_LOCK_RELEASE" "LOA_USAGE" "LOA_ACCEPTANCE" "LOA_UNAUTHORIZATION" "LOA_EXPIRATION" "TYPE_UNKNOWN"

Digital LOA change type.

uuid

string <uuid>

Digital LOA change unique identifier.

status

string

Enum: "REQUESTED" "COMPLETED" "FAILED"

Digital LOA change status.

object (ChangeResult)

Change result

object (LoaResult)

Digital LOA change result

state

string (State)

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

Digital LOA document status.

Response samples

200
401
404
500

Content type

application/json

{"createdDateTime": "2021-11-17T22:59:59.999Z",
"updatedDateTime": "2021-11-17T22:59:59.999Z",
"data": "{\"type\": \"ACCEPT\"}",
"description": "Create Loa",
"href": "diloa/v1/digitalLoas/402cbf99-97d7-440f-8291-1a4b9639154a",
"links": [{"rel": "info",
"href": "diloa/v1/digitalLoas/{resource-path}",
"method": "GET",
"contentType": "application/json",
"authenticate": true
}
],
"type": "LOA_CREATION",
"uuid": "4c7d67e2-bbf2-4407-bcff-05a385ed0d4e",
"status": "COMPLETED",
"result": {"loa": {"state": "USED"
}
}
}

Private Beta Access

Check private beta permission

Checks if the user is authorized to use Digital LOA Manager private beta.

Authorizations:

BearerAuth

Responses

Response Schema: application/json

privateBetaTests

boolean

Defines if the user is allowed to use application in the private beta phase.

Response samples

200
401
500

Content type

application/json

{"privateBetaTests": true
}

Create private beta access request

Creates a request for an access to private beta Digital LOA Manager.

Authorizations:

BearerAuth

Request Body schema: application/json
required

email required	string <email> Email of the user submitting a request.
companyName required	string Name of the company of user submitting a request.

Responses

Request samples

Payload

Content type

application/json

{"email": "kyle@mail.com",
"companyName": "XYZ Inc."
}

Response samples

400
401
500

Content type

application/json

[{"errorCode": "EQ-7200030",
"errorMessage": "Not found",
"details": "Error details",
"correlationId": "Correlation ID to trace the error back",
"help": "URL to a help page for the corresponding errorCode",
"additionalInfo": [{"reason": "missing id",
"property": "id"
}
]
}
]

User Profile

Get beta terms agreement

Returns information whether the user has accepted beta terms agreement.

Authorizations:

BearerAuth

Responses

Response Schema: application/json

agreementAccepted

boolean

User-accepted beta terms.

Response samples

200
401
500

Content type

application/json

{"agreementAccepted": true
}

Update beta terms agreement

Updates beta terms agreement for current user.

Authorizations:

BearerAuth

Request Body schema: application/json

agreementAccepted

boolean

User-accepted beta terms.

Responses

Response Schema: application/json

agreementAccepted

boolean

User-accepted beta terms.

Request samples

Payload

Content type

application/json

{"agreementAccepted": true
}

Response samples

200
400
401
500

Content type

application/json

{"agreementAccepted": true
}

Marketplace Organizations

Marketplace organizations selection

Search organizations available in a given IBX data center.

Authorizations:

BearerAuth

query Parameters

location.ibx required	string Example: location.ibx=AM11 IBX data center identifier.
product.type	Array of strings Default: "CROSS_CONNECT" Items Value: "CROSS_CONNECT" Example: product.type=CROSS_CONNECT Product types.

Responses

Response Schema: application/json

Array

orgIds	Array of strings Organization identifiers.
name	string Organization name

Response samples

200
400
401
500

Content type

application/json

[{"orgIds": ["7436"
],
"name": "XYZ Inc."
}
]

Digital LOA API (1.0.0)

Loa

Create Digital LOA document

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Perform action on Digital LOA document.

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Get specified Digital LOA document.

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

Delete Digital LOA document

Authorizations:

path Parameters

Responses

Response samples

Modify a Digital LOA document

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Retrieve Digital LOA Documents

Authorizations:

query Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

LoaRequests

Create Digital LOA Request

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

LoaChanges

Get specified Digital LOA changes

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

Get specified Digital LOA change

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

Private Beta Access

Check private beta permission

Authorizations:

Responses

Response Schema: application/json

Response samples

Create private beta access request

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

User Profile

Get beta terms agreement

Authorizations:

Responses

Response Schema: application/json

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required