Skip to main content

Module: Blueprint

Module: Blueprint

Method Paramters HTTP Method Description URL Example

addFile

String username, String blueprintType, String path

Adds external file

compareBlueprints

String username, String baselinePath, String blueprintPath, int execution

Compare Blueprints

createBlueprint

String username, String fields

Creates Web Blueprint with user parameters

createBlueprintFromTemplate

String username, String template

Creates Blueprint from Template file

createBlueprintFromTemplateUI

String username, String templateFile

Creates Blueprint from Template file

createBlueprintFromTemplateWithDataset

String username, String template, String dataset

Creates Blueprint from Template file after replacing with selected Dataset

createExecution

String username, String fields

Creates Execution

createJsonValidationReportCICD

String username

Downloads Json Validations Report file for CI/CD

createMobileBlueprint

Creates Mobile Blueprint

Creates Mobile Blueprint

createRequestTXTFile

String username, int status

Downloads Requests Report file for the Execution

createResponseTimesReport

String username

Downloads Response Times Report file for the Execution

createResponseTimesReportCICD

String username, int code

Downloads Response Times Report file for CI/CD

createSmartTagsReport

String username

Downloads SmartTags Report file for the Execution

createSmokeTestReport

String username

Downloads Smoke Test Report file for the Execution

createValidationReportCICD

String username

Downloads Validations Report file for CI/CD

createValidationsBP

String username

Create validations with a Blueprint

createValidationsReport

String username

Downloads Validations Report file for the Execution

deleteFile

String username, String blueprintType, String fileName

Deletes file

deleteSets

String username, String name

Deletes selected Dataset

downloadBlueprint

String username

Downloads Blueprint file

downloadBlueprintActions

String username, int executionId, String fileType

Downloads Blueprint Scripts

downloadCustomActions

String username, int executionId, int stateId, String type

Downloads Custom Actions for the Execution

downloadFailedActions

String username, int executionId

Downloads Failed Actions for the Execution

downloadFailedInconsistentActionsReport

String username, int executionId, String type

Downloads Failed and Inconsistent Actions Report file for the Execution

downloadFile

String username, String blueprintType, String fileName

Downloads external file

downloadInconsistentActions

String username, int executionId

Downloads Inconsistent Actions for the Execution

downloadMobileConfiguration

String username

Downloads Mobile Configuration file

downloadMobileConfigurationTemplate

String username, String platform, String service, String device

Downloads Mobile Configuration Template file

downloadRequestActions

String username, String type, String actionIds

Downloads Scripts for the Request

downloadValidationsActions

String username, int executionId, String urlId, int id, String fileType, String type

Downloads Scripts for failed Validations

exportDataSets

String username, String path, String commitMessage

Exports Dataset Names from Blueprint Template

exportDataSetsCSV

String username, String path, String commitMessage

Exports Dataset Names from Blueprint Template

exportSelfHealedSmartTagsLibrary

String username, String path, String commitMessage

Write SmartTags Library to user defined file

exportSmartTagsLibrary

String username, String path, String commitMessage

Write SmartTags Library to user defined file

exportTemplate

String username, String path, String commitMessage

Exports Blueprint Template

getAllStatusCodes

String username

Returns Status Codes of Requests

getBindings

String username, int executionId, int page, String type

Returns Bindings for the Execution

getBindingsCICD

String username

Returns Bindings for the Execution

getBlueprintResults

String username

Returns Blueprint Results

getBlueprintType

String username

Returns Blueprint type

getCustomActions

String username, int executionId, int stateId

Returns Custom Actions for the Binding

getDataSets

String username

Returns Datasets

getExecutionIDs

String username

Returns id and name of all Executions

getFieldVisualHint

String username, int executionId, int stateId, String name, String type

Returns Visual Hint bytes for selected field

getHTMLSmarttagsCICD

String username, String filter

Downloads SmartTags Report file for the Execution

getInteractive

String username

Returns Interactive mode

getMaxBindings

String username, int executionId, String type

Returns Max Bindings for the Execution

getPagesActionsCICD

String username

Gets the Pages and Actions for the CI CD Dashboard

getReportDuration

String username

Returns Request Duration for Response Times Report

getReportStatusCode

String username

Returns Request Status Code for Smoke Test Report

getRequestMaxDuration

String username

Returns Request Duration for Response Times Report

getRequestsWithStatusCode

String username, int status

Returns Requests with Status Code

getScanDetails

String username

Returns Global and each Execution details

getScanParameters

String username, String blueprintType

Returns Blueprint intial scan parameters

getSmartTagHints

String username, String path

Returns Visual Hint bytes

getSmartTags

String username, int executionId

Returns SmartTags for the Execution

getSmartTagVisualHint

String username, int executionId, String urlId, String name

Returns Visual Hint bytes for selected SmartTag

getSource

String username, int executionId, int stateId

Returns Source

getUseVisualHints

String username

Returns if uses Visual Hints

getValidations

String username, int executionId

Returns Validations for the Execution

getValidationsBP

String username

Create validations with a Blueprint

getValidationsCICD

String username

Gets Valiadation reports for CI/CD

getVersion

String username

Returns Blueprint version

getVisualHint

String username, int executionId, int stateId

Returns Visual Hint bytes

makeCustomActionsGlobal

String username, int executionId, int caoId, boolean global

Moves Custom Actions to stateId or -1

openBlueprint

String username, String path

Opens Blueprint

openTemplate

String username, String path

Opens Blueprint Template

pauseExecution

String username, int executionId

Pause Executions

playExecution

String username, int executionId

Play Executions of the blueprint

playWithBindings

String username, String fields

Play with Bindings

processBinding

String username, String fields

Creates Custom Actions for the Binding

processDPL

String username, String filepath

Returns Datasets from dpl file

removeBlueprint

String username, String blueprintType

Deletes Blueprint

removeCustomAction

String username, int executionId, int actionId

Removes Custom Action

retryFailed

String username, int executionId

Reprocess Failed Actions for the Execution

retryInconsistent

String username, int executionId

Reprocess Inconsistent Actions for the Execution

saveAsBlueprint

String username, String fields, String commitMessage

Writes to temporary and new user defined files

saveBlueprint

String username, String fields, String commitMessage

Writes to temporary and user defined files

saveBlueprintTemplate

String username, String path, String content, String commitMessage

Saves files to Disk

saveCustomActions

String username, int executionId, int stateId, String type, String path

Saves Custom Actions for the Execution

saveToServer

String username, String content

Saves Mobile Configuration file

serverConfig

String username, String path

Returns Mobile Configuration file

setInteractive

String username, boolean interactive

Changes Interactive mode

setReportDuration

String username, int milliseconds

Sets Request Duration for Response Times Report

setReportStatusCode

String username, int status

Sets Request Status Code for Smoke Test Report

setRequestMaxDuration

String username, int milliseconds

Sets Request maximum Duration for Response Times Report

stopAllRunnings

String username

Stops Blueprint

stopByExecId

String username, int executionId

Stops Execution

updateDataSets

String username, String set

Updates selected Dataset

uploadFile

String username, String blueprintType, String path, String fileName

Uploads external file