Attachments as a Service API | Equinix Product Documentation

Get List of Attachments

Request

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

Query

offsetinteger, >= 0

Page number to skip the results

Default:0

limitinteger, [ 0 .. 100 ]

Number of expected records in the response

Default:20

attachmentIdsArray of strings, non-empty, unique

Comma separated attachment ids to search

Authorizationstring, >= 1required

Specify the Access token with prefix 'Bearer '.

Payload

// No request payload

Responses

Bodyapplication/json

dataArray of objects, >= 0 items(Attachment)required

List of records

Example:

[
  {
    "attachmentId": "56d10de6-f2c0-4edd-ba29-b70736aa2094",
    "attachmentName": "Example_Invoice_1.xlsx",
    "attachmentType": "xlsx",
    "attachmentSize": 259388,
    "createdDate": "2017-01-31T09:03:08.340Z",
    "createdBy": "john.doe@example.com",
    "lastUpdatedDate": "2017-04-06T17:10:44.807Z"
  },
  {
    "attachmentId": "56d10de6-f2c0-4edd-ba29-b70736aa2093",
    "attachmentName": "Example_Invoice_2.xlsx",
    "attachmentType": "xlsx",
    "attachmentSize": 259387,
    "createdDate": "2017-01-31T09:03:08.340Z",
    "createdBy": "john.doe@example.com",
    "lastUpdatedDate": "2017-04-06T17:10:44.807Z"
  }
]

pageobject(Page)

Example:

{
  "total": 100,
  "limit": 20,
  "offset": 0,
  "sorts": [
    "-createdDate"
  ]
}

_linksobject(Links)required

Example:

{
  "first": {
    "href": "/attachments?limit=10&offset=0"
  },
  "next": {
    "href": "/attachments?limit=10&offset=50"
  },
  "self": {
    "href": "/attachments?limit=10&offset=40"
  },
  "prev": {
    "href": "/attachments?limit=10&offset=30"
  },
  "last": {
    "href": "/attachments?limit=10&offset=100"
  }
}

Response

{
  "data": [
    { … },
    { … }
  ],
  "page": {
    "total": 100,
    "limit": 10,
    "offset": 0,
    "sorts": [ … ]
  },
  "_links": {
    "first": { … },
    "next": { … },
    "self": { … },
    "prev": { … },
    "last": { … }
  }
}

Get List of Attachments

Request

Query

Headers

Responses