<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html><head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1"><title>UIApi</title></head>
<body>
<table style="text-align: left;" border="1" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td>Operation</td>
<td>Endpoint details</td>
<td>Form/Querystring fields</td>
<td>Output</td>
</tr>
<tr>
<td>User Login</td>
<td>Method: POST<br>
Path: /user-account</td>
<td>
<ol>
<li>userid : String</li>
<li>password : String</li>
<li>action : String - "login"</li>
</ol>
</td>
<td>String : "success"</td>
</tr>
<tr>
<td>User Registration</td>
<td>Method: POST<br>
Path: /user-account</td>
<td>
<ol>
<li>userid : String</li>
<li>email : String</li>
<li>password : String</li>
<li>action : String - "register"</li>
</ol>
</td>
<td>String : "registration success"</td>
</tr>
<tr>
<td>Create business process</td>
<td>Method : POST<br>
Path : /uiapi/businessprocess/[business process name]/create<br>
<br>
<ul>
<li>business process name - name of the new business
process to be created</li>
</ul>
</td>
<td>
<ol>
<li>user - String</li>
<li>description - String</li>
</ol>
</td>
<td>businessprocessId, <br>
messages Array<br>
<br>
<a href="createbp.json">Sample Create business
process response JSON</a></td>
</tr>
<tr>
<td>Upload documents</td>
<td>Method : POST<br>
Path : /uiapi/businessprocess/[business process id]/docupload/[doctype]<br>
<ul>
<li>doctype : String - Allowed values : "CONTEXT" ,
"RISK"</li>
<li>business process id : unique id of the business
process</li>
</ul>
</td>
<td>
<ol>
<li>user - String</li>
<li>uploadType - String ("url"||"file")</li><li>document - File</li><li>documentUrl - String</li>
</ol>
</td>
<td>JSON<br>
<br>
messages Array</td>
</tr>
<tr>
<td>Get business process list</td>
<td>Method : GET<br>
Path : /lists/businessprocess/[user] <br>
OR<br>
Path : /lists/businessprocess <br>
</td>
<td>
<ol>
<li>term : String</li>
</ol>
</td>
<td><a href="businessprocesslist.json">Business
process list JSON</a></td>
</tr>
<tr>
<td>Get alternates list</td>
<td>Method : GET<br>
Path : /lists/alternate/[businessprocessid]</td>
<td>
<ol>
<li>term : String</li>
</ol>
</td>
<td><a href="alternatelist.json">Alternate
list JSON</a></td>
</tr>
<tr>
<td>Get status</td>
<td>Method : GET<br>
Path : /uiapi/businessprocess/[businessprocessid]/status</td>
<td></td>
<td><a href="status.json">Status JSON</a></td>
</tr>
<tr>
<td>Get Alternate</td>
<td>Method : GET<br>
Path : /uiapi/alternate/[businessprocessid]</td>
<td>
<ol>
<li>risk - String</li>
<li>altIdx - String</li>
</ol>
</td>
<td><a href="alternate.json">Alternate JSON</a></td>
</tr>
<tr>
<td>Get costing</td>
<td>Method: POST<br>
Path : /uiapi/costings</td>
<td>
<ol>
<li>user - String</li>
<li>data - String (JSON with cost inputs - <a href="costInputs.json">Sample</a>)</li>
</ol>
</td>
<td> <a href="costanalysis.json">Cost
Analysis JSON</a></td>
</tr>
<tr>
<td>Upload Artifact</td>
<td>Method: POST<br>
Path : /uiapi/artifact/[business process id]/upload</td>
<td>
<ol>
<li>artifactName : String</li>
<li>user : String</li>
<li>artifactResource : String</li>
<li>artifactUrl : String</li>
<li>source : String ("local"||"url")</li>
<li>artifactFile : File</li>
</ol>
</td>
<td>JSON<br>
<br>
messages Array</td>
</tr>
<tr><td>Delete Artifact</td><td>Method: POST<br>Path : /uiapi/artifact/[business process id]/delete</td><td><ol><li>artifactId : String</li><li>user : String</li></ol></td><td>JSON<br>
<br>
messages Array</td></tr><tr>
<td>Artifact List</td>
<td>Method: GET<br>
Path : /lists/artifacts/[business process id]</td>
<td></td>
<td><a href="artifactlist.json">Artifact List
JSON</a></td>
</tr>
<tr>
<td>Resource List</td>
<td>Method : GET<br>
Path : /lists/resources/[business process id]</td>
<td>
<ol>
<li>term : String</li>
</ol>
</td>
<td><a href="resourcelist.json">Resource List
JSON</a></td>
</tr>
<tr><td>Status List</td><td>Method : GET<br>Path : /lists/status</td><td></td><td><a href="statuslist.json">Status List JSON</a></td></tr><tr>
<td>Recommendation</td>
<td>Method : POST<br>
Path /uiapi/businessprocess/[business process id]/recommendation</td>
<td>
<ol>
<li>user : String</li>
<li>risk : String</li>
<li>altIdx : String</li>
<li>preserve : Boolean</li>
</ol>
</td>
<td>JSON <br>
<br>
Messages Array</td>
</tr>
<tr>
<td>Get Metadata</td>
<td>Method : GET<br>
Path : /uiapi/metadata/[business process id]/get</td>
<td>
<ol>
<li>type : String {"project"||"artifact"}</li>
<li>artifactId : String (when type = "artifact")</li>
</ol>
</td>
<td><a href="projectmetadata.json">Project
Metadata JSON</a><br>
<a href="artifactmetadata.json">Artifact Metadata
JSON</a></td>
</tr>
<tr>
<td>Save Metadata</td>
<td>Method : POST<br>
Path : /uiapi/metadata/[business process id]/save</td>
<td>
<ol>
<li>type : String {"project"||"artifact"}</li>
<li>data : String (Metadata JSON)</li>
<li>artifactId : String (when type = "artifact")</li>
<li>user : String</li>
</ol>
</td>
<td>JSON <br>
<br>
Messages Array</td>
</tr>
<tr><td>Save verification data</td><td>Method : POST<br>Path : /uiapi/verification/[business process id]/save</td><td><ol><li>user : String</li><li>verificationXml : String</li></ol></td><td>JSON <br>
<br>
Messages Array</td></tr><tr><td>Get verification data</td><td>Method : GET<br>Path : /uiapi/verification/[business process id]/get</td><td></td><td>Verification Data</td></tr><tr><td>Create package</td><td>Method : POST<br>
Path : /uiapi/businessprocess/[business process id]/package</td><td><ol><li>user : String</li></ol></td><td>JSON <br>
<br>
Messages Array</td></tr><tr><td>Get package</td><td>Method : GET<br>Path : /uiapi/package/[business process id]</td><td></td><td><a href="package_sample.owl">Context Model</a></td></tr><tr><td>Preserve</td><td>Method : POST<br>Path : /uiapi/businessprocess/[business process id]/preserve</td><td><ol><li>user : String</li><li>repoId : String</li></ol></td><td>JSON <br>
<br>
Messages Array</td></tr><tr><td>Retrieve</td><td>Method : POST<br>Path : /uiapi/businessprocess/[business process id]/retrieve</td><td><ol><li>user : String</li><li>repoId : String</li></ol></td><td>JSON <br>
<br>
Messages Array</td></tr><tr><td>Set status</td><td>Method : POST<br>Path : /uiapi/businessprocess/[business process id]/setstatus</td><td><ol><li>user : String</li><li>statuscode : String </li></ol></td><td>JSON <br><br>Messages Array</td></tr><tr><td>Events</td><td>Method : GET<br>Path : /uiapi/businessprocess/[business process id]/events</td><td><ol><li>limit : integer</li></ol></td><td><a href="events.json">Events JSON</a></td></tr></tbody>
</table>
<br>
</body></html>