Skip to main content

Explain

Qsc search api (search, navigatioin etc...) can be verified via explain=true search flag.

Quick start

  • Create security config in your tenant

  • Generate basic authentication base64 hash. Lets use username username with password password

    Example for linux:

    echo -n "username:password" | base64
    #Output:
    #dXNlcm5hbWU6cGFzc3dvcmQ=
  • Set parameters in previously created security config

    "securityType": "basicAuth",
    "secret": "dXNlcm5hbWU6cGFzc3dvcmQ=",
    "apiPermissions": {
    "explain": {
    "permit": true
    }
    },
  • Make your request with explain=true flag.

    Example GET search request with query parameter:

    GET
    /api/v1/search/{tenantCode}/{searchConfigCode}?q=*&explain=true

    headers:
    Content-Type: application/json
    Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
  • To see explain graph the output need to be pasted to QSFExplainUI