API

Quality management APIs

GET quality/risks/{riskId}/potential-consequences/{potentialConsequenceId}

Gets a potential consequence of a risk

HTTP method GET
URI https://api.rambase.net/quality/risks/{riskId}/potential-consequences/{potentialConsequenceId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {riskId} Identifier of the risk
Integer, minimum 100000
- URI parameter {potentialConsequenceId} Potential consequence identifier
Integer, minimum 1
Successful HTTP status code 200
API resource identifier 5210, version 13

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.

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
<PotentialConsequence>
2
     <PotentialConsequenceId
PotentialConsequenceId

Potential consequence identifier

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

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

>{Integer}</Score>
4
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
5
     <ConsequenceType
ConsequenceType

Consequence type is a text that shortly describes the direct consequence of an incidient. I.E "broken arm".

Possible domain values can be found here

>{Integer}</ConsequenceType>
6
     <Comment
Comment

Comment to the potential consequence

>{String}</Comment>
7
     <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

>
8
          <ActionsCount
ActionsCount

Number of actions related to this potential consequence

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}</ActionsCount>
9
          <ControlsCount
ControlsCount

Number of controls linked to this potential consequence

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>
10
     </Totals>
11
     <Severity>
12
          <SeverityId
SeverityId

Identifier for a consequence severity

>{Integer}</SeverityId>
13
          <Rating
Rating

Severity rating of a potential consequence

>{Integer}</Rating>
14
          <Level
Level

Level of the severity. These values are typically from 1 to the dimension of a risk matrix.

>{Integer}</Level>
15
          <TranslatedLabel
TranslatedLabel

Translated label

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

>{String}</TranslatedLabel>
16
          <SeverityLink
SeverityLink

Quality severity document id

>{String}</SeverityLink>
17
     </Severity>
18
     <Likelihood>
19
          <LikelihoodId
LikelihoodId

Likelihood identifier

>{Integer}</LikelihoodId>
20
          <Level
Level

Likelihood level of a potential consequence

>{Integer}</Level>
21
          <TranslatedLabel
TranslatedLabel

Translation of likelihood label

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

>{String}</TranslatedLabel>
22
          <LikelihoodLink
LikelihoodLink

Fulldocid of likelihood

>{String}</LikelihoodLink>
23
     </Likelihood>
24
     <QualityConsequenceArea>
25
          <QualityConsequenceAreaId
QualityConsequenceAreaId

Quality consequence identifier

>{Integer}</QualityConsequenceAreaId>
26
          <Name
Name

Name of the quality consequence area

>{String}</Name>
27
          <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

>{Integer}</LowerThreshold>
28
          <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

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

Quality consequence area reference

>{String}</QualityConsequenceAreaLink>
30
     </QualityConsequenceArea>
31
     <RecentScoreLogEntries
RecentScoreLogEntries

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

>
32
          <ScoreLogEntry
ScoreLogEntry

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

>
33
               <ScoreLogEntryId
ScoreLogEntryId

Score log entry identifier

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

>{Integer}</ScoreLogEntryId>
34
               <Score
Score

Risk score in score log

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

>{Integer}</Score>
35
               <ScoreLogEntryLink
ScoreLogEntryLink

API reference to the item

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

>{Docref-customlink}</ScoreLogEntryLink>
36
          </ScoreLogEntry>
37
     </RecentScoreLogEntries>
38
</PotentialConsequence>
1
{
2
     "potentialConsequence": {
3
          "potentialConsequenceId
PotentialConsequenceId

Potential consequence identifier

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

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

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

Date and time of creation

": "{Datetime}",
6
          "consequenceType
ConsequenceType

Consequence type is a text that shortly describes the direct consequence of an incidient. I.E "broken arm".

Possible domain values can be found here

": "{Integer}",
7
          "comment
Comment

Comment to the potential consequence

": "{String}",
8
          "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

": {
9
               "actionsCount
ActionsCount

Number of actions related to this potential consequence

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}",
10
               "controlsCount
ControlsCount

Number of controls linked to this potential consequence

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}"
11
          },
12
          "severity": {
13
               "severityId
SeverityId

Identifier for a consequence severity

": "{Integer}",
14
               "rating
Rating

Severity rating of a potential consequence

": "{Integer}",
15
               "level
Level

Level of the severity. These values are typically from 1 to the dimension of a risk matrix.

": "{Integer}",
16
               "translatedLabel
TranslatedLabel

Translated label

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

": "{String}",
17
               "severityLink
SeverityLink

Quality severity document id

": "{String}"
18
          },
19
          "likelihood": {
20
               "likelihoodId
LikelihoodId

Likelihood identifier

": "{Integer}",
21
               "level
Level

Likelihood level of a potential consequence

": "{Integer}",
22
               "translatedLabel
TranslatedLabel

Translation of likelihood label

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

": "{String}",
23
               "likelihoodLink
LikelihoodLink

Fulldocid of likelihood

": "{String}"
24
          },
25
          "qualityConsequenceArea": {
26
               "qualityConsequenceAreaId
QualityConsequenceAreaId

Quality consequence identifier

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

Name of the quality consequence area

": "{String}",
28
               "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

": "{Integer}",
29
               "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

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

Quality consequence area reference

": "{String}"
31
          },
32
          "recentScoreLogEntries
RecentScoreLogEntries

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

": [
33
               {
34
                    "scoreLogEntryId
ScoreLogEntryId

Score log entry identifier

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

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

Risk score in score log

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

": "{Integer}",
36
                    "scoreLogEntryLink
ScoreLogEntryLink

API reference to the item

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

": "{Docref-customlink}"
37
               }
38
          ]
39
     }
40
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 105657 HTTP 404 Could not find consequence area.
Error 105664 HTTP 404 Could not find incident consequence