About API: Get description

Method

GET

Path

/qrs/about/api/description?extended={extended}&method={method}&format={format}

Description

List all paths available in the Qlik Sense Repository Service (QRS) API. Optionally, return extended information, endpoints that use a specific HTTP verb, or the return values in JSON format.

Body

-

Return value

List<string>:

[
   "GET     /qrs/about",
   "GET     /qrs/about/api/default?listentries={listEntries}",
   "GET     /qrs/about/api/description?extended={extended}&method={method}&format={format}",
   "GET     /qrs/about/api/enums",
   "..."
]

Optional parameters

• {extended}: If true, returns the following:
  • The type (if any) that needs to be included in the body.
  • The type of return value (if any).
  • If the endpoint is automatically generated or not.
• {method}: If set to an HTTP verb (GET, PUT, POST, or DELETE), only endpoints that use the verb are returned.
• {format}: If set to "JSON", the return value is given in JSON format.