JobManagement Resource

GET /v2/job/instances

Returns a paginated list of Job instances. filter accepts a single filter term with a list of values separated by comma. eg: parentTemplateKey:ra151dddc007f947ce,ra151dddc007f947cb sort accepts a list of entries to sort on in order eg: jobName:asc,templateKey:desc asc - Ascending, desc - Descending

Request Parameters
name type description constraints
filter query  
pageIndex query long
pageSize query long
sort query  
Response Body
media type data type description
application/json PaginatedResponseOfJobDetailsTO (JSON)

Example

Request
GET /v2/job/instances
Content-Type: application/json
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "totalCount" : 12345,
  "list" : [ {
    "key" : "..."
  }, {
    "key" : "..."
  } ]
}
                
              

GET /v2/job/instances/currentuser

Returns a paginated list of Job instances for the current user. filter accepts a single filter term with a list of values separated by comma. eg: parentTemplateKey:ra151dddc007f947ce,ra151dddc007f947cb sort accepts a list of entries to sort on in order eg: jobName:asc,templateKey:desc asc - Ascending, desc - Descending

Request Parameters
name type description constraints
filter query  
pageIndex query long
pageSize query long
sort query  
Response Body
media type data type description
application/json PaginatedResponseOfJobDetailsTO (JSON)

Example

Request
GET /v2/job/instances/currentuser
Content-Type: application/json
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "totalCount" : 12345,
  "list" : [ {
    "key" : "..."
  }, {
    "key" : "..."
  } ]
}
                
              

GET /v2/job/instances/{key}

Returns a single Job instance based on the provided key.

Request Parameters
name type description
key path
Response Body
media type data type description
application/json JobDetailsTO (JSON)

Example

Request
GET /v2/job/instances/{key}
Content-Type: application/json
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "key" : "..."
}
                
              

GET /v2/job/instances/{key}/executions

Returns the executions/steps for the provided job instance key.

Request Parameters
name type description
key path
Response Body
media type data type description
application/json array of JobExecutionTO (JSON)

Example

Request
GET /v2/job/instances/{key}/executions
Content-Type: application/json
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ { } ]