TestSuite

A Test Suite is grouping a number of diagnostic Tests that can be run 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  
enterpriseID string read only  
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  
underlayTest boolean filterable   orderable  

API Resource

/testsuites/id
delete get put

Parents

/enterprises/id/testsuites
get post

Children

/testsuites/id/permissions
delete get post put
/testsuites/id/tests
get post
/testsuites/id/testsuiteruns
get
/testsuites/id/metadatas
get post
/testsuites/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

An operator given description of the Test Suite.


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

enterpriseID string read only  
Discussion

The ID of the Enterprise to which this Test Suite belongs to.


Charateristics

Format: free
SDK attribute: enterpriseID

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

The name given by the operator to the Test Suite.


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

underlayTest boolean filterable   orderable  
Discussion

Flag to define if this Test Suite is the internal 'Underlay Tests' Test Suite


Charateristics

Default value: false
SDK attribute: underlayTest