Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

Some value fields output data, which is 1-many, i.e. sometimes a value field can output a single data point (string or number), or one JSON object, or an array of data.

isArray signifies that a value field's output is always output as an array.

Example:

The value field 


With this added value field, the returned search result is (the response contains data other than this single value field, but that data has been omitted for clarity's sake):

{
    "items": [
        {
            //The value field
            "Keywords": [
                "Keyword1",
                "Keyword2"
            ]            
        },
        {
			//The value field
            "Keywords": "Keyword2"       
        }
    ],
    "success": true,
    "total": "2"
}

The result contains two objects. Each of these objects have a "Keywords" property. The first object has two keywords:

"Keywords": [
                "Keyword1",
                "Keyword2"
            ]


The second object has only one keyword:

"Keywords": "Keyword2"


If we edit the value field, so that isArray is checked, the returned result is:

{
    "items": [
        {
            //The value field
            "Keywords": [
                "Keyword1",
                "Keyword2"
            ]
        },
        {
            //The value field
            "Keywords": [
                "Keyword2"
            ]
        }
    ],
    "success": true,
    "total": "2"
}

Now both of the objects' Keywords property is an array.

  • No labels