Operation Endpoint details Form/Querystring fields Output
User Login Method: POST
Path: /user-account
  1. userid : String
  2. password : String
  3. action : String - "login"
 String : "success"
User Registration Method: POST
Path: /user-account
  1. userid : String
  2. email : String
  3. password : String
  4. action : String - "register"
 String : "registration success"
Create business process Method : POST
Path :  /uiapi/businessprocess/[business process name]/create

  • business process name - name of the new business process to be created
  1. user - String
  2. description - String
 businessprocessId,
messages Array

Sample Create business process response JSON
Upload documents Method : POST
Path : /uiapi/businessprocess/[business process id]/docupload/[doctype]
  • doctype : String - Allowed values : "CONTEXT" ,  "RISK"
  • business process id : unique id of the business process
  1. user - String
  2. uploadType - String ("url"||"file")
  3. document - File
  4. documentUrl - String
 JSON

messages Array
Get business process list Method : GET
Path : /lists/businessprocess/[user]  
OR
Path : /lists/businessprocess
  1. term : String
 Business process list JSON
Get alternates list Method : GET
Path : /lists/alternate/[businessprocessid]
  1. term : String
 Alternate list JSON
Get status Method : GET
Path : /uiapi/businessprocess/[businessprocessid]/status		 Status JSON
Get Alternate Method : GET
Path : /uiapi/alternate/[businessprocessid]
  1. risk - String
  2. altIdx - String
 Alternate JSON
Get costing Method: POST
Path : /uiapi/costings
  1. user - String
  2. data - String (JSON with cost inputs - Sample)
  Cost Analysis JSON
Upload Artifact Method: POST
Path : /uiapi/artifact/[business process id]/upload
  1. artifactName : String
  2. user : String
  3. artifactResource : String
  4. artifactUrl : String
  5. source : String ("local"||"url")
  6. artifactFile : File
 JSON

messages Array
Delete Artifact Method: POST
Path : /uiapi/artifact/[business process id]/delete
  1. artifactId : String
  2. user : String
 JSON

messages Array
Artifact List Method: GET
Path : /lists/artifacts/[business process id]		 Artifact List JSON
Resource List Method : GET
Path : /lists/resources/[business process id]
  1. term : String
 Resource List JSON
Status List Method : GET
Path : /lists/status		 Status List JSON
Roles list Method : GET
Path : /lists/roles		 Roles List JSON
Security groups list Method : GET
Path : /lists/groups		 JSON Array with following fields :
- groupId
- groupName
- orgName
Users List Method : GET
Path : /lists/users		 Users list JSON
Recommendation Method : POST
Path /uiapi/businessprocess/[business process id]/recommendation
  1. user : String
  2. risk : String
  3. altIdx : String
  4. preserve : Boolean
 JSON

Messages Array
Get Metadata Method : GET
Path : /uiapi/metadata/[business process id]/get
  1. type : String {"project"||"artifact"}
  2. artifactId : String (when type = "artifact")
 Project Metadata JSON
Artifact Metadata JSON
Save Metadata Method : POST
Path : /uiapi/metadata/[business process id]/save
  1. type : String {"project"||"artifact"}
  2. data : String (Metadata JSON)
  3. artifactId : String (when type = "artifact")
  4. user : String
 JSON

Messages Array
Save verification data Method : POST
Path : /uiapi/verification/[business process id]/save
  1. user : String
  2. verificationXml : String
 JSON

Messages Array
Get verification data Method : GET
Path : /uiapi/verification/[business process id]/get		 Verification Data
Create package Method : POST
Path : /uiapi/businessprocess/[business process id]/package
  1. user : String
 JSON

Messages Array
Get package Method : GET
Path : /uiapi/package/[business process id]		 Context Model
Preserve Method : POST
Path : /uiapi/businessprocess/[business process id]/preserve
  1. user : String
  2. repoId : String
 JSON

Messages Array
Retrieve Method : POST
Path : /uiapi/businessprocess/[business process id]/retrieve
  1. user : String
  2. repoId : String
 JSON

Messages Array
Set status Method : POST
Path : /uiapi/businessprocess/[business process id]/setstatus
  1. user : String
  2. statuscode : String
JSON

Messages Array
Events Method : GET
Path : /uiapi/businessprocess/[business process id]/events
  1. limit : integer
 Events JSON
Get User access dataMethod : GET
Path : /uiapi/useraccess/[userId]/get
Set User access dataMethod : POST
Path : /uiapi/useraccess/[userId]/set
  1. accessData : JSON String
JSON Messages Array
Analytics - StorageMethod : GET
Path : /uiapi/analytics/[optional - business process id]/storage
view : String {"contentType"||"resourceType"}By Resource Type JSON
By Content Type JSON
Analytics - UsersMethod : GET
Path : /uiapi/analytics//users		Userstats JSON
Analytics - CostsMethod : GET
Path : /uiapi/analytics//costs
  1. startYear : Integer (Optional)
  2. startQuarter : Integer (Optional)
Cost stats JSON