Skip to main content
API docs by Redocly

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

Content type
application/json
{
  • "name": "eu exercitation",
  • "parameters": [
    ],
  • "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": [
    ],
  • "reports": [
    ]
}

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": [
    ],
  • "page": {
    },
  • "_links": {
    }
}

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:
string <binary>

Response samples

Content type
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": [
    ],
  • "reports": [
    ]
}

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

Content type
application/json
{
  • "name": "eu exercitation",
  • "parameters": [
    ],
  • "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": [
    ],
  • "reports": [
    ]
}

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
[
  • {
    },
  • {
    }
]

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
[
  • {
    },
  • {
    },
  • {
    }
]

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": [
    ],
  • "page": {
    },
  • "_links": {
    }
}

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": [
    ]
}

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": [
    ],
  • "control": "ALLOW",
  • "categories": [
    ]
}

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:
string <binary>

Response samples

Content type
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": [
    ],
  • "publisherInfo": { }
}