Reports Service API | Equinix Product Documentation

Get report definition by name

Request

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

Path

reportNamestring, non-emptyrequired

Unique report name of the definition

Authorizationstring, >= 1required

Specify the Access token with prefix 'Bearer '.

Payload

// No request payload

Responses

Bodyapplication/json

namestring, non-emptyrequired

Report Name

Example:"eu exercitation"

parametersArray of objects, >= 0 items(Parameter)required

List of input parameters

Example:

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

scheduleTypestring(ScheduleType)required

Scheduling strategy for the report to be generated.

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

Example:"MONTHLY"

periodstring(Period)required

Date range which the report should be generated

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

Example:"30_DAYS"

controlstring

Indicates whether user is entitled to use this report type.

Enum:"ALLOW""DENY"

categoriesArray of strings, unique

The list of categories this definition belongs to

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

Response

{
  "name": "consectetur in amet ullamco occaecat",
  "parameters": [
    { … },
    { … },
    { … },
    { … }
  ],
  "control": "ALLOW",
  "categories": [
    "SITE_AND_ENVIRONMENT",
    "ASSET",
    "FINANCE",
    "SECURITY"
  ]
}

Get report definition by name

Request

Path

Headers

Responses