Get Decision Support link for a session
GET /api/v1/session/{sessionId}/decisionSupportLink?auditUserIdentifier={auditUserIdentifier}
Description
Get the link to the decision support. The link will be valid for 5 minutes.
Decision Support
Read more about the Decision Support interface here.
Request Parameters (path)
| Name | Description | Required | Type |
|---|---|---|---|
sessionId | The identifier of the session | Yes | uuid |
auditUserIdentifier | Will be included in all audit logs | Yes | string |
Response
HTTP Status Codes
| Code | Description |
|---|---|
| 200 | Success, returns a Link |
| 401 | Unauthorized, missing X-Red-Robin-API-Key header |
| 403 | Forbidden, invalid X-Red-Robin-API-Key header |
| 404 | Not found, invalid configuration |
Link
| Name | Description | Type | Example |
|---|---|---|---|
link | Url to decision support | string | https://se.visibatriage.com/decision-support/exchange/CfDJ8GpLvI98UsZKme7/b497833 |
token | Url to decision support | string | CfDJ8GpLvI98UsZKme7/b497833 |
managerScriptUrl | Url to decision support | string | https://se.visibatriage.com/api/v1/decisionSupport/manager.js |
Example Usage
- Javascript
GET /api/v1/session/{sessionId}/decisionSupportLink
const headers = new Headers();
headers.append('X-Red-Robin-API-Key', 'API_KEY');
headers.append('Content-Type', 'application/json');
const requestOptions = {
method: 'GET',
headers: headers,
};
fetch('https://se.visibatriage.com/api/v1/session/{sessionId}/decisionSupportLink', requestOptions)
.then((response) => response.text())
.then((result) => console.log(result))
.catch((error) => console.log('error', error));
Example Success Response
{
"link": "https://se.visibatriage.com/decision-support/exchange/CfDJ8GpLvI98UsZKme7/b497833",
"token": "CfDJ8GpLvI98UsZKme7/b497833",
"managerScriptUrl": "https://se.visibatriage.com/api/v1/decisionSupport/manager.js"
}