Get Variable by Name

Description

Returns details of a specific permanent variable identified by the variable name.

Request URL

http://{controllerMachine}:{controllerPort}/api/v3/variables/MyVariable

Input parameters

Examples

Curl

 curl -X GET --header 'Accept: application/json' --header 'AccessKey: Mo87Nc4qDAtzJNDb' 'http://localhost:9001/api/v3/variables/MyVariable'

PowerShell 

$headers = @{}
$headers.Add("AccessKey","Mo87Nc4qDAtzJNDb")
Invoke-WebRequest -Uri "http://localhost:9001/api/v3/variables/MyVariable" -ContentType "application/json" -Headers $headers -Method GET

Response Body

Information about the Variable Name and its Value.

{
  {
     "$id": "1",
     "Name": "Var2",
     "Value":
     {
         "$id": "2",
         "$type": "Leapwork.Models.Models.LDataTypes.LText, Leapwork.Models",
         "Value": "500"
     }
  }
}

Response Parameters

Response Code

200 (OK)

401 (Unauthorized,incorrect access key)

404 (Variable not found)

500 (Internal Server Error)