Skip to main content
API docs by Redocly

Attachments as a Service API (1.0.0)

Download OpenAPI specification:Download

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

Attachment Management API for Equinix Customer Portal

Attachments

Upload a Multipart File

This method can be used to upload an attachment as a multipart file.

query Parameters
purpose
string
Enum: "LOA" "PO_DOCUMENT"

Purpose of the file is uploaded. [ ex. LOA is for Cross connect, PO is for Purchar order ]

header Parameters
Authorization
required
string >= 1

Specify the Access token with prefix 'Bearer '.

Request Body schema: multipart/form-data
required
uploadFile
required
string <binary>

The file to be uploaded

Responses

Response Schema: application/json
attachmentId
required
string <uuid>

Unique Identifier for the attachment

attachmentName
required
string

File name of the attachment

attachmentType
required
string

Extension of the document

attachmentSize
required
number [ 0 .. 1000000000 )
Default: 0

size of the attachment in bytes

createdDate
required
string <date-time>

Created date

createdBy
required
string

User key of the author of the attachment

lastUpdatedDate
required
string <date-time>

Last accessed date for the record

Response samples

Content type
application/json
{
  • "attachmentId": "56d10de6-f2c0-4edd-ba29-b70736aa2093",
  • "attachmentName": "Example_Invoice.xlsx",
  • "attachmentType": "xlsx",
  • "attachmentSize": 259387,
  • "createdDate": "2017-01-31T09:03:08.340Z",
  • "createdBy": "john.doe@example.com",
  • "lastUpdatedDate": "2017-04-06T17:10:44.807Z"
}

Delete Attachment by Id

This method deletes the attachment with a specific id value.

path Parameters
attachmentId
required
string <uuid>

The id of the attachment.

header Parameters
Authorization
required
string >= 1

Specify the Access token with prefix 'Bearer '.

Responses

Response Schema: application/json
status
required
boolean
Default: false

Status message

Response samples

Content type
application/json
{
  • "status": true
}

Get Attachment by Id

This method gets the metadata for the attachment file with a specific. attachment id value.

path Parameters
attachmentId
required
string <uuid>

The id of the attachment.

header Parameters
Authorization
required
string >= 1

Specify the Access token with prefix 'Bearer '.

Responses

Response Schema: application/json
attachmentId
required
string <uuid>

Unique Identifier for the attachment

attachmentName
required
string

File name of the attachment

attachmentType
required
string

Extension of the document

attachmentSize
required
number [ 0 .. 1000000000 )
Default: 0

size of the attachment in bytes

createdDate
required
string <date-time>

Created date

createdBy
required
string

User key of the author of the attachment

lastUpdatedDate
required
string <date-time>

Last accessed date for the record

Response samples

Content type
application/json
{
  • "attachmentId": "56d10de6-f2c0-4edd-ba29-b70736aa2093",
  • "attachmentName": "Example_Invoice.pdf",
  • "attachmentType": "application/pdf",
  • "attachmentSize": 259387,
  • "createdDate": "2017-01-31T09:03:08.340Z",
  • "createdBy": "john.doe@example.com",
  • "lastUpdatedDate": "2017-04-06T17:10:44.807Z"
}

Download Attachment File

This method gets the binary file attachment with a specific attachment id value.

path Parameters
attachmentId
required
string <uuid>

The id of the attachment record you want to get binary data from.

header Parameters
Authorization
required
string >= 1

Specify the Access token with prefix 'Bearer '.

Responses

Response samples

Content type
No sample

Get List of Attachments

This method gets the metadata for multiple attachments. The response is paginated and will output limited number of records per page.

query Parameters
offset
integer >= 0
Default: 0

Page number to skip the results

limit
integer [ 0 .. 100 ]
Default: 20

Number of expected records in the response

attachmentIds
Array of strings non-empty unique

Comma separated attachment ids to search

header Parameters
Authorization
required
string >= 1

Specify the Access token with prefix 'Bearer '.

Responses

Response Schema: application/json
required
Array of objects (Attachment) >= 0 items

List of records

Array (>= 0 items)
attachmentId
required
string <uuid>

Unique Identifier for the attachment

attachmentName
required
string

File name of the attachment

attachmentType
required
string

Extension of the document

attachmentSize
required
number [ 0 .. 1000000000 )
Default: 0

size of the attachment in bytes

createdDate
required
string <date-time>

Created date

createdBy
required
string

User key of the author of the attachment

lastUpdatedDate
required
string <date-time>

Last accessed date for the record

object (Page)
total
required
number >= 0
Default: 0

Total number of records

limit
required
integer >= 0
Default: 0

Number of records per page

offset
required
integer >= 0
Default: 0

The page number

sorts
Array of strings

Sorted by latest created attachments

required
object (Links)
required
object (ReferenceLink)
href
required
string non-empty

href of the link

object (ReferenceLink)
href
required
string non-empty

href of the link

required
object (ReferenceLink)
href
required
string non-empty

href of the link

object (ReferenceLink)
href
required
string non-empty

href of the link

object (ReferenceLink)
href
required
string non-empty

href of the link

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "page": {
    },
  • "_links": {
    }
}