ScheduledTestSuite

A Scheduled Test Suite is grouping of a number of ICMP Echo Tests that can be run at the specified schedule, consecutively from a given source (NSGateway or VPort) toward a specified destination.

Overview

creationDate string read only   autogenerated   orderable  
description string filterable   orderable  
embeddedMetadata list read only   autogenerated  
endDateTime time filterable   orderable  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
lastUpdatedDate string read only   autogenerated   orderable  
name string required   filterable   orderable  
owner string autogenerated  
scheduleInterval integer filterable   orderable  
scheduleIntervalUnits enum (DAYS | HOURS | MINUTES | MONTHS) filterable   orderable  
startDateTime time filterable   orderable  

API Resource

/scheduledtestsuites/id
delete get put

Parents

/enterprises/id/scheduledtestsuites
get post

Children

/scheduledtestsuites/id/scheduledtestsuiteruns
get
/scheduledtestsuites/id/tests
get post
/scheduledtestsuites/id/metadatas
get post
/scheduledtestsuites/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

creationDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was created.

Charateristics

SDK attribute: creationDate

description string filterable   orderable  
Discussion

Description for the scheduled test suite instance.

Charateristics

Format: free
Max length: 255
SDK attribute: description

embeddedMetadata list read only   autogenerated  
Discussion

Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.

Charateristics

SDK attribute: embeddedMetadata

endDateTime time filterable   orderable  
Discussion

The date and time by which this suite will be terminated. If this is not specified the tests will continue to run at the specified frequency.

Charateristics

SDK attribute: endDateTime

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems

Charateristics

Format: free
SDK attribute: externalID

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

lastUpdatedDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was last updated.

Charateristics

SDK attribute: lastUpdatedDate

name string required   filterable   orderable  
Discussion

Name of the scheduled test suite instance.

Charateristics

Format: free
Min length: 1
Max length: 255
SDK attribute: name

owner string autogenerated  
Discussion

Identifies the user that has created this object.

Charateristics

Format: free
SDK attribute: owner

scheduleInterval integer filterable   orderable  
Discussion

This is the interval between all test runs in this suite and the next run of tests in this suite.

Charateristics

Default value: 1
Max value: 300
SDK attribute: scheduleInterval

scheduleIntervalUnits enum filterable   orderable  
Discussion

The units for the specified interval. This can be minutes, hours or days.

Charateristics

Allowed values: DAYS, HOURS, MINUTES, MONTHS
Default value: DAYS
SDK attribute: scheduleIntervalUnits

startDateTime time filterable   orderable  
Discussion

The date and time when this suite will start on the NSGateway.

Charateristics

SDK attribute: startDateTime