Many of the lifecycle phases of the Janus API also require Directives to be included in the request JSON. Directives are instructions provided to an endpoint to determine how a template should be processed. One example of this is the “Language” directive of the Enrichment phase, which determines the Language that the resulting report is generated in. Each template in each measure has its own set of Directives, defined in the “Directives” tab of the ScalesItems file.

Figure 2 – A sample Directives table from a ScalesItems file

The Directive tables function similarly to the Items tables. The “ID” GUID above the table is the templateID that these directives belong to. So when making a request that uses that templateID, these Directives must be included.

Directives are included in the request JSONs in the following structure:

"directives": {
    "keyValuePairsArray": [
        {
            "key": "AdministrationMethod",
            "value": "1"
        },
        {
            "key": "ItemResponses_Section",
            "value": "1"
        },
        {
            "key": "ItemsByScale_Section",
            "value": "1"
        },
        {
            "key": "Language",
            "value": "en-US"
        }
    ]
}