REST APIs for Load Sets

The following REST APIs are available to support load sets (through Swagger link > https://platform.subject7.com/spec/index.html )

POST / load-plan-executions / Send Load Plan to Cloud Run: This API call can be used to load run any load set on the platform.

Example Payload:

{
  "name": "subject7_test_plan",
  "configuration": {
    "pool": "default_load",
    "browser": "HEADLESS",
    "virtualUsers": 25,
    "speed": 200,
    "capacity": 100,
    "pageTimout": 30,
    "rampup": 75,
    "runPeriod": 0,
    "locatorTimout": 5,
    "delay": 0,
    "dataSetSelection": [
      {
        "testCaseName": "subject7_website_login_logout",
        "templateName": "subject7_reference_credentials",
        "dataSetNames": [
          "subject7_login_tom_smith"
        ],
        "overriddenDataSets": []
      }
    ],
    "projectName": "Common",
    "versionName": "default"
  }
}

URL:

https://platform.subject7.com/api/v2/load-plan-executions

PUT / load-plan-executions/{id} / Cancel Load Plan Execution: This API call can be used to cancel execution for a load set currently being executed.

No payload is required for this API call, but an Execution ID is required and can be added to the URL:

https://platform.subject7.com/api/v2/load-plan-executions/15

GET / load-plan-executions / Load Plan Executions: This API call can be used to get load set executions using various filters.

This API call does not require a payload and works with the URL only. Here are the filters:

offset: The number of items to skip before starting to collect the result set
limit: The maximum numbers of items to return
sort: how to sort the displayed items. Available options are: ID, NAME, REQUESTED, BROWSER, REQUESTER, STATE, STATUS
requester: Filter results by requester
requested-date-from: Filter results using a specific date / from
requested-date-to: Filter results using a specific date / to
duration-max: Filter result by duration/maximum in milliseconds
duration-min: Filter result by duration/minimum in milliseconds
owner: Filter result by owner
load-plan: Filter result by using a test plan ID
projectName: Filter result by project name
versionName: Filter result by version name

You can use all filters as shown in the below URL:

https://platform.subject7.com/api/v2/load-plan-executions?offset=1&limit=20&sort=NAME&requester=joseph&requested-date-from=2019-01-01T12%3A00%3A00Z&requested-date-to=2022-03-03T12%3A00%3A00Z&duration-max=1000000&duration-min=10&owner=joseph&load-plan=48&projectName=Common&versionName=default

GET / load-plan-executions/{id} / Load Plan Executions: This API call can be used to get load set executions using the execution ID

No payload is required for this API call, but an Execution ID is required and can be added to the URL:

https://platform.subject7.com/api/v2/load-plan-executions/87

Example Response:

{
  "id": 87,
  "loadPlan": "test2022",
  "requester": "joseph",
  "browser": "HEADLESS",
  "pool": "default_load",
  "requested": 1643819490.187,
  "started": 1643819493.146,
  "completed": 1643819520.529,
  "status": "PASS",
  "state": "COMPLETED",
  "virtualUser": 5,
  "capacity": 100,
  "rumpup": 15,
  "pageTimeout": 30,
  "locatorTimeout": 5,
  "speed": 200,
  "runPeriod": 0,
  "duration": 67888
}

GET / load-test-executions / Test Cases of Load Plan Execution: This API call can be used to get test cases used in the load plan execution using various filters.

This API call does not require a payload and works with the URL only. Here are the filters:

offset: The number of items to skip before starting to collect the result set
limit: The maximum numbers of items to return
load-plan-execution: Filter result by load plan execution ID
projectName: Filter result by project name
versionName: Filter result by version name

You can use all filters as shown in the below URL:

https://platform.subject7.com/api/v2/load-test-executions?offset=1&limit=100&load-plan-execution=87&projectName=Common&versionName=default

GET / load-test-executions{id} / Test Case Execution of Load Plan: This API call can be used to get information about the test case(s) used in the load plan by using the execution ID

No payload is required for this API call, but an Execution ID is required and can be added to the URL:

https://platform.subject7.com/api/v2/load-test-executions/87

Example Response:

{
  "id": 87,
  "loadPlanExecution": 87,
  "name": "subject7_website_login_logout",
  "status": "PASS"
}

GET / load-step-executions / Step Executions of Load Plan: This API call can be used to get steps which are part of the test case used in the load plan execution using various filters.

This API call does not require a payload and works with the URL only. Here are the filters:

offset: The number of items to skip before starting to collect the result set
limit: The maximum numbers of items to return
load-plan-execution: Filter result by load plan execution ID
projectName: Filter result by project name
versionName: Filter result by version name

You can use all filters as shown in the below URL:

https://platform.subject7.com/api/v2/load-step-executions?offset=0&limit=5&load-test-execution=87&projectName=Common&versionName=default

REST APIs for Load Sets

Related content