Skip to main content

Comments-v1 1.0.0

Helper

1. Authenticate

Text (formatted, long)

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. Get Information

Text (formatted, long)

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.

3. Add a Comment

Add Comments


The method is used to add a comment to an existing work order. Multiple comments can be added to a work order as long as the status of the order is not closed or cancelled.

 Method POST
End point /v1/comments
Headers Authorization, Master-Account-Id, Account-Id, Content-Type
Query Parameters n/a
Body requestId, comment

 

Sample Curl Request

curl --location --request POST 'https://api.digitalrealty.com/v1/comments' \
--header 'Master-Account-Id: <Master-Account-Id>' \
--header 'Account-Id: <Account-Id>' \
--header 'Authorization: Bearer <access_token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "requestId": "WO9271561",
    "comment": "Example Comment"
}'

 

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

Field Name Mandatory Type Description
requestId true string(20) Identifier of the work order.
comment true string(4k) Note of the work order.

 

Sample JSON Response

{
    "comment": "Example Comment",
    "commentedBy": "John Doe",
    "commentedOn": "2022-08-30 12:30:00"
}

 

Payload Description

Field Name Type Description
comment string(4k) Note of the work order.
commentedBy string(40) Designates the user that initially generated the comment.
commentedOn string(date-time) Date on which the comment was generated.

format: [yyyy-MM-dd HH:mm:ss] timezone: [UTC]

4. Retrieve Comments

Retrieve Comments


The method is used to retrieve all comments that are made to a specific work order. 

 Method GET
End point /v1/comments/{requestId}
Headers Authorization, Master-Account-Id, Account-Id
Query Parameters n/a
Body n/a

 

Sample Curl Request

curl --location --request GET 'https://api.digitalrealty.com/v1/comments/<requestId>' \
--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

n/a

Body

n/a

Sample JSON Response

[
  {
    "comment": "Example comment",
    "commentedBy": "John Doe",
    "commentedOn": "2022-08-30 12:30:00"
  }
]

 

Payload Description

Field Name Type Description
comment string(4k) Note of the work order.
commentedBy string(40) Designates the user that initially generated the comment.
commentedOn string(date-time) Date on which the comment was generated.

format: [yyyy-MM-dd HH:mm:ss] timezone: [UTC]

Response Codes

Text (formatted, long)

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


Need Help?

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

globe