NeoLoad API v3
The Tricentis NeoLoad Web REST API for continuous performance testing — workspaces, projects, test settings, test results, scenarios, SLA profiles, monitors, infrastructure providers, zones and resources.
OpenAPI Specification
openapi: 3.0.1
info: {version: '3.0', title: NeoLoad API}
paths:
/v3/workspaces:
get:
operationId: GetWorkspaceList
summary: Get the list of all accessible Workspaces
description: Lists all accessible Workspaces.
tags: [Workspaces]
parameters:
- name: allWorkspaces
in: query
required: false
description: If true (reserved to admin users), returns all existing workspaces,
including the workspaces I am not member of. If false, returns only the
workspaces I am a member of.
schema: {type: boolean, default: false}
- {$ref: '#/components/parameters/page_limit'}
- {$ref: '#/components/parameters/page_offset'}
responses:
'200':
description: OK
headers:
Access-Control-Allow-Origin:
schema: {type: string}
content:
application/json:
schema: {$ref: '#/components/schemas/WorkspaceDefinitionList'}
'400': {$ref: '#/components/responses/error_400'}
'401': {$ref: '#/components/responses/error_401'}
'403': {$ref: '#/components/responses/error_403'}
'429': {$ref: '#/components/responses/error_429'}
'500': {$ref: '#/components/responses/error_500'}
post:
tags: [Workspaces]
summary: Create a new Workspace
description: Create a new Workspace
operationId: create_1
requestBody:
content:
application/json:
schema: {$ref: '#/components/schemas/WorkspaceCreateRequest'}
responses:
'200':
description: OK
content:
application/json:
schema: {$ref: '#/components/schemas/FullWorkspaceDefinition'}
'400': {$ref: '#/components/responses/error_400'}
'401': {$ref: '#/components/responses/error_401'}
'403': {$ref: '#/components/responses/error_403'}
'404': {$ref: '#/components/responses/error_404'}
'413': {$ref: '#/components/responses/error_413'}
'429': {$ref: '#/components/responses/error_429'}
'500': {$ref: '#/components/responses/error_500'}
/v3/workspaces/{workspaceId}/tests:
get:
operationId: GetTestList
summary: Get a test list
description: |
Lists the tests of the Workspace.
___
*Sortable fields :*
- name
- projectName
- lastUpdateDate (descending sort by default : the most recent first)
- lastRunDate
- userModifierName
tags: [Tests]
parameters:
- {$ref: '#/components/parameters/workspace-id'}
- {$ref: '#/components/parameters/page_limit'}
- {$ref: '#/components/parameters/page_offset'}
- {$ref: '#/components/parameters/single_sort'}
responses:
'200':
description: OK
headers:
Access-Control-Allow-Origin:
schema: {type: string}
content:
application/json:
schema: {$ref: '#/components/schemas/TestDefinitionList'}
'400': {$ref: '#/components/responses/error_400'}
'401': {$ref: '#/components/responses/error_401'}
'403': {$ref: '#/components/responses/error_403'}
'429': {$ref: '#/components/responses/error_429'}
'500': {$ref: '#/components/responses/error_500'}
post:
operationId: PostCreateTest
summary: Create a new test
description: Create a new test with the specified name
tags: [Tests]
parameters:
- {$ref: '#/components/parameters/workspace-id'}
requestBody:
content:
application/json:
schema: {$ref: '#/components/schemas/TestCreate'}
required: true
responses:
'200':
description: OK
headers:
Access-Control-Allow-Origin:
schema: {type: string}
content:
application/json:
schema: {$ref: '#/components/schemas/TestCreated'}
'400': {$ref: '#/components/responses/error_400'}
'401': {$ref: '#/components/responses/error_401'}
'403': {$ref: '#/components/responses/error_403'}
'413': {$ref: '#/components/responses/error_413'}
'429': {$ref: '#/components/responses/error_429'}
'500': {$ref: '#/components/responses/error_500'}
/v3/workspaces/{workspaceId}/tests/{testId}:
get:
operationId: GetTest
summary: Get a test
description: Get the test
tags: [Tests]
parameters:
- {$ref: '#/components/parameters/workspace-id'}
- {$ref: '#/components/parameters/test-id'}
responses:
'200':
description: OK
headers:
Access-Control-Allow-Origin:
schema: {type: string}
content:
application/json:
schema: {$ref: '#/components/schemas/GetTestDefinition'}
'400': {$ref: '#/components/responses/error_400'}
'401': {$ref: '#/components/responses/error_401'}
'403': {$ref: '#/components/responses/error_403'}
'429': {$ref: '#/components/responses/error_429'}
'500': {$ref: '#/components/responses/error_500'}
patch:
operationId: PatchTest
summary: Partially update a test
description: Update only the specified fields of the test
tags: [Tests]
parameters:
- {$ref: '#/components/parameters/workspace-id'}
- {$ref: '#/components/parameters/test-id'}
requestBody:
description: The fields to update. No field is required, only those supplied
will be updated.
required: false
content:
application/json:
schema: {$ref: '#/components/schemas/TestUpdate'}
responses:
'200':
description: OK
headers:
Access-Control-Allow-Origin:
schema: {type: string}
content:
application/json:
schema: {$ref: '#/components/schemas/TestDefinition'}
'400': {$ref: '#/components/responses/error_400'}
'401': {$ref: '#/components/responses/error_401'}
'403': {$ref: '#/components/responses/error_403'}
'413': {$ref: '#/components/responses/error_413'}
'429': {$ref: '#/components/responses/error_429'}
'500': {$ref: '#/components/responses/error_500'}
put:
operationId: PutTest
summary: Fully update a test
description: Update all fields of the test
tags: [Tests]
parameters:
- {$ref: '#/components/parameters/workspace-id'}
- {$ref: '#/components/parameters/test-id'}
requestBody:
description: The fields to update. All fields are required and will be updated.
required: true
content:
application/json:
schema: {$ref: '#/components/schemas/TestUpdate'}
responses:
'200':
description: OK
headers:
Access-Control-Allow-Origin:
schema: {type: string}
content:
application/json:
schema: {$ref: '#/components/schemas/TestDefinition'}
'400': {$ref: '#/components/responses/error_400'}
'401': {$ref: '#/components/responses/error_401'}
'403': {$ref: '#/components/responses/error_403'}
'413': {$ref: '#/components/responses/error_413'}
'429': {$ref: '#/components/responses/error_429'}
'500': {$ref: '#/components/responses/error_500'}
delete:
operationId: DeleteTest
summary: Delete a test
description: Delete the test with the specified id
tags: [Tests]
parameters:
- {$ref: '#/components/parameters/workspace-id'}
- {$ref: '#/components/parameters/test-id'}
- name: deleteResults
in: query
required: false
description: Also delete related Test Results, including locked Test Results.
Default is true.
example: true
schema: {type: string}
responses:
'200':
description: OK
headers:
Access-Control-Allow-Origin:
schema: {type: string}
content:
application/json:
schema: {$ref: '#/components/schemas/TestDefinition'}
'400': {$ref: '#/components/responses/error_400'}
'401': {$ref: '#/components/responses/error_401'}
'403': {$ref: '#/components/responses/error_403'}
'429': {$ref: '#/components/responses/error_429'}
'500': {$ref: '#/components/responses/error_500'}
/v3/workspaces/{workspaceId}/tests/{testId}/project:
servers:
- {url: 'https://neoload-files.saas.neotys.com'}
post:
operationId: PostUploadProject
summary: Uploads a NeoLoad project zip file or a standalone as-code file
description: Uploads a NeoLoad project of the Workspace corresponding to the
parameters. The maximum size file is 250 MB
tags: [Tests|Projects]
parameters:
- {$ref: '#/components/parameters/workspace-id'}
- {$ref: '#/components/parameters/test-id'}
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
file: {type: string, format: binary}
responses:
'200':
description: OK
headers:
Access-Control-Allow-Origin:
schema: {type: string}
content:
application/json:
schema: {$ref: '#/components/schemas/ProjectDefinition'}
'400': {$ref: '#/components/responses/error_400'}
'401': {$ref: '#/components/responses/error_401'}
'403': {$ref: '#/components/responses/error_403'}
'413': {$ref: '#/components/responses/error_413'}
'429': {$ref: '#/components/responses/error_429'}
'500': {$ref: '#/components/responses/error_500'}
get:
operationId: ReadProjectMetadata
summary: Get project's metadata
description: Get project's metadata
tags: [Tests|Projects]
parameters:
- {$ref: '#/components/parameters/workspace-id'}
- {$ref: '#/components/parameters/test-id'}
responses:
'200':
description: OK
headers:
Access-Control-Allow-Origin:
schema: {type: string}
content:
application/json:
schema: {$ref: '#/components/schemas/ProjectDefinition'}
'400': {$ref: '#/components/responses/error_400'}
'401': {$ref: '#/components/responses/error_401'}
'403': {$ref: '#/components/responses/error_403'}
'429': {$ref: '#/components/responses/error_429'}
'500': {$ref: '#/components/responses/error_500'}
/v3/workspaces/{workspaceId}/tests/{testId}/start:
post:
operationId: GetTestsRun
summary: Starts a test
description: Starts a test of the Workspace according to the method parameters.
tags: [Tests|Runtime]
parameters:
- {$ref: '#/components/parameters/workspace-id'}
- {$ref: '#/components/parameters/test-id'}
- name: testResultName
in: query
required: true
description: The name of the Test Result
schema: {type: string}
- name: testResultDescription
in: query
required: false
description: The description of the Test Result
schema: {type: string}
- name: asCode
in: query
required: false
description: The comma-separated as-code files to use for the test. Those
files must be part of the uploaded project.
schema: {type: string}
- name: reservationId
in: query
required: false
description: The reservation identifier to use for the test that can be retrieved
from the NeoLoad Web reservation calendar URL. If the reservation mode is
enabled and "reservationId" value is defined, "reservationDuration", "reservationWebVUs"
and "reservationSAPVUs" values will be ignored, otherwise if the reservation
mode is disabled the value will be ignored.
schema: {type: string}
- name: reservationDuration
in: query
required: false
description: The duration of the reservation for the test. If the reservation
mode is enabled, this value or "reservationDuration", "reservationWebVUs",
"reservationSAPVUs" must be defined, otherwise if the reservation mode is
disabled the value will be ignored. The value (in seconds) is optional when
the reservation mode is enabled and ignored when reservationId value is
defined or if the reservation mode is disabled. The default value is the
selected scenario duration + 1200 seconds (20 minutes). All reserved resources
will be released when the test ends.
schema: {type: integer, format: int64}
- name: reservationWebVUs
in: query
required: false
description: The number of Web Virtual Users to be reserved for the test.
The value is optional when the reservation mode is enabled and ignored when
"reservationId" value is defined or if the reservation mode is disabled.
schema: {type: integer, format: int32}
- name: reservationSAPVUs
in: query
required: false
description: The number of SAP Virtual Users to be reserved for the test.
The value is optional when the reservation mode is enabled and ignored when
"reservationId" value is defined or if the reservation mode is disabled.
schema: {type: integer, format: int32}
- name: publishTestResult
in: query
required: false
description: When "true" and the project is a collaborative project (other
than git) then the Test Result is published onto the server. If empty, the
default value is "false".
schema: {type: boolean}
responses:
'200':
description: OK
headers:
Access-Control-Allow-Origin:
schema: {type: string}
content:
application/json:
schema: {$ref: '#/components/schemas/RunTestDefinition'}
'400': {$ref: '#/components/responses/error_400'}
'401': {$ref: '#/components/responses/error_401'}
'403': {$ref: '#/components/responses/error_403'}
'413': {$ref: '#/components/responses/error_413'}
'429': {$ref: '#/components/responses/error_429'}
'500': {$ref: '#/components/responses/error_500'}
'501': {$ref: '#/components/responses/error_501'}
/v3/workspaces/{workspaceId}/test-results:
get:
operationId: GetTestResultList
summary: Lists Test Results
description: |
Lists the Test Results of the Workspace according to the method parameters.
___
*Sortable fields :*
- name
- project
- startDate (descending sort by default : the most recent first)
- qualityStatus
tags: [Results]
parameters:
- {$ref: '#/components/parameters/workspace-id'}
- name: status
in: query
required: false
description: Returns only the Test Results with the specified status.
schema:
type: string
enum: [STARTING, RUNNING, TERMINATED]
- name: project
in: query
required: false
description: Project name. Returns only the Test Results of the specified
project.
schema: {type: string}
- name: author
in: query
required: false
description: The author of the Test Result. Returns only the Test Results
launched by the specified author.
schema: {type: string}
- {$ref: '#/components/parameters/page_limit'}
- {$ref: '#/components/parameters/page_offset'}
- {$ref: '#/components/parameters/single_sort'}
- name: fields
in: query
required: false
description: Comma-separated list of fields to include in the json Test Result
definition.
schema: {type: string}
- name: pretty
in: query
required: false
description: If true the Json returned is human readable.
schema: {type: boolean}
responses:
'200':
description: OK
headers:
Access-Control-Allow-Origin:
schema: {type: string}
content:
application/json:
schema: {$ref: '#/components/schemas/ArrayOfTestResultDefinition'}
'400': {$ref: '#/components/responses/error_400'}
'401': {$ref: '#/components/responses/error_401'}
'403': {$ref: '#/components/responses/error_403'}
'404': {$ref: '#/components/responses/error_404'}
'429': {$ref: '#/components/responses/error_429'}
'500': {$ref: '#/components/responses/error_500'}
/v3/workspaces/{workspaceId}/test-results/{resultId}:
get:
operationId: GetTestResult
summary: Test Result description
description: Provides a Test Result description using a unique Test Result identifier.
Provides name, dates, owner ...
tags: [Results]
parameters:
- {$ref: '#/components/parameters/workspace-id'}
- {$ref: '#/components/parameters/result-id'}
responses:
'200':
description: OK
headers:
Access-Control-Allow-Origin:
schema: {type: string}
content:
application/json:
schema: {$ref: '#/components/schemas/TestResultDefinition'}
'400': {$ref: '#/components/responses/error_400'}
'401': {$ref: '#/components/responses/error_401'}
'403': {$ref: '#/components/responses/error_403'}
'404': {$ref: '#/components/responses/error_404'}
'429': {$ref: '#/components/responses/error_429'}
'500': {$ref: '#/components/responses/error_500'}
delete:
operationId: DeleteTestResult
summary: Deletes a Test Result
description: Deletes a Test Result and all the associated statistics. This action
cannot be undone.
tags: [Results]
parameters:
- {$ref: '#/components/parameters/workspace-id'}
- {$ref: '#/components/parameters/result-id'}
responses:
'204':
description: OK
headers:
Access-Control-Allow-Origin:
schema: {type: string}
'400': {$ref: '#/components/responses/error_400'}
'401': {$ref: '#/components/responses/error_401'}
'403': {$ref: '#/components/responses/error_403'}
'404': {$ref: '#/components/responses/error_404'}
'429': {$ref: '#/components/responses/error_429'}
'500': {$ref: '#/components/responses/error_500'}
patch:
operationId: UpdateTestResult
summary: Partially update a Test Result
description: Updates the specified fields of a Test Result. All fields are optional.
tags: [Results]
parameters:
- {$ref: '#/components/parameters/workspace-id'}
- {$ref: '#/components/parameters/result-id'}
responses:
'200':
description: OK
headers:
Access-Control-Allow-Origin:
schema: {type: string}
content:
application/json:
schema: {$ref: '#/components/schemas/TestResultDefinition'}
'204':
description: OK
headers:
Access-Control-Allow-Origin:
schema: {type: string}
'400': {$ref: '#/components/responses/error_400'}
'401': {$ref: '#/components/responses/error_401'}
'403': {$ref: '#/components/responses/error_403'}
'404': {$ref: '#/components/responses/error_404'}
'413': {$ref: '#/components/responses/error_413'}
'429': {$ref: '#/components/responses/error_429'}
'500': {$ref: '#/components/responses/error_500'}
requestBody:
content:
application/json:
schema: {$ref: '#/components/schemas/TestResultUpdateRequest'}
required: true
/v3/workspaces/{workspaceId}/test-results/{resultId}/stop:
post:
operationId: StopTestResult
summary: Stop a running Test Result
description: Stop the running Test Result with the specified id
tags: [Tests|Runtime]
parameters:
- {$ref: '#/components/parameters/workspace-id'}
- {$ref: '#/components/parameters/result-id'}
requestBody:
content:
application/json:
schema: {$ref: '#/components/schemas/TestResultStopRequest'}
required: true
responses:
'200':
description: OK
headers:
Access-Control-Allow-Origin:
schema: {type: string}
content:
application/json:
schema:
type: object
properties:
testResultId: {type: string, description: The unique identifier
of the stopped Test Result.}
'400': {$ref: '#/components/responses/error_400'}
'401': {$ref: '#/components/responses/error_401'}
'403': {$ref: '#/components/responses/error_403'}
'413': {$ref: '#/components/responses/error_413'}
'429': {$ref: '#/components/responses/error_429'}
'500': {$ref: '#/components/responses/error_500'}
/v3/workspaces/{workspaceId}/test-results/{resultId}/logs:
get:
operationId: GetTestResultLogs
summary: Get the logs from a test result
description: The 1000th first lines of logs (timestamp, content and source)
about a specified test result. If the test result does not have any logs the
result will be an empty list.
tags: [Results]
parameters:
- {$ref: '#/components/parameters/workspace-id'}
- {$ref: '#/components/parameters/result-id'}
responses:
'200':
description: OK
headers:
Access-Control-Allow-Origin:
schema: {type: string}
content:
application/json:
schema: {$ref: '#/components/schemas/TestResultLogs'}
'400': {$ref: '#/components/responses/error_400'}
'401': {$ref: '#/components/responses/error_401'}
'403': {$ref: '#/components/responses/error_403'}
'429': {$ref: '#/components/responses/error_429'}
'500': {$ref: '#/components/responses/error_500'}
/v3/workspaces/{workspaceId}/test-results/{resultId}/events:
get:
operationId: GetTestResultEvents
summary: Test Result events
description: |
List the events of the specified Test Result according to the method parameters.
___
*Sortable fields :*
- offset
- fullname
- code
- source
tags: [Results|Events]
parameters:
- {$ref: '#/components/parameters/workspace-id'}
- {$ref: '#/components/parameters/result-id'}
- {$ref: '#/components/parameters/event_types'}
- {$ref: '#/components/parameters/page_limit'}
- {$ref: '#/components/parameters/page_offset'}
- {$ref: '#/components/parameters/single_sort'}
responses:
'200':
description: OK
headers:
Access-Control-Allow-Origin:
schema: {type: string}
content:
application/json:
schema: {$ref: '#/components/schemas/ArrayOfEventDefinition'}
'400': {$ref: '#/components/responses/error_400'}
'401': {$ref: '#/components/responses/error_401'}
'403': {$ref: '#/components/responses/error_403'}
'404': {$ref: '#/components/responses/error_404'}
'429': {$ref: '#/components/responses/error_429'}
'500': {$ref: '#/components/responses/error_500'}
post:
operationId: PostTestResultCustomEvent
summary: Create a Test Result custom event
description: |
Creates a Test Result custom event.
Custom events stored by this endpoint can be retrieved using the [GetTestResultEvents](#/Results/GetTestResultEvents) endpoint.
Custom events allow you to associate to a Test Result events that occurred outside of NeoLoad.
Custom events can have two different kinds of timeframe:
- INSTANT: an event having a timestamp and a duration of 0 seconds.
- TIME_RANGE: an event having a start timestamp and an end timestamp.
Custom events timestamps are in seconds.
The maximum of custom events per Test Result is 1000.
Custom events must match some constraints, see <a href="#model-PostCustomEventRequest">PostCustomEventRequest model</a> to get more details.
____
tags: [Results|Events]
parameters:
- {$ref: '#/components/parameters/workspace-id'}
- {$ref: '#/components/parameters/result-id'}
requestBody:
content:
application/json:
schema: {$ref: '#/components/schemas/PostCustomEventRequest'}
description: The custom event
required: true
responses:
'201':
description: Created
headers:
Access-Control-Allow-Origin:
schema: {type: string}
content:
application/json:
schema: {$ref: '#/components/schemas/PostCustomEventResponse'}
'400':
description: An error occurred while processing the request. Please verify
the parameters and try again.
content:
application/json:
schema: {$ref: '#/components/schemas/PostCustomEventError'}
'401': {$ref: '#/components/responses/error_401'}
'403': {$ref: '#/components/responses/error_403'}
'404': {$ref: '#/components/responses/error_404'}
'413': {$ref: '#/components/responses/error_413'}
'429': {$ref: '#/components/responses/error_429'}
'500': {$ref: '#/components/responses/error_500'}
/v3/workspaces/{workspaceId}/test-results/{resultId}/events/{eventId}:
patch:
operationId: PatchTestResultCustomEvent
summary: Partially update a Test Result custom event
description: |
Update a field of an existing custom event:
- endTimestamp
- description
- url
Custom events with INSTANT timeframe can be patched to TIME_RANGE timeframe by setting an endTimestamp different than the startTimestamp.
Custom events with TIME_RANGE timeframe can be patched to INSTANT timeframe by setting an endTimestamp equals to the startTimestamp.
Custom events timestamps are in seconds.
Request to patch a custom event has some constraints, see <a href="#model-PatchCustomEventRequest">PatchCustomEventRequest model</a> to get more details.
____
tags: [Results|Events]
parameters:
- {$ref: '#/components/parameters/workspace-id'}
- {$ref: '#/components/parameters/result-id'}
- {$ref: '#/components/parameters/event-id'}
requestBody:
content:
application/json:
schema: {$ref: '#/components/schemas/PatchCustomEventRequest'}
description: The patch of an existing custom event.
required: true
responses:
'200':
description: OK
headers:
Access-Control-Allow-Origin:
schema: {type: string}
content:
application/json:
schema: {$ref: '#/components/schemas/PatchCustomEventResponse'}
'400':
description: An error occurred while processing the request. Please verify
the parameters and try again.
content:
application/json:
schema: {$ref: '#/components/schemas/PatchCustomEventError_400'}
'401': {$ref: '#/components/responses/error_401'}
'403': {$ref: '#/components/responses/error_403'}
'404':
description: Resource not found. Please verify the parameters and try again.
content:
application/json:
schema: {$ref: '#/components/schemas/PatchCustomEventError_404'}
'413': {$ref: '#/components/responses/error_413'}
'429': {$ref: '#/components/responses/error_429'}
'500': {$ref: '#/components/responses/error_500'}
/v3/workspaces/{workspaceId}/test-results/{resultId}/statistics:
get:
operationId: GetTestResultStatistics
summary: Test Result main statistics
description: Provides the main statistics of a Test Result. For a runnning test,
these statistics are live, for a Test Result, those are average for the all
Test Result.
tags: [Results]
parameters:
- {$ref: '#/components/parameters/workspace-id'}
- {$ref: '#/components/parameters/result-id'}
responses:
'200':
description: OK
headers:
Access-Control-Allow-Origin:
schema: {type: string}
content:
application/json:
schema: {$ref: '#/components/schemas/TestResultStatistics'}
'400': {$ref: '#/components/responses/error_400'}
'401': {$ref: '#/components/responses/error_401'}
'403': {$ref: '#/components/responses/error_403'}
'404': {$ref: '#/components/responses/error_404'}
'429': {$ref: '#/components/responses/error_429'}
'500': {$ref: '#/components/responses/error_500'}
/v3/workspaces/{workspaceId}/test-results/{resultId}/elements:
get:
operationId: GetTestResultElements
summary: Test Result elements
description: Provides the tests elements of a Test Result. The elements type
must be provided.
tags: [Results|Elements]
parameters:
- {$ref: '#/components/parameters/workspace-id'}
- {$ref: '#/components/parameters/result-id'}
- name: category
in: query
required: true
description: Category of the elements to return.
schema:
type: string
enum: [TRANSACTION, ACTION, PAGE, REQUEST]
default: TRANSACTION
responses:
'200':
description: OK
headers:
Access-Control-Allow-Origin:
schema: {type: string}
content:
application/json:
schema: {$ref: '#/components/schemas/ArrayOfElementDefinition'}
'400': {$ref: '#/components/responses/error_400'}
'401': {$ref: '#/components/responses/error_401'}
'403': {$ref: '#/components/responses/error_403'}
'404': {$ref: '#/components/responses/error_404'}
'429': {$ref: '#/components/responses/error_429'}
'500': {$ref: '#/components/responses/error_500'}
/v3/workspaces/{workspaceId}/test-results/{resultId}/elements/values:
get:
operationId: GetTestResultAllElementsValues
summary: Values for all elements of a Test Result
description: Provides the values for all elements of a Test Result.
tags: [Results|Elements]
parameters:
- {$ref: '#/components/parameters/workspace-id'}
- {$ref: '#/components/parameters/result-id'}
- name: category
in: query
required: true
description: Category of elements to return.
schema:
type: string
enum: [TRANSACTION, ACTION, PAGE, REQUEST]
default: TRANSACTION
responses:
'200':
description: OK
headers:
Access-Control-Allow-Origin:
schema: {type: string}
content:
application/json:
schema: {$ref: '#/components/schemas/Values'}
'400': {$ref: '#/components/responses/error_400'}
'401': {$ref: '#/components/responses/error_401'}
'403': {$ref: '#/components/responses/error_403'}
'404': {$ref: '#/components/responses/error_404'}
'429': {$ref: '#/components/responses/error_429'}
'500': {$ref: '#/components/responses/error_500'}
/v3/workspaces/{workspaceId}/test-results/{resultId}/elements/{elementId}:
get:
operationId: GetTestResultElementDefinition
summary: Test Result element definition
description: Provides a Test Result element definition.
tags: [Results|Elements]
parameters:
- {$ref: '#/components/parameters/workspace-id'}
- {$ref: '#/components/parameters/result-id'}
- {$ref: '#/components/parameters/element_id'}
responses:
'200':
description: OK
headers:
Access-Control-Allow-Origin:
schema: {type: string}
content:
# --- truncated at 32 KB (158 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/tricentis/refs/heads/main/openapi/tricentis-neoload-openapi.yaml