指定されたワークスペース内のジョブテンプレートを一覧表示します。結果はページネーション、ソートが可能であり、作成者、TemplateId、または TemplateName でフィルターできます。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
GET /api/v1/jobtemplates HTTP/1.1リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| WorkspaceId |
string |
必須 |
ワークスペースの ID です。 |
4***9 |
| UserId |
string |
任意 |
作成者の ID です。このパラメーターを使用して、特定の作成者による結果をフィルターできます。 |
20**************02 |
| TemplateId |
string |
任意 |
ジョブテンプレートの ID です。このパラメーターを使用して、完全に一致するものにフィルターできます。 |
tpl1****6jcq2q |
| TemplateName |
string |
任意 |
ジョブテンプレートの名前です。このパラメーターを使用して、部分一致でフィルターできます。 |
job-template-example-1778047**** |
| SortBy |
string |
任意 |
結果をソートするフィールドです。デフォルト値： |
GmtCreateTime |
| Order |
string |
任意 |
ソート順です。有効な値： |
desc |
| PageNumber |
integer |
任意 |
取得するページ番号です。 |
1 |
| PageSize |
integer |
任意 |
1 ページあたりに返される結果の数です。 |
10 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスボディです。 |
||
| JobTemplates |
array<object> |
ジョブテンプレートのリストです。 |
|
|
array<object> |
ジョブテンプレートの詳細です。 |
||
| TemplateId |
string |
ジョブテンプレートの ID です。 |
tpl1r5g9ait7**** |
| TemplateName |
string |
ジョブテンプレートの名前です。 |
job-template-1772516653885 |
| Description |
string |
ジョブテンプレートの説明です。 |
job description |
| Metadata |
object |
カスタムメタデータ。キーと値のペアのコレクションとして表されます。 |
{} |
| UserId |
string |
作成者の ID です。 |
20**************26 |
| WorkspaceId |
string |
ワークスペースの ID です。 |
88**** |
| TenantId |
string |
テナントの ID です。 |
142388383837**** |
| DefaultVersion |
integer |
デフォルトのバージョン番号です。 |
2 |
| GmtCreateTime |
string |
テンプレートの作成時刻（UTC、ISO 8601 形式）です。 |
2026-01-23T07:29:06Z |
| GmtModifyTime |
string |
テンプレートの更新時刻（UTC、ISO 8601 形式）です。 |
2026-03-03T05:48:02Z |
| ModifiedBy |
string |
更新者の ID です。 |
20**************26 |
| TotalCount |
integer |
フィルター条件に一致するジョブテンプレートの総数です。 |
100 |
| PageNumber |
integer |
現在のページ番号です。 |
1 |
| PageSize |
integer |
現在のページに含まれる結果の数です。 |
50 |
| RequestId |
string |
リクエストの一意な ID です。この ID を使用して問題をトラブルシューティングできます。 |
473469C7-AA6F-4DC5-B3DB-A3DC0D***** |
例
成功レスポンス
JSONJSON
{
"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*****"
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。