Read Custom Variables

The list of all client-side custom variables can be requested.

This is required to assign client-side variable values when engaging with server-side ReST API requests.

Read App Studio Custom Variables

POST AppStudio/ReadCustomVariables

This is a POST method which passes both the API and session keys as headers, and a body. If successful, the custom variables can be stored.

Headers

Name	Value
Content-Type	application/json
SiteKey	API Key
DataServicesKey	Session Key

Body

Name	Type	Description
TreeFormat	Boolean	true

Response

200

{
  "Success": true,
  "JSON": "base64 encoded string"
}

400

{
  "error": "Invalid request"
}

Base64 JSON Decoding

The JSON data is Base64 encoded. You must decode this into a JSON string and convert that into a multi-hierarchical object.

This example shows the custom variables in the App Studio configurator on the left and a matching portion of the multi-hierarchical object returned from the API.

Here is an example of a client-side list of custom variables.

{  
  "Client": [
    {
      "Name": "BetsyPalmerContactID",
      "Source": "Betsy Palmer ContactID",
      "Value": "49346"
    },
    {
      "Name": "BookID",
      "Source": "BookID",
      "Value": "2"
    },
    {
      "Name": "CapitalCity",
      "Source": "CapitalCity",
      "Value": "Capo Seet"
    },
    {
      "Name": "Country",
      "Source": "Country",
      "Value": "Foo Kinhel"
    },
    {
      "Name": "Country_Code",
      "Source": "Country_Code",
      "Value": "FK"
    },
    {
      "Name": "DataSource-Sort",
      "Source": "DataSource-Sort",
      "Value": ""
    },
    {
      "Name": "Footballer-Biography",
      "Source": "Footballer-Biography",
      "Value": "Oh what a lonely boy"
    },
    {
      "Name": "Footballer-ID",
      "Source": "Footballer-ID",
      "Value": ""
    },
    {
      "Name": "Footballer-Name",
      "Source": "Footballer-Name",
      "Value": "David X-Ray Custom Variable"
    },
    {
      "Name": "Footballer-PhotoURL",
      "Source": "Footballer-PhotoURL",
      "Value": "https://resources.premierleague.com/premierleague/photos/players/110x140/p154561.png"
    },
    {
      "Name": "Footballer-Position",
      "Source": "Footballer-Position",
      "Value": ""
    },
    {
      "Name": "Footballer-PositionID",
      "Source": "Footballer-PositionID",
      "Value": "6756e62f050c585400050d8b"
    },
    {
      "Name": "Footballer-SquadNumber",
      "Source": "Footballer-SquadNumber",
      "Value": ""
    },
    {
      "Name": "Footballer-TeamID",
      "Source": "Footballer-TeamID",
      "Value": "674d85df050c58540003f7d4"
    },
    {
      "Name": "MovieID",
      "Source": "MovieID",
      "Value": "2"
    },
    {
      "Name": "Nationality-ID",
      "Source": "Nationality-ID",
      "Value": ""
    },
    {
      "Name": "NationalityName",
      "Source": "Search Criteria",
      "Value": "Which nation player represents"
    },
    {
      "Name": "Page",
      "Source": "Component",
      "Value": "1"
    },
    {
      "Name": "Population",
      "Source": "Population",
      "Value": "747"
    },
    {
      "Name": "Rows",
      "Source": "Component",
      "Value": "10"
    },
    {
      "Name": "Search-Text",
      "Source": "Search-Text",
      "Value": "dan"
    },
    {
      "Name": "Team",
      "Source": "Grid",
      "Value": ""
    },
    {
      "Name": "Team-Badge",
      "Source": "Team-Badge",
      "Value": "67fe193278badf650005d1c3"
    },
    {
      "Name": "Team-Badge-URL",
      "Source": "Team-Badge-URL",
      "Value": "https://api.trisys.co.uk/FileViewer//Josie.Musto/20250506_151741_7dc42935-75e0-4d86-995b-e0a675cffa4"
    },
    {
      "Name": "Team-Description",
      "Source": null,
      "Value": "Test Club 11:40"
    },
    {
      "Name": "TeamID",
      "Source": null,
      "Value": "681a493978badf65000afda0"
    },
    {
      "Name": "TeamName",
      "Source": "Grid",
      "Value": ""
    },
    {
      "Name": "Wine-ID",
      "Source": "Wine-ID",
      "Value": "6714ce76443fd8fa014b6441"
    },
    {
      "Name": "Wine-Name",
      "Source": "Wine-Name",
      "Value": "Syrah"
    },
    {
      "Name": "RealEstate-ID",
      "Source": "RealEstate-ID",
      "Value": "68668df878badf650013b7e7"
    }
  ]
}