POST   selfservicejobs/preset

Start a new self service job by a preset name.

Remarks

Note that currently it's not possible to enter job groups via this service call. If your preset includes a group job, i.e. a range of user counts, then only the first user count will be taken to insert a new job.

It is possible to start a job with on-demand locations. Just make sure you save your on-demand settings in the LTP New Test page and create your preset with that on-demand configuration.

The preset can be set up on the New Test page of the Loadtest Portal. You can refer to this preset by the name you saved it under.

Request body model example and description

{
  "PresetName": "large_loadtest_USA",
  "RunnableFileName": "my_scenario.class or my_scenario.zip",
  "ScheduledDate": {
    "Year": 2016,
    "Month": 3,
    "Day": 16,
    "Hour": 13,
    "Minute": 30
  },
  "OverriddenTestParameters": {
    "UserCount": 50,
    "RampUpTimeSeconds": 10,
    "DurationMinutes": 2
  }
}
Name Type Required Description
PresetName String Yes

The name of the preset as you saved it in LTP
RunnableFileName String Yes

The name of the loadtest file, e.g. 'mytest.class' or 'mytest.zip'
ScheduledDate Object No

The ScheduledDate section of the input JSON is optional. If you ignore it then the test will start immediately. Otherwise if you wish to schedule a job then you can use this sub-section. The time zone of your profile will be used to determine the intended schedule date.
Year Integer No

The year part of the scheduled date
Month Integer No

The numeric value of a month, e.g. January = 1, February = 2 etc.
Day Integer No

The day within the month, values 1-31
Hour Integer No

The hour value in a 24-hr clock, values 0-23
Minute Integer No

The minute value, values 0-59
OverriddenTestParameters Object No

Some of the parameters in the preset can be overridden by an extra argument section in the JSON: 'OverriddenTestParameters'
UserCount Integer No

Override the user count in the preset
RampUpTimeSeconds Integer No

Override the ramp up time of the load test in seconds
DurationMinutes Integer No

Override the duration of the load test
;

Response body model example and description

{
  "jobid": 153758,
  "exception": "An exception was encountered during execution: {exception details...}"
}
Name Type Description
jobid Integer

The ID of the inserted job. You can take this ID and use it to check its status in the GET /selfservicejobs/{selfServiceJobId} endpoint.
exception String

Any exception that arose during the function call. In case no exception was thrown this will be an empty string.
;