Web API: Expression/query: Difference between revisions

From QPR ProcessAnalyzer Wiki
Jump to navigation Jump to search
(Created page with "The Analysis operation run a query in the server and returns data. Form of the url is <nowiki>https://SERVER/qprpa/api/analysis/33</nowiki> where SERVER is the DNS name to a...")
 
No edit summary
Line 3: Line 3:
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.)


HTTP request header '''Authorization''' with value '''Bearer <access token>''' needs to be in place to identify the session to be signed out.  
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]].
Line 16: Line 16:
}
}
</pre>
</pre>
[[Category: QPR ProcessAnalyzer]]

Revision as of 22:26, 15 May 2020

The Analysis operation run a query in the server and returns data.

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.

Returns Example:

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