JobManagement Resource

GET /v2/job/templates

Returns a paginated list of Job Templates. 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 Supported sort keys: key, templateKey, jobName, jobDescription, createdBy, assetType

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/templates
Content-Type: application/json
Accept: application/json

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

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

POST /v2/job/templates

Creates a job template. Flow for creation of Job Templates: Fetch the key of VirtualFolder (/virtualfolder/name/{VirtualFolder_Name}) Fetch an appropriate Sequence key (/job/sequences) Feed the sequence key and virtual folder key in the Job template json along with other template details. Post the payload.

Request Body
media type data type
application/json JobDetailsTO (JSON)
Response Body
media type data type description
application/json JobDetailsTO (JSON)

Example

Request
POST /v2/job/templates
Content-Type: application/json
Accept: application/json

                
{
  "key" : "..."
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "key" : "..."
}
                
              

POST /v2/job/templates/bulkdelete

Delete a set of Job templates

Request Body
media type data type
application/json object (JSON)

Example

Request
POST /v2/job/templates/bulkdelete
Content-Type: application/json

                
...
                
              
Response
HTTP/1.1 201 Created

              

DELETE /v2/job/templates/{key}

API to delete an existing Job template

Request Parameters
name type description
key path

Example

Request
DELETE /v2/job/templates/{key}
Content-Type: application/json

                
...
                
              
Response
HTTP/1.1 204 No Content

              

GET /v2/job/templates/{key}

Returns a single Job template for 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/templates/{key}
Content-Type: application/json
Accept: application/json

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

                
{
  "key" : "..."
}
                
              

PUT /v2/job/templates/{key}

API to update an existing Job Template. Only a restricted set of fields can be updated through the API Fields supported: name, description, assetList, assetPaths

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

Example

Request
PUT /v2/job/templates/{key}
Content-Type: application/json
Accept: application/json

                
{
  "key" : "..."
}
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "key" : "..."
}
                
              

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

Returns a list of Job instances for the provided Job template key

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

Example

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

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

                
[ {
  "key" : "..."
} ]