QPR ProcessAnalyzer API

From QPR ProcessAnalyzer Wiki
Revision as of 10:54, 26 January 2018 by VesKivi (talk | contribs)
Jump to navigation Jump to search

QPR ProcessAnalzyer Web Service Application Programming Interface can be used to automate operations, and to create integration with other applications.

Functions

The following functions are available in QPR ProcessAnalyzer Web Service API:

QueryObjectProperties

The QueryObjectProperties function returns all the listed properties queried for all the listed objects identified by unique identifiers.

ValidateModel

The ValidateModel function can be used to perform all the pending tasks stored in the work queue of the given model.

Object Types and Their Supported Properties

Common Supported Properties for Object Types

'DataTable' Object Type

'Product' Object Type

'Project' Object Type

Identifying QPR ProcessAnalyzer Objects

Unique identifiers are used to identify any object in a QPR ProcessAnalyzer database.


Example

//login                 
$.ajax({
    "method": "POST",
    "url": "http://localhost/qprpa/Mainservice.svc/webHttp/Authenticate",
    "dataType": "json", "contentType": "application/json; charset=utf-8",
     "data": JSON.stringify({
         'logOnName': '<username>',
       'password': '<password>',
    'parameters': ''})
});                       

//create user
$.ajax({
"method": "POST",
"url": "http://localhost/qprpa/Mainservice.svc/webHttp/SetUser",
"dataType": "json", "contentType": "application/json; charset=utf-8",
                             "data": JSON.stringify({ 
                             "sessionId":"547c1aa5-e85b-4642-bbb1-8cb656015002",
                             "user":{"Name": "user", "FullName": "first last" },
                             "parameters":[{"Key": "Password", "Value": "demo"}]
                             })
});

//add user to group, value 8:12:0 is user:group:member type
$.ajax({
"method": "POST",
"url": "http://localhost/qprpa/Mainservice.svc/webHttp/ModifyUserRelations",
"dataType": "json", "contentType": "application/json; charset=utf-8",
                             "data": JSON.stringify({ 
                             "sessionId":"749dcbdb-e57b-434b-a739-1f4ddc7ebc30",
                             "parameters":[{"Key": "AddGroups", "Value": "8:12:0"}]
                             })
});

//log off
$.ajax({
"method": "POST",
"url": "http://localhost/qprpa/Mainservice.svc/webHttp/LogOff",
"dataType": "json", "contentType": "application/json; charset=utf-8",
                             "data": JSON.stringify({ 
                             "sessionId":"75aa3d08-5ad9-4b0b-8981-7daca98348cd"
                             })
});


Power Shell Example of listing users

$paService=New-WebServiceProxy –Uri “http://localhost/qprpa/MainService.svc ”
$connection=$paService.Authenticate("username","password",@())
$token=$connection.GetValue(0).Value
$token
$param=@()
$users=$paService.GetUsers($token,$null,$param)
$users
$paService | get-member | ? {$_.definition -match "GetAnalysis"}