Query interdependent selection options

Returns selection options for a report parameter of a report template if the parameter depends on one or two others.

URLs

GET    /api/v1/report/{TemplateID}/parameter/{ParameterGuid}/{ParentChoiceKey}

GET   /api/v1/report/{TemplateID}/parameter/{ParameterGuid}/{ParentChoiceKey}/

{ParentParentChoiceKey}

 

Example:

/api/v1/report/872C4FEA-DDD4-47B8-B38F-970CEBAD9F50/parameter/4EBF075B-CAF6-4961-B0DE-493DEE4CE108/dependencies/[LLVar]AwABAAAA

Optional parameters

Parameter can be passed in URL as ?param=value or form-encoded in the request body.

Name

Values

Default

Function

format

json/xml

xml

Defines the format with which the list of Choice objects is serialized.

 

Result type: IEnumerable<Choice>

A list of choices is returned.

As XML

<?xml version="1.0" encoding="utf-16"?>

<ArrayOfChoice xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

    <Choice>

        <Key>[LLVar]AwABAAAA</Key>

        <Value>Chai</Value>

        <IsSelected>true</IsSelected>

    </Choice>

    <Choice>

        <Key>[LLVar]AwACAAAA</Key>

        <Value>Chang</Value>

        <IsSelected>false</IsSelected>

    </Choice>

    <Choice>

        <Key>[LLVar]AwAYAAAA</Key>

        <Value>Guaraná Fantástica</Value>

        <IsSelected>false</IsSelected>

    </Choice>

    <Choice>

        <Key>[LLVar]AwAiAAAA</Key>

        <Value>Sasquatch Ale</Value>

        <IsSelected>false</IsSelected>

    </Choice>

    <Choice>

        <Key>[LLVar]AwAjAAAA</Key>

        <Value>Steeleye Stout</Value>

        <IsSelected>false</IsSelected>

    </Choice>

    <Choice>

        <Key>[LLVar]AwAmAAAA</Key>

        <Value>Côte de Blaye</Value>

        <IsSelected>false</IsSelected>

    </Choice>

    <Choice>

        <Key>[LLVar]AwAnAAAA</Key>

        <Value>Chartreuse verte</Value>

        <IsSelected>false</IsSelected>

    </Choice>

    <Choice>

        <Key>[LLVar]AwArAAAA</Key>

        <Value>Ipoh Coffee</Value>

        <IsSelected>false</IsSelected>

    </Choice>

    <Choice>

        <Key>[LLVar]AwBDAAAA</Key>

        <Value>Laughing Lumberjack Lager</Value>

        <IsSelected>false</IsSelected>

    </Choice>

    <Choice>

        <Key>[LLVar]AwBGAAAA</Key>

        <Value>Outback Lager</Value>

        <IsSelected>false</IsSelected>

    </Choice>

    <Choice>

        <Key>[LLVar]AwBLAAAA</Key>

        <Value>Rhönbräu Klosterbier</Value>

        <IsSelected>false</IsSelected>

    </Choice>

    <Choice>

        <Key>[LLVar]AwBMAAAA</Key>

        <Value>Lakkalikööri</Value>

        <IsSelected>false</IsSelected>

    </Choice>

</ArrayOfChoice>

 

As JSON

[

    {

        "Key": "[LLVar]AwABAAAA",

        "Value": "Chai",

        "IsSelected": true

    },

    {

        "Key": "[LLVar]AwACAAAA",

        "Value": "Chang",

        "IsSelected": false

    },

    {

        "Key": "[LLVar]AwAYAAAA",

        "Value": "Guaraná Fantástica",

        "IsSelected": false

    },

    {

        "Key": "[LLVar]AwAiAAAA",

        "Value": "Sasquatch Ale",

        "IsSelected": false

    },

    {

        "Key": "[LLVar]AwAjAAAA",

        "Value": "Steeleye Stout",

        "IsSelected": false

    },

    {

        "Key": "[LLVar]AwAmAAAA",

        "Value": "Côte de Blaye",

        "IsSelected": false

    },

    {

        "Key": "[LLVar]AwAnAAAA",

        "Value": "Chartreuse verte",

        "IsSelected": false

    },

    {

        "Key": "[LLVar]AwArAAAA",

        "Value": "Ipoh Coffee",

        "IsSelected": false

    },

    {

        "Key": "[LLVar]AwBDAAAA",

        "Value": "Laughing Lumberjack Lager",

        "IsSelected": false

    },

    {

        "Key": "[LLVar]AwBGAAAA",

        "Value": "Outback Lager",

        "IsSelected": false

    },

    {

        "Key": "[LLVar]AwBLAAAA",

        "Value": "Rhönbräu Klosterbier",

        "IsSelected": false

    },

    {

        "Key": "[LLVar]AwBMAAAA",

        "Value": "Lakkalikööri",

        "IsSelected": false

    }

]