orchestrator

2023.4

false

Getting started
- About OData and references
- Enumerated types
- Authenticating
- Permissions per endpoint
- Building API Requests
- Response codes
- Health check endpoints
Authentication
- Authentication methods
- External Applications (OAuth)
- ROPC (not recommended)
Swagger definition
- Read me
- Authorizing API calls in Swagger
- Managing logical resources
Orchestrator APIs
- Alerts Requests
- Assets requests
- Calendars requests
- Environments requests
- Folders requests
- Generic Tasks requests
- Jobs requests
- Libraries requests
- License requests
- Packages requests
- Permissions requests
- Personal workspaces requests
- Processes requests
- Queue Items requests
- Queue retention policy requests
- Robots requests
- Roles requests
- Schedules requests
- Settings requests
- Storage bucket requests
- Tasks requests
- Task Catalogs requests
- Task Forms requests
- Tenants requests
- Transactions requests
- Users requests
- Webhooks requests
Platform Management APIs
- Getting started
  - About this guide
  - Available resources
  - API endpoint URL structure
  - Enumeration List
- Scopes and permissions
  - About scopes and permissions
  - Platform Management scopes and permissions
- Platform Management APIs
  - Audit Logs
    - Get Audit Logs
    - Download Audit Logs
  - Groups
    - Get All Groups
    - Get Specific Group
    - Delete Specific Group
    - Create a New Local Group
    - Update Group
  - Robot Account
    - Get All Robot Accounts
    - Delete Robot Accounts
    - Get Specific Robot Account
    - Delete Specific Robot Account
    - Create a New Robot Account
    - Update Robot Account
  - User
    - Update User
    - Delete Specific User
    - Delete Users
  - Settings
    - Get Settings
    - Update Settings
  - Message Template
    - Get Message Template
    - Update a Message Template
    - Get Message Template by Name

Orchestrator API guide

DELIVERY:

Last updated Feb 13, 2025

Get Message Template by Name

Returns message templates, filtered by name.

API Endpoint

GET https://{yourDomain}/{organizationName}/identity/api/MessageTemplate

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

Param	Data type	Description
`name`	String	The 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"
}

On this page

API Endpoint
Scopes
Request Headers
Query Parameters
Responses
200 OK

Was this page helpful?

PREVIOUSUpdate a Message Template