TestDefinition

A Test definition describes a command to run inside a diagnositcs container on an NSGateway. It represents a command with arguments that will be run in the container as part of a Test Suite run

Overview

arguments string
command string required   filterable   orderable  
description string filterable   orderable  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
name string required   filterable   orderable  
timeout integer filterable   orderable  

API Resource

/testdefinitions/id
delete get put

Parents

/enterprises/id/testdefinitions
get post
/testdefinitions
delete get post put

Children

/testdefinitions/id/metadatas
get post
/testdefinitions/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

arguments string
Discussion

The arguments that will be appended to the test command field.

Charateristics

Format: free
Max value: 255
SDK attribute: arguments

command string required   filterable   orderable  
Discussion

The Linux command that this test definition will use.

Charateristics

Format: free
Min value: 1
Max value: 255
SDK attribute: command

description string filterable   orderable  
Discussion

A concise description of the Test Definition object.

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

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

name string required   filterable   orderable  
Discussion

A descriptive name for the Test Definition instance.

Charateristics

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

timeout integer filterable   orderable  
Discussion

Optional timeout value, in seconds, for the test until the system considers it as failed. Default is 60 s.

Charateristics

Default value: 60
Min value: 1
Max value: 1200
SDK attribute: timeout