API

Quality management APIs

GET quality/risks/{riskId}

Get risk details

HTTP method GET
URI https://api.rambase.net/quality/risks/{riskId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {riskId} Identifier of the risk
Integer, minimum 100000
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 5207, version 15

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.
$showCustomFields Boolean, optional Set to "true" to include custom fields. Default value is false.

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<Risk>
2
     <RiskId
RiskId

Identifier of the risk

>{Integer}</RiskId>
3
     <CreatedAt
CreatedAt

Date and time when risk was created

>{Datetime}</CreatedAt>
4
     <UpdatedAt
UpdatedAt

Date and time of update

>{Datetime}</UpdatedAt>
5
     <Status
Status

Status of the risk

Possible domain values can be found here

>{Integer}</Status>
6
     <Title
Title

Title of the risk

>{String}</Title>
7
     <Description
Description

Description of the risk

>{String}</Description>
8
     <PositiveScore
PositiveScore

This field is greyed out because it is an expandable field. You have to add $expand=PositiveScore in your request URI to get this field

>
9
          <PotentialConsequenceId
PotentialConsequenceId

Potential consequence identifier

This field is greyed out because it is an expandable field. You have to add $expand=PositiveScore in your request URI to get this field

>{Integer}</PotentialConsequenceId>
10
          <Score
Score

Score of the potential consequence. Calculated from severity rating multiplied with likelihood level

This field is greyed out because it is an expandable field. You have to add $expand=PositiveScore in your request URI to get this field

>{Integer}</Score>
11
          <QualityConsequenceArea
QualityConsequenceArea

This field is greyed out because it is an expandable field. You have to add $expand=PositiveScore in your request URI to get this field

>
12
               <QualityConsequenceAreaId
QualityConsequenceAreaId

Quality consequence identifier

This field is greyed out because it is an expandable field. You have to add $expand=PositiveScore in your request URI to get this field

>{Integer}</QualityConsequenceAreaId>
13
               <LowerThreshold
LowerThreshold

Threshold for risk scores. Values less than or equal to this threshold will have a low risk. Medium or higher risks have risk scores greater than this threshold value

This field is greyed out because it is an expandable field. You have to add $expand=PositiveScore in your request URI to get this field

>{Integer}</LowerThreshold>
14
               <UpperThreshold
UpperThreshold

Threshold for risk scores. Values less than this threshold will have a low or medium risk. High risks will have risk scores greater than or equal to this threshold value

This field is greyed out because it is an expandable field. You have to add $expand=PositiveScore in your request URI to get this field

>{Integer}</UpperThreshold>
15
               <QualityConsequenceAreaLink
QualityConsequenceAreaLink

Quality consequence area reference

This field is greyed out because it is an expandable field. You have to add $expand=PositiveScore in your request URI to get this field

>{String}</QualityConsequenceAreaLink>
16
          </QualityConsequenceArea>
17
          <PotentialConsequenceLink
PotentialConsequenceLink

API reference to the item

This field is greyed out because it is an expandable field. You have to add $expand=PositiveScore in your request URI to get this field

>{String}</PotentialConsequenceLink>
18
     </PositiveScore>
19
     <NegativeScore
NegativeScore

This field is greyed out because it is an expandable field. You have to add $expand=NegativeScore in your request URI to get this field

>
20
          <PotentialConsequenceId
PotentialConsequenceId

Potential consequence identifier

This field is greyed out because it is an expandable field. You have to add $expand=NegativeScore in your request URI to get this field

>{Integer}</PotentialConsequenceId>
21
          <Score
Score

Score of the potential consequence. Calculated from severity rating multiplied with likelihood level

This field is greyed out because it is an expandable field. You have to add $expand=NegativeScore in your request URI to get this field

>{Integer}</Score>
22
          <QualityConsequenceArea
QualityConsequenceArea

This field is greyed out because it is an expandable field. You have to add $expand=NegativeScore in your request URI to get this field

>
23
               <QualityConsequenceAreaId
QualityConsequenceAreaId

Quality consequence identifier

This field is greyed out because it is an expandable field. You have to add $expand=NegativeScore in your request URI to get this field

>{Integer}</QualityConsequenceAreaId>
24
               <LowerThreshold
LowerThreshold

Threshold for risk scores. Values less than or equal to this threshold will have a low risk. Medium or higher risks have risk scores greater than this threshold value

This field is greyed out because it is an expandable field. You have to add $expand=NegativeScore in your request URI to get this field

>{Integer}</LowerThreshold>
25
               <UpperThreshold
UpperThreshold

Threshold for risk scores. Values less than this threshold will have a low or medium risk. High risks will have risk scores greater than or equal to this threshold value

This field is greyed out because it is an expandable field. You have to add $expand=NegativeScore in your request URI to get this field

>{Integer}</UpperThreshold>
26
               <QualityConsequenceAreaLink
QualityConsequenceAreaLink

Quality consequence area reference

This field is greyed out because it is an expandable field. You have to add $expand=NegativeScore in your request URI to get this field

>{String}</QualityConsequenceAreaLink>
27
          </QualityConsequenceArea>
28
          <PotentialConsequenceLink
PotentialConsequenceLink

API reference to the item

This field is greyed out because it is an expandable field. You have to add $expand=NegativeScore in your request URI to get this field

>{String}</PotentialConsequenceLink>
29
     </NegativeScore>
30
     <RiskAssessment
RiskAssessment

This field is greyed out because it is an expandable field. You have to add $expand=RiskAssessment in your request URI to get this field

>
31
          <RiskAssessmentId
RiskAssessmentId

Risk assessment identifier

This field is greyed out because it is an expandable field. You have to add $expand=RiskAssessment in your request URI to get this field

>{Integer}</RiskAssessmentId>
32
          <Status
Status

Status of risk assessment

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=RiskAssessment in your request URI to get this field

>{Integer}</Status>
33
          <Name
Name

Name of the risk assessment

This field is greyed out because it is an expandable field. You have to add $expand=RiskAssessment in your request URI to get this field

>{String}</Name>
34
          <IsTemplate
IsTemplate

This field indicates if risk assessment is marked as a template assessment

This field is greyed out because it is an expandable field. You have to add $expand=RiskAssessment in your request URI to get this field

>{Boolean}</IsTemplate>
35
          <RiskAssessmentLink
RiskAssessmentLink

API reference to the object

This field is greyed out because it is an expandable field. You have to add $expand=RiskAssessment in your request URI to get this field

>{String}</RiskAssessmentLink>
36
     </RiskAssessment>
37
     <Owner
Owner

This field is greyed out because it is an expandable field. You have to add $expand=Owner in your request URI to get this field

>
38
          <EmployeeId
EmployeeId

Employee identifier

This field is greyed out because it is an expandable field. You have to add $expand=Owner in your request URI to get this field

>{Integer}</EmployeeId>
39
          <LastName
LastName

Last name of employee

This field is greyed out because it is an expandable field. You have to add $expand=Owner in your request URI to get this field

>{String}</LastName>
40
          <FirstName
FirstName

First name of employee

This field is greyed out because it is an expandable field. You have to add $expand=Owner in your request URI to get this field

>{String}</FirstName>
41
          <EmployeeLink
EmployeeLink

Employee reference

This field is greyed out because it is an expandable field. You have to add $expand=Owner in your request URI to get this field

>{String}</EmployeeLink>
42
     </Owner>
43
     <Context
Context

This field is greyed out because it is an expandable field. You have to add $expand=Context in your request URI to get this field

>
44
          <Source
Source

This field is greyed out because it is an expandable field. You have to add $expand=Context in your request URI to get this field

>
45
               <ObjectId
ObjectId

Identifier of the object

This field is greyed out because it is an expandable field. You have to add $expand=Context in your request URI to get this field

>{Integer}</ObjectId>
46
               <ObjectType
ObjectType

Type of object

This field is greyed out because it is an expandable field. You have to add $expand=Context in your request URI to get this field

>{String}</ObjectType>
47
               <ObjectLink
ObjectLink

API reference to the object

This field is greyed out because it is an expandable field. You have to add $expand=Context in your request URI to get this field

>{String}</ObjectLink>
48
               <ItemId
ItemId

Item-number of the object

This field is greyed out because it is an expandable field. You have to add $expand=Context in your request URI to get this field

>{Integer}</ItemId>
49
               <ItemLink
ItemLink

API reference to the item

This field is greyed out because it is an expandable field. You have to add $expand=Context in your request URI to get this field

>{String}</ItemLink>
50
          </Source>
51
     </Context>
52
     <Totals
Totals

This field is greyed out because it is an expandable field. You have to add $expand=Totals in your request URI to get this field

>
53
          <PotentialConsequencesCount
PotentialConsequencesCount

Shows count of all consequence types belonging to this risk

This field is greyed out because it is an expandable field. You have to add $expand=Totals in your request URI to get this field

>{Integer}</PotentialConsequencesCount>
54
          <ControlsCount
ControlsCount

Shows count of all controls belonging to this risk

This field is greyed out because it is an expandable field. You have to add $expand=Totals in your request URI to get this field

>{Integer}</ControlsCount>
55
          <RiskActionsCount
RiskActionsCount

Shows all actions count belonging to this risk.

This field is greyed out because it is an expandable field. You have to add $expand=Totals in your request URI to get this field

>{Integer}</RiskActionsCount>
56
          <DoneRiskActionsCount
DoneRiskActionsCount

Shows count of done actions belonging to this risk

This field is greyed out because it is an expandable field. You have to add $expand=Totals in your request URI to get this field

>{Integer}</DoneRiskActionsCount>
57
          <NotesCount
NotesCount

Shows count of the notes added to the risk

This field is greyed out because it is an expandable field. You have to add $expand=Totals in your request URI to get this field

>{Integer}</NotesCount>
58
     </Totals>
59
</Risk>
1
{
2
     "risk": {
3
          "riskId
RiskId

Identifier of the risk

": "{Integer}",
4
          "createdAt
CreatedAt

Date and time when risk was created

": "{Datetime}",
5
          "updatedAt
UpdatedAt

Date and time of update

": "{Datetime}",
6
          "status
Status

Status of the risk

Possible domain values can be found here

": "{Integer}",
7
          "title
Title

Title of the risk

": "{String}",
8
          "description
Description

Description of the risk

": "{String}",
9
          "positiveScore
PositiveScore

This field is greyed out because it is an expandable field. You have to add $expand=PositiveScore in your request URI to get this field

": {
10
               "potentialConsequenceId
PotentialConsequenceId

Potential consequence identifier

This field is greyed out because it is an expandable field. You have to add $expand=PositiveScore in your request URI to get this field

": "{Integer}",
11
               "score
Score

Score of the potential consequence. Calculated from severity rating multiplied with likelihood level

This field is greyed out because it is an expandable field. You have to add $expand=PositiveScore in your request URI to get this field

": "{Integer}",
12
               "qualityConsequenceArea
QualityConsequenceArea

This field is greyed out because it is an expandable field. You have to add $expand=PositiveScore in your request URI to get this field

": {
13
                    "qualityConsequenceAreaId
QualityConsequenceAreaId

Quality consequence identifier

This field is greyed out because it is an expandable field. You have to add $expand=PositiveScore in your request URI to get this field

": "{Integer}",
14
                    "lowerThreshold
LowerThreshold

Threshold for risk scores. Values less than or equal to this threshold will have a low risk. Medium or higher risks have risk scores greater than this threshold value

This field is greyed out because it is an expandable field. You have to add $expand=PositiveScore in your request URI to get this field

": "{Integer}",
15
                    "upperThreshold
UpperThreshold

Threshold for risk scores. Values less than this threshold will have a low or medium risk. High risks will have risk scores greater than or equal to this threshold value

This field is greyed out because it is an expandable field. You have to add $expand=PositiveScore in your request URI to get this field

": "{Integer}",
16
                    "qualityConsequenceAreaLink
QualityConsequenceAreaLink

Quality consequence area reference

This field is greyed out because it is an expandable field. You have to add $expand=PositiveScore in your request URI to get this field

": "{String}"
17
               },
18
               "potentialConsequenceLink
PotentialConsequenceLink

API reference to the item

This field is greyed out because it is an expandable field. You have to add $expand=PositiveScore in your request URI to get this field

": "{String}"
19
          },
20
          "negativeScore
NegativeScore

This field is greyed out because it is an expandable field. You have to add $expand=NegativeScore in your request URI to get this field

": {
21
               "potentialConsequenceId
PotentialConsequenceId

Potential consequence identifier

This field is greyed out because it is an expandable field. You have to add $expand=NegativeScore in your request URI to get this field

": "{Integer}",
22
               "score
Score

Score of the potential consequence. Calculated from severity rating multiplied with likelihood level

This field is greyed out because it is an expandable field. You have to add $expand=NegativeScore in your request URI to get this field

": "{Integer}",
23
               "qualityConsequenceArea
QualityConsequenceArea

This field is greyed out because it is an expandable field. You have to add $expand=NegativeScore in your request URI to get this field

": {
24
                    "qualityConsequenceAreaId
QualityConsequenceAreaId

Quality consequence identifier

This field is greyed out because it is an expandable field. You have to add $expand=NegativeScore in your request URI to get this field

": "{Integer}",
25
                    "lowerThreshold
LowerThreshold

Threshold for risk scores. Values less than or equal to this threshold will have a low risk. Medium or higher risks have risk scores greater than this threshold value

This field is greyed out because it is an expandable field. You have to add $expand=NegativeScore in your request URI to get this field

": "{Integer}",
26
                    "upperThreshold
UpperThreshold

Threshold for risk scores. Values less than this threshold will have a low or medium risk. High risks will have risk scores greater than or equal to this threshold value

This field is greyed out because it is an expandable field. You have to add $expand=NegativeScore in your request URI to get this field

": "{Integer}",
27
                    "qualityConsequenceAreaLink
QualityConsequenceAreaLink

Quality consequence area reference

This field is greyed out because it is an expandable field. You have to add $expand=NegativeScore in your request URI to get this field

": "{String}"
28
               },
29
               "potentialConsequenceLink
PotentialConsequenceLink

API reference to the item

This field is greyed out because it is an expandable field. You have to add $expand=NegativeScore in your request URI to get this field

": "{String}"
30
          },
31
          "riskAssessment
RiskAssessment

This field is greyed out because it is an expandable field. You have to add $expand=RiskAssessment in your request URI to get this field

": {
32
               "riskAssessmentId
RiskAssessmentId

Risk assessment identifier

This field is greyed out because it is an expandable field. You have to add $expand=RiskAssessment in your request URI to get this field

": "{Integer}",
33
               "status
Status

Status of risk assessment

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=RiskAssessment in your request URI to get this field

": "{Integer}",
34
               "name
Name

Name of the risk assessment

This field is greyed out because it is an expandable field. You have to add $expand=RiskAssessment in your request URI to get this field

": "{String}",
35
               "isTemplate
IsTemplate

This field indicates if risk assessment is marked as a template assessment

This field is greyed out because it is an expandable field. You have to add $expand=RiskAssessment in your request URI to get this field

": "{Boolean}",
36
               "riskAssessmentLink
RiskAssessmentLink

API reference to the object

This field is greyed out because it is an expandable field. You have to add $expand=RiskAssessment in your request URI to get this field

": "{String}"
37
          },
38
          "owner
Owner

This field is greyed out because it is an expandable field. You have to add $expand=Owner in your request URI to get this field

": {
39
               "employeeId
EmployeeId

Employee identifier

This field is greyed out because it is an expandable field. You have to add $expand=Owner in your request URI to get this field

": "{Integer}",
40
               "lastName
LastName

Last name of employee

This field is greyed out because it is an expandable field. You have to add $expand=Owner in your request URI to get this field

": "{String}",
41
               "firstName
FirstName

First name of employee

This field is greyed out because it is an expandable field. You have to add $expand=Owner in your request URI to get this field

": "{String}",
42
               "employeeLink
EmployeeLink

Employee reference

This field is greyed out because it is an expandable field. You have to add $expand=Owner in your request URI to get this field

": "{String}"
43
          },
44
          "context
Context

This field is greyed out because it is an expandable field. You have to add $expand=Context in your request URI to get this field

": {
45
               "source
Source

This field is greyed out because it is an expandable field. You have to add $expand=Context in your request URI to get this field

": {
46
                    "objectId
ObjectId

Identifier of the object

This field is greyed out because it is an expandable field. You have to add $expand=Context in your request URI to get this field

": "{Integer}",
47
                    "objectType
ObjectType

Type of object

This field is greyed out because it is an expandable field. You have to add $expand=Context in your request URI to get this field

": "{String}",
48
                    "objectLink
ObjectLink

API reference to the object

This field is greyed out because it is an expandable field. You have to add $expand=Context in your request URI to get this field

": "{String}",
49
                    "itemId
ItemId

Item-number of the object

This field is greyed out because it is an expandable field. You have to add $expand=Context in your request URI to get this field

": "{Integer}",
50
                    "itemLink
ItemLink

API reference to the item

This field is greyed out because it is an expandable field. You have to add $expand=Context in your request URI to get this field

": "{String}"
51
               }
52
          },
53
          "totals
Totals

This field is greyed out because it is an expandable field. You have to add $expand=Totals in your request URI to get this field

": {
54
               "potentialConsequencesCount
PotentialConsequencesCount

Shows count of all consequence types belonging to this risk

This field is greyed out because it is an expandable field. You have to add $expand=Totals in your request URI to get this field

": "{Integer}",
55
               "controlsCount
ControlsCount

Shows count of all controls belonging to this risk

This field is greyed out because it is an expandable field. You have to add $expand=Totals in your request URI to get this field

": "{Integer}",
56
               "riskActionsCount
RiskActionsCount

Shows all actions count belonging to this risk.

This field is greyed out because it is an expandable field. You have to add $expand=Totals in your request URI to get this field

": "{Integer}",
57
               "doneRiskActionsCount
DoneRiskActionsCount

Shows count of done actions belonging to this risk

This field is greyed out because it is an expandable field. You have to add $expand=Totals in your request URI to get this field

": "{Integer}",
58
               "notesCount
NotesCount

Shows count of the notes added to the risk

This field is greyed out because it is an expandable field. You have to add $expand=Totals in your request URI to get this field

": "{Integer}"
59
          }
60
     }
61
}

Possible error codes the response might return:

Error 101814 HTTP 404 Employee not found