How to Guide | Digital Realty

1. Authenticate

Prerequisites

You should have registered in our developer portal. Check this link about how to register an Account.
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.
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. Permissions

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 Service Tickets information

The method can be used to retrieve all service tickets of the customers account.

Method	GET
End point	/v1/service-tickets
Headers	Authorization, Master-Account-Id, Account-Id
Query Parameters	site, status, requestType, category, createdBy, size, page
Body	n/a

Sample Curl Request

curl --location --request GET 'https://api.digitalrealty.com/v1/service-tickets' \
--header 'Master-Account-Id: <Master-Account-Id>' \
--header 'Account-Id: <Account-Id>' \
--header 'Authorization: Bearer <access_token>'

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.

Query Parameters

Field Name	Mandatory	Type	Description
site	false	string(6)	Filter by the DLR facility that handles the tickets.
status	false	string(enum)	Filter by state of the tickets.
requestType	false	string(enum)	Filter by the type of tickets.
category	false	string(enum)	Filter by the category of tickets.
createdBy	false	string(40)	Filter by user who generated the work order.
size	false	integer	The maximum number of search results to return. Default value: 25
page	false	integer	The page number of the returning search results. Default value: 0

Body

n/a

Sample JSON Response

{
    "content": [
      {
            "id": "WO9296751",
            "title": "Customer Support Title",
            "status": "New",
            "site": "PHX015",
            "requestType": "Accounts Receivable",
            "category": "General Billing Inquiry",
            "isBulkRequest": false,
            "createdOn": "2023-06-21 12:03:15",
            "updatedOn": "2023-08-22 12:03:49",
            "closedOn": "",
            "createdBy": "portaluser test",
            "ticketType": "Customer Support",
            "description": "Customer Support Title",
            "accessRequestedFor": " ",
            "location": ""
        }
    ],
    "pageable": {
        "last": false,
        "totalPages": 643,
        "totalElements": 16061,
        "size": 25,
        "number": 0,
        "numberOfElements": 25,
        "first": true,
        "empty": false
    }
}

Payload Description

Field Name	Type	Description
id	string(20)	Identifier of the ticket.
title	string(160)	Label on the work order.
status	string(enum)	Designates the stage of the ticket.
site	string(6)	Identifier of the DLR facility.
requestType	string(enum)	Type of Service Ticket request.
category	string(enum)	The category of Service Ticket request.
isBulkRequest	boolean	Only use if this is a request for more than 10 visitors. See details below
createdOn	string(date-time)	Date on which the work order was generated. format: [yyyy-MM-dd HH:mm:ss] timezone: [GMT]
updatedOn	string(date-time)	Last date on which the work order details were modified. format: [yyyy-MM-dd HH:mm:ss] timezone: [GMT]
closedOn	string(date-time)	Date on which the work order’s status was marked Completed. format: [yyyy-MM-dd HH:mm:ss] timezone: [GMT]
createdBy	string(40)	Designates the user that initially generated the work order.
ticketType	string(enum)	Type of the ticket.
description	string	Short description of work order.
accessRequestedFor	string	Access Requested for.
location	string(40)	Identifier of customer premise within DLR facility.

Bulk request:

You can submit a bulk request for more than 10 visitors. This can be done by setting the isBulkRequest to true and attach an excel sheet with all the visitors by using the Attachments API after a successful submitted visitors request.

Response Codes

Please check the Response Codes overview in case of any issues.

ServiceTickets-v1 1.0.0