UiPath Documentation
test-cloud
latest
false
Test Cloud API guide

Get Message Template by Name

API endpoint reference for retrieving message templates filtered by name in Test Cloud.

Returns message templates, filtered by name.

API Endpoint

GET {accessURL}/{organizationName}/identity_/api/MessageTemplate

Replace {accessURL} in all endpoint paths with the base URL for your cloud platform:

Cloud platformAccess URL
Test Cloudhttps://cloud.uipath.com/
Test Cloud Public Sectorhttps://govcloud.uipath.us/
Test Cloud Dedicatedhttps://{customURL}.dedicated.uipath.com/

Scopes

Requires the following scopes:

  • PM.MessageTemplate
  • PM.MessageTemplate.Read

Request Headers

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'

Query Parameters

ParamData typeDescription
nameStringThe name of the message template.

Responses

200 OK

Returns the message templates filtered by their names.

{
  "id": 0,
  "name": "string",
  "value": "string"
}
{
  "id": 0,
  "name": "string",
  "value": "string"
}
  • API Endpoint
  • Scopes
  • Request Headers
  • Query Parameters
  • Responses
  • 200 OK

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated