POST
/
renderDSL
/
{app}
Get and render a template
curl --request POST \
  --url https://{FUSION_HOST.com}/api/templating/renderDSL/{app} \
  --header 'Content-Type: application/json' \
  --data '{
  "context": {},
  "facets": {
    "fields": [
      {
        "domain": {
          "additionalFilters": [
            {
              "type": "<string>"
            }
          ],
          "excludedFiltersByName": [
            "<string>"
          ]
        },
        "ensuredValues": [
          "<string>"
        ],
        "field": "<string>",
        "limit": 123,
        "minCount": 123,
        "missing": true,
        "offset": 123,
        "prefix": "<string>",
        "sort": "count"
      }
    ],
    "groupFacets": true,
    "groupingMethod": "header_doc",
    "ranges": [
      {
        "domain": {
          "additionalFilters": [
            {
              "type": "<string>"
            }
          ],
          "excludedFiltersByName": [
            "<string>"
          ]
        },
        "end": "<string>",
        "field": "<string>",
        "gap": "<string>",
        "hardEnd": true,
        "include": [
          "all"
        ],
        "minCount": 123,
        "other": [
          "after"
        ],
        "start": "<string>"
      }
    ]
  },
  "params": {},
  "queryDefinition": {
    "boostsByQuery": [
      {
        "boost": 123,
        "query": {
          "type": "<string>"
        },
        "type": "<string>"
      }
    ],
    "boostsByValues": [
      {
        "boosts": [
          {
            "boost": 123,
            "key": "<string>"
          }
        ],
        "field": "<string>"
      }
    ],
    "filters": [
      {
        "type": "<string>"
      }
    ],
    "groupedFilters": [
      {
        "type": "<string>"
      }
    ],
    "groupedQuery": {
      "type": "<string>"
    },
    "main": {
      "type": "<string>"
    },
    "namedFilters": [
      {
        "name": "<string>",
        "query": {
          "type": "<string>"
        }
      }
    ],
    "userQuery": "<string>"
  },
  "results": {
    "cursor": "<string>",
    "fields": [
      "<string>"
    ],
    "group": {
      "field": "<string>",
      "leaderStrategy": {
        "type": "<string>"
      },
      "size": 123,
      "sort": [
        {
          "order": "asc",
          "query": {
            "type": "<string>"
          },
          "type": "expression",
          "value": "<string>"
        }
      ]
    },
    "highlight": {
      "count": 123,
      "defaultHighlight": true,
      "fields": [
        "<string>"
      ],
      "length": 123,
      "post": "<string>",
      "pre": "<string>"
    },
    "includeRawResponse": true,
    "returnScore": true,
    "size": 123,
    "sort": [
      {
        "order": "asc",
        "query": {
          "type": "<string>"
        },
        "type": "expression",
        "value": "<string>"
      }
    ],
    "start": 123
  }
}'
{
  "templateId": "441eb3be-7de6-470a-8141-e416a15c7db1",
  "rendered": [
    {
      "zone": {
        "name": "Results List",
        "id": "6a092bd4-5098-466c-94aa-40bf68294303",
        "type": "result-list",
        "queryProfile": "query-profile-name",
        "omitFilters": false,
        "dirty": false,
        "neverPublished": false,
        "metadata": {
          "image": "image-id",
          "secondary": "_text_",
          "primary": "primary-metadata-id",
          "layout": "grid"
        }
      },
      "inTemplates": [
        "e123f4bc-5e7e-46dd-9be8-71a4f73e511a, 8084969c-bd23-40f7-9acf-c68d6798bec2, 441eb3be-7de6-470a-8141-e416a15c7db1, fb148491-b39e-46d1-af33-44cd964d8ee0"
      ],
      "staging": false,
      "published": false,
      "layout": "grid"
    }
  ],
  "render": {
    "response": {
      "docs": [
        "<string>"
      ],
      "numFound": 123,
      "start": 123,
      "maxScore": 123,
      "numFoundExact": true
    }
  },
  "responseHeader": {
    "zkConnected": true,
    "QTime": 123,
    "totalTime": 123,
    "params": {
      "_stateVer_": "your-app-name:version",
      "lw.pipelineId": "<string>",
      "start": 3,
      "params": "\"dictionary[\\\"key1\\\" : \\\"value1\\\", \\\"key2\\\" : [\\\"one\\\", \\\"two\\\", \\\"a\\\", \\\"B\\\", \\\"bubbles\\\"], \\\"key3\\\" : [\\\"five bubbles\\\", \\\"sunny\\\"], \\\"key4\\\" : \\\"value4\\\"\",",
      "rows": 10,
      "version": "2.2",
      "queryProfileID": "query-profile",
      "isFusionQuery": true,
      "defType": "eDisMax",
      "templateTypes": "landing",
      "showInactive": true,
      "shards.preference": "<string>",
      "wt": "json",
      "staging": true,
      "fusionQueryId": "fusion-query-id"
    }
  },
  "status": 0
}

Path Parameters

​
app
string
required

Fusion application name that contains the templates.

Query Parameters

​
requestParams
any
required

Additional request parameters, will be passed through to the query profile when rendering a zone. If there is a 'tags' parameter it will be merged with any tags configured in the zones.

​
staging
boolean
default:false

This field indicates if the request is set to retrieve published or unpublished (staging) templates. The default of false retrieves published templates. If set to true, the request retrieves unpublished (staging) templates.

​
templateTypes
string[]

Comma-separated list of template types, indicating which possible types of templates to trigger (e.g. landing, item-detail...)

Body

application/json

DSL request, used to determine navigation state and will be passed through to the indicated query profiles when rendering each zone.

The body is of type object.

Response

200
application/json

OK

The response is of type object.