5.236
This section describes behavior of the Job Template object in Moab Web Services. It contains the URLs, request bodies, and responses delivered to and from MWS.
The Fields: Job Templates reference section contains the type and description of all fields in the Job Template object. It also contains details regarding which fields are valid during PUT and POST actions.
Supported methods
| Resource | GET | PUT | POST | DELETE |
|---|---|---|---|---|
| /rest/job-templates | Get All Job Templates | -- | -- | -- |
| /rest/job-templates/<id> | Get Single Job Template | -- | -- | -- |
This topic contains these sections:
The HTTP GET method is used to retrieve Job Template information. Queries for all objects and a single object are available.
Quick reference
GET http://localhost:8080/mws/rest/job-templates/<id>?api-version=3
5.236.1.A Get All Job Templates
URLs and parameters
GET http://localhost:8080/mws/rest/job-templates?api-version=3
See Global URL Parameters for available URL parameters.
Sample response
GET http://localhost:8080/mws/rest/job-templates?api-version=3&fields=id
------------------------------------
{
"totalCount": 14,
"resultCount": 14,
"results": [
{"id": "DEFAULT"},
{"id": "genericVM"},
{"id": "genericVM-setup"},
{"id": "genericVM-destroy"},
{"id": "genericVM-migrate"},
{"id": "genericPM"},
{"id": "genericPM-setup"},
{"id": "genericPM-destroy"},
{"id": "OSStorage"},
{"id": "OSStorage-setup"},
{"id": "OSStorage-destroy"},
{"id": "extraStorage"},
{"id": "extraStorage-setup"},
{"id": "extraStorage-destroy"}
]
}
5.236.1.B Get Single Job Template
URLs and parameters
GET http://localhost:8080/mws/rest/job-templates/<id>?api-version=3
| Parameter | Required | Type | Valid values | Description |
|---|---|---|---|---|
| id | Yes | String | -- | The unique identifier of the object. |
See Global URL Parameters for available URL parameters.
Sample response
JSON response
------------------------------------
{
"account": "account",
"args": "arg1 arg2",
"commandFile": "/tmp/script",
"description": "description",
"genericSystemJob": true,
"id": "genericVM",
"inheritResources": false,
"jobDependencies": [ {
"name": "genericVM-setup",
"type": "JOBSUCCESSFULCOMPLETE"
}],
"jobFlags": ["VMTRACKING"],
"jobTemplateFlags": ["SELECT"],
"jobTemplateRequirements": [ {
"architecture": "x86_64",
"diskRequirement": 500,
"genericResources": {"tape": 3},
"nodeAccessPolicy": "SINGLEJOB",
"operatingSystem": "Ubuntu 10.04.3",
"requiredDiskPerTask": 200,
"requiredFeatures": ["dvd"],
"requiredMemoryPerTask": 1024,
"requiredProcessorsPerTask": 2,
"requiredSwapPerTask": 512,
"taskCount": 4
}],
"priority": 20,
"qos": "qos",
"queue": "queue",
"durationRequested": 600,
"select": true,
"trigger": null,
"version": 0,
"vmUsagePolicy": "REQUIREPM"
}
Related Topics