Glossary
This section covers the various terms that are used throughout the APIs discussed.
Account ID
This is the unique identifier of an account. It is used in the following APIs:
- Accounts
- Add User to Account
- List Account Invitations
- Account User List
- Update Account User
- Account Engine Utilization Report
- Account Functionalities List
- Create a Workspace
- Workspaces List
- Projects List
- Create a Private Location
- List Private Locations
- List Private Locations Supported Browsers
- List Schedules
- List Schedule History
It is found through the BlazeMeter URL, using the following example:
https://a.blazemeter.com/app/#/accounts/{account ID}...
The number that comes after accounts
in the example above is the Account ID.
It can be found in these APIs:
- The Workspace Object
- Workspace Details
- Workspaces List
- Private Location
- Add a Workspace to Private Location
- List Private Locations
- Private Location Details
- Update a Private Location
- The Private Location Object
Concurrency
The Taurus Term used to describe the number of concurrent users to run the test with. It is used in the following APIs:
It is found in the response of the following APIs:
- List Tests
- Test Details
- List Test Suites
- Test Suite Details
- Start a Test
- Start a Test Suite
- List Masters
- Master Details
Collection ID
This is the unique identifier of a multi test. It is used in the following APIs:
- Add Tests to Test Suite
- Delete a Test in Test Suite
- Test Suite Details
- Update a Test Suite
- Duplicate a Test Suite
- Delete a Test Suite
- Start a Test Suite
- Create a Schedule
- List Schedules
- List Schedule History
It is found in the response of the following APIs:
- Create a Test Suite
- List Test Suites
- List Masters
- Master Details
- Update Schedule
- List Schedules
- List Schedule History
For another method for finding this value, visit this article.
Data Model ID
This is the unique identifier of a data model for test data generation. It is used in the following APIs:
It is found in the response of the following APIs:
Executor
The Taurus Term used to describe the execution type for a test (i.e. JMeter, Selenium, Gatling, etc.). It is used in the following APIs:
It is found in the response of the following APIs:
- List Tests
- Test Details
- List Test Suites
- Start a Test
- Start a Test Suite
- List Masters
- Master Details
Folder ID
This is the unique identifier of the shared folder. It is used in the following APIs:
- Create a Test
- Update a Test
- Shared Folder Details
- Update a Shared Folder
- Upload or Update Files to Shared Folder
- List Shared Folder Files
- Delete Shared Folder File
- Delete Shared Folder
It is found in the response of the following APIs:
Group ID
This is the unique identifier for API Functional test groups. It is used in the following APIs:
It is found in the repsones of the following APIs:
Harbor ID
This is the unique identifier of the private location. It is used in the following APIs:
- Create an Agent
- Generate Docker Command
- Add a Workspace to Private Location
- List Private Locations
- Update a Private Location
- List Agents
- Agent Details
- Update an Agent
- Private Location Image Versions
- Delete a Workspace in Private Locations
- Delete an Agent
- Delete a Private Location
It is found in the response of the following APIs:
For another method of finding this value, visit this article.
Hold-for
The Taurus Term to describe the length of time the test will run at the full concurrency settings. It is used in the following APIs:
It is found in the response of the following APIs:
Location ID
This is the unique identifier for a cloud location or a private location. Visit the Functional Locations List appendix for more details on this term. It is used in the following APIs:
It is found in the response of the following APIs:
- Upload or Update Asset Files
- Update a Test
- List Tests
- Test Details
- Duplicate a Test
- Start a Test
- Start a Test Suite
- List Masters
- Master Details
- List Private Locations Supported Browsers
For another method for finding this value, visit this article. For the full list of functional locations, see here.
Master ID
This is the unique identifier that identifies a test run. It is used in the following APIs:
- Master Details
- API Functional Summary Statistics
- API Functional Full Report
- GUI Functional Scenarios Summary
- GUI Functional Summary Statistics
- Test Suite Summary
It is found in the response of the following APIs:
For another method for finding this value, visit this article.
Project ID
This is the unique identifier that identifies a given project. It is used in the following APIs:
- Create a Project
- Project Details
- Update a Project
- Delete a Project
- Create a Test
- Update a Test
- List Tests
- Test Details
- Create a Test Suite
- List Test Suites
- List Masters
- List Schedules
- List Schedule History
It is found in the response of the following APIs:
- Projects List
- Upload or Update Asset Files
- Update a Test
- List Tests
- Duplicate a Test
- Add Tests to Test Suite
- Delete Test in Test Suite
- Test Suite Details
- Update a Test Suite
- Duplicate a Test Suite
- Start a Test
- List Masters
- Master Details
For another method for finding this value, visit this article.
Ramp-up
The Taurus Term to describe the time it takes to ramp up to the full concurrency set. It is used in the following APIs:
It is found in the response of the following APIs:
Scenario ID
The id attribute of the test. It is used in the following APIs:
Schedule ID
This is the unique identifier that identifies a scheduled test run. It is used in the following APIs:
It is found in the response of the following APIs:
Session ID
This is the unique identifier that identifies a session in a test run. It is used in the following APIs:
It is found in the response of the following APIs:
- Start a Test
- Master Details
- List Masters
- API Functional Summary Statistics
- GUI Functional Summary Statistics
- GUI Functional Scenarios Summary
For another method for finding this value, visit this article.
Ship ID
This is the unique identifier of an agent within a private location. It is used in the following APIs:
- Generate Docker Command
- Agent Details
- Update an Agent
- Private Location Image Versions
- Delete an Agent
It is found in the response of the following APIs
For another method of finding this value, visit this article.
Steps
The Taurus Term for describing the number of steps the rampup will use (i.e. setting this to 3 will make the ramp up increase 3 times during the ramp up period). It is used in the following APIs:
It is found in the response of the following APIs:
Test ID
This is the unique identifier that identifies a test. It is used in the following APIs:
- Upload or Update Asset Files
- List Test Files
- Delete Asset Files
- Validate a File
- Check File Validation
- Update a Test
- Test Details
- Duplicate a Test
- Delete a Test
- Add Tests to Test Suite
- Delete a Test in Test Suite
- Start a Test
- Start a Test Suite
- List Masters
- Create a Schedule
- List Schedules
- List Schedule History
It is found in the response of the following APIs:
- Create a Test
- List Tests
- List Test Suites
- Update a Test Suite
- Duplicate a Test Suite
- List Masters
- Master Details
- Update Schedule
- List Schedules
- Schedule Details
- List Schedule History
For another method for finding this value, visit this article.
Test Data Model properties and requirements
To generate test data, you define a data model.
The properties section is where you declare data properties and their types. The syntax is based on the property type section of the JSON Schema specification.
"properties":{
"name":{ "type":"string"},
"age":{"type":"integer"},
"email":{"type":"string"}
}
The requirements section is BlazeMeter's custom extension of the JSON Schema. In this section, you define requirements for the values of each property. The requirements are expressions using ECMAScript 6 syntax, such as “randInt(x,y) + 10” or "$name".
Requirements commonly use BlazeMeter data generator functions, such as randText(5,10). For more information, see Get List of Data Generator Functions, Get List of Seedlists, and Get List of CardIssuers.
"requirements":{
"name":"randText(5,10)",
"email":"$name + '@acme.com'"
"age":"randRange(18,99)"
}
In the requirements, you can also use JavaScript expressiosn such as yield, await, new, delete, typeof, void, instanceof, in, arrow functions, spread, shift, variables and operators, such as $name + '@acme.com'. Valid number literals are limited to decimal literals; hex, octal and binary literals are not supported.
Example:
{ "data":{
"type":"datamodel",
"attributes":{
"id":"datamodel/Pet",
"title":"Pet",
"description":"A Pet can be dog or cat",
"type":"object",
"kind":"tdm",
"repeat":1,
"properties":{
"name":{ "type":"string"},
"age":{"type":"integer"},
"email":{"type":"string"}
},
"requirements":{
"name":"randText(5, 10)",
"email":"$name + '@acme.com'"
"age":"randRange(18,99)"
}
}
}
}
User ID
This is the unique identifier that identifies a user. It is used in the following APIs:
It is found in the response of the following APIs:
Workspace ID
This is the unique identifier that identifies a workspace. It is used in the following APIs:
- Workspaces Details
- Add User to Workspace
- Workspace User List
- Update Workspace User
- Create a Project
- Projects List
- Update a Project
- Delete a Project
- List Tests
- List Test Suites
- List Masters
- Create a Shared Folder
- List Shared Folders
- Shared Folder Details
- List Shared Folder Files
- List Schedules
- List Schedule History
- Create a Private Location
- Add a Workspace to Private Location
- List Private Locations
- Delete a Workspace in Private Location
It is found in the response of the following APIs:
- Create a Workspace
- Workspaces List
- Project Details
- Create a Schedule
- List Schedules
- Schedule Details
- List Schedule History
- List Private Locations
- Private Locations Details
- Update a Private Location
For another method for finding this value, visit Get Your Workspace ID .