Device-Controller-v1 1.0.1

DCIM

1. Authenticate

Prerequisites

  1. You should have registered in our developer portal. Check this link about how to register an Account.
  2. You should request access to the playground, sandbox and production environment using our Support page. Here is the link to support page to request access to our environments.
  3. You should have an App created in your account to get the client id and client secret. Check this link about how to create an App.

Note : The time data attribute on APIs follows a 24-hour clock starting at 00:00 and ending at 23:59.

 

Authentication

The bearer token obtained after successful authentication should be passed as credential when calling this API for authentication. Check the Access Token API link for instructions on how to generate your bearer token.

 

 

Read the Get Started documentation if you are unaware of your client credentials.

 

2. Permisssions

3. Get Information

Get Account Information

Master account Id and account Id need to be passed in the header for this API call. This is needed to indicate your legal entity.
Refer to the Accounts API for instructions on how to retrieve your account information. You may skip this step if you already know your master account Id and account Id.

 

Get Site Information

Retrieve the available facility information which are assigned to you. You need the site code to indicate to which facility you want to make a request.
Refer to the Sites API for instructions on how to retrieve your site information. You may skip this step if you already know your sites.

 

Get Location Information

Retrieve the available location information which are assigned to you. You need the location name to indicate to which location in the facility you want to make a request.
Refer to the Locations API for instructions on how to retrieve your location information. You may skip this step if you already know your locations.

4. Retrieve Device Controllers meta-data

 Method GET
End point /v1/dcim-devices/{locationId}/chart-metadata
Headers Authorization, Master-Account-Id, Account-Id, Content-Type
Query Parameters n/a
Body n/a

 

 

Sample Curl Request

curl --location --request GET'https://api.digitalrealty.com/v1/dcim-devices/{locationId}/chart-metadata' \
--header 'Master-Account-Id: <Master-Account-Id>' \
--header 'Account-Id: <Account-Id>' \
--header 'Authorization: Bearer <access_token>' \
--header 'Content-Type: application/json' \

 

Headers

Field Name Mandatory Type Description
Master-Account-Id true string Customer master account identifier.
Account-Id true string Customer account identifier.
Authorization true string Token-based authentication.
Content-Type true string Indicates the request body format.
value: [application/json]

 

Query Parameters

n/a

Body

n/a

Sample JSON Response

[
    {
        "TDCID": "24",
        "SubCategory": "PDU",
        "DefaultFunctionAliasName": "kWTtl",
        "DeviceFunctions": [
            "AmpC",
            "kWTtl",
            "AmpB",
            "AmpA",
            "kVATtl"
        ],
        "DisplayOrder": 47,
        "TrendValueType": "AVG"
    }
]

 

Payload Description

Field Name Type Description
TDCID int Index
SubCategory string Insite asset subcategory.
DefaultFunctionAliasName string When loading summary page, if this value exists in the insite record for this SubCatagory, use this function for summary page data.
DeviceFunctions array When in device detail chart, get all functions from insite record for this SubCatagory.
DisplayOrder int Numerical value that determines the display order of subcategories in the summary page.
TrendValueType string AVG or MAX is a parameter that is passed to the Get Trend data call. AVG returns average values from within the date intervals, whereas Max returns the Maximum value in a data interval. This helps display on/off data in a meaningful way.

5. Retrieve Device Controllers chart-data

 Method GET
End point /v1/dcim-devices/{locationId}/chart-metadata
Headers Authorization, Master-Account-Id, Account-Id, Content-Type
Query Parameters n/a
Body n/a

 

 

Sample Curl Request

curl --location --request GET'https://api.digitalrealty.com/v1/dcim-devices/{locationId}/chart-metadata' \
--header 'Master-Account-Id: <Master-Account-Id>' \
--header 'Account-Id: <Account-Id>' \
--header 'Authorization: Bearer <access_token>' \
--header 'Content-Type: application/json' \

 

Headers

Field Name Mandatory Type Description
Master-Account-Id true string Customer master account identifier.
Account-Id true string Customer account identifier.
Authorization true string Token-based authentication.
Content-Type true string Indicates the request body format.
value: [application/json]

 

Query Parameters

n/a

Body

n/a

Sample JSON Response

{
  "StartDateTime": "2024-08-22T14:18:16Z",
  "EndDateTime": "2024-08-29T14:18:16Z",
  "Interval": "hour",
  "PortalTrendData": [
    {
      "DeviceName": "TOR1_CR3_PDU-3/4C1",
      "DeviceDataID": "2227427",
      "FunctionName": "KW",
      "FunctionUnits": "kW",
      "TrendData": [
        {
          "PointValue": "152.51",
          "PollDateTime": "2024-08-22 01:00:00",
          "UTCPollDateTime": "2024-08-22 01:00:00",
          "MinValue": "151.20",
          "MaxValue": "154.00"
        }
      ]
    }
  ]
}

 

Payload Description

Field Name Type Description
StartDateTime date-time  
EndDateTime date-time  
Interval string  
PortalTrendData array  
DeviceName string  
DeviceDataID Int  
FunctionName string  
FunctionUnits string  
TrendData array  
PointValue float  
PollDateTime date-time  
UTCPollDateTime date-time  
MinValue float  
MaxValue float  

Need Help?

Have not found what you are looking for, please do not hesitate to reach out to us!

FAQs
Contact Us
globe