API: UserView Task JSON Sample

UserView based scripts can be created (recorded) only by using a web or desktop version of EveryStep Scripting Tool. However, you can edit a script in a UserView Task or create a new UserView Task by uploading an EveryStep (ES) script that was recorded in the desktop or web version of the tool.

Example POST/PUT JSON

{ 
    "Device_Id": 3153, 
    "Task_Type_Id": 21, 
    "Name": "dotcom-monitor.com", 
    "Timeout": 13, 
    "base64dmuv": "AAEAAAD/////AQAAAAAAAAAEAQAAAAxTeXN0ZW0uSW50MzIBAAAAB21fdmFsdWUACAIAAAALAAEAAAD/////AQAAAAAAAAAMAgAAAERfT1FMX0R5bmFtaWNfLCB.......1bHR1cmU9bmV1dHJh"
    
}

UserView Task JSON Sample

Sample JSON Object

{
    "Timeout": 0,
    "Script": "// script_version=3.0; everystep_version=0; date=1/19/2023; Chrome=104.0.5112.57; \nTabs.SetSize (1820, 490);\nDMBrowser tab0 = null;\nStep (1, \"Phone Number Availability Checker Online » Phone Number Monitoring - https://www.phonenumbermonitoring.com/\");\ntab0 = Tabs.NewTab ();\ntab0.GoTo (\"http://phonenumbermonitoring.com/\");\nTabs.SetSize (1820, 553);\ntab0.Link (\"//A[normalize-space(@TITLE)=\\\"Client Login\\\"]\", \"(//A[normalize-space(text())=\\\"Client Login\\\"])[1]\", \"/HTML/BODY/DIV[1]/DIV/HEADER/DIV[2]/DIV/DIV/DIV/DIV/DIV/A\").Click ();\nStep (2, \"Login - https://user.phonenumbermonitoring.com/client/#/login\");\ntab0.Navigating (\"https://user.phonenumbermonitoring.com/guest/ClientLogin.aspx\");\ntab0.Element (\"//H1[normalize-space()=\\\"Login\\\"]\", \"//H1[normalize-space(text())=\\\"Login\\\"]\", \"//H1\").Click ();\ntab0.KeywordAssert (\"Login\");\ntab0.TextField (\"//INPUT[@TYPE=\\\"text\\\"]\", \"//LABEL[normalize-space()=\\\"Username\\\"]/..//INPUT\", \"//LABEL[normalize-space()=\\\"Password\\\"]/../preceding-sibling::DIV[1]//INPUT\").Click ();\ntab0.TextField (\"//INPUT[@TYPE=\\\"text\\\"]\", \"//LABEL[normalize-space()=\\\"Username\\\"]/..//INPUT\", \"//LABEL[normalize-space()=\\\"Password\\\"]/../preceding-sibling::DIV[1]//INPUT\").TypeText (\"login1\");\ntab0.TextField (\"//INPUT[@TYPE=\\\"password\\\"]\", \"//LABEL[normalize-space()=\\\"Password\\\"]/..//INPUT\", \"//LABEL[normalize-space()=\\\"Username\\\"]/../following-sibling::DIV[1]//INPUT\").Click ();\ntab0.TextField (\"//INPUT[@TYPE=\\\"password\\\"]\", \"//LABEL[normalize-space()=\\\"Password\\\"]/..//INPUT\", \"//LABEL[normalize-space()=\\\"Username\\\"]/../following-sibling::DIV[1]//INPUT\").TypeText ((string) context.Password_0);\ntab0.Span (\"//SPAN[normalize-space()=\\\"Login\\\"]\", \"//SPAN[normalize-space(text())=\\\"Login\\\"]\", \"//BUTTON[@TYPE=\\\"submit\\\"]//SPAN\").Click ();\ntab0.TextField (\"//INPUT[@TYPE=\\\"password\\\"]\", \"//LABEL[normalize-space()=\\\"Password\\\"]/..//INPUT\", \"//LABEL[normalize-space()=\\\"Username\\\"]/../following-sibling::DIV[1]//INPUT\").TypeText ((string) context.Password_1);\ntab0.Span (\"//SPAN[normalize-space()=\\\"Login\\\"]\", \"//SPAN[normalize-space(text())=\\\"Login\\\"]\", \"//BUTTON[@TYPE=\\\"submit\\\"]//SPAN\").Click ();\ntab0.TextField (\"//INPUT[@TYPE=\\\"text\\\"]\", \"//LABEL[normalize-space()=\\\"Username\\\"]/..//INPUT\", \"//LABEL[normalize-space()=\\\"Password\\\"]/../preceding-sibling::DIV[1]//INPUT\").TypeText (\"vadimm1\");\ntab0.TextField (\"//INPUT[@TYPE=\\\"password\\\"]\", \"//LABEL[normalize-space()=\\\"Password\\\"]/..//INPUT\", \"//LABEL[normalize-space()=\\\"Username\\\"]/../following-sibling::DIV[1]//INPUT\").TypeText ((string) context.Password_2);\ntab0.Button (\"//SPAN[normalize-space()=\\\"Login\\\"]/..\", \"//BUTTON[@TYPE=\\\"submit\\\"]\", \"//PRX-BUTTON[@TYPE=\\\"submit\\\"]//BUTTON\").Click ();\nStep (3, \"Dashboard - https://user.phonenumbermonitoring.com/client/#/dashboard\");\ntab0.KeywordAssert (\"Dashboard\");",
    "ImageList": "",
    "BrowserEngine": "Chrome",
    "IsRIA": "NO",
    "RequireRepeatVisit": "NO",
    "WriteVideoOnEachMonitoring": "NO",
    "AbortOnError": "NO",
    "DNSResolveMode": "Device Cached",
    "DNSserverIP": "",
    "CustomDNSHosts": null,
    "base64dmuv": null,
    "Device_Id": 309224,
    "Id": 531165,
    "Task_Type_Id": 21,
    "Name": "http://phonenumbermonitoring.com/"
   
}

Fields Description

To Create a UserView Task and Edit a UserView Task use the parameters provided in this section.

Field Type Required/Optional Description

Timeout

int32

optional

Contains task execution timeout in ms.

base64dmuv

string

required

Contains ES script in the Base64 format.

Use the field in EDIT and CREATE operations to upload an EveryStep script previously recorded with ES Scripting Tool and converted to BASE64.

Device_Id

int32

required

The unique device id.

Example:

"Device_Id": 8692

int32

required

*Only for edit operations

The unique task id.

Task_Type_Id

int32

required

The type of the task.

Name

string

optional

The task description.

Read-Only Fields Description

Please refer to the description of the UserView Task object fields provided below for INFORMATIONAL PURPOSES ONLY. The described fields are read-only and can’t be modified.

Field Type Required/Optional Description

Script

string

optional

Contains recorded EveryStep script.

Note that the Script parameter of the UserView Task JSON object is READ-ONLY and can’t be used to create or edit a UserView Task.

ImageList

string

optional

Contains encoded picture data that is used for Image Validation.

BrowserEngine

string

optional

Defines which engine is emulated during monitoring.

POSSIBLE VALUES: “Chrome”, “Edge”, “Firefox”.

Example:

"Browser": "Chrome"

IsRIA

boolean

optional

Defines if RIA validation is used in the script.

POSSUBLE VALUES:

Yes – the script contains RIA validation step.
No – no RIA validation.

RequireRepeatVisit

boolean

optional

Defines the state of the Simulate Return Visitor flag.

POSSIBLE VALUES:

Yes – monitoring is executed to simulate a frequent visitor who already has elements from the page cached.
No – a new visitor is simulated for each run.

WriteVideoOnEachMonitoring

boolean

optional

Defines the state of the Record Video on Each Run option.

POSSIBLE VALUES:

Yes – a video record is created for each monitoring session.
No – the system records a video on the first session of a day that errors or on the first error detected from a location.

AbortOnError

boolean

optional

Indicates if the Abort Script on First Error option is activated.

POSSIBLE VALUES:

Yes – script execution will be stopped on the first monitoring error.
No – script execution will be continued untill the timeout is reached.

DNSResolveMode

string

optional

POSSIBLE VALUES:

Device Cached
Non Cached
TTL Cached
External DNS Server

For detailed explanation, see the DNS Mode Option article.

DNSserverIP string optional The field for a custom DNS server IP address. For detailed explanation, see the DNS Mode Option article.

CustomDNSHosts string optional Contains the list of IP address – host name pairs that are used to set up mapping of IP addresses to host names.