Reports Service API (1.0.0)

Download OpenAPI specification:Download

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

The Reports APIs provide services to trigger and access various reports types available on Equinix Customer Portal. These report types can be triggered and accessed by a user depending on their permissions. The reports can be scheduled to be generated on a recurring basis, or they can be generated on an ad hoc basis.

Report Center

Schedule New Report

Use this API to schedule a report to be generated on a recurring or ad hoc basis.

header Parameters

Authorization

required

string >= 1

Specify the Access token with prefix 'Bearer '.

Request Body schema: application/json

name

required

string non-empty

Report Name

required

Array of objects (Parameter) >= 0 items

List of input parameters

Array (>= 0 items)

name required	string Parameter name
value required	string non-empty Parameter value
type	string Enum: "ARRAY" "STRING" "LONG" "INT" "BOOLEAN" "DOUBLE" "JSON" "JSON_ARRAY" Parameter type
required	boolean Flag to indicate the parameter is required or optional

scheduleType

required

string (ScheduleType)

Enum: "ONE_TIME" "DAILY" "WEEKLY" "MONTHLY" "QUARTERLY" "ANNUALLY"

Scheduling strategy for the report to be generated.

period

required

string (Period)

Enum: "1_DAY" "7_DAYS" "14_DAYS" "30_DAYS" "90_DAYS" "180_DAYS" "1_YEAR" "CUSTOM" "NONE"

Date range which the report should be generated

control

string

Enum: "ALLOW" "DENY"

Indicates whether user is entitled to use this report type.

categories

Array of strings unique

Items Enum: "SECURITY" "SITE_AND_ENVIRONMENT" "ASSET" "POWER" "FINANCE"

The list of categories this definition belongs to

Responses

Response Schema: application/json

scheduledId

required

string <uuid>

A unique UUID string denoting the id of the scheduled entry

reportName

required

string non-empty

Name of the report

scheduleType

required

string (ScheduleType)

Enum: "ONE_TIME" "DAILY" "WEEKLY" "MONTHLY" "QUARTERLY" "ANNUALLY"

Scheduling strategy for the report to be generated.

period

string (Period)

Enum: "1_DAY" "7_DAYS" "14_DAYS" "30_DAYS" "90_DAYS" "180_DAYS" "1_YEAR" "CUSTOM" "NONE"

Date range which the report should be generated

createdBy

required

string

Person/Entity who created this entry first time

createdDate

required

string <date-time>

Time when this entry was first created

lastAttemptedDate

required

string <date-time>

Last attempted date to trigger the report generation

customerOrganizationId

required

integer >= 0

Customer Organization Id

forOrg

integer >= 1

Customer Org Id where report is generated on behalf of

forUser

string

User key where report is generated on behalf of

lastModifiedBy

string

Person/Entity who modified this entry last time

lastModifiedDate

string <date-time>

Last modified date of this entry

numberOfFailedAttempts

integer [ 0 .. 3 ]

Number of times the generation of report were failed

status

required

string (ScheduleStatus)

Enum: "ACTIVE" "INACTIVE" "SUSPENDED"

Scheduling Status

required

Array of objects (Parameter) >= 0 items

Parameters for the reports to be generated

Array (>= 0 items)

name required	string Parameter name
value required	string non-empty Parameter value
type	string Enum: "ARRAY" "STRING" "LONG" "INT" "BOOLEAN" "DOUBLE" "JSON" "JSON_ARRAY" Parameter type
required	boolean Flag to indicate the parameter is required or optional

required

Array of objects (Report)

Array of generated reports

Array

reportId required	string <uuid> A unique UUID string denoting the id of the report entry
scheduledId required	string <uuid> Scheduled Id for the report entry
createdBy required	string Person/Entity who created this entry first time
createdDate required	string <date-time> Time when this entry was first created
lastAccessedBy	string Person/Entity who accessed this entry last time
lastAccessedDate	string <date-time> Time when this entry was last accessed
startTime required	string <date-time> Processing start time of the report
endTime	string <date-time> Processing end time of the report
status required	string (ReportStatus) Enum: "IN_PROGRESS" "DELAYED" "SUCCESS" "ERROR" "INACTIVE" Status of the report
errorMessage	string Contains an error message if something is failed.
location	string Location of the report once it is generated
numberOfDownloads	integer >= 0 Default: 0 Number of times this report is downloaded by the customer
numberOfAttempts required	integer [ 0 .. 3 ] Number of times attempted to generate the report
required	Array of objects (Parameter) >= 0 items Parameters for the reports to be generated
publisherInfo	object Contains report publish data as a json

Request samples

Payload

Content type

application/json

{"name": "eu exercitation",
"parameters": [{"name": "id sunt",
"value": "tempor consequat minim",
"type": "INT"
},
{"name": "eu consequat minim commodo",
"value": "Duis ex laboris",
"type": "LONG"
},
{"name": "nostrud nulla in minim",
"value": "est laborum magna ea",
"type": "STRING"
},
{"name": "ut ullamco pariatur ex",
"value": "laboris Duis commodo culpa",
"type": "LONG"
}
],
"scheduleType": "MONTHLY",
"period": "30_DAYS"
}

Response samples

Content type

application/json

{"scheduledId": "fec45434-dd6a-4fe9-8fd4-06f219e5dff6",
"reportName": "eiusmod qui nisi",
"scheduleType": "QUARTERLY",
"period": "14_DAYS",
"createdBy": "reprehenderit",
"createdDate": "4804-01-02T06:54:41.561Z",
"lastAttemptedDate": "4533-03-23T21:44:07.660Z",
"customerOrganizationId": 75750444,
"forOrg": 36659,
"forUser": 59730,
"lastModifiedBy": "john.doe",
"lastModifiedDate": "2017-07-02T21:59:15.045Z",
"numberOfFailedAttempts": 1,
"status": "ACTIVE",
"parameters": [{"name": "ipsum sed et dolor non",
"value": "laborum reprehenderit",
"type": "DOUBLE"
},
{"name": "et sit Ut aute",
"value": "eu",
"type": "BOOLEAN"
},
{"name": "cillum",
"value": "Ut consequat",
"type": "DOUBLE"
}
],
"reports": [{"reportId": "95f08f5b-ee7d-473a-975f-0e9a49f03ab0",
"scheduledId": "741ebc4b-07b8-4aca-bbd1-f65c79c962da",
"createdBy": "proid",
"createdDate": "3614-05-18T07:13:42.624Z",
"startTime": "4827-05-13T00:28:17.727Z",
"status": "ERROR",
"numberOfAttempts": 2,
"parameters": [{"name": "id laborum reprehenderit cillum irur",
"value": "consequat",
"type": "LONG"
},
{"name": "ullamco aute",
"value": "nulla aute consectetur est ea",
"type": "STRING"
}
],
"lastAccessedDate": "4302-06-01T23:03:58.540Z"
}
]
}

Get your Scheduled Reports

Use this method to get a list of reports that the authenticated user has scheduled to be generated on a recurring basis.

query Parameters

offset	integer >= 0 Default: 0 Use offset and limit to restrict the number of users in the output. Offset can be used to specify the start record
limit	integer [ 0 .. 100 ] Default: 10 Use offset and limit to restrict the number of users in the output. Limit can be used to restrict the number of reports in the response
sorts	Array of strings unique Default: "-CREATED_DATE" Items Enum: "REPORT_NAME" "-REPORT_NAME" "CREATED_DATE" "-CREATED_DATE" Use sort to get the reports in the response sorted in the particular order. for example, use '-GENERATED_DATE to sort the reports by generated date in descending order. And ‘GENERATED_DATE’ for ascending order. For descending order, the field name should be prefixed with '-'

header Parameters

Authorization

required

string >= 1

Specify the Access token with prefix 'Bearer '.

Responses

Response Schema: application/json

required

Array of objects (ScheduledReport) >= 0 items

List of records

Array (>= 0 items)

scheduledId required	string <uuid> A unique UUID string denoting the id of the scheduled entry
reportName required	string non-empty Name of the report
scheduleType required	string (ScheduleType) Enum: "ONE_TIME" "DAILY" "WEEKLY" "MONTHLY" "QUARTERLY" "ANNUALLY" Scheduling strategy for the report to be generated.
period	string (Period) Enum: "1_DAY" "7_DAYS" "14_DAYS" "30_DAYS" "90_DAYS" "180_DAYS" "1_YEAR" "CUSTOM" "NONE" Date range which the report should be generated
createdBy required	string Person/Entity who created this entry first time
createdDate required	string <date-time> Time when this entry was first created
lastAttemptedDate required	string <date-time> Last attempted date to trigger the report generation
customerOrganizationId required	integer >= 0 Customer Organization Id
forOrg	integer >= 1 Customer Org Id where report is generated on behalf of
forUser	string User key where report is generated on behalf of
lastModifiedBy	string Person/Entity who modified this entry last time
lastModifiedDate	string <date-time> Last modified date of this entry
numberOfFailedAttempts	integer [ 0 .. 3 ] Number of times the generation of report were failed
status required	string (ScheduleStatus) Enum: "ACTIVE" "INACTIVE" "SUSPENDED" Scheduling Status
required	Array of objects (Parameter) >= 0 items Parameters for the reports to be generated
required	Array of objects (Report) Array of generated reports

object (Page)

total required	integer >= 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 Sort fields based on polarity

required

object (Links)

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

Response samples

Content type

application/json

{"data": [{"scheduledId": "fb85e943-39da-4d62-afcf-46ed1077ce60",
"reportName": "voluptate",
"scheduleType": "DAILY",
"createdBy": "cupidatat dolore adipisicing quis",
"createdDate": "3269-06-06T22:03:28.837Z",
"lastAttemptedDate": "3699-07-10T06:45:56.312Z",
"customerOrganizationId": 48422050,
"status": "INACTIVE",
"parameters": [ ],
"reports": [ ],
"period": "1_DAY",
"forOrg": 43909627,
"forUser": 12354,
"lastModifiedBy": "john.doe",
"lastModifiedDate": "2017-07-02T21:59:15.045Z",
"numberOfFailedAttempts": 2
},
{"scheduledId": "37f5fa8f-5fe8-40b3-91db-627bc053432c",
"reportName": "eiusmod ullamco ipsum pariatur laborum",
"scheduleType": "QUARTERLY",
"createdBy": "occaecat dolor consectetur",
"createdDate": "3109-05-27T03:32:30.773Z",
"lastAttemptedDate": "3115-06-07T03:13:50.038Z",
"customerOrganizationId": 77997941,
"forOrg": 43909627,
"forUser": 12354,
"lastModifiedBy": "john.doe",
"lastModifiedDate": "2017-07-02T21:59:15.045Z",
"numberOfFailedAttempts": 3,
"status": "INACTIVE",
"parameters": [{"name": "ex cu",
"value": "mollit dolor laboris sint",
"type": "ARRAY"
},
{"name": "sed",
"value": "pariatur anim dolor cupidatat consectetur",
"type": "INT"
},
{"name": "ipsum",
"value": "minim Excepteur tempor ulla",
"type": "INT"
},
{"name": "Ut laborum",
"value": "esse commodo adipisicing sed",
"type": "INT"
},
{"name": "anim Duis elit nisi irure",
"value": "cillum",
"type": "ARRAY"
}
],
"reports": [ ],
"period": "7_DAYS"
},
{"scheduledId": "ca32d0c1-4eee-4dd6-8d29-1401d91ce2af",
"reportName": "fugiat magna cupidatat",
"scheduleType": "DAILY",
"createdBy": "esse tempor sunt mollit aute",
"createdDate": "4740-12-25T16:47:30.142Z",
"lastAttemptedDate": "2223-10-26T12:30:20.003Z",
"customerOrganizationId": 25319222,
"forUser": 12354,
"lastModifiedBy": "john.doe",
"lastModifiedDate": "2017-07-02T21:59:15.045Z",
"numberOfFailedAttempts": 2,
"status": "ACTIVE",
"parameters": [{"name": "eiusmod exercitation in",
"value": "fugiat e",
"type": "BOOLEAN",
"required": true
},
{"name": "id irure L",
"value": "sed",
"type": "ARRAY"
},
{"name": "eiusmod non proident",
"value": "enim",
"type": "LONG"
},
{"name": "exercitation sint sunt",
"value": "veniam",
"type": "STRING"
}
],
"reports": [ ],
"forOrg": 37814662
},
{"scheduledId": "384ebadf-6cac-4258-9432-254d97a43edc",
"reportName": "culpa qui enim quis ipsum",
"scheduleType": "DAILY",
"createdBy": "sint",
"createdDate": "2054-06-06T17:58:19.383Z",
"lastAttemptedDate": "2777-08-05T04:43:04.000Z",
"customerOrganizationId": 3386629,
"forOrg": 43909627,
"forUser": 12354,
"lastModifiedBy": "john.doe",
"lastModifiedDate": "2017-07-02T21:59:15.045Z",
"numberOfFailedAttempts": 0,
"status": "ACTIVE",
"parameters": [{"name": "sint",
"value": "amet",
"type": "ARRAY"
},
{"name": "incididunt aute tempor ",
"value": "anim ullamco",
"type": "ARRAY",
"required": true
}
],
"reports": [ ]
}
],
"page": {"total": 4,
"limit": 5,
"offset": 0,
"sorts": ["sint sit dolor",
"ut est laborum",
"magna voluptate",
"velit nulla sed in voluptate"
]
},
"_links": {"self": {"href": "esse aute"
},
"next": {"href": "Duis dolor"
},
"prev": {"href": "labore velit"
}
}
}

Delete your scheduled reports

Use this API to delete specific recurring reports of an authenticated user by the recurring reports' scheduled IDs.

query Parameters

scheduledIds

required

Array of strings [ 1 .. 20 ] items unique

Comma separated scheduled ids to be deleted.

header Parameters

Authorization

required

string >= 1

Specify the Access token with prefix 'Bearer '.

Responses

Response Schema: application/json

status

required

boolean

Default: true

staus of the operation

Response samples

Content type

application/json

{"status": true
}

Download list of generated reports

Use this method to download a list of generated reports triggered by the authenticated user.

query Parameters

reportIds

required

Array of strings [ 1 .. 20 ] items unique

Comma separated report ids to be deleted.

header Parameters

Authorization

required

string >= 1

Specify the Access token with prefix 'Bearer '.

Responses

Response Schema:
application/octet-stream

string <binary>

Response samples

Content type

application/octet-stream

No sample

Get details of scheduled report

Use this API to get the report details of a specific recurring scheduled report requested by the authenticated user.

path Parameters

scheduledId

required

string <uuid>

Scheduled Id for the report entry

header Parameters

Authorization

required

string >= 1

Specify the Access token with prefix 'Bearer '.

Responses

Response Schema: application/json

scheduledId

required

string <uuid>

A unique UUID string denoting the id of the scheduled entry

reportName

required

string non-empty

Name of the report

scheduleType

required

string (ScheduleType)

Enum: "ONE_TIME" "DAILY" "WEEKLY" "MONTHLY" "QUARTERLY" "ANNUALLY"

Scheduling strategy for the report to be generated.

period

string (Period)

Enum: "1_DAY" "7_DAYS" "14_DAYS" "30_DAYS" "90_DAYS" "180_DAYS" "1_YEAR" "CUSTOM" "NONE"

Date range which the report should be generated

createdBy

required

string

Person/Entity who created this entry first time

createdDate

required

string <date-time>

Time when this entry was first created

lastAttemptedDate

required

string <date-time>

Last attempted date to trigger the report generation

customerOrganizationId

required

integer >= 0

Customer Organization Id

forOrg

integer >= 1

Customer Org Id where report is generated on behalf of

forUser

string

User key where report is generated on behalf of

lastModifiedBy

string

Person/Entity who modified this entry last time

lastModifiedDate

string <date-time>

Last modified date of this entry

numberOfFailedAttempts

integer [ 0 .. 3 ]

Number of times the generation of report were failed

status

required

string (ScheduleStatus)

Enum: "ACTIVE" "INACTIVE" "SUSPENDED"

Scheduling Status

required

Array of objects (Parameter) >= 0 items

Parameters for the reports to be generated

Array (>= 0 items)

name required	string Parameter name
value required	string non-empty Parameter value
type	string Enum: "ARRAY" "STRING" "LONG" "INT" "BOOLEAN" "DOUBLE" "JSON" "JSON_ARRAY" Parameter type
required	boolean Flag to indicate the parameter is required or optional

required

Array of objects (Report)

Array of generated reports

Array

reportId required	string <uuid> A unique UUID string denoting the id of the report entry
scheduledId required	string <uuid> Scheduled Id for the report entry
createdBy required	string Person/Entity who created this entry first time
createdDate required	string <date-time> Time when this entry was first created
lastAccessedBy	string Person/Entity who accessed this entry last time
lastAccessedDate	string <date-time> Time when this entry was last accessed
startTime required	string <date-time> Processing start time of the report
endTime	string <date-time> Processing end time of the report
status required	string (ReportStatus) Enum: "IN_PROGRESS" "DELAYED" "SUCCESS" "ERROR" "INACTIVE" Status of the report
errorMessage	string Contains an error message if something is failed.
location	string Location of the report once it is generated
numberOfDownloads	integer >= 0 Default: 0 Number of times this report is downloaded by the customer
numberOfAttempts required	integer [ 0 .. 3 ] Number of times attempted to generate the report
required	Array of objects (Parameter) >= 0 items Parameters for the reports to be generated
publisherInfo	object Contains report publish data as a json

Response samples

Content type

application/json

{"scheduledId": "7a48fc3e-5263-4d75-a6ea-a1c576318ec5",
"reportName": "nisi",
"scheduleType": "MONTHLY",
"period": "7_DAYS",
"createdBy": "ut ullamco in qui",
"createdDate": "3549-12-27T03:27:05.019Z",
"lastAttemptedDate": "3732-11-15T13:24:17.660Z",
"customerOrganizationId": 86501527,
"forOrg": 80446188,
"forUser": 12354,
"lastModifiedBy": "john.doe",
"lastModifiedDate": "2017-07-02T21:59:15.045Z",
"numberOfFailedAttempts": 3,
"status": "INACTIVE",
"parameters": [{"name": "ex cillum culpa et",
"value": "enim in",
"type": "INT"
},
{"name": "proident exercitation sed do Lorem",
"value": "incididunt cupidatat commodo ip",
"type": "LONG"
},
{"name": "Excepteur Lorem qui esse nulla",
"value": "ad ",
"type": "STRING"
},
{"name": "Ut dolor id in",
"value": "eiusmod consequat velit",
"type": "STRING"
},
{"name": "minim ut",
"value": "quis",
"type": "LONG"
}
],
"reports": [{"reportId": "53b2e8e0-6eb0-45c5-bb75-2c684ef176ca",
"scheduledId": "6a996098-29d4-462b-abb8-9fc546bdf48d",
"createdBy": "Ut minim",
"createdDate": "2229-08-20T08:22:59.562Z",
"startTime": "2047-05-28T10:40:18.068Z",
"status": "INACTIVE",
"numberOfAttempts": 0,
"parameters": [{"name": "dolor",
"value": "non aliqua tempor labore reprehenderit",
"type": "ARRAY"
},
{"name": "sint Ut dolo",
"value": "sint laboris officia",
"type": "STRING"
},
{"name": "magna sit proident voluptate dolore",
"value": "labore exercitation",
"type": "INT"
},
{"name": "dolor",
"value": "nulla commodo esse ea",
"type": "STRING"
}
],
"publisherInfo": { }
},
{"reportId": "54c39784-7232-47db-acd4-00da92619ee9",
"scheduledId": "1c5e15e7-1ea7-49f2-801f-27b33f3efbbf",
"createdBy": "sed occaecat elit voluptate Duis",
"createdDate": "2317-01-16T05:33:22.543Z",
"startTime": "3867-08-22T17:01:49.260Z",
"status": "INACTIVE",
"numberOfAttempts": 0,
"parameters": [{"name": "pariatur laboris dolore in",
"value": "mollit veniam ullamco aliquip i",
"type": "STRING"
}
],
"location": "Excepteur do",
"endTime": "3863-01-02T05:40:11.392Z",
"lastAccessedDate": "2312-09-12T04:10:52.600Z",
"publisherInfo": { }
},
{"reportId": "e46697b7-7db5-4d7d-9a2a-f0ca371f4840",
"scheduledId": "34648279-fa1b-42dc-8edb-65678addd710",
"createdBy": "commodo eu sint laborum",
"createdDate": "2549-04-09T16:14:33.705Z",
"startTime": "4589-10-27T11:35:19.288Z",
"status": "SUCCESS",
"numberOfAttempts": 2,
"parameters": [{"name": "aute occaecat sunt",
"value": "do eu cillum reprehenderit deserunt",
"type": "STRING"
},
{"name": "voluptate",
"value": "aliqua",
"type": "ARRAY"
},
{"name": "q",
"value": "adipisicing nostrud u",
"type": "STRING"
},
{"name": "elit cillum esse pariatur ut",
"value": "qui cons",
"type": "STRING"
}
],
"endTime": "3400-03-13T05:45:48.760Z",
"lastAccessedDate": "4299-07-20T20:00:25.475Z",
"location": "commodo est qui",
"publisherInfo": { }
}
]
}

Modify scheduled report parameters

Use this method to modify the report parameters and values of an existing scheduled report by the authenticated user.

path Parameters

scheduledId

required

string <uuid>

Scheduled Id for the report entry

header Parameters

Authorization

required

string >= 1

Specify the Access token with prefix 'Bearer '.

Request Body schema: application/json

name

required

string non-empty

Report Name

required

Array of objects (Parameter) >= 0 items

List of input parameters

Array (>= 0 items)

name required	string Parameter name
value required	string non-empty Parameter value
type	string Enum: "ARRAY" "STRING" "LONG" "INT" "BOOLEAN" "DOUBLE" "JSON" "JSON_ARRAY" Parameter type
required	boolean Flag to indicate the parameter is required or optional

scheduleType

required

string (ScheduleType)

Enum: "ONE_TIME" "DAILY" "WEEKLY" "MONTHLY" "QUARTERLY" "ANNUALLY"

Scheduling strategy for the report to be generated.

period

required

string (Period)

Enum: "1_DAY" "7_DAYS" "14_DAYS" "30_DAYS" "90_DAYS" "180_DAYS" "1_YEAR" "CUSTOM" "NONE"

Date range which the report should be generated

control

string

Enum: "ALLOW" "DENY"

Indicates whether user is entitled to use this report type.

categories

Array of strings unique

Items Enum: "SECURITY" "SITE_AND_ENVIRONMENT" "ASSET" "POWER" "FINANCE"

The list of categories this definition belongs to

Responses

Response Schema: application/json

scheduledId

required

string <uuid>

A unique UUID string denoting the id of the scheduled entry

reportName

required

string non-empty

Name of the report

scheduleType

required

string (ScheduleType)

Enum: "ONE_TIME" "DAILY" "WEEKLY" "MONTHLY" "QUARTERLY" "ANNUALLY"

Scheduling strategy for the report to be generated.

period

string (Period)

Enum: "1_DAY" "7_DAYS" "14_DAYS" "30_DAYS" "90_DAYS" "180_DAYS" "1_YEAR" "CUSTOM" "NONE"

Date range which the report should be generated

createdBy

required

string

Person/Entity who created this entry first time

createdDate

required

string <date-time>

Time when this entry was first created

lastAttemptedDate

required

string <date-time>

Last attempted date to trigger the report generation

customerOrganizationId

required

integer >= 0

Customer Organization Id

forOrg

integer >= 1

Customer Org Id where report is generated on behalf of

forUser

string

User key where report is generated on behalf of

lastModifiedBy

string

Person/Entity who modified this entry last time

lastModifiedDate

string <date-time>

Last modified date of this entry

numberOfFailedAttempts

integer [ 0 .. 3 ]

Number of times the generation of report were failed

status

required

string (ScheduleStatus)

Enum: "ACTIVE" "INACTIVE" "SUSPENDED"

Scheduling Status

required

Array of objects (Parameter) >= 0 items

Parameters for the reports to be generated

Array (>= 0 items)

name required	string Parameter name
value required	string non-empty Parameter value
type	string Enum: "ARRAY" "STRING" "LONG" "INT" "BOOLEAN" "DOUBLE" "JSON" "JSON_ARRAY" Parameter type
required	boolean Flag to indicate the parameter is required or optional

required

Array of objects (Report)

Array of generated reports

Array

reportId required	string <uuid> A unique UUID string denoting the id of the report entry
scheduledId required	string <uuid> Scheduled Id for the report entry
createdBy required	string Person/Entity who created this entry first time
createdDate required	string <date-time> Time when this entry was first created
lastAccessedBy	string Person/Entity who accessed this entry last time
lastAccessedDate	string <date-time> Time when this entry was last accessed
startTime required	string <date-time> Processing start time of the report
endTime	string <date-time> Processing end time of the report
status required	string (ReportStatus) Enum: "IN_PROGRESS" "DELAYED" "SUCCESS" "ERROR" "INACTIVE" Status of the report
errorMessage	string Contains an error message if something is failed.
location	string Location of the report once it is generated
numberOfDownloads	integer >= 0 Default: 0 Number of times this report is downloaded by the customer
numberOfAttempts required	integer [ 0 .. 3 ] Number of times attempted to generate the report
required	Array of objects (Parameter) >= 0 items Parameters for the reports to be generated
publisherInfo	object Contains report publish data as a json

Request samples

Payload

Content type

application/json

{"name": "eu exercitation",
"parameters": [{"name": "id sunt",
"value": "tempor consequat minim",
"type": "INT"
},
{"name": "eu consequat minim commodo",
"value": "Duis ex laboris",
"type": "LONG"
},
{"name": "nostrud nulla in minim",
"value": "est laborum magna ea",
"type": "STRING"
},
{"name": "ut ullamco pariatur ex",
"value": "laboris Duis commodo culpa",
"type": "LONG"
}
],
"scheduleType": "MONTHLY",
"period": "30_DAYS"
}

Response samples

Content type

application/json

{"scheduledId": "2f5d2739-6761-409c-ac9c-5093b5f130c2",
"reportName": "occaecat tempor proident sint magna",
"scheduleType": "QUARTERLY",
"period": "7_DAYS",
"createdBy": "culpa Lorem",
"createdDate": "2388-03-14T01:42:40.633Z",
"lastAttemptedDate": "1979-10-12T21:39:16.862Z",
"customerOrganizationId": 42799428,
"forOrg": 55997535,
"forUser": 12354,
"lastModifiedBy": "john.doe",
"lastModifiedDate": "2017-07-02T21:59:15.045Z",
"numberOfFailedAttempts": 0,
"status": "ACTIVE",
"parameters": [{"name": "qui veniam irure",
"value": "et",
"type": "BOOLEAN"
}
],
"reports": [{"reportId": "3050cbb7-b49a-4396-a034-258b5cdcb308",
"scheduledId": "1a6772a5-db72-4a7b-94c6-84ea738d398b",
"createdBy": "dolore",
"createdDate": "3550-09-11T03:45:02.961Z",
"startTime": "4018-06-28T02:17:57.901Z",
"status": "INACTIVE",
"numberOfAttempts": 2,
"parameters": [{"name": "minim",
"value": "id cupidatat consectetur",
"type": "DOUBLE"
},
{"name": "pariatur aliqua",
"value": "ut commodo",
"type": "ARRAY"
},
{"name": "pariatur voluptate commodo",
"value": "fugiat sit",
"type": "INT"
},
{"name": "reprehenderit",
"value": "cupidatat aliquip",
"type": "ARRAY"
},
{"name": "eu id officia esse",
"value": "ea consequat ad",
"type": "DOUBLE"
}
],
"location": "anim dolor do eu",
"lastAccessedBy": "occaecat dolor officia in elit",
"lastAccessedDate": "4226-05-03T17:49:05.713Z",
"endTime": "2408-02-04T16:24:12.594Z"
},
{"reportId": "f94c7d84-1072-493f-8c41-3be00a4852fd",
"scheduledId": "d1b1a11b-a6ba-437d-b106-999dfcc307a8",
"createdBy": "amet non",
"createdDate": "4855-08-18T01:00:39.416Z",
"startTime": "4505-05-25T14:28:52.122Z",
"status": "INACTIVE",
"numberOfAttempts": 0,
"parameters": [{"name": "Ut",
"value": "consectetur irure exercitation",
"type": "ARRAY"
},
{"name": "Ut laborum",
"value": "enim",
"type": "STRING"
},
{"name": "est cillum fugiat",
"value": "occaecat nulla sit ut",
"type": "STRING"
}
],
"location": "officia exercitation sed pariatur occaecat",
"numberOfDownloads": 84017338,
"lastAccessedBy": "ullamco adipisicing esse est"
}
]
}

Get all reports definitions

This API returns all the parameter configurations and applicable values for all the report types supported by Equinix.

header Parameters

Authorization

required

string >= 1

Specify the Access token with prefix 'Bearer '.

Responses

Response Schema: application/json

Array

name

required

string non-empty

Report Name

required

Array of objects (Parameter) >= 0 items

List of input parameters

Array (>= 0 items)

name required	string Parameter name
value required	string non-empty Parameter value
type	string Enum: "ARRAY" "STRING" "LONG" "INT" "BOOLEAN" "DOUBLE" "JSON" "JSON_ARRAY" Parameter type
required	boolean Flag to indicate the parameter is required or optional

scheduleType

required

string (ScheduleType)

Enum: "ONE_TIME" "DAILY" "WEEKLY" "MONTHLY" "QUARTERLY" "ANNUALLY"

Scheduling strategy for the report to be generated.

period

required

string (Period)

Enum: "1_DAY" "7_DAYS" "14_DAYS" "30_DAYS" "90_DAYS" "180_DAYS" "1_YEAR" "CUSTOM" "NONE"

Date range which the report should be generated

control

string

Enum: "ALLOW" "DENY"

Indicates whether user is entitled to use this report type.

categories

Array of strings unique

Items Enum: "SECURITY" "SITE_AND_ENVIRONMENT" "ASSET" "POWER" "FINANCE"

The list of categories this definition belongs to

Response samples

Content type

application/json

[{"name": "consectetur in amet ullamco occaecat",
"parameters": [{"name": "status",
"type": "BOOLEAN",
"value": "true"
},
{"name": "recordCount",
"type": "INT",
"value": "1234"
},
{"name": "startDate",
"type": "STRING",
"value": "cillum"
},
{"name": "userKeys",
"type": "ARRAY",
"value": "312453,542784,682012"
}
],
"control": "ALLOW",
"categories": ["SITE_AND_ENVIRONMENT",
"ASSET",
"FINANCE",
"SECURITY"
]
},
{"name": "ul",
"parameters": [ ],
"categories": ["POWER"
],
"control": "DENY"
}
]

Delete your generated reports

Use this API to delete specific generated reports of an authenticated user by the generated reports' report IDs.

query Parameters

reportIds

required

Array of strings [ 1 .. 20 ] items unique

Comma separated report ids to be deleted.

header Parameters

Authorization

required

string >= 1

Specify the Access token with prefix 'Bearer '.

Responses

Response Schema: application/json

Array

reportId required	string <uuid> A unique UUID string denoting the id of the report entry
scheduledId	string <uuid> Scheduled Id for the report entry
reportName	string non-empty Name of the report
fileName	string non-empty File name of the report
fileType	string non-empty Enum: "XLS" "CSV" "PDF" File type of the report
fileSize	number >= 0 Size of the report in bytes
createdFor	string Person/Entity whom this entry belongs to
requestedDate	string <date-time> Time when this entry was first requested
generatedDate	string <date-time> Time when this entry was generated
status required	string (ReportStatus) Enum: "IN_PROGRESS" "DELAYED" "SUCCESS" "ERROR" "INACTIVE" Status of the report
numberOfDownloads	integer >= 0 Default: 0 Number of times this report is downloaded by the customer

Response samples

Content type

application/json

[{"reportId": "e96b42b6-ef0f-458f-a3f2-a5fd188236d7",
"status": "SUCCESS"
},
{"reportId": "75e7c1e3-8593-4afa-ab75-b80b341d5547",
"status": "ERROR"
},
{"reportId": "737b187c-3c28-4bd2-8c4c-b46c95e69547",
"status": "SUCCESS"
}
]

Get your generated reports

Use this method to get a list of reports triggered for generation by the authenticated user.

query Parameters

offset	integer >= 0 Default: 0 The start index from which the list is created.
limit	integer [ 0 .. 100 ] Default: 10 Use offset and limit to restrict the number of users in the output. Limit can be used to restrict the number of reports in the response
duration	integer [ 1 .. 365 ] Default: 7 Number of days since should reports be searched
sorts	Array of strings unique Default: "-GENERATED_DATE" Items Enum: "REPORT_NAME" "-REPORT_NAME" "GENERATED_DATE" "-GENERATED_DATE" "REQUESTED_DATE" "-REQUESTED_DATE" Use sort to get the reports in the response sorted in the particular order. for example, use '-GENERATED_DATE' to sort the reports by generated date in descending order. And ‘GENERATED_DATE’ for ascending order. For descending order, the field name should be prefixed with '-'
statuses	Array of strings unique Default: "IN_PROGRESS,SUCCESS,ERROR" Items Enum: "IN_PROGRESS" "SUCCESS" "ERROR" List of statuses of reports to be searched.

header Parameters

Authorization

required

string >= 1

Specify the Access token with prefix 'Bearer '.

Responses

Response Schema: application/json

required

Array of objects (DownloadableReport) >= 0 items

List of records

Array (>= 0 items)

reportId required	string <uuid> A unique UUID string denoting the id of the report entry
scheduledId	string <uuid> Scheduled Id for the report entry
reportName	string non-empty Name of the report
fileName	string non-empty File name of the report
fileType	string non-empty Enum: "XLS" "CSV" "PDF" File type of the report
fileSize	number >= 0 Size of the report in bytes
createdFor	string Person/Entity whom this entry belongs to
requestedDate	string <date-time> Time when this entry was first requested
generatedDate	string <date-time> Time when this entry was generated
status required	string (ReportStatus) Enum: "IN_PROGRESS" "DELAYED" "SUCCESS" "ERROR" "INACTIVE" Status of the report
numberOfDownloads	integer >= 0 Default: 0 Number of times this report is downloaded by the customer

object (Page)

total required	integer >= 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 Sort fields based on polarity

required

object (Links)

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

Response samples

Content type

application/json

{"data": [{"reportId": "624c4a6c-7871-41c3-ba6e-75850d29ed92",
"scheduledId": "5a7107c6-7192-45b6-bf3d-d9e941aa4348",
"reportName": "dolore",
"createdBy": "in ea officia Lorem",
"requestedDate": "3964-08-29T08:17:55.966Z",
"generatedDate": "2436-06-24T06:01:42.805Z",
"status": "SUCCESS",
"fileSize": 22690250,
"numberOfDownloads": 0
},
{"reportId": "ab35a2cc-171f-42d4-bbb4-a0193585450d",
"scheduledId": "511c1f32-da86-42bf-9a5d-e0fbe1145070",
"reportName": "in ea nostrud dolor anim",
"createdBy": "ullamco sin",
"requestedDate": "3721-10-04T04:48:32.824Z",
"generatedDate": "2778-10-01T13:16:17.591Z",
"status": "ERROR",
"numberOfDownloads": 1
},
{"reportId": "2007a3a4-e9d0-49a5-bcb1-18ca689a6e50",
"scheduledId": "0d9f98ed-cc78-41ab-847a-1fbdf79ff55d",
"reportName": "ullamco aliquip veniam",
"createdBy": "in nostrud",
"requestedDate": "2053-11-05T10:45:49.313Z",
"generatedDate": "4251-04-28T12:19:23.748Z",
"status": "ERROR",
"fileSize": 22695633,
"numberOfDownloads": 3
}
],
"page": {"total": 20393392,
"limit": 12512897,
"offset": 49505553,
"sorts": ["deserunt laboris",
"cupidatat",
"ut ex",
"do sit",
"ut qui"
]
},
"_links": {"self": {"href": "non cupidatat esse ex"
},
"next": {"href": "ad nulla quis aliqua anim"
}
}
}

Generate new report from schedule

Use this API to generate a new report from an existing scheduled report of the authenticated user, as identified by its scheduled ID.

path Parameters

scheduledId

required

string <uuid>

Scheduled Id to generate a new report

header Parameters

Authorization

required

string >= 1

Specify the Access token with prefix 'Bearer '.

Responses

Response Schema: application/json

reportId

required

string <uuid>

A unique UUID string denoting the id of the report entry

scheduledId

required

string <uuid>

Scheduled Id for the report entry

createdBy

required

string

Person/Entity who created this entry first time

createdDate

required

string <date-time>

Time when this entry was first created

lastAccessedBy

string

Person/Entity who accessed this entry last time

lastAccessedDate

string <date-time>

Time when this entry was last accessed

startTime

required

string <date-time>

Processing start time of the report

endTime

string <date-time>

Processing end time of the report

status

required

string (ReportStatus)

Enum: "IN_PROGRESS" "DELAYED" "SUCCESS" "ERROR" "INACTIVE"

Status of the report

errorMessage

string

Contains an error message if something is failed.

location

string

Location of the report once it is generated

numberOfDownloads

integer >= 0

Default: 0

Number of times this report is downloaded by the customer

numberOfAttempts

required

integer [ 0 .. 3 ]

Number of times attempted to generate the report

required

Array of objects (Parameter) >= 0 items

Parameters for the reports to be generated

Array (>= 0 items)

name required	string Parameter name
value required	string non-empty Parameter value
type	string Enum: "ARRAY" "STRING" "LONG" "INT" "BOOLEAN" "DOUBLE" "JSON" "JSON_ARRAY" Parameter type
required	boolean Flag to indicate the parameter is required or optional

publisherInfo

object

Contains report publish data as a json

Response samples

Content type

application/json

{"reportId": "eab1d606-2315-476f-848a-a622a47f24ff",
"scheduledId": "b48696e4-6fdb-49ed-868e-040df6596245",
"startTime": "4498-05-31T11:48:13.373Z",
"endTime": "4472-01-16T11:56:02.238Z",
"createdBy": "elit consequat occaecat",
"createdDate": "2251-10-21T02:07:18.598Z",
"lastAccessedBy": "occaecat ullamco tempor c",
"lastAccessedDate": "2594-04-16T16:02:41.030Z",
"status": "IN_PROGRESS",
"location": "eu labore",
"numberOfDownloads": 1,
"numberOfAttempts": 1,
"parameters": [{"name": "reprehender",
"value": "quis laborum ut",
"type": "LONG"
},
{"name": "nostrud qui pariatur",
"value": "eiusmod ut officia ex sint",
"type": "BOOLEAN"
},
{"name": "ullamco esse eu enim",
"value": "anim qui commodo Excepteur dolor",
"type": "BOOLEAN"
},
{"name": "amet veniam",
"value": "voluptate",
"type": "INT"
},
{"name": "dolor adipisicing",
"value": "commodo",
"type": "ARRAY"
}
]
}

Get report definition by name

Use this API to return the parameter configurations and applicable values for a specific report type supported by Equinix.

path Parameters

reportName

required

string non-empty

Unique report name of the definition

header Parameters

Authorization

required

string >= 1

Specify the Access token with prefix 'Bearer '.

Responses

Response Schema: application/json

name

required

string non-empty

Report Name

required

Array of objects (Parameter) >= 0 items

List of input parameters

Array (>= 0 items)

name required	string Parameter name
value required	string non-empty Parameter value
type	string Enum: "ARRAY" "STRING" "LONG" "INT" "BOOLEAN" "DOUBLE" "JSON" "JSON_ARRAY" Parameter type
required	boolean Flag to indicate the parameter is required or optional

scheduleType

required

string (ScheduleType)

Enum: "ONE_TIME" "DAILY" "WEEKLY" "MONTHLY" "QUARTERLY" "ANNUALLY"

Scheduling strategy for the report to be generated.

period

required

string (Period)

Enum: "1_DAY" "7_DAYS" "14_DAYS" "30_DAYS" "90_DAYS" "180_DAYS" "1_YEAR" "CUSTOM" "NONE"

Date range which the report should be generated

control

string

Enum: "ALLOW" "DENY"

Indicates whether user is entitled to use this report type.

categories

Array of strings unique

Items Enum: "SECURITY" "SITE_AND_ENVIRONMENT" "ASSET" "POWER" "FINANCE"

The list of categories this definition belongs to

Response samples

Content type

application/json

{"name": "consectetur in amet ullamco occaecat",
"parameters": [{"name": "status",
"type": "BOOLEAN",
"value": "true"
},
{"name": "recordCount",
"type": "INT",
"value": "1234"
},
{"name": "startDate",
"type": "STRING",
"value": "cillum"
},
{"name": "userKeys",
"type": "ARRAY",
"value": "312453,542784,682012"
}
],
"control": "ALLOW",
"categories": ["SITE_AND_ENVIRONMENT",
"ASSET",
"FINANCE",
"SECURITY"
]
}

Download a generated report

This method downloads a specific generated report that was originally triggered by the authenticated user.

path Parameters

reportId

required

string <uuid>

Unique identifier of generated report

header Parameters

Authorization

required

string >= 1

Specify the Access token with prefix 'Bearer '.

Responses

Response Schema:
application/octet-stream

string <binary>

Response samples

Content type

application/octet-stream

No sample

Get details of generated report

Use this API to get the details of a report triggered for generated by the authenticated user.

path Parameters

reportId

required

string <uuid>

Unique identifier of generated report

header Parameters

Authorization

required

string >= 1

Specify the Access token with prefix 'Bearer '.

Responses

Response Schema: application/json

reportId

required

string <uuid>

A unique UUID string denoting the id of the report entry

scheduledId

required

string <uuid>

Scheduled Id for the report entry

createdBy

required

string

Person/Entity who created this entry first time

createdDate

required

string <date-time>

Time when this entry was first created

lastAccessedBy

string

Person/Entity who accessed this entry last time

lastAccessedDate

string <date-time>

Time when this entry was last accessed

startTime

required

string <date-time>

Processing start time of the report

endTime

string <date-time>

Processing end time of the report

status

required

string (ReportStatus)

Enum: "IN_PROGRESS" "DELAYED" "SUCCESS" "ERROR" "INACTIVE"

Status of the report

errorMessage

string

Contains an error message if something is failed.

location

string

Location of the report once it is generated

numberOfDownloads

integer >= 0

Default: 0

Number of times this report is downloaded by the customer

numberOfAttempts

required

integer [ 0 .. 3 ]

Number of times attempted to generate the report

required

Array of objects (Parameter) >= 0 items

Parameters for the reports to be generated

Array (>= 0 items)

name required	string Parameter name
value required	string non-empty Parameter value
type	string Enum: "ARRAY" "STRING" "LONG" "INT" "BOOLEAN" "DOUBLE" "JSON" "JSON_ARRAY" Parameter type
required	boolean Flag to indicate the parameter is required or optional

publisherInfo

object

Contains report publish data as a json

Response samples

Content type

application/json

{"reportId": "894d2b14-30b2-413b-8370-110998b9923d",
"scheduledId": "102eb0a5-0d4b-46ba-8865-773728cfffbb",
"createdBy": "ad dolor",
"createdDate": "2909-07-21T00:14:20.700Z",
"lastAccessedBy": "eu reprehenderit",
"lastAccessedDate": "3111-04-13T18:17:23.826Z",
"startTime": "3698-08-25T04:24:44.011Z",
"endTime": "1994-03-01T04:43:58.554Z",
"status": "ERROR",
"errorMessage": "cupidatat qui non",
"location": "Excepteur fugiat consequat Ut eu",
"numberOfDownloads": 92915061,
"numberOfAttempts": 1,
"parameters": [{"name": "Lorem",
"value": "ad nostrud sunt sit",
"type": "ARRAY"
}
],
"publisherInfo": { }
}

Reports Service API (1.0.0)

Report Center

Schedule New Report

header Parameters

Request Body schema: application/json

Responses

Response Schema: application/json

Request samples

Response samples

Get your Scheduled Reports

query Parameters

header Parameters

Responses

Response Schema: application/json

Response samples

Delete your scheduled reports

query Parameters

header Parameters

Responses

Response Schema: application/json

Response samples

Download list of generated reports

query Parameters

header Parameters

Responses

Response Schema: application/octet-streamapplication/jsonapplication/octet-stream

Response samples

Get details of scheduled report

path Parameters

header Parameters

Responses

Response Schema: application/json

Response samples

Modify scheduled report parameters

path Parameters

header Parameters

Request Body schema: application/json

Responses

Response Schema: application/json

Request samples

Response samples

Get all reports definitions

header Parameters

Responses

Response Schema: application/json

Response samples

Delete your generated reports

query Parameters

header Parameters

Responses

Response Schema: application/json

Response samples

Get your generated reports

query Parameters

header Parameters

Responses

Response Schema: application/json

Response samples

Generate new report from schedule

path Parameters

header Parameters

Responses

Response Schema: application/json

Response samples

Get report definition by name

path Parameters

header Parameters

Responses

Response Schema: application/json

Response samples

Download a generated report

path Parameters

header Parameters

Responses

Response Schema: application/octet-streamapplication/jsonapplication/octet-stream

Response samples

Get details of generated report

path Parameters

header Parameters

Responses

Response Schema:
application/octet-stream

Response Schema:
application/octet-stream