Class Test

constructor

• new Test(name, testType?, contextID?, options?): Test

• Parameters

  • name: string
  • testType: TestTypes = TestTypes.SIMULATION
  • Optional contextID: number
  • options: TestOptions = {}

  Returns Test

Readonly contextType

Optional jobID

options

testType

Static Readonly childTypes

Static Readonly resourceType

Static Readonly resourceTypeRun

deleteStep

• deleteStep(index): void

• Parameters

  • index: number

  Returns void

deleteTagValidation

• deleteTagValidation(index): void

• Parameters

  • index: number

  Returns void

getSteps

• getSteps(): readonly Step[]

• Returns readonly Step[]

getTagValidations

• getTagValidations(): readonly TagValidation[]

• Returns readonly TagValidation[]

insertStep

• insertStep(step, index?): void

• Parameters

  • step: Step
  • index: number = ...

  Returns void

insertTagValidation

• insertTagValidation(tagValidation, index?): void

• Parameters

  • tagValidation: TagValidation
  • index: number = ...

  Returns void

progress

• progress(): Promise<JobStatus>

• Retrieve the JobStatus for a resource

  Returns Promise<JobStatus>

  Promise of the JobStatus

report

• report(): Promise<TestResultReport>

• Returns Promise<TestResultReport>

run

• run(emailUsers?, variables?): Promise<string>

• Run the resource in DataTrue

  Parameters

  • emailUsers: number[] = []

    an array of user IDs to whom the test results should be sent
  • variables: Record<string, string> = {}

    variables to set for the test run

  Returns Promise<string>

  Promise of the jobID

setOptions

• setOptions(options, override?): void

• Set options from the passed options object

  Parameters

  • options: TestOptions

    the object to set options from
  • override: boolean = false

    whether to override the options object

  Returns void

setVariable

• setVariable(name, type, value): void

• Parameters

  • name: string
  • type: VariableTypes
  • value: string

  Returns void

toJSON

• toJSON(): Promise<Record<string, any>>

• Convert the resource to an Object

  Returns Promise<Record<string, any>>

  object representation of the resource

Static fromID

• fromID(id): Promise<Test>

• Create a resource from a given ID

  Parameters

  • id: number

    the ID of the resource

  Returns Promise<Test>

  Promise of the resource

Static fromJSON

• fromJSON(obj, copy?): Test

• Create a resource from an object

  Parameters

  • obj: Record<string, any>

    object to create resource from
  • copy: boolean = false

    whether to create a copy of the resource or not (removes resource IDs)

  Returns Test

  new Resource