Lists job templates in a specified workspace. You can paginate, sort, and filter the results by creator, TemplateId, or TemplateName.
Try it now
Test
RAM authorization
Request syntax
GET /api/v1/jobtemplates HTTP/1.1Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| WorkspaceId |
string |
Yes |
The ID of the workspace. |
4***9 |
| UserId |
string |
No |
The ID of the creator. Use this parameter to filter results by a specific creator. |
20**************02 |
| TemplateId |
string |
No |
The job template ID. Use this parameter to filter for an exact match. |
tpl1****6jcq2q |
| TemplateName |
string |
No |
The job template name. Use this parameter to filter for a partial match. |
job-template-example-1778047**** |
| SortBy |
string |
No |
The field to sort the results by. Default value: |
GmtCreateTime |
| Order |
string |
No |
The sort order. Valid values: |
desc |
| PageNumber |
integer |
No |
The page number to retrieve. |
1 |
| PageSize |
integer |
No |
The number of results to return per page. |
10 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response body. |
||
| JobTemplates |
array<object> |
The list of job templates. |
|
|
array<object> |
The details of a job template. |
||
| TemplateId |
string |
The ID of the job template. |
tpl1r5g9ait7**** |
| TemplateName |
string |
The name of the job template. |
job-template-1772516653885 |
| Description |
string |
The description of the job template. |
job description |
| Metadata |
object |
Custom metadata, represented as a collection of key-value pairs. |
{} |
| UserId |
string |
The ID of the creator. |
20**************26 |
| WorkspaceId |
string |
The ID of the workspace. |
88**** |
| TenantId |
string |
The ID of the tenant. |
142388383837**** |
| DefaultVersion |
integer |
The default version number. |
2 |
| GmtCreateTime |
string |
The creation time of the template, in UTC and ISO 8601 format. |
2026-01-23T07:29:06Z |
| GmtModifyTime |
string |
The modification time of the template, in UTC and ISO 8601 format. |
2026-03-03T05:48:02Z |
| ModifiedBy |
string |
The ID of the modifier. |
20**************26 |
| TotalCount |
integer |
The total number of job templates that match the filter conditions. |
100 |
| PageNumber |
integer |
The current page number. |
1 |
| PageSize |
integer |
The number of results on the current page. |
50 |
| RequestId |
string |
The unique ID of the request. Use this ID to troubleshoot issues. |
473469C7-AA6F-4DC5-B3DB-A3DC0D***** |
Examples
Success response
JSON format
{
"JobTemplates": [
{
"TemplateId": "tpl1r5g9ait7****",
"TemplateName": "job-template-1772516653885",
"Description": "job description",
"Metadata": {},
"UserId": "20**************26",
"WorkspaceId": "88****",
"TenantId": "142388383837****",
"DefaultVersion": 2,
"GmtCreateTime": "2026-01-23T07:29:06Z",
"GmtModifyTime": "2026-03-03T05:48:02Z",
"ModifiedBy": "20**************26"
}
],
"TotalCount": 100,
"PageNumber": 1,
"PageSize": 50,
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0D*****"
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.