Web API: Expression/query: Difference between revisions

From QPR ProcessAnalyzer Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
The Analysis operation run a query in the server and returns data.  
The Analysis operation runs a query in the server and returns the query results.  


Form of the url is <nowiki>https://SERVER/qprpa/api/analysis/33</nowiki> where SERVER is the DNS name to access QPR ProcessAnalyzer server. (The 33 is the number of the analysis which is the one mostly used. This documentation only covers using the analysis type 33.)
Form of the url is <nowiki>https://SERVER/qprpa/api/analysis/33</nowiki> where SERVER is the DNS name to access QPR ProcessAnalyzer server. (The 33 is the number of the analysis which is the one mostly used. This documentation only covers using the analysis type 33.)
Line 5: Line 5:
HTTP request header '''Authorization''' with value '''Bearer <access token>''' needs to be in place to identify the session.  
HTTP request header '''Authorization''' with value '''Bearer <access token>''' needs to be in place to identify the session.  


The request body is a JSON object containing key-value pairs as properties. Available properties are described in the [[QPR_ProcessAnalyzer_Expression_Analysis#Expression_Analysis_Query_Parameters|Expression Analysis parameters]].
The request body is a JSON object containing key-value pairs as properties. Available properties are described in the [[QPR_ProcessAnalyzer_Expression_Analysis#Expression_Analysis_Query_Parameters|Expression Analysis parameters]]. Note that all keys are strings, so JSON values need to be stringified.


Returns  
Returns  

Revision as of 22:28, 15 May 2020

The Analysis operation runs a query in the server and returns the query results.

Form of the url is https://SERVER/qprpa/api/analysis/33 where SERVER is the DNS name to access QPR ProcessAnalyzer server. (The 33 is the number of the analysis which is the one mostly used. This documentation only covers using the analysis type 33.)

HTTP request header Authorization with value Bearer <access token> needs to be in place to identify the session.

The request body is a JSON object containing key-value pairs as properties. Available properties are described in the Expression Analysis parameters. Note that all keys are strings, so JSON values need to be stringified.

Returns Example:

url: https://SERVER/qprpa/api/analysis/33
Body:
{
  "IncludeModelInformation": 1
}