-
Notifications
You must be signed in to change notification settings - Fork 17
gmsapi
The following endpoints are available for use with the Governed Metrics Service. All endpoints are prefaced with masterlib.
To test and explore the API, you can use the free tool Postman
You can import a collection and environment from the folder where Governed Metrics Service is installed.
The default location is: %Program Files%\Qlik\Sense\EAPowerTools\GovernedMetricsService\postman
To learn more about Postman collections look here
To learn more about Postman environment look here
Returns the hypercube definition for the data to be returned to the Governed Metrics Service for population in master libraries across apps.
- Status: 200
Returns the json definition of the hypercube used to populate master library items.
Navigates to the test page used for running the Governed Metrics Service in push button fashion.
- Status: 200
Rendered testpage.
Returns the GUID ID for the metrics library app name designated in the config.js file.
- Status: 200
The guid for the metrics library app.
Returns the guid for the application name supplied.
- Content-Type: application/json
{
"appname":"Operations Monitor"
}
- Status: 200
Returns the guid for the application name supplied.
Calls the update/all method
- Status: 200
Updates metrics in a specific app referenced by id or name, or can be used to update metrics in all apps.
- Content-Type: "application/json"
{
"mode" : ["SINGLE"] , ["ALL"],
"appId" : *guid of application*,
"appName": *name of application*
}
Use appId or appName, not both
- Status: 200
Updates applications with the ManagedMasterItems custom property applied with the master library dimensions and measures corresponding to applied values.
- Status: 200
Deletes all of the master library items applied by GMS for the supplied application name.
- Content-Type: application/json
{
"appname":"Operations Monitor"
}
- Status: 200
Triggers a refresh of the data contained in the Metrics Library Qlik application that stores dimension and measure metadata for use with the GMS.
- Status: 200
Returns the Governed Metrics Service version.
Returns the Governed Metrics Service version.
An endpoint used by the Qlik Sense REST Connector to populate master library items from an app into the Metrics Library application.
The response is the definitions of dimensions and measures from apps with the MasterLibrarySource custom property applied.
Receives messages from the QRS api telling the Governed Metrics Service to process ownership changes on master library items applied by the service.
An array of objects matching the notification criteria set by the Governed Metrics Service prompting a call to the endpoint.
Receives messages from the QRS api telling the Governed Metrics Service that delete operations in the repository have completed for the entities listed in body.
An array of objects matching the notification criteria set by the Governed Metrics Service.
Retrieves a list of apps to populate a drop down box in the test page. Used for finding master library item ids to incorporate into GMS.
JSON object with the id and name of each app in the Qlik Sense site GMS is installed.
Retrieves a list of dimensions and measures from the app selected in the drop down list of apps on the GMS test page.
id = the app guid representing the app in Qlik Sense repository.
JSON object with the ID, UID, description, type, and gms tag (where applied) for each dimension or measure.