This chapter contains the sections listed below. The first section provides a summary of all the REST APIs covered in this chapter, whereas the following sections provide an introduction to TaaS, the TaaS resource models and the REST API examples.
The table below shows a summary of all the TaaS REST APIs covered in this chapter.
Table 58-1 Summary of TaaS REST APIs
Resource | Data Model | GET | POST | PUT | DELETE |
---|---|---|---|---|---|
Application Resource |
Not supported |
Not supported |
Not supported |
||
Test driver type |
Not supported |
Not supported |
Not supported |
||
Test driver |
Not supported |
Not supported |
Not supported |
||
Quota usage |
Supported |
Not supported |
Not supported |
Not supported |
|
Test asset |
Not supported |
Not supported |
Not supported |
||
OLT scenario |
Supported |
Not supported |
Not supported |
Not supported |
|
Custom parameters |
Supported |
Not supported |
Not supported |
Not supported |
|
OFT asset script |
Supported |
Not supported |
Not supported |
Not supported |
|
OFT asset script CSV databanks |
Supported |
Not supported |
Not supported |
Not supported |
|
OFT playback settings |
Supported |
Not supported |
Not supported |
Not supported |
|
OFT database databanks |
Supported |
Not supported |
Not supported |
Not supported |
|
Test environment |
Not supported |
Not supported |
Not supported |
||
Test |
|||||
Trial |
|||||
Metric |
Supported |
Not supported |
Not supported |
Not supported |
|
Metric value |
Supported |
Not supported |
Not supported |
Not supported |
|
OLT session |
Supported |
Not supported |
Not supported |
Not supported |
|
OLT counter |
Supported |
Not supported |
Not supported |
Not supported |
|
OLT counter value |
Supported |
Not supported |
Not supported |
Not supported |
|
OFT trial asset execution |
Supported |
Not supported |
Not supported |
Not supported |
|
Test driver instance |
Not supported |
||||
Test environment instance |
Not supported |
||||
Operation |
Supported |
Supported |
Not supported |
Not supported |
|
Test type |
Supported |
Not supported |
Not supported |
Not supported |
|
Target |
Supported |
Not supported |
Not supported |
Not supported |
|
OLT agent |
Supported |
Not supported |
Not supported |
Not supported |
Note:
In the table above, “supported" indicates that the operation is supported on the resource. However, there is no example in the chapter for this operation.
Using the TaaS REST API, you can:
Interact with the TaaS application without accessing the TaaS user interface.
Run TaaS functions in script form.
Easily integrate TaaS with your existing applications and systems.
The TaaS REST API is implemented using the RESTful (Representational State Transfer) Web Service.A complete explanation about the Cloud REST APIs is available in Introduction to Cloud APIs.
The following diagram shows how a Tester uses Testing as a Service:
Figure 58-1 Testing Cloud End User Activities
Here are a few tasks and operations you can perform using the TaaS REST API:
Tests
List/view/create/update/delete tests and list all trials that belong to a test.
Quota and Usage
See overall quota usage of a user.
Trials
View/create/update/delete trials of a trial and its operations/details on Trial Home page.
Test Asset/Test Environment
List/view test asset and test environments being published to TaaS user.
Test Driver/Environment Instances
List/view/create/update/delete/start/stop instances of test driver and test environment.
The purpose of using Testing as a Service is to create tests and then run trials using the tests. Figure 58-2 shows the resources used to define tests and the trials.
Simply put:
Test driver types are used when defining test assets.
Test assets, test environments, targets, and test drivers are used when defining tests.
Tests, test environment instances, and test driver instances are used when defining trials.
Figure 58-2 shows these resources and their relationships.
Figure 58-2 TaaS Resources Relationship Diagram
Most resources have common attributes such as context_id and uri. context_id is an identifier which could be a GUID or a unique ID of the corresponding entity in the database table.
Methods GET/POST/PUT/DELETE (corresponding to read/create/update/delete methods) are standard HTTP methods. Usually GET means find/query, POST means create, PUT means update, and DELETE means delete/remove. For example, when a field is marked as '[POST] required', this means that when you create a resource (use the POST method), you must provide this field.
The available resources are:
Application types are used by Test Designers when creating Test Assets and Test Environments. The application type is metadata used to organize test related activities
The following table describes the Application resource model.
Table 58-2 Application Resource Data Model
Field | Type | Description |
---|---|---|
uri |
String |
URI of the resource |
name |
String |
Name of the application |
contextId(id) |
Long |
Context ID of the application |
The following table lists the methods supported in the Application resource.
Table 58-3 Supported Methods for Application Resource
Method | Description | Sample URI |
---|---|---|
LIST (GET without contextId) |
Returns a list of applications |
/em/websvcs/restful/extws/cloudservices/taas/v1/applications |
GET |
Returns an application by ID. |
/em/websvcs/restful/extws/cloudservices/taas/v1/applications/1 |
The TestDriverType (Test Driver Type) resource defines the type of Test Driver.
Table 58-4 TestDriverType Resource Data Model
Field | Type | Description |
---|---|---|
uri |
String |
URI of the resource |
name |
String |
Name of the custom test driver type |
contextId(id) |
Long |
Context ID of the test driver type |
testTypeUri |
String |
URI of test type (Oracle Load Testing, Oracle Functional Testing, or Custom) |
testTypeName |
String |
Name of test type |
The following table lists the methods supported in the TestDriverType resource.
Table 58-5 Supported Methods for TestDriverType Resource
Method | Description | Sample URI |
---|---|---|
LIST (GET without context_id) |
Returns a list of a test driver types |
/em/websvcs/restful/extws/cloudservices/taas/v1/test_driver_types |
GET |
Returns a test driver type by ID. |
/em/websvcs/restful/extws/cloudservices/taas/v1/test_driver_types/1 |
The TestDriver (Test Driver) resource is the package of software that Enterprise Manager uses to generate tests or workload against test systems based on a deployment plan.
Table 58-6 TestDriver Resource Data Model
Field | Type | Description |
---|---|---|
uri |
String |
URI of the resource |
name |
String |
Name of the test driver |
testDriverTypeUri |
String |
URI of the test driver type being set to this test driver |
testDriverTypeName |
String |
Test driver type name of the test driver |
version |
String |
Version of the test driver |
description |
String |
Description of the test driver |
contextId(guid) |
String |
Context ID of the test driver |
resultsStorage |
String |
Result storage type of the Oracle Functional Testing test driver |
resultFileSystem |
OftRfsEntity |
Detailed result file system information for Oracle Functional Testing test driver, if the 'resultsStorage' attribute is 'rfs'. |
Table 58-7 Supported Methods for the TestDriver Resource
Method | Description | Sample URI |
---|---|---|
LIST (GET without context_id) |
Returns a list of test drivers |
/em/websvcs/restful/extws/cloudservices/taas/v1/test_drivers |
GET |
Returns a test driver by GUID |
/em/websvcs/restful/extws/cloudservices/taas/v1/test_drivers/C0D0F1A8F11A2EA1E040E50A42BB70CF |
OftRfsEntity Subtype
The OftRfsEntity (Oracle Functional Testing RFS Entity) subtype represents a NFS (Network File System) that provides the file storage service, and optional access to the stored file with HTTP protocol, for the end user.
Table 58-8 OftRfsEntity Subtype
Field | Type | Description |
---|---|---|
name |
String |
Name of the result file system |
exportPath |
String |
Export path for the result file system |
httpAccessUrl |
String |
HTTP URL to access the result file system |
The QuotaUsage (Quota Usage) resource represents usage quotas for Testers by specific roles, including the Number of Guest VMs (Virtual Machines), Number of CPUs, Memory (GB), Storage Size (GB), and Number of VUs (Virtual Users).
Table 58-9 QuotaUsage Resource Data Model
Field | Type | Description |
---|---|---|
uri |
String |
URI of the resource |
maxNumberOfGuestVM |
Long |
Maximum number of guest Virtual Machines that are allowed to be assigned to the role |
maxNumberOfCpu |
Long |
Maximum number of CPUs that are allowed to be assigned to the role |
maxMemory |
Double |
Maximum amount of memory that is allowed to be assigned to the role |
maxStorageSize |
Double |
Maximum amount of storage that is allowed to be assigned to the role |
maxNumberOfVU |
Long |
Maximum number Virtual Users that are allowed to be assigned to the role |
numberOfCpu |
Long |
Number of CPUs used |
numberOfGuestVM |
Long |
Number of guest Virtual Machines used |
memory |
Double |
Amount of memory |
storageSize |
Double |
Amount of storage used |
numberOfVU |
Long |
Number of Virtual Users used |
The following table lists the methods supported in the QuotaUsage resource.
Table 58-10 Supported Methods for QuotaUsage Resource
Method | Description | Sample URI |
---|---|---|
GET |
Returns quota and usage of current user. |
/em/websvcs/restful/extws/cloudservices/taas/v1/quota_usage/user_quota_usage |
A Test Asset is a collection of test artifacts (scenarios, scripts, tests) that can be executed on a test environment. A test asset defines the actions that need to be executed to reproduce the workload against the test environment.
Table 58-11 Test Asset Resource Data Model
Field | Type | Description |
---|---|---|
uri |
String |
URI of the resource |
name |
String |
Name of the test asset |
testDriverTypeUri |
String |
URI of the test driver type of the test asset. (Oracle Functional Testing, Oracle Load Testing, or Custom test drivers) |
testDriverTypeName |
String |
Name of the test driver type of the test asset (Oracle Functional Testing, Oracle Load Testing or Custom test drivers) |
applicationUri |
String |
URI of the application being associated with this test asset |
applicationName |
String |
Name of the application being associated with this test asset |
tags |
String |
Tags of the test asset. A tag is a keyword assigned to an asset. Tags help describe the test asset and allows it to be found again in browsing or searching. |
lastModified |
String (ISO 8601 date) |
Last time the test asset was modified |
owner |
String |
User name of the owner |
contextId(guid) |
String |
Context ID of the test asset |
oltTestAssetSettings |
OltTestAssetSettings |
Specific test asset settings for Oracle Load Testing test asset. |
oftTestAssetSettings |
OftTestAssetSettings |
Specific test asset settings for Oracle Functional Testing test asset |
customTestAssetSettings |
CustomTestAssetSettings |
Specific test asset settings for Custom test asset |
The following table lists the methods supported in the TestAsset resource.
Table 58-12 Supported Methods for TestAsset Resource
Method | Description | Sample URI |
---|---|---|
LIST (GET without context_id) |
Returns a list of test assets being published to current user |
/em/websvcs/restful/extws/cloudservices/taas/v1/test_assets |
GET |
Returns attributes of test asset by GUID. |
/em/websvcs/restful/extws/cloudservices/taas/v1/test_assets/C0D0F1A8F11A2EA1E040E50A42BB70CF |
OltTestAssetSettings Subtype
Use the OltTestAssetSettings subtype to provide specific test settings for the Oracle Load Testing test asset.
Table 58-13 OltTestAssetSettings Subtype
Field | Type | Description |
---|---|---|
vuCountEditable |
Boolean |
Whether script VU counts are editable |
rampupSettingEditable |
Boolean |
Whether rampup is editable |
endConditionEditable |
Boolean |
Whether end condition is editable |
oltScenarioFileDownloadUri |
String |
URI of the Oracle Load Testing test scenario file download location |
oltScenarioUri |
String |
URI of the Oracle Load Testing scenario details |
OftTestAssetSettings Subtype
Use OftTestAssetSettings subtype to provide specific test settings for the Oracle Functional Testing test asset.
Table 58-14 OftTestAssetSettings Subtype
Field | Type | Description |
---|---|---|
scriptDetailsUri |
String |
URI for the Oracle Functional Testing script details |
scriptFileUri |
String |
URI used to indicate the download URL for the Oracle Functional Testing script zip file |
CustomTestAssetSettings Subtype
Use the CustomTestAssetSettings subtype to provide specific test settings for the Oracle Custom test asset.
Table 58-15 CustomTestAssetSettings Subtype
Field | Type | Description |
---|---|---|
scriptFileDownloadUri |
String |
URI of the custom script file download location |
customParametersUri |
String |
URI of the custom parameters |
OltScenario (Oracle Load Testing OLT Scenario) represents detail scenario information for an Oracle Load Testing Test Asset.
Table 58-16 OltScenario Resource Data Model
Field | Type | Description |
---|---|---|
uri |
String |
URI of the resource |
testAssetContextId |
String |
Context ID of the test asset |
testAssetUri |
Strong |
URI of the test asset |
hardwareEstimationAvailable |
Boolean |
Whether hardware estimation is available for this scenario |
ramupDescription |
String |
Description of test asset default rampup setting |
endConditionDescription |
String |
Description of test asset default end condition |
scriptVuCounts |
OltScript |
VU counts for scripts in the scenario |
The following table lists the method supported in the OltScenario resource.
Table 58-17 Supported Method for OltScenario Resource
Method | Description | Sample URI |
---|---|---|
GET |
Returns Oracle Load Testing Scenario |
em/websvcs/restful/extws/cloudservices/taas/v1/test_assets/DFF34956DD08E27AE040F50A351D3DB5/olt_scenario |
OltScript Subtype
Use the OltScript subtype to identify the Oracle Load Testing script.
Table 58-18 OltScript Subtype
Field | Type | Description |
---|---|---|
name |
String |
Name of the script |
vuCount |
Integer |
Number of virtual user count |
Custom Parameters is a collection of custom parameter settings for custom Test Asset or custom Trial.
Table 58-19 CustomParameters Resource Data Model
Field | Type | Description |
---|---|---|
uri |
String |
URI of the resource |
parameters |
List of CustomParameter |
List of custom parameter |
The following table lists the method supported in the CustomParameters resource.
Table 58-20 Supported Method for CustomParameter Resource
Method | Description | Sample URI |
---|---|---|
GET |
Returns custom parameters |
|
CustomParameter Subtype
The customParameter subtype is used in custom test asset or custom trial. Each customParameter represents a custom defined parameter.
Table 58-21 CustomParameter Subtype
Field | Type | Description |
---|---|---|
name |
String |
Name of the parameter |
value |
String |
Value of the parameter |
defaultValue |
String |
Default value of the parameter |
configurable |
Boolean |
Is the parameter configurable |
OFTAssetScript (Oracle Functional Testing Asset Script) represents the detailed data for a script (in zip format) of an Oracle Functional Testing test asset. URI for more detailed data (if available), for example, the Open Script script information, databanks, playback settings, are retrievable from this resource.
Table 58-22 OFTAssetScript Resource Data Model
Field | Type | Description |
---|---|---|
uri |
String |
URI of the resource |
testAssetContextId |
String |
Context ID for the test asset |
testAssetUri |
String |
URI for the test asset |
scripts |
List of OftScriptEntity |
List of detailed data for each Open Script script inside this asset script zip file |
urlsInsideScripts |
List of String |
List of URLS inside the Open Script scripts of this Oracle Functional Testing asset script zip file |
csvDatabanksUri |
String |
URI for the resource that represents the comma-separated value (CSV) databanks |
playbackSettingsUri |
String |
URI for the resource that represents the playback settings |
dbDatabanksUri |
String |
URI the resource that represents the database databanks |
The following table lists the methods supported in the OFTAssetScript resource.
Table 58-23 Supported Methods for OFTAssetScript Resource
Method | Description | Sample URI |
---|---|---|
GET |
Returns Oracle Functional Testing test asset script by asset GUID. |
/em/websvcs/restful/extws/cloudservices/taas/v1/test_assets/E3F48FC047CCE9E5E040F50A2D1E128E/oft_script_details |
OftScriptEntity Subtype
Use the OftScriptEntity subtype to provide the specific details for the Oracle Functional Testing script entity.
Table 58-24 OftScriptEntity Subtype
Field | Type | Description |
---|---|---|
name |
String |
Name of the Open Script script |
type |
String |
Type of Open Script script |
version |
String |
Version of the Open Script script |
encrypted |
Boolean |
Indicates if the script is encrypted or not |
modules |
List of OftScriptModuleEntity |
Modules defined and used in this Open Script script |
OftScriptModuleEntity Subtype
Use the OftScriptModuleEntity subtype to provide the specific details for the Oracle Functional Testing script module entity.
Table 58-25 OftScriptModuleEntity Subtype
Field | Type | Description |
---|---|---|
name |
String |
Name of the Open Script module |
The OftAssetScriptCsvDatabanks (Oracle Functional Testing Asset Script Comma-Separated Values Databanks) resource represents a list of CSV databank. The OFT Asset Script CSV Databanks resource is represented with type CsvDatabankCollection.
Databanks are used to hold unlimited amounts of input data that can be automatically fed into your Web application.
Table 58-26 OftAssetScriptCsvDatabanks Resource Data Model
Field | Type | Description |
---|---|---|
uri |
String |
URI of the resource |
testAssetContextId |
String |
Context ID of the test asset |
testAssetUri |
String |
URI for the test asset |
scriptDetails |
String |
URI for the asset script details |
csvDatabanks |
List of OftAssetCsvDatabankEntity |
List of detailed data for all CSV databanks inside the Oracle Functional Testing asset script |
The following table lists the method supported in the OftAssetScriptCsvDatabanks resource.
Table 58-27 Supported Method for OftAssetScriptCsvDatabanks Resource
Method | Description | Sample URI |
---|---|---|
LIST (GET without context_id) |
Returns a list of csv databanks for the specified test asset script |
/em/websvcs/restful/extws/cloudservices/taas/v1/test_assets/E3F48FC047CCE9E5E040F50A2D1E128E/oft_script_details/csv_data_banks |
CsvDatabank Subtype
Use the CsvDatabank subtype to provide the specific details for the Oracle Functional Testing asset script resource.
Table 58-28 CsvDatabank Subtype
Field | Type | Description |
---|---|---|
name |
String |
Name of the csv databank |
contents |
String |
Contents inside the comma-separated value (CSV) databank |
The OftPlaybackSettings (Oracle Functional Testing Playback Settings) resource represents all the playback settings configuration for a script.
Table 58-29 OftPlaybackSettings Resource Data Model
Field | Type | Description |
---|---|---|
uri |
String |
URI of the resource |
testAssetContextId |
String |
Context ID for the test asset |
TestAssetUri |
String |
URI for the test asset |
scriptDetailsUri |
Script |
URI for the asset script details |
values |
String |
Playback settings configuration contents for the asset script |
The following table lists the method supported in the OftPlaybackSettings resource.
Table 58-30 Supported Methods for OftPlaybackSetting Resource
Method | Description | Sample URI |
---|---|---|
GET |
Returns playback settings for specified Oracle Functional Testing asset script |
/em/websvcs/restful/extws/cloudservices/taas/v1/test_assets/E3F48FC047CCE9E5E040F50A2D1E128E/oft_script_details/playback_settings |
The OftDatabaseDatabanks (Oracle Functional Testing Database Databanks) resource represents a list of database databanks for a specified Oracle Functional Testing test asset. OftDatabaseDatabanks is represented with type DbDatabankCollection.
Databanks are used to hold unlimited amounts of input data that can be automatically fed into your Web application.
Table 58-31 OftDatabaseDatabanks Resource Data Model
Field | Type | Description |
---|---|---|
uri |
String |
URI of the resource |
testAssetContextId |
String |
Context ID for the test asset |
testAssetUri |
String |
URI for the test asset |
scriptDetailsUri |
String |
URI for the asset script details |
databaseDatabanks |
List of OftScriptDbDatabankEntity |
List of detailed data for all database databanks inside the Oracle Functional Testing asset script |
The following table lists the methods supported in the OftDatabaseDatabanks resource.
Table 58-32 Supported Methods for OftDatabaseDatabanks Resource
Method | Description | Sample URI |
---|---|---|
LIST (GET without id parameter) |
Returns a list of database databanks for the specified test asset script |
/em/websvcs/restful/extws/cloudservices/taas/v1/test_assets/E3F708CCD6CAC1E6E040F50A2D1E4ADE/oft_script_details/db_data_banks |
OftScriptDbDatabankEntity Subtype
Use the OftScriptDbDatabankEntity subtype to provide the specific details for the Oracle Functional Testing script database databank entity resource.
Table 58-33 OftScriptDbDatabankEntity Subtype
Field | Type | Description |
---|---|---|
alias |
String |
Alias of the database databank |
driver |
String |
Driver for the database databank |
connectUrl |
String |
Connection URL for the database databank |
userName |
String |
User name for the database databank |
sql |
String |
SQL string defined inside the database databank |
TestEnvironment is a collection of resources that represents the entire application stack.
Table 58-34 TestEnvironment Resource Data Model
Field | Type | Description |
---|---|---|
uri |
String |
URI of the resource |
name |
String |
Name of the test environment |
applicationUri |
String |
URI of the application of this test environment. |
applicationName |
String |
Name of the application of this test environment |
tags |
String |
Tags of the test environment |
owner |
String |
User name of the owner of this test environment |
description |
String |
Description of the test environment |
lastModified |
String (ISO 8601 date) |
Last modified date of the test environment |
contextId |
String |
Context ID (GUID) of the test environment |
The following table lists the methods supported in the TestEnvironment resource.
Table 58-35 Supported Methods for TestEnvironment Resource
Method | Description | Sample URI |
---|---|---|
LIST (GET without ID parameter) |
Returns a list of test environments being published to current user |
/em/websvcs/restful/extws/cloudservices/taas/v1/test_environments |
GET |
Returns test environment by GUID |
/em/websvcs/restful/extws/cloudservices/taas/v1/test_environments/C0D0F1A8F11A2EA1E040E50A42BB70CF |
Note: Test is a parent resource of the Trial resource.
Testers use this resource to create tests from test assets and test environments to perform testing activities. Testers create tests using test assets and environments that have been assigned to them by the Test Administrator.
Table 58-36 Test Resource Data Model
Field | Type | Description |
---|---|---|
uri |
String |
URI of the resource |
name |
String |
Name of the test. When using the POST method, name is required. When using the PUT method, name is optional. |
testDriverTypeUri |
String |
URI of the test driver type |
testDriverTypeName |
String |
Name of the test driver type |
description |
String |
Description of the test. [POST] [PUT] optional |
testAssets |
List of AssetInTestEntity |
List of the test assets of this test. For Oracle Load Testing or custom test, one asset is used. For Oracle Functional Testing test, one or more test assets could be defined.[POST][PUT] required |
testEnvironmentUri |
String |
URI of the test environment of this test |
testEnvironmentName |
String |
Name of the test environment of this test |
useEnvironmentLibrary |
Boolean |
Returns true if the associated test environment is from 'my library'. Returns false if the associated test environment is an existing Enterprise Manager target |
systemTargetUri |
String |
Returns true if the associated test environment is from 'my library'. Returns false if the associated test environment is an existing Enterprise Manager target |
testDriverUri |
String |
URI of the test driver of this test |
testDriverName |
String |
Name of the test driver of this test |
replaceUrls |
List of ReplaceUrl |
A list of replace URLs for this test asset. Only for Oracle Functional Testing test, multi (more than one) replace URLs are supported. [POST][PUT] optional, if null using default setting. |
trialsUri |
String |
URI of all trials of this test |
contextId(guid) |
String |
GUID of the test |
testEnvironmentContextId |
String |
GUID of the test environment. [POST][PUT] optional. |
systemTargetContextId |
String |
GUID of the Enterprise Manager target. [POST][PUT] optional. |
testDriverContextId |
String |
GUID of the test driver. [POST][PUT] optional. |
The following table lists the methods supported in the Test resource.
Table 58-37 Supported Methods for Test Resource
Method | Description | Sample URI |
---|---|---|
LIST (GET without context_id) |
Returns a list of tests of the current user |
/em/websvcs/restful/extws/cloudservices/taas/v1/tests |
GET |
Returns test by GUID as context_id |
/em/websvcs/restful/extws/cloudservices/taas/v1/tests/C0D0F1A8F11A2EA1E040E50A42BB70CF |
POST |
Create a new test. context_id should be null in request. It returns the URI of new created test. |
/em/websvcs/restful/extws/cloudservices/taas/v1/tests/ |
PUT |
Update attributes of a test |
/em/websvcs/restful/extws/cloudservices/taas/v1/tests/C0D0F1A8F11A2EA1E040E50A42BB70CF |
DELETE |
Delete a test |
/em/websvcs/restful/extws/cloudservices/taas/v1/tests/C0D0F1A8F11A2EA1E040E50A42BB70CF |
AssetInTestEntity Subtype
Use the AssetInTestEntity subtype to provide the specific details for the test asset used in the Test resource.
Table 58-38 AssetInTestEntity Subtype
Field | Type | Description |
---|---|---|
testAssetContextId |
String |
Context ID of the test asset resource |
testAssetUri |
String |
GUID of the test environment. [POST][PUT] optional. |
testAssetName |
String |
Name of the test asset |
ReplaceUrl Subtype
Represents a URL replacing a recorded script within test asset. While a trial is running, a URL starting with the specified segment will be replaced by the given string before the URL request is sent.
Table 58-39 ReplaceUrl Subtype
Field | Type | Description |
---|---|---|
originalUrl |
String |
Original recorded URL in the script of the Test Asset. This field is optional for the POST and PUT methods. |
newUrl |
String |
New URL to replace original URL This field is optional for the POST and PUT methods. |
replaceType |
String |
Value of KEEP_SAME, FROM_APPLIANCE, SPECIFIED. KEEP_SAME: newUrl is ignored. FROM_APPLIANCE newUrl is set from test environment appliance. SPECIFIED: originalUrl is replaced by newUrl that provided by user. |
Note: Trial is a child resource of Test.
Testers to create and run trials from the test instances that have been created. The Tester runs trials on the test asset and environment, monitors ongoing trials, and analyzes the results of completed trials.
Table 58-40 Trial Resource Model Data Model
Field | Type | Description |
---|---|---|
uri |
String |
URI of the resource |
name |
String |
Name of the trial. [POST] required [PUT] optional |
testUri |
String |
URI of the associated test |
testName |
String |
Name of the associated test |
testContextId |
String |
Context ID of the test. [POST][PUT] required |
testEnvironmentInstanceContextId |
String |
Context ID of the test environment instance. [POST][PUT] required if Test Environment is selected by its Test, and testEnvironmentInstanceName testEnvironmentInstancePassword are not provided |
testEnvironmentInstanceUri |
String |
URI of the associated test environment instance |
testEnvironmentInstanceName |
String |
Name of the associated test environment instance. [POST][PUT] required if Test Environment is selected by its Test, and testEnvironmentInstanceContextId is not provided |
testEnvironmentInstancePassword |
String |
Password of the new environment instance is going to create. [POST][PUT] required if Test Environment is selected by its Test, and testEnvironmentInstanceContextId is not provided |
testEnvironmentInstanceStopDelaySeconds |
Long |
Stop test environment instance delay seconds after trial complete. [POST][PUT] optional |
testEnvironmentInstanceDeleteDelaySeconds |
Long |
Delete test environment instance delay seconds after trial complete. [POST][PUT] optional, ignored if the testEnvironmentInstanceContextId is provided. |
testDriverInstanceContextId |
String |
Context ID of the test driver instance. [POST][PUT] required if testDriverInstanceName and testDriverInstancePassword are not provided |
testDriverInstanceUri |
String |
URI of the test driver instance |
testDriverInstanceName |
String |
Name of test driver instance. [POST][PUT] required if testDriverInstanceContextId is not provided. |
testDriverInstancePassword |
String |
Password of the new test driver instance is going to create. [POST][PUT] required if testDriverInstanceContextId is not provided. |
testDriverInstanceStopDelaySeconds |
Long |
Delay seconds to stop the test driver instance after trial complete. [POST][PUT] optional |
testDriverInstanceDeleteDelaySeconds |
Long |
Delay seconds to delete test driver instance after trial is complete. [POST][PUT] optional, ignored if the testDriverInstanceContextId is provided. |
description |
String |
Description of the trial. [POST][PUT] optional |
owner |
String |
User name of the user of this trial |
status |
String |
Status of this trial |
startTime |
String (ISO 8601 date time) |
Scheduled start time of this trial. [POST][PUT] optional |
endTime |
String (ISO 8601 date time) |
End time of this trial. |
testingExistedSystem |
Boolean |
Test is defined as testing existed target system |
executionLog |
String |
Execution log of the trial |
metricsUri |
String |
URI of the Enterprise Manager metrics collected by the trial. |
awrDownloadUri |
String |
URI of the AWR report download place generated by the trial. |
operationsUri |
String |
URI of the operations available for the trial. |
contextId(guid) |
String |
GUID of the trial |
oltTrialSettings |
String |
Specific trial settings for Oracle Load Testing. [POST][PUT] optional, using default setting from test asset if null |
customTrialSettings |
String |
Specific trial settings for Custom.[POST][PUT] optional, using default setting from test asset if null. |
oftAssetExecutions |
String |
Specific Oracle Functional Testing trial asset execution configuration and result data. [POST][PUT] optional, using default settings from test assets if this is null |
The following table lists the methods supported in the Trial resource.
Table 58-41 Supported Methods for Trial Resource
Method | Description | Sample URI |
---|---|---|
LIST (GET without context_id parameter) |
Returns a list of trials of a test being owned by current user. |
/em/websvcs/restful/extws/cloudservices/taas/v1/trials |
GET |
Returns a trial by context_id (GUID) |
/em/websvcs/restful/extws/cloudservices/taas/v1/trials/C0D0F1A8F11A2EA1E040E50A42BB70CE |
POST |
Creates a new trial |
/em/websvcs/restful/extws/cloudservices/taas/v1/trials |
PUT |
Updates a trial by context_id. |
/em/websvcs/restful/extws/cloudservices/taas/v1/trials/C0D0F1A8F11A2EA1E040E50A42BB70CE |
DELETE |
Deletes a trial by context_id. |
/em/websvcs/restful/extws/cloudservices/taas/v1/trials/C0D0F1A8F11A2EA1E040E50A42BB70CE |
OltTrialSettings Subtype
Use the OltTrialSettings subtype to provide specific trial settings for the Oracle Load Testing trial.
Table 58-42 Oracle Load Testing Trial Settings Subtype
Field | Type | Description |
---|---|---|
oltSessionName |
String |
Name of the Oracle Load Testing session |
oltSessionUri |
String |
URI of the Oracle Load Testing session resource |
rampup |
OltRampup |
Oracle Load Testing rampup setting. [POST][PUT] optional, using default setting from test asset if null |
endCondition |
OltEndCondition |
Oracle Load Testing trial end condition setting. [POST][PUT] optional, using default setting from test asset if null |
scriptVuCounts |
OltScript |
Script VU counts setting. Refer to the details on OltScript in OltTestAssetSettings. [POST][PUT] optional, using default setting from test asset if null |
numberOfAgentDeployments |
Long |
Number of agent deployments |
OltRampup Subtype
Use the OltRampup subtype to provide the specific details for the rampup settings used in the Oracle Load Testing trial. OltRampup represents the rate at which an OLT trial starts running virtual users.
Table 58-43 OltRampup Subtype
Field | Type | Description |
---|---|---|
rampupOption |
Integer |
Rampup setting option. Value from 1,2,3,4.
|
user |
Integer |
Number of users [POST][PUT] required if rampupOption 1,2 |
percent |
Double |
Number of percent [POST][PUT] required if rampupOption 3,4 percent - Specifies a percentage of the virtual users to start at a time based on the After setting. After every - Specifies how often the specified number or percentage of virtual users start running. After every has the following options: seconds, iterations. |
seconds |
Long |
Number of seconds [POST][PUT] required if rampupOption 1,3 |
iterations |
Long |
Number of iterations [POST][PUT] required if rampupOption 2,4 |
OltEndCondition Subtype
Use the OltEndCondition subtype to provide the specific end conditions used in the Oracle Load Testing trial.
Table 58-44 OltEndCondition Subtype
Field | Type | Description |
---|---|---|
endConditionOption |
Integer |
End condition option. Value from 1,2. 1: end after X seconds 2: end after X iterations |
afterSeconds |
Long |
Number of seconds. [POST][PUT] required if endConditionOption 1 |
afterIterations |
Long |
Number of iterations. [POST][PUT] required if endConditionOption 2 |
CustomTrialSettings Subtype
Use the CustomTrial Settings subtype to provide the specific custom trial settings used in the trial resource.
Table 58-45 CustomTrialSettings Subtype
Field | Type | Description |
---|---|---|
resultAvailable |
Boolean |
States whether the custom result is available. This field is read only. |
resultStatus |
String |
Status of custom result. Value from RESULT_PASSED, RESULT_FAILED, RESULT_PASSED_WITH_WARN |
resultDownloadUri |
String |
URI of result file download place. |
customParametersUri |
String |
URI of custom parameters. |
parameters |
List of CustomParameter |
The custom parameters setting for custom trial. Refer to CustomParameter definition on CutomTestAssetSettings. [POST][PUT] optional, using default setting from test asset if null. |
OftAssetExecutionCollection Subtype
Use the OftAssetExecutionCollection subtype to provide the specific Oracle Functional Testing asset execution collection settings used in the trial resource.
Table 58-46 OftAssetExecutionCollection Subtype
Field | Type | Description |
---|---|---|
trialContextId |
String |
Context ID for the trial |
trialUri |
String |
URI for the trial |
totalAssets |
Integer |
Number of total assets for this trial. |
passedAssets |
Integer |
Number of passed assets for this trial. |
failedAssets |
Integer |
Number of failed assets for this trial. |
warningAssets |
Integer |
Number of warning assets for this trial. |
notExecutedAssets |
Integer |
Number of not executed assets for this trial. |
assetExecutions |
List of OftTrialAssetExecution |
List of executions that represent the execution and playback of all asset scripts for this trial. |
Enterprise Manager target metric monitored by a Trial.
Table 58-47 Metric Resource Data Model
Field | Type | Description |
---|---|---|
uri |
String |
URI of the resource |
contextId(trial_metric_id) |
String |
Trial metric ID of the metric. |
trialContextId |
Long |
Context ID the trial refers to |
trialUri |
String |
URI of the trial |
metricName |
String |
Name of the metric |
metricValuesUri |
String |
URI of MetricValues |
The following table lists the methods supported in the Metric resource.
Table 58-48 Supported Methods for Metric Resource
Method | Description | Sample URI |
---|---|---|
LIST (GET without context_id parameter) |
Returns a list of metrics |
em/websvcs/restful/extws/cloudservices/taas/v1/trials/E0306FAA6635149DE040F50A351D0350/metrics |
GET |
Returns a metric |
em/websvcs/restful/extws/cloudservices/taas/v1/metrics/1085 |
Note: Enterprise Manager metric value.
The value of a metric at a specific time stamp.
Table 58-49 MetricValue Resource Data Model
Field | Type | Description |
---|---|---|
metricContextId |
String |
Trial metric ID of the metric |
metricUri |
String |
URI of the metric |
metricName |
String |
Name of the metric |
metricValue |
Double |
Number of metric value |
collectionDate |
String (ISO 8601 date) |
Date and time value when metric value is collected. |
The following table lists the method supported in the MetricValue resource.
Table 58-50 Supported Method for MetricValue Resource
Method | Description | Sample URI |
---|---|---|
LIST (GET without context_id parameter) |
Returns a list of metric values |
em/websvcs/restful/extws/cloudservices/taas/v1/metrics/1085/metric_values |
Note: Only application to Oracle Load Testing trial.
The OltSession (Oracle Load Testing Session) associated with a Oracle Load Testing trial.
Table 58-51 OltSession Resource Data Model
Field | Type | Description |
---|---|---|
uri |
String |
URI of this entity |
contextId(olt session run id) |
String |
Session run ID of the Oracle Load Testing session |
trialUri |
String |
URI of the trial |
trialContextId |
String |
Context of the trial |
oltCountersUri |
String |
URI of the Oracle Load Testing counters |
sessionName |
String |
Name of the Oracle Load Testing session |
startTime |
String (ISO 8601 date) |
Start time of the session |
finishTime |
String (ISO 8601 date) |
Finish time of the session |
The following table lists the methods supported in the OltSession resource.
Table 58-52 Supported Methods for OltSession Resource
Method | Description | Sample URI |
---|---|---|
GET |
Returns an Oracle Load Testing session |
em/websvcs/restful/extws/cloudservices/taas/v1/trials/E082496BD7336A9EE040F50A351D4F28/olt_session |
Note: Only applicable to Oracle Load Testing trial.
The OltCounter (Oracle Load Testing Counter) monitored by Oracle Load Testing trial.
Table 58-53 OltCounter Resource Data Model
Field | Type | Description |
---|---|---|
uri |
String |
URI of this entity |
oltSessionContextId |
String |
ID of the counter |
oltSessionUri |
String |
URI of the Oracle Load Testing session |
counterName |
String |
Name of the counter. For example, Hits/sec, Number of VUs, and Trans/sec |
objectName |
String |
Script object name of the counter |
instanceName |
String |
Step instance name of the counter. E.g. {Run: MedRecAppScript}.{[2] Oracle WebLogic Server - Medical Record Sample Application} |
niceName |
String |
User-friendly display name of the counter |
oltCounterValuesUri |
String |
URI of OltCounterValues |
The following table lists the methods supported in the OltCounter resource.
Table 58-54 Supported Methods for OltCounter Resource
Method | Description | Sample URI |
---|---|---|
LIST (GET without context_id parameter) |
Returns a list of Oracle Load Testing counters |
em/websvcs/restful/extws/cloudservices/taas/v1/olt_sessions/81/olt_counters |
GET |
Returns an Oracle Load Testing counter |
em/websvcs/restful/extws/cloudservices/taas/v1/olt_counters/81/1671 |
The value of Oracle Load Testing counter at specific time stamp.
Table 58-55 OltCounterValue Resource Data Model
Field | Type | Description |
---|---|---|
oltSessionUri |
String |
URI of the Oracle Load Testing session |
oltCounterUri |
String |
URI of the Oracle Load Testing counter |
counterValue |
Double |
Value of the counter |
couterTime |
String (ISO 8601 date) |
Time the counter value is collected. |
The following table lists the method supported in the OltCounterValue resource.
Table 58-56 Supported Method for OltCounterValue Resource
Method | Description | Sample URI |
---|---|---|
LIST (GET without context_id parameter) |
Returns a list of Oracle Load Testing counters |
em/websvcs/restful/extws/cloudservices/taas/v1/olt_counters/81/1671/olt_counter_values |
This resource represents details (configuration and results) of an Oracle Functional Testing test asset script execution (playback).
Table 58-57 OftTrialAssetExecution Resource Data Model
Field | Type | Description |
---|---|---|
uri |
String |
URI of the resource |
contextId |
String |
Context ID for the Oracle Functional Testing trial asset execution. |
trialContextId |
String |
Context ID of the Oracle Functional Testing trial |
trialUri |
String |
URI of the Oracle Functional Testing trial |
assetContextId |
String |
Context ID of the asset |
assetUri |
String |
URI of the asset |
configuration |
AssetConfigurationEntity |
Configuration of the Oracle Functional Testing trial asset execution. |
executionResult |
AssetResultEntity |
Result of the Oracle Functional Testing trial asset execution. |
The following table lists the method supported in the OftTrialAssetExecution resource.
Table 58-58 Supported Method for OftTrialAssetExecution Resource
Method | Description | Sample URI |
---|---|---|
GET |
Returns data of an Oracle Functional Testing trial execution by trial and execution context ID |
/em/websvcs/restful/extws/cloudservices/taas/v1/trials /E3F85B2946C890BAE040F50A2D1E2D1B/executions /E3F85B2946C990BAE040F50A2D1E2D1B |
AssetConfigurationEntity Subtype
Use the AssetConfigurationEntity subtype to provide the specific asset configuration entity settings used in the Oracle Functional Testing Trial Asset Execution resource.
Table 58-59 AssetConfigurationEntity Subtype
Field | Type | Description |
---|---|---|
runAlways |
Boolean |
Configure if the execution will always run without considering previous errors. |
continueOnWarning |
Boolean |
Configure if the execution will always run without considering previous errors. |
continueOnError |
Boolean |
Configure if the execution will continue to run in the event there are errors in the previous execution. |
playbackSettings |
List of PlaybackSettingEntity |
List of playback settings configuration. |
csvDatabanks |
List of CsvDatabankEntity |
List of csv databanks configuration. |
databaseDatabanks |
List of DbDatabankEntity |
List of database databanks configuration. |
playbackSettingsUri |
String |
URI to access the modified playback settings configuration |
csvDatabanksUri |
String |
URI to access the modified csv databanks configuration |
dbDatabanksUri |
String |
URI to access the modified database databanks configuration |
PlaybackSettingEntity Subtype
Use the PlaybackSettingEntity subtype to provide the specific playback entity settings used in the Oracle Functional Testing Trial Asset Execution resource.
Table 58-60 PlaybackSettingEntity Subtype
Field | Type | Description |
---|---|---|
name |
String |
Name of the playback setting field |
value |
String |
Value of the playback setting field |
CsvDatabankEntity Subtype
Use the CsvDatabankEntity subtype to provide the specific comma-separated databank entity settings used in the Oracle Functional Testing Trial Asset Execution resource.
Table 58-61 CSV Databank Entity Subtype
Field | Type | Description |
---|---|---|
name |
String |
Name of the csv databank |
contents |
String |
Contents of the csv databank file |
DbDatabankEntity Subtype
Use the DbDatabankEntity subtype to provide the specific database databank entity settings used in the Oracle Functional Testing Trial Asset Execution resource.
Table 58-62 Database Databank Entity Subtype
Field | Type | Description |
---|---|---|
alias |
String |
Alias of the database databank |
driver |
String |
Driver of the database databank |
connectUrl |
String |
Connection URL for the database databank. |
userName |
String |
User name for the database databank. |
password |
String |
Password for the database databank. [GET] not available for GET method. |
sql |
String |
SQL string defined inside the database databank. |
AssetResultEntity Subtype
Use the AssetResultEntity subtype to provide the specific asset result entity settings used in the Oracle Functional Testing Trial Asset Execution resource.
Table 58-63 Asset Result Entity Subtype
Field | Type | Description |
---|---|---|
trialContextId |
String |
Context ID for the trial |
assetContextId |
String |
Context ID for the asset |
executionResultUri |
String |
URI for the trial asset execution result. |
overallResult |
String |
Overall result of the execution |
status |
String |
Status of the asset result |
iterations |
Integer |
Total iterations of the asset script execution. |
totalUserDefinedTests |
Integer |
Amount of total user defined tests. |
passedUserDefinedTests |
Integer |
Amount of passed user defined tests. |
failedUserDefinedTests |
Integer |
Amount of failed user defined tests |
warningUserDefinedTests |
Integer |
Amount of warning user defined tests. |
totalScriptActions |
Integer |
Amount of total script actions. |
passedScriptActions |
Integer |
Amount of passed script actions. |
failedScriptActions |
Integer |
Amount of failed script actions. |
warningScriptActions |
Integer |
Amount of warning script actions. |
totalSteps |
Integer |
Amount of total steps |
execOrder |
Integer |
Order of this execution inside the Oracle Functional Testing trial all assets executions. |
uniqueName |
String |
Unique name of the asset execution. |
scriptName |
String |
Name of the script. |
resultStorage |
String |
Result storage (local or rfs) of the asset execution. |
zipResultUri |
String |
URI to the execution result zip |
rfsLocation |
String |
Location of the asset execution stored on rfs. |
stepDetailsUri |
String |
URI to the steps details of the executions. |
The instance of Test Driver.
Table 58-64 TestDriverInstance Resource Data Model
Field | Type | Description |
---|---|---|
uri |
String |
URI of the resource |
name |
String |
Name of the test driver instance. [POST] required |
status |
String |
Status of the test driver instance. |
testDriverUri |
String |
URI of the test driver of the instance. |
testDriverContextId |
String |
ID of the test driver. [POST] required |
testDriverName |
String |
Name of the test driver of the instance. |
owner |
String |
Owner of the test driver instance. |
creationDate |
String (ISO 8601 date) |
Creation date of the test driver instance. |
contextId(id) |
Long |
Context ID of the test driver instance |
testDriverInstancePassword |
String |
Password of the new test driver instance. [POST] required |
scheduledStartTime |
String (ISO 8601 date) |
Scheduled start time of the new instance. [POST] optional |
scheduledDeleteTime |
String (ISO 8601 date) |
Scheduled delete time of the new instance. [POST] optional |
operationsUri |
String |
URI of all available operations. |
The following table lists the methods supported in the TestDriverInstance resource.
Table 58-65 Supported Methods for Test Driver Instance Resource
Method | Description | Sample URI |
---|---|---|
LIST (GET without context_id parameter) |
List all test driver instances. |
/em/websvcs/restful/extws/cloudservices/taas/v1 /test_driver_instances |
GET |
Returns data of a test driver instance by context ID. |
/em/websvcs/restful/extws/cloudservices/taas/v1 /test_driver_instances/C0D0F1A8F11A2EA1E040E50A42BB70CF |
POST |
Create a test driver instance. |
/em/websvcs/restful/extws/cloudservices/taas/v1 /test_driver_instances |
DELETE |
Delete the test driver instance by context ID. |
/em/websvcs/restful/extws/cloudservices/taas/v1 /test_driver_instances/C0D0F1A8F11A2EA1E040E50A42BB70CF |
The instance of Test Environment.
Table 58-66 TestEnvironmentInstance Resource Data Model
Field | Type | Description |
---|---|---|
uri |
String |
URI of the resource |
name |
String |
Name of the test environment instance. [POST] required |
status |
String |
Status of the test environment instance |
testEnvironmentContextId |
String |
Context id of the test environment. [POST] required |
testEnvironmentUri |
String |
URI of the test environment of this instance. |
testEnvironmentName |
String |
Name of the test environment of this instance. |
owner |
String |
Owner of the test environment instance. |
creationDate |
String (ISO 8601 date) |
Creation date of the instance. |
contextId |
Long |
ID of the test environment instance |
testEnvironmentInstancePassword |
String |
Password of the new test driver instance. [POST] required |
scheduledStartTime |
String (ISO 8601 date) |
Scheduled start time of the new instance. [POST] optional |
scheduledDeleteTime |
String (ISO 8601 date) |
Scheduled delete time of the new instance. [POST] optional |
operationsUri |
String |
URI of available operations. |
The following table lists the methods supported in the TestEnvironmentInstance resource.
Table 58-67 Supported Methods for Test Environment Instance Resource
Method | Description | Sample URI |
---|---|---|
LIST (GET without context_id parameter) |
List all test environment instances. |
/em/websvcs/restful/extws/cloudservices/taas/v1 /test_environment_instances |
GET |
Returns data of a test environment instance by context ID. |
/em/websvcs/restful/extws/cloudservices/taas/v1 /test_environment_instances /C0D0F1A8F11A2EA1E040E50A42BB70CF |
POST |
Create a test environment instance. |
/em/websvcs/restful/extws/cloudservices/taas/v1 /test_environment_instances |
DELETE |
Delete the test environment instance by context id. |
/em/websvcs/restful/extws/cloudservices/taas/v1 /test_environment_instances /C0D0F1A8F11A2EA1E040E50A42BB70CF |
An Operation represents one allowed operation on a resource, for example, TestEnvironmentInstance/TestDriverInstance/Trial.
The supported operations for test environment instance are: start, stop, restart.
The supported operations for test driver instance are: start, stop, restart, add_agents, remove_agent, acquire_agent.
The supported operation for trial is stop.
Table 58-68 Operation Resource Data Model
Field | Type | Description |
---|---|---|
uri |
String |
URI of the operation |
name |
String |
Name of the operation |
method |
String |
Method of the operation (POST) |
parameters |
List of OperationParameter |
Parameters for Method |
The following table lists the methods supported in the Operation resource.
Table 58-69 Supported Methods for Operation Resource
Method | Description | Sample URI |
---|---|---|
LIST (GET without context_id parameter) |
List all operations of test environment/driver instances |
/em/websvcs/restful/extws/cloudservices/taas/v1 /test_environment_instances/C0D0F1A8F11A2EA1E040E50A42BB70CF /operations |
POST |
Perform an operation on instance. |
1./em/websvcs/restful/extws/cloudservices/taas/v1 /test_environment_instances/C0D0F1A8F11A2EA1E040E50A42BB70CF /operations/start 2./em/websvcs/restful/extws/cloudservices/taas/v1 /test_environment_instances/C0D0F1A8F11A2EA1E040E50A42BB70CF /operations/stop 3./em/websvcs/restful/extws/cloudservices/taas/v1 /test_driver_instances/C0D0F1A8F11A2EA1E040E50A42BB70CF /operations/add_agents Parameter:number of agent want to add. 4./em/websvcs/restful/extws/cloudservices/taas/v1 /test_driver_instances/C0D0F1A8F11A2EA1E040E50A42BB70CF /operations/remove_agent Parameters:context id of agent. 5./em/websvcs/restful/extws/cloudservices/taas/v1/tests /C0D0F1A8F11A2EA1E040E50A42BB70CF/trials /C0D0F1A8F11A2EA1E040E50A42BB70CE/operations/stop 6./em/websvcs/restful/extws/cloudservices/taas/v1 /test_driver_instances/C0D0F1A8F11A2EA1E040E50A42BB70CF /operations/acquire_agent Parameters:context id of agent. |
OperationParameter Subtype
Use the OperationParameter subtype to provide the specific operation parameter settings used in the Operation resource.
Table 58-70 OperationParameter Subtype
Field | Type | Description |
---|---|---|
name |
String |
Name of the parameter |
value |
String |
The parameter value |
defaultValue |
String |
Default parameter value |
isRequiredValue |
Boolean |
Whether the parameter is required |
possibleValues |
List of String |
Possible values for the parameter |
description |
String |
Description of parameter |
The type of Test
Table 58-71 TestType Resource Data Model
Field | Type | Description |
---|---|---|
uri |
String |
URI of the resource |
name |
String |
Test type name |
contextId(id) |
Long |
ID of the test type |
The following table lists the methods supported in the TestType resource.
Table 58-72 Supported Methods for Test Type Resource Model
Method | Description | Sample URI |
---|---|---|
LIST (GET without context_id parameter) |
List all test types. |
/em/websvcs/restful/extws/cloudservices/taas/v1/test_types |
GET |
Returns a test type |
/em/websvcs/restful/extws/cloudservices/taas/v1/test_types/1 |
Enterprise Manager target.
Table 58-73 Target Resource Data Model
Field | Type | Description |
---|---|---|
uri |
String |
URI of the resource |
contextId |
String |
GUID of the target |
targetName |
String |
Name of the target |
targetType |
String |
Type of the target |
status |
Integer |
Status of the target |
statusDisplay |
String |
The display status of the target. For example, up, down, and so on |
hostName |
String |
The host name of the target that on |
The following table lists the methods supported in the Target resource.
Table 58-74 Supported Methods for Target Resource
Method | Description | Sample URI |
---|---|---|
LIST |
Returns a list of targets |
/em/websvcs/restful/extws/cloudservices/taas/v1/targets |
GET |
Returns a target |
/em/websvcs/restful/extws/cloudservices/taas/v1/targets /C0D0F1A8F11A2EA1E040E50A42BB70CF |
OltAgent (Oracle Load Testing Agent) represents an agent machine that can be used to run an Oracle Load Testing trial.
Table 58-75 OltAgent Resource Data Model
Field | Type | Description |
---|---|---|
uri |
String |
URI of the OLT agent |
contextId |
String |
GUID of the OLT agent |
hostName |
String |
Name of the OLT agent |
status |
String |
Status of the OLT agent |
ip |
String |
IP address of the OLT agent |
port |
String |
Port of Agent service of Olt Agent |
version |
String |
Version of OLT Agent |
cpu |
String |
CPU count of OLT Agent |
memory |
String |
Memory of OLT Agent, unit is MB. |
storage |
String |
Storage of OLT Agent, unit is MB. |
The following table lists the methods supported in the OltAgent resource.
Table 58-76 Supported Methods for OltAgent Resource
Method | Description | Sample URI |
---|---|---|
LIST |
Returns a list of OLT Agent |
/em/websvcs/restful/extws/cloudservices/taas/v1/test_driver_instances /C0D0F1A8F11A2EA1E040E50A42BB70CF /OltAgents |
GET |
Returns an Agent |
/em/websvcs/restful/extws/cloudservices/taas/v1/test_driver_instances /C0D0F1A8F11A2EA1E040E50A42BB70CF /OltAgents/C0D0F1A8F11A2EA1E040E50A42BB70CF |
The following are examples of how to use the TaaS REST API.
The table below shows the GET request configuration.
Table 58-77 GET Request Configuration for Listing all Applications
Feature | Description |
---|---|
URI |
/em/websvcs/restful/extws/cloudservices/taas/v1/applications |
Body |
None |
Request method |
GET |
A sample of the response received is shown below.
{ "uri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/applications", "items": { "uri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/applications/1", "contextId": "1", "name": "medrec" } }
The table below shows the GET request configuration.
Table 58-78 GET Request Configuration for Querying an Application by Context ID
Feature | Description |
---|---|
URI |
/em/websvcs/restful/extws/cloudservices/taas/v1/applications/1 |
Body |
None |
Request method |
GET |
A sample of the response received is shown below.
{ "uri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/applications/1", "contextId": "1", "name": "medrec" }
The table below shows the GET request configuration.
Table 58-79 GET Request Configuration for Listing all Test Assets
Feature | Description |
---|---|
URI |
/em/websvcs/restful/extws/cloudservices/taas/v1/test_assets |
Body |
None |
Request method |
GET |
A sample of the response received is shown below.
{ "uri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_assets", "items": { "uri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_assets/DCBDEA617F62EC63E040F20AA0512492", "contextId": "DCBDEA617F62EC63E040F20AA0512492", "name": "Asset001", "testDriverTypeUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_driver_types/1", "testDriverTypeName": "OLT", "applicationUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/applications/1", "applicationName": "medrec", "lastModified": "1368603913000", "owner": "TAASUSER1", "vuCountEditable": "true", "rampupSettingEditable": "true", "endConditionEditable": "true" } }
The table below shows the GET request configuration.
Table 58-80 GET Request Configuration for Querying a Test Assets by Context ID
Feature | Description |
---|---|
URI |
/em/websvcs/restful/extws/cloudservices/taas/v1/test_assets/DCBDEA617F62EC63E040F20AA0512492 |
Body |
None |
Request method |
GET |
A sample of the response received is shown below.
{ "uri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_assets/DCBDEA617F62EC63E040F20AA0512492", "contextId": "DCBDEA617F62EC63E040F20AA0512492", "name": "Asset001", "testDriverTypeUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_driver_types/1", "testDriverTypeName": "OLT", "applicationUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/applications/1", "applicationName": "medrec", "lastModified": "1368603913000", "owner": "TAASUSER1", "oltScenario": { "scripts": { "name": "MedRec1Script", "vuCount": "1" }, "rampupOptionIndex": "3", "rampupOptionLabel": "X Percent every Y Seconds", "rampupUserOrPercent": "10.0", "rampupSecondOrIteration": "10.0", "endCondition": "As defined in the scenario: After each user plays 2 Iterations" }, "vuCountEditable": "true", "rampupSettingEditable": "true", "endConditionEditable": "true" }
The table below shows the GET request configuration.
Table 58-81 GET Request Configuration for Viewing all the Test Environments
Feature | Description |
---|---|
URI |
/em/websvcs/restful/extws/cloudservices/taas/v1/test_environments |
Body |
None |
Request method |
GET |
A sample of the response received is shown below.
{ "uri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_environments", "items": { "uri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_environments/DCBDF6F2FFC90069E040F20AA051215F", "contextId": "DCBDF6F2FFC90069E040F20AA051215F", "name": "MedrecEnv", "applicationUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/applications/1", "applicationName": "medrec", "owner": "TAASUSER1", "lastModified": "1368604061000" } }
The table below shows the GET request configuration.
Table 58-82 GET Request Configuration for Querying a Test Environment by Context ID
Feature | Description |
---|---|
URI |
/em/websvcs/restful/extws/cloudservices/taas/v1/test_environments/DCBDF6F2FFC90069E040F20AA051215F |
Body |
None |
Request method |
GET |
A sample of the response received is shown below.
{ "uri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_environments/DCBDF6F2FFC90069E040F20AA051215F", "contextId": "DCBDF6F2FFC90069E040F20AA051215F", "name": "MedrecEnv", "applicationUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/applications/1", "applicationName": "medrec", "owner": "TAASUSER1", "lastModified": "1368604061000" }
The table below shows the GET request configuration.
Table 58-83 GET Request Configuration for Listing all Test Drivers
Feature | Description |
---|---|
URI |
/em/websvcs/restful/extws/cloudservices/taas/v1/test_drivers |
Body |
None |
Request method |
GET |
A sample of the response received is shown below.
{ "uri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_drivers", "items": { "uri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_drivers/DCBD49A045FFD35BE040F20AA05150F5", "contextId": "DCBD49A045FFD35BE040F20AA05150F5", "name": "Default OLT", "testDriverTypeUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_driver_types/1", "testDriverTypeName": "OLT" } }
The table below shows the GET request configuration.
Table 58-84 GET Request Configuration for Querying a Test Driver by Context ID
Feature | Description |
---|---|
URI |
/em/websvcs/restful/extws/cloudservices/taas/v1/test_drivers/DCBD49A045FFD35BE040F20AA05150F5 |
Body |
None |
Request method |
GET |
A sample of the response received is shown below.
{ "uri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_drivers/DCBD49A045FFD35BE040F20AA05150F5", "contextId": "DCBD49A045FFD35BE040F20AA05150F5", "name": "Default OLT", "testDriverTypeUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_driver_types/1", "testDriverTypeName": "OLT" }
The table below shows the GET request configuration.
Table 58-85 GET Request Configuration for Querying a Test Driver Type by Context ID
Feature | Description |
---|---|
URI |
/em/websvcs/restful/extws/cloudservices/taas/v1/test_driver_types/1 |
Body |
None |
Request method |
GET |
A sample of the response received is shown below.
{ "uri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_driver_types/1", "contextId": "1", "name": "OLT", "testTypeUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_types/1", "testTypeName": "OLT" }
The table below shows the GET request configuration.
Table 58-86 GET Request Configuration for Viewing all Test Environment Instances
Feature | Description |
---|---|
URI |
/em/websvcs/restful/extws/cloudservices/taas/v1/test_environment_instances |
Body |
None |
Request method |
GET |
A sample of the response received is shown below.
{ "uri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_environment_instances", "items": [ { "uri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_environment_instances/1", "contextId": "1", "name": "Medrec_11", "status": "Ready", "testEnvironmentUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_environments/DCBDF6F2FFC90069E040F20AA051215F", "testEnvironmentName": "MedrecEnv", "owner": "TAASUSER1", "creationDate": "1368604209000", "operations": { "uri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_environment_instances/1/operations",\\\\ "items": [ { "uri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_environment_instances/1/operations/stop",\\\\ "contextId": "stop", "method": "POST" }, { "uri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_environment_instances/1/operations/restart", "contextId": "restart", "method": "POST" } ] } } ] }
The table below shows the GET request configuration.
Table 58-87 GET Request Configuration for Querying a Test Environment Instance by Context ID
Feature | Description |
---|---|
URI |
/em/websvcs/restful/extws/cloudservices/taas/v1/test_environment_instances/1 |
Body |
None |
Request method |
GET |
A sample of the response received is shown below.
{ "uri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_environment_instances/1", "contextId": "1", "name": "Medrec_11", "status": "Ready", "testEnvironmentUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_environments/DCBDF6F2FFC90069E040F20AA051215F", "testEnvironmentName": "MedrecEnv", "owner": "TAASUSER1", "creationDate": "1368604209000", "operations": { "uri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_environment_instances/1/operations", "items": [ { "uri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_environment_instances/1/operations/stop", "contextId": "stop", "method": "POST" }, { "uri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_environment_instances/1/operations/restart", "contextId": "restart", "method": "POST" } ] } }
The table below shows the POST request configuration.
Table 58-88 POST Request Configuration for Creating a Test Environment Instance
Feature | Description |
---|---|
URI |
/em/websvcs/restful/extws/cloudservices/taas/v1/test_environment_instances |
Body |
{ "name": "testEnvInst1", "testEnvironmentContextId": "DCBDF6F2FFC90069E040F20AA051215F", "testEnvironmentInstancePassword": "Oracle123" "scheduledStartTime": null, "scheduledDeleteTime": null } |
Request method |
POST |
A sample of the response received is shown below.
Method: POST URI: https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_environment_instances Request: Response: { "uri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_environment_instances/41", "contextId": "41", "name": "testEnvInst1", "status": "Scheduled", "testEnvironmentUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_environments/DCBDF6F2FFC90069E040F20AA051215F", "testEnvironmentName": "MedrecEnv", "owner": "TAASUSER1", "creationDate": "1368772865392", "operations": { "uri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_environment_instances/41/operations" } }
Note:
The executable operation depends on the status of the test environment instance. Operations are start, stop, and restart.
The table below shows the POST request configuration.
Table 58-89 POST Request Configuration for Executing an Operation on a Test Environment / Driver Instance
Feature | Description |
---|---|
URI |
/em/websvcs/restful/extws/cloudservices/taas/v1/test_environment_instances/1/operations/stop |
Body |
None |
Request method |
POST |
A sample of the response received is shown below.
Operation request has been submitted.
The table below shows the DELETE request configuration.
Table 58-90 DELETE Request Configuration for Deleting a Stopped Test Environment Instance
Feature | Description |
---|---|
URI |
/em/websvcs/restful/extws/cloudservices/taas/v1/test_environment_instances/21 |
Body |
None |
Request method |
DELETE |
A sample of the response received is shown below.
TestEnvironmentInstanceEntity has been deleted.Context Id:21
The table below shows the GET request configuration.
Table 58-91 GET Request Configuration for Viewing all Test Driver Instances
Feature | Description |
---|---|
URI |
/em/websvcs/restful/extws/cloudservices/taas/v1/test_driver_instances |
Body |
None |
Request method |
GET |
A sample of the response received is shown below.
{ "uri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_driver_instances", "items": { "uri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_driver_instances/1", "contextId": "1", "name": "ManualTDInst", "status": "Ready", "testDriverUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_drivers/DCBD49A045FFD35BE040F20AA05150F5", "testDriverName": "Default OLT", "owner": "TAASUSER1", "creationDate": "1368576000000", "operations": { "uri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_driver_instances/1/operations", "items": [ { "uri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_driver_instances/1/operations/stop", "contextId": "stop", "method": "POST" }, { "uri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_driver_instances/1/operations/restart", "contextId": "restart", "method": "POST" } ] } } }
The table below shows the GET request configuration.
Table 58-92 GET Request Configuration for Querying a Test Driver Instance by Context ID
Feature | Description |
---|---|
URI |
/em/websvcs/restful/extws/cloudservices/taas/v1/test_driver_instances/1 |
Body |
None |
Request method |
GET |
A sample of the response received is shown below.
{ "uri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_driver_instances/1", "contextId": "1", "name": "ManualTDInst", "status": "Ready", "testDriverUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_drivers/DCBD49A045FFD35BE040F20AA05150F5", "testDriverName": "Default OLT", "owner": "TAASUSER1", "creationDate": "1368576000000", "operations": { "uri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_driver_instances/1/operations", "items": [ { "uri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_driver_instances/1/operations/stop", "contextId": "stop", "method": "POST" }, { "uri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_driver_instances/1/operations/restart", "contextId": "restart", "method": "POST" } ] } }
The table below shows the POST request configuration.
Table 58-93 POST Request Configuration for Creating a Test Driver Instance
Feature | Description |
---|---|
URI |
/em/websvcs/restful/extws/cloudservices/taas/v1/test_driver_instances/1 |
Body |
{ "name": "testDriverInst1", "testDriverContextId": "DCBD49A045FFD35BE040F20AA05150F5", "testDriverInstancePassword": "Oracle123" "scheduledStartTime": null, "scheduledDeleteTime": null } |
Request method |
POST |
A sample of the response received is shown below.
{ "uri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_driver_instances/25", "contextId": "25", "name": "testDrvInst1", "status": "NotAvailable", "testDriverUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_drivers", "owner": "TAASUSER1", "creationDate": "1368774079487", "operations": { "uri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_driver_instances/25/operations" } }
The table below shows the DELETE request configuration.
Table 58-94 DELETE Request Configuration for Deleting a Stopped Test Driver Instance
Feature | Description |
---|---|
URI |
/em/websvcs/restful/extws/cloudservices/taas/v1/test_driver_instances/25 |
Body |
None |
Request method |
DELETE |
A sample of the response received is shown below.
TestDriverInstanceEntity has been deleted. Context Id:25
The table below shows the GET request configuration.
Table 58-95 GET Request Configuration for Viewing all Tests
Feature | Description |
---|---|
URI |
/em/websvcs/restful/extws/cloudservices/taas/v1/tests |
Body |
None |
Request method |
GET |
A sample of the response received is shown below.
{ "uri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/tests", "items": [ { "uri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/tests/DCC7AC5803CF97B2E040F20AA05152EC", "contextId": "DCC7AC5803CF97B2E040F20AA05152EC", "name": "Test1", "testDriverTypeContextId": "1", "testDriverTypeUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_driver_types/1", "testDriverTypeName": "OFT", "testAssets": { "testAssetContextId": "DCBDEA617F62EC63E040F20AA0512492", "testAssetUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_assets/DCBDEA617F62EC63E040F20AA0512492", "testAssetName": "Asset001" }, "testEnvironmentContextId": "DCBDF6F2FFC90069E040F20AA051215F", "testEnvironmentUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_environments/DCBDF6F2FFC90069E040F20AA051215F",\\ "testEnvironmentName": "MedrecEnv", "useEnvironmentLibrary": "false" "testDriverContextId": "DCBD49A045FFD35BE040F20AA05150F5", "testDriverUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_drivers/DCBD49A045FFD35BE040F20AA05150F5", "testDriverName": "Default OLT", "mappingUrls": "xx.example.com:7011|FROM_APPLIANCE|MedRec/MedRec1/MedRecServer", "trialsUri"://slc03rgd:5416/em/websvcs/restful/extws/cloudservices/taas/v1/tests/DCC7AC5803CF97B2E040F20AA05152EC/trials" } ] }
The table below shows the GET request configuration.
Table 58-96 GET Request Configuration for Querying a Test by Context ID
Feature | Description |
---|---|
URI |
/em/websvcs/restful/extws/cloudservices/taas/v1/tests/DCC7AC5803CF97B2E040F20AA05152EC |
Body |
None |
Request method |
GET |
A sample of the response received is shown below.
{ "uri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/tests/DCC7AC5803CF97B2E040F20AA05152EC", "contextId": "DCC7AC5803CF97B2E040F20AA05152EC", "name": "Test1", "testDriverTypeContextId": "1", "testDriverTypeUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_driver_types/1", "testDriverTypeName": "OLT", "testAssets": { "testAssetContextId": "DCBDEA617F62EC63E040F20AA0512492", "testAssetUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_assets/DCBDEA617F62EC63E040F20AA0512492", "testAssetName": "Asset001" }, "testEnvironmentContextId": "DCBDF6F2FFC90069E040F20AA051215F", "testEnvironmentUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_environments/DCBDF6F2FFC90069E040F20AA051215F", "testEnvironmentName": "MedrecEnv", "useEnvironmentLibrary": "false", "testDriverContextId": "DCBD49A045FFD35BE040F20AA05150F5", "testDriverUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_drivers/DCBD49A045FFD35BE040F20AA05150F5", "testDriverName": "Default OLT", "replaceUrls": { "originalUrl": "testserver2.us.example.com", "newUrl": "MedRec/MedRec1/MedRecServer", "replaceType": "FROM_APPLIANCE" }, "trialsUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/tests/DCC7AC5803CF97B2E040F20AA05152EC/trials" }
The table below shows the POST request configuration.
Table 58-97 POST Request Configuration for Creating a Test
Feature | Description |
---|---|
URI |
/em/websvcs/restful/extws/cloudservices/taas/v1/tests |
Body |
{ "name": "Test100", "testAssets": { "testAssetContextId": "DCBDEA617F62EC63E040F20AA0512492" }, "testEnvironmentContextId": "DCBDF6F2FFC90069E040F20AA051215F", "testDriverContextId" : "DCBD49A045FFD35BE040F20AA05150F5", "replaceUrls": { "originalUrl": "testserver2.us.example.com", "replaceType": "FROM_APPLIANCE" } } |
Request method |
POST |
A sample of the response received is shown below.
{ "uri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/tests/DCE58A1CBF8B0D06E040F20AA0511AB5", "contextId": "DCE58A1CBF8B0D06E040F20AA0511AB5", "name": "Test100", "testDriverTypeContextId": "1", "testDriverTypeUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_driver_types/1", "testDriverTypeName": "OLT", "testAssets": { "testAssetContextId": "DCBDEA617F62EC63E040F20AA0512492", "testAssetUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_assets/DCBDEA617F62EC63E040F20AA0512492", "testAssetName": "Asset001" }, "testEnvironmentContextId": "DCBDF6F2FFC90069E040F20AA051215F", "testEnvironmentUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_environments/DCBDF6F2FFC90069E040F20AA051215F", "testEnvironmentName": "MedrecEnv", "useEnvironmentLibrary": "false", "testDriverContextId": "DCBD49A045FFD35BE040F20AA05150F5", "testDriverUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_drivers/DCBD49A045FFD35BE040F20AA05150F5", "testDriverName": "Default OLT", "replaceUrls": { "originalUrl": "testserver2.us.example.com", "replaceType": "FROM_APPLIANCE" }, "trialsUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/tests/DCE58A1CBF8B0D06E040F20AA0511AB5/trials" }
The table below shows the PUT request configuration.
Table 58-98 PUT Request Configuration for Updating a Test
Feature | Description |
---|---|
URI |
/em/websvcs/restful/extws/cloudservices/taas/v1/tests/DCE58A1CBF8B0D06E040F20AA0511AB5 |
Body |
{ "name": "Test101", "testAssets":{ "testAssetContextId": "DCBDEA617F62EC63E040F20AA0512492", }, "testEnvironmentContextId": "DCBDF6F2FFC90069E040F20AA051215F", "testDriverContextId" : "DCBD49A045FFD35BE040F20AA05150F5" } |
Request method |
PUT |
A sample of the response received is shown below.
{ "uri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/tests/DCE58A1CBF8B0D06E040F20AA0511AB5", "contextId": "DCE58A1CBF8B0D06E040F20AA0511AB5", "name": "Test101", "testDriverTypeContextId": "1", "testDriverTypeUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_driver_types/1", "testDriverTypeName": "OLT", "testAssets":{ "testAssetContextId": "DCBDEA617F62EC63E040F20AA0512492", "testAssetUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_assets/DCBDEA617F62EC63E040F20AA0512492", "testAssetName": "Asset001" }, "testEnvironmentContextId": "DCBDF6F2FFC90069E040F20AA051215F", "testEnvironmentUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_environments/DCBDF6F2FFC90069E040F20AA051215F", "testEnvironmentName": "MedrecEnv", "useEnvironmentLibrary": "false", "testDriverContextId": "DCBD49A045FFD35BE040F20AA05150F5", "testDriverUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_drivers/DCBD49A045FFD35BE040F20AA05150F5", "testDriverName": "Default OLT", "replaceUrls": { "originalUrl":"burepv14.us.example.com:7011", "replaceType":"FROM_APPLIANCE", "newUrl":"MedRec/MedRec1/MedRecServer" }, "trialsUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/tests/DCE58A1CBF8B0D06E040F20AA0511AB5/trials" }
The table below shows the DELETE request configuration.
Table 58-99 DELETE Request Configuration for Deleteing a Test
Feature | Description |
---|---|
URI |
/em/websvcs/restful/extws/cloudservices/taas/v1/tests/DCE58A1CBF8B0D06E040F20AA0511AB5 |
Body |
None |
Request method |
DELETE |
A sample of the response received is shown below.
TestEntity has been deleted. Context Id:DCE58A1CBF8B0D06E040F20AA0511AB5
The table below shows the GET request configuration.
Table 58-100 GET Request Configuration for Viewing all the Trials
Feature | Description |
---|---|
URI |
/em/websvcs/restful/extws/cloudservices/taas/v1/trials |
Body |
None |
Request method |
GET |
A sample of the response received is shown below.
{ "uri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/trials", "items": [ { "uri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/trials/DCC75B3C889F0463E040F20AA0514349", "contextId": "DCC75B3C889F0463E040F20AA0514349", "name": "Trial1", "owner": "TAASUSER1", "status": "ERROR_SUBMITTING", "startTime": "1368671518000", "testUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/tests/DCC7AC5803CF97B2E040F20AA05152EC", "testName": "Test1", "testContextId": "DCC7AC5803CF97B2E040F20AA05152EC", "testAssetUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_assets/DCBDEA617F62EC63E040F20AA0512492", "testAssetName": "Asset001", "testEnvironmentUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_environments/DCBDF6F2FFC90069E040F20AA051215F", "testEnvironmentName": "MedrecEnv", "testEnvironmentInstanceUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_environment_instances/1", "testEnvironmentInstanceName": "MedrecEnv", "testEnvironmentInstanceContextId": "1", "testDriverUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_drivers/DCBD49A045FFD35BE040F20AA05150F5", "testDriverName": "Default OLT", "testDriverInstanceUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_driver_instances/1", "testDriverInstanceContextId": "1", "testDriverInstanceName": "ManualTDInst", "oltTrialSettings": { "scriptVuCounts": { "name": "MedRec1Script", "value": "1" }, "rampupOptionIndex": "3", "rampupOptionLabel": "X Percent every Y Seconds", "rampupUserOrPercent": "0.1", "rampupSecondOrIteration": "5.0" } } ] }
The table below shows the GET request configuration.
Table 58-101 GET Request Configuration for Querying a Trail by Context ID
Feature | Description |
---|---|
URI |
/em/websvcs/restful/extws/cloudservices/taas/v1/trials/DCC75B3C889F0463E040F20AA0514349 |
Body |
None |
Request method |
GET |
A sample of the response received is shown below.
{ "uri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/trials/DCC75B3C889F0463E040F20AA0514349", "contextId": "DCC75B3C889F0463E040F20AA0514349", "name": "Trial1", "owner": "TAASUSER1", "status": "ERROR_SUBMITTING", "startTime": "1368671518000", "testUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/tests/DCC7AC5803CF97B2E040F20AA05152EC", "testName": "Test1", "testContextId": "DCC7AC5803CF97B2E040F20AA05152EC", "testAssetUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_assets/DCBDEA617F62EC63E040F20AA0512492", "testAssetName": "Asset001", "testEnvironmentUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_environments/DCBDF6F2FFC90069E040F20AA051215F", "testEnvironmentName": "MedrecEnv", "testEnvironmentInstanceUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_environment_instances/1", "testEnvironmentInstanceName": "MedrecEnv", "testEnvironmentInstanceContextId": "1", "testDriverUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_drivers/DCBD49A045FFD35BE040F20AA05150F5", "testDriverName": "Default OLT", "testDriverInstanceUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_driver_instances/1", "testDriverInstanceContextId": "1", "testDriverInstanceName": "ManualTDInst", "oltTrialSettings": { "scriptVuCounts": { "name": "MedRec1Script", "value": "1" }, "rampupOptionIndex": "3", "rampupOptionLabel": "X Percent every Y Seconds", "rampupUserOrPercent": "0.1", "rampupSecondOrIteration": "5.0" } }
The table below shows the POST request configuration.
Table 58-102 POST Request Configuration for Creating a Trail
Feature | Description |
---|---|
URI |
/em/websvcs/restful/extws/cloudservices/taas/v1/trials |
Body |
{ "name": "APITrial1", "testContextId": "DCC7AC5803CF97B2E040F20AA05152EC", "testEnvironmentInstanceContextId": "1", "testDriverInstanceContextId": "1", "startTime": null, "oltTrialSettings": { "scriptVuCounts": { "name": "MedRec1Script", "value": "3" }, "rampupOptionIndex": "3", "rampupUserOrPercent": "0.1", "rampupSecondOrIteration": "5.0" } } |
Request method |
POST |
A sample of the response received is shown below.
{ "uri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/trials/DCE58A1CBF8D0D06E040F20AA0511AB5", "contextId": "DCE58A1CBF8D0D06E040F20AA0511AB5", "name": "APITrial1", "owner": "TAASUSER1", "status": "SCHEDULED", "startTime": "1368800849000", "testUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/tests/DCC7AC5803CF97B2E040F20AA05152EC", "testName": "Test1", "testContextId": "DCC7AC5803CF97B2E040F20AA05152EC", "testAssetUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_assets/DCBDEA617F62EC63E040F20AA0512492", "testAssetName": "Asset001", "testEnvironmentUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_environments/DCBDF6F2FFC90069E040F20AA051215F", "testEnvironmentName": "MedrecEnv", "testEnvironmentInstanceUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_environment_instances/1", "testEnvironmentInstanceName": "MedrecEnv", "testEnvironmentInstanceContextId": "1", "testDriverUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_drivers/DCBD49A045FFD35BE040F20AA05150F5", "testDriverName": "Default OLT", "testDriverInstanceUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_driver_instances/1", "testDriverInstanceContextId": "1", "testDriverInstanceName": "ManualTDInst", "oltTrialSettings": { "scriptVuCounts": { "name": "MedRec1Script", "value": "3" }, "rampupOptionIndex": "3", "rampupOptionLabel": "X Percent every Y Seconds", "rampupUserOrPercent": "0.1", "rampupSecondOrIteration": "5.0" } }
Note:
This is applicable only if the trial is in "Scheduled" status.
The table below shows the PUT request configuration.
Table 58-103 PUT Request Configuration for Updating a Trail
Feature | Description |
---|---|
URI |
/em/websvcs/restful/extws/cloudservices/taas/v1/trials/DCE58A1CBF8D0D06E040F20AA0511AB5 |
Body |
{ "name": "NewTrialName", "testContextId": "DCC7AC5803CF97B2E040F20AA05152EC", "testEnvironmentInstanceContextId": "1", "testDriverInstanceContextId": "1", "startTime":1398800849000, "oltTrialSettings": { "scriptVuCounts": { "name": "MedRec1Script", "value": "3" }, "rampupOptionIndex": "3", "rampupUserOrPercent": "0.1", "rampupSecondOrIteration": "5.0" } } |
Request method |
PUT |
A sample of the response received is shown below.
{ "uri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/trials/DCE58A1CBF8D0D06E040F20AA0511AB5", "contextId": "DCE58A1CBF8D0D06E040F20AA0511AB5", "name": "NewTrialName", "owner": "TAASUSER1", "status": "SCHEDULED", "startTime": "1398800849000", "testUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/tests/DCC7AC5803CF97B2E040F20AA05152EC", "testName": "Test1", "testContextId": "DCC7AC5803CF97B2E040F20AA05152EC","testAssetContextId": "DCBDEA617F62EC63E040F20AA0512492", "testAssetUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_assets/DCBDEA617F62EC63E040F20AA0512492", "testAssetName": "Asset001", "testEnvironmentUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_environments/DCBDF6F2FFC90069E040F20AA051215F", "testEnvironmentName": "MedrecEnv", "testEnvironmentInstanceUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_environment_instances/1", "testEnvironmentInstanceName": "MedrecEnv", "testEnvironmentInstanceContextId": "1", "testDriverUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_drivers/DCBD49A045FFD35BE040F20AA05150F5", "testDriverName": "Default OLT", "testDriverInstanceUri": "https://example.com/em/websvcs/restful/extws/cloudservices/taas/v1/test_driver_instances/1", "testDriverInstanceContextId": "1", "testDriverInstanceName": "ManualTDInst", "oltTrialSettings": { "scriptVuCounts": { "name": "MedRec1Script", "value": "3" }, "rampupOptionIndex": "3", "rampupOptionLabel": "X Percent every Y Seconds", "rampupUserOrPercent": "0.1", "rampupSecondOrIteration": "5.0" } }
The table below shows the DELETE request configuration.
Table 58-104 DELETE Request Configuration for Deleting a Trail
Feature | Description |
---|---|
URI |
/em/websvcs/restful/extws/cloudservices/taas/v1/trials/DCE5F68EEF937640E040F20AA0514029 |
Body |
None |
Request method |
DELETE |
A sample of the response received is shown below.
TrialEntity has been deleted. Context Id:DCE5F68EEF937640E040F20AA0514029