GET All Job Templates

Job templates contain the configuration for how a job should run: which URLs to test, in which browser, and, in the case of a crawl, how long it should run for.

When querying for job templates, parameters that are common to all job types will be returned within the main object. Parameters that are specific to certain types of jobs will be included in the meta section. For consistency across job types, browsers and URLs will always be in the common section and will be returned as arrays, even through some job types only permit one of these.

Request

Method GET
Path /jobTemplates
Header

Realm: account_realm

Authorization: Bearer access_token

Response

The response for this request is an array of job template objects:

Body

"results": [

{

"sref": "jobTemplates/123456",

"type": "Single",

"name": "My single job template",

"description": "",

urls": [

"www.mydomain.com"

],

"browsers": [

"browsers/ff",

"browsers/ch",

"browsers/ie11",

]

"createdBy": "Joe Bloggs",

"capture": true,

"advanced": {

"inactivityTimeout": 0

},

"meta": {},

"deviceProfile": "deviceProfiles/1",

"networkSpeed": {

"networkSpeedUri": "networkSpeeds/1",

"meta": {

"downloadKbps": 2010,

"uploadKbps": 190,

"latency": 0,

"packetLossRate": 0

}

}

},

{

"sref": "jobTemplates/456789",

"type": "Multi",

"name": "My multi job template",

"description": "Comparison between us and main competitor",

"urls": [

"www.mydomain.com",

"www.yourdomain.com",

],

"browsers": [

"browsers/ff"

],

"createdBy": "Joe Bloggs",

"capture": true,

"advanced": {

"inactivityTimeout": 0

},

"meta": {},

"deviceProfile": null,

"networkSpeed": {

"networkSpeedUri": "networkSpeeds/1",

"meta": {

"downloadKbps": 2010,

"uploadKbps": 190,

"latency": 0,

"packetLossRate": 0

}

}

},

{

"sref": "jobTemplates/654321",

"type": "Crawl",

"name": "My crawl job template",

"description": "",

"urls": [

"www.mydomain.com"

],

"browsers": [

"browsers/ch"

],

"createdBy": "John Doe",

"capture": false,

"advanced": {

"inactivityTimeout": 1

},

"meta": {

"crawlExcludes": {

"type": "regex",

"data": [

"%.*\.jpe?g%i",

"%.*\.pdf%i"

]

},

"crawlTimeout": 10800

},

"deviceProfile": null,

"networkSpeed": {

"networkSpeedUri": "networkSpeeds/1",

"meta": {

"downloadKbps": 2010,

"uploadKbps": 190,

"latency": 0,

"packetLossRate": 0

}

}

}

]

Job Template Parameters

Parameter Details
sref The self-reference path that describes how you request the individual job template
type

The type of job: Single, Multi, Crawl, or Scripted

name The name of the job template
description The description of the job template
urls An array of URLs for the job template
browsers An array of browsers that jobs of this job template will run in (as can be discovered using the /browsers request)
createdBy The name of the person who created or last edited the job template
capture Whether or not screen capture has been enabled for the job template
advanced Any advanced parameters for the job template, such as the inactivity timeout
meta Anything configured for the job template that is not standard for all types of job template. Typically, this contains additional details about a crawl.
deviceProfile Defines the device profile that jobs of this job template will run in, or null if no device profile has been set (these can be discovered using the /deviceProfiles request)
networkSpeed Defines the network speed that jobs of this job template will run in (as can be discovered using the /networkSpeeds request), where meta includes individual elements of the network speed

 

This topic was last updated on October 11, 2019, at 11:18:53 AM.

Eggplant icon Eggplantsoftware.com | Documentation Home | User Forums | Support | Copyright © 2019 Eggplant