Elements

Name Description
AddOrUpdateMaintenanceWindowsRequest This element contains the data expected in an invocation of the AddOrUpdateMaintenanceWindows operation. The element is embedded in a SOAP envelope.
AddOrUpdateMaintenanceWindowsResponse This element contains the data expected in the response to an AddOrUpdateMaintenanceWindows invocation. The element is embedded in a SOAP message.
AddOrUpdateSubstitutionParametersRequest An AddOrUpdateSubstitutionParametersRequest contains credentials and a collection of 1 to many ParameterizedMonitor elements. A ParameterizedMonitor element contains test data relevant to the definition of global and site-level substitution parameters. A substitution parameter is a user-defined script variable whose value may be updated via the Test Management API, either at the global level or at the site level. This element is typically embedded in a SOAP message.
AddOrUpdateSubstitutionParametersResponse This element contains the data expected in the response to an AddOrUpdateSubstitutionParameters invocation.
AgentType [type FilterBase] If present, this element restricts the output of GetTests() or GetScripts() by agent type.
ApplyMaintenanceWindowTemplateRequest This is the type of element expected in an invocation of the ApplyMaintenanceWindowTemplate operation. This element is embedded in a SOAP envelope.
ApplyMaintenanceWindowTemplateResponse An ApplyMaintenanceWindowTemplateResponse element extends OperationResponseType. It contains the response status for the request and an optional message (populated if the request failed). This element is embedded in a SOAP request.
Credentials A Credentials element contains the username and password of an authorized account user. The element is required in all requests to the Test Management Web Service.
Description [element Script] The Description names the script. It must be unique within an account. The description field is typically set by the Recorder. When the script is incorporated into a test, the description can be overwritten.
DisplayName [element Step] The DisplayName is populated with the Title of the web page or application.
ErrorMessage [type OperationResponseType] The error message is provided if the ResponseStatus was FAILURE.
GetMaintenanceWindowsRequest This element is sent by the API client when the GetMaintenanceWindows operation is invoked. This element is embedded in SOAP envelope.
GetMaintenanceWindowsResponse This element is returned in the response to a GetMainenanceWindows operation invocation. The element is embedded in a SOAP Envelope.
GetParameterizedTestsRequest This element is sent by the API client in a GetParameterizedTests operation invocation. It is embedded within a SOAP envelope.
GetParameterizedTestsResponse A GetParameterizedTestsResponse contains the output of a GetParameterizedTests operation invocation. It includes only those tests that contain global and possibly site-level Substitution Parameters.
GetScriptsRequest A GetScriptsRequest is the message sent by the API Client to obtain the list of inactive but ready-to-deploy scripts under a given account.
GetScriptsResponse This element is returned by an invocation of the GetScripts operation.
GetSitesRequest This element is sent in an invocation of the GetSites operation.
GetSitesResponse This element is the response to a GetSites operation invocation. The element is embedded in a SOAP envelope.
GetTestsRequest This element is sent in an invocation of the GetTests operation.
GetTestsResponse The xml element containing the payload of a GetTests() response.
GetTestsSummaryRequest This element is sent in an invocation of the GetTestsSummary operation.
GetTestsSummaryResponse This element appears in the response to a GetTestsSummary operation invocation.
Group [element MonitorFilter] If present, this element restricts GetTests() output by membership in a particular monitor group (also called Folder). If multiple instances of Group are supplied, the tests in the output have to match ANY of them.
MaintenanceWindowFilter A MaintenanceWindowFilter element is sent as part of a GetMaintenanceWindows operation invocation. The use of the filter limits the output of this query.
MaintenanceWindowMonitor A maintenance window monitor appears in both the GetMaintenanceWindows output as well as in the AddOrUpdateMaintenanceWindows request. In the first context, it is a container of monitor-level maintenance window data for already configured maintenance windows. In the second context, it contains monitor-level maintenance window data for use in adding new or updating existing maintenance windows.
MaintenanceWindowType The MaintenanceWindowType is an enumeration used in MaintenanceWindowFilters to restrict the output of the GetMaintenanceWindows query. ONE_TIME maintenance windows are maintenance windows defined for a single datetime range. Once the interval expires, the maintenance window will never occur again. RECURRING maintenance windows occur once a week.
Message [element MonitorOrderResponse] This is an error message at the level of a specific monitor order response. However, even if there is no error, message is populated with a description of the outcome of the monitor order. Use the orderStatus field to determine the outcome of the provisioning attempt and the message as a container of supporting data.
Monitor The monitor element appears in the output of a GetTests operation invocation.
MonitorClass This element defines the type of tests to be retrieved.
MonitorFilter A MonitorFilter is used in a GetTests operation invocation to restrict the output of the query.
MonitorId [element ParameterizedTestFilter] If present, this element restricts the filter output to a specific browser test.
MonitorId [element MonitorFilter] A monitor id uniquely identifies a test in the Dynatrace Portal. When a MonitorId element appears in a ParameterizedTestFilter, it restricts the GetParameterizedTests output to that monitor id. However, there is output only if there are substitution parameters defined for the specified monitor.
MonitorId
MonitorIds The MonitorIds element contains a list of monitor ids. This element may appear in a MaintenanceWindowFilter. The output of this query is restricted to the monitors listed in the MonitorIds. However, the monitors listed in the MonitorIds element that are not defined under the account or that do not have maintenance window definitions do not appear in the output. The MonitorIds element may also appear in an ApplyMaintenanceWindowTemplateRequest. In this context, the monitor ids listed in the element designate the monitors that will receive new maintenance window definitions as a result of the request.
MonitorOrderResponse MonitorOrderResponse elements appear in both ProvisionTestsResponse elements and in UpdateTestsResponse elements. In both contexts, the contain information about a monitor-level transaction that either completed successfully or failed to complete successfully.
MonitorOrderResponses MonitorOrderResponses are collections of MonitorOrderResponse elements. They occur in the responses of both ProvisionTests and UpdateTests operation invocations. See the MonitorOrderResponse help page for more information.
MonitorProperties The MonitorProperties element appears in UpdateTestParameters operation invocations. It is a container of MonitorProperty elements, name value pairs used to set new values on the test parameters of previously provisioned tests.
MonitorProperty The MonitorProperty element appears in an UpdateTestParameters operation invocation. The element is a name-value pair used to reset a test parameter value such as ExpirationDate or SummaryFlag.
Monitors A Monitors element is a container of Monitor elements. It appears in the GetTests and GetTestsEx responses and holds all the data that the query is expected to contain. It also appears in an UpdateTests request. There it contains all of the Monitor elements that are used to update the already provisioned tests.
MonitorSite [type ProvisionTestsMonitorSitesType] The ProvisionTestsMonitorSites type is no longer used in the Test Management API, so the local definition of MonitorSite that it contains is also unused.
Backbone MonitorSite This element is used pretty widely in the Test Management API to represent a Backbone node.
MonitorSites The MonitorSites element is a container of MonitorSite elements. See MonitorSite for more information.
MonitorStatus [element ParameterizedTestFilter] The MonitorStatus element filters out tests whose status is not equal to the value of this element sent by the API client.
MonitorStatus [element MonitorFilter] If present, this element restricts GetTests() output by MonitorStatus (Active or Inactive).
MonitorStatus [element GetTestsSummaryRequest] The status of a test (may be Active or Inactive when included in a ParameterizedTestFilter).
MonitorSummaries Appears in a GetTestsSummaryResponse (the payload returned by the server on a GetTestsSummary operation invocation). Contains a MonitorSummary for each test returned by the query.
MonitorSummary Appears in a GetTestsSummaryResponse (the payload returned by the server on a GetTestsSummary operation invocation) as child of MonitorSummaries. One MonitorSummary is returned for each test returned by the query.
MultiStepMonitor Appears in a ProvisionTestsRequest. A MultiStepMonitor is the form of monitor order to be submitted when the test is being created based on an existing GSL script recorded by the Recorder and uploaded to the Dynatrace Portal (the opposite of a SingleStepMonitor, where the GSL is created on the fly based on a URL passed in the monitor order).
MultiStepMonitors Appears in a ProvisionTestsRequest. A MultiStepMonitors is a collection of one or more MultiStepMonitor elements. See MultiStepMonitor.
OneTimeMaintenanceWindow A OneTimeMaintenanceWindow appears in a GetMaintenanceWindowsResponse, an AddOrUpdateMaintenanceWindowsRequest, and an ApplyMaintenanceWindowTemplateRequest. In each context, it represents a definition of a non-recurring maintenance window.
OneTimeMaintenanceWindows OneTimeMaintenanceWindows are collections of OneTimeMaintenanceWindow elements (see OneTimeMaintenanceWindow).
ParameterizedMonitor A ParameterizedMonitor is a description of a browser test that contains substitution parameters. This element appears in a GetParameterizedTestsResponse and in an AddOrUpdateSubstitutionParametersRequest. In the first context, it describes a configuration of an existing browser test (one that has substitution parameter definitions). In the second context, it describes the manner in which existing global substitution parameters are to be updated and/or the manner in which site-level substitution parameters are to be created, updated or deleted.
ParameterizedTestFilter A ParameterizedTestFilter element is included in a GetParameterizedTestsRequest to limit the output of the GetParameterizedTests query. The output can be limited by monitor id (only monitors whose ids are listed in the filter can be returned) or by monitor status.
PartialUpdate One or more PartialUpdate elements appear in an UpdateTestParametersRequest. Each PartialUpdate targets a specific monitor. A PartialUpdate may be used to update the list of sites to which a monitor is deployed, the name of a test step, or one or more test parameters such as SummaryFlag, IncludeRenderTime, IP version, etc.
Password [element Credentials] A secret used as part of user credentials for authentication. Every request to the Test Management API web service must include a Credentials element. That element itself contains a UserName and a Password element.
ProvisionTestsRequest A ProvisionTestsRequest element is sent in a ProvisionTests operation invocation, which is the only method that the Test Management API provides for creating a browser test within the Dynatrace Portal.
ProvisionTestsResponse A ProvisionTestsResponse element returned by the server in response to a ProvisionTests operation invocation. It reports the status of each monitor order transaction within the ProvisionTestsRequest.
QueryByCreateDate [type FilterBase] QueryByCreateDate is supported in both ScriptFilters and MonitorFilters. If present, this element restricts the output by create date. Multiple instances of this element are permitted so that both upper and lower bounds can be set.
QueryByExpirationDate [element MonitorFilter] If present, this element restricts GetTests() output by test expiration date. Multiple instances of this element are permitted so that both upper and lower bounds can be set.
QueryByModifyDate [type FilterBase] QueryByModifyDate is supported in both ScriptFilters and MonitorFilters. If present, this element restricts the output by modify date. Multiple instances of this element are permitted so that both upper and lower bounds can be set.
RecurringMaintenanceWindow A RecurringMaintenanceWindow element represents the definition of a maintenance window, one that recurs once every week. This element is present in a GetMaintenanceWindowsResponse, where it shows the state of an already provisioned maintenance window, and in both an AddOrUpdateMaintenanceWindowsRequest and in an ApplyMaintenanceWindowTemplateRequest. In these second and third types of Request, the element is used to provision a new maintenance window or windows in the system.
RecurringMaintenanceWindows The RecurringMaintenanceWindows element is a container of RecurringMaintenanceWindow elements. It appears in both GetMaintenanceWindowsResponses and in invocations of the two operations provided for updating the existing maintenance windows (AddOrUpdateMaintenanceWindows and ApplyMaintenanceWindowTemplate) to the monitors.
ResponseStatus This element appears in most of the responses issued when the Test Management API operations are invoked.
Script A Script element appears only in a GetScripts operation response. It represents a GSL script in the Dynatrace Portal that has yet to be incorporated into a browser test.
ScriptFilter
ScriptId [element ScriptFilter] If present, this element restricts the output of GetScripts() to a single script.
Scripts A Scripts element appears only in a GetScripts operation response. It represents a collection of GSL scripts in the Dynatrace Portal that have yet to be incorporated into a browser test.
SingleStepMonitor A SingleStepMonitor appears in a ProvisionTestsRequest and is used to create a Backbone test that browses a single URL.
SingleStepMonitors A SingleStepMonitors element appears in a ProvisionTestsRequest and is used to create one or more Backbone tests that browse a single URL.
Step A Step represents a web page that might be browsed within a larger GSL script run by the browser agent. The Step appears in the output of both the GetTests query and the GetScripts query. It also figures in an UpdateTestParameters request where it is used to rename a step in an existing test.
Steps A Steps element is a collection of one to many Steps. Everywhere a Step may appear, it is enclosed in such a collection.
SubstitutionParameter A SubstitutionParameter element defines a name-value pair that may be referenced in a GSL script once or multiple times. Typically, a SubstitutionParameter is used to represent a username or a password. The Test Management API now provides a mechanism for updating SubstitutionParameter values whenever the need arises. So if the username and password used in GSL script expires, it may be updated without the script having to be reloaded or redeployed.
SubstitutionParameters A SubstitutionParameters collection. A SubstitutionParameters collection is only present in methods dealing with SubstitutionParameters and not in a GetTests() response or a GetSites() response. See SubstitutionParameter for more details.
TestStatusUpdate [element TestStatusUpdateRequest] A TestStatusUpdate identifies a specific test in the system by its monitorId and sets the Status that the test has after the update has occurred.
TestStatusUpdateRequest A TestStatusUpdateRequest is sent in an invocation of the TestStatusUpdate operation. The request can modify the status of one to many tests.
TestStatusUpdateResponse A TestStatusUpdateResponse is returned by the service when the TestStatusUpdate operation is invoked. It indicates the success or failure of the transaction.
UpdateTestParametersRequest An UpdateTestParametersRequest is sent on invocations of the UpdateTestParameters operation. It may be used to assign monitors to sites, to update the display name on a test step, or to modify test parameters.
UpdateTestParametersResponse An UpdateTestParametersResponse element is returned by the Test Management API web service on invocations of the UpdateTestParameters operation. It indicates the success or failure of the transaction.
UpdateTestsRequest Contains a collection of monitor update orders (both for SingleStepMonitors and MultiStepMonitors). Each monitor update order is processed in its own transaction.
UpdateTestsResponse A response to an UpdateOrDeleteTestsRequest. Contains a collection of 0 to many MonitorOrderResponses (actually monitor update order responses). If no errors occurred during processing, there should be as many monitor update order responses as there were monitor update order requests. If a failure occurred during processing, at the most one monitor update order response will contain a failure, since processing halts after the first failure. Successfully processed monitor order requests will be committed. However, no change resulting from a failure to complete a monitor update will be committed.
URL [element Script] This element is no longer provided, because the Steps include the URL and Display name for each step in the Script.
URL [element SingleStepMonitor] In a SingleStepMonitor, a URL contains the target of the test: A single web page or application to be browsed.
URL [element Step] The URL is a web address.
UserName [element Credentials] The UserName of an employee for an account (and used for authentication).