Get all the jobs
get
/rhp-restapi/rhp/jobs
Returns a list of all the jobs available in the server.
Request
Supported Media Types
- application/json
Query Parameters
-
client: string
Client cluster name.
-
jobTag: string
Tag associated with the job.
-
status: string
Job status for which to get the jobs.Allowed Values:
[ "SCHEDULED", "UNKNOWN", "EXECUTING", "PAUSED", "ABORTED", "TERMINATED", "FAILED", "SUCCEEDED" ]
-
user: string
Name of the user for whom the software home is being provisioned.
Response
Supported Media Types
- application/json
- text/html
200 Response
OK. A JSON object containing an "items" property populated with 0 or more elements with at least an Id property and the links array with at least the "self" link.
Nested Schema : singleResourceLinks
Type:
Show Source
object
-
href:
string
The referenced hyperlink element provided in an absolute format.
-
rel:
string
Allowed Values:
[ "self", "collection", "up", "describedBy" ]
Specify the type of relationship the link has with the described resource.
Default Response
Unexpected error. A JSON object containing error details of the issue while executing the operation.
Root Schema : errorResource
Type:
Show Source
object
-
errorCode:
string
Application specific error code, related to the error message shown at tittle.
-
errorDetails:
array errorDetails
If multiple errors are reported they can be organized in a hierarchical structure in this array.
-
errorPath:
string
XPath or JSON path to indicate where the error occurs.
-
instance:
string
URI to the link that provides more detail about the error.
-
status:
integer
HTTP status code.
-
title:
string
Summary error message.
-
type:
string
Link to HTTP error code page.
Nested Schema : errorDetails
Type:
array
If multiple errors are reported they can be organized in a hierarchical structure in this array.
Show Source
Examples
The following example shows how to view a list of all the jobs available by submitting a GET request on the REST resource using cURL.
curll -u restUser -X GET "https://RHP_node_name:8894/rhp-restapi/rhp/jobs"
HTTP Status Code and Response Headers
The following shows an example of the response header.
HTTP/1.1 200
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Access-Control-Allow-Methods: GET,PUT,POST,DELETE,PATCH,OPTIONS
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Content-Length, Authorization
Connection: keep-alive
Content-Type: application/json
Content-Length: 204
Date: Tue, 19 Jun 2018 14:03:23 GMT
Response Body
{
"items": [
{
"links": [{
"uri": "https://RHP_node_name:8894/rhp-restapi/rhp/jobs/1",
"rel": "self"
}],
"jobId": "1",
"output": { }
}
]
}