API

Quality management APIs

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

Gets a list of potential consequences

HTTP method GET
URI https://api.rambase.net/quality/risks/{riskId}/potential-consequences
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {riskId} Identifier of the risk
Integer, minimum 100000
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 5214, version 20

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
$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.
$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.
$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.
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$top String, optional Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

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

ContainingActionTaskId Integer It is possible to filter by task identifier which is handling this potential consequence in actions.
ContainingDoneTasks Boolean Shows all potential consequences, which are handled by done tasks.
ContainingQualityControlId Integer It is possible to filter by quality control identifier which is referencing this potential consequence in controls.
Likelihoodlevel Integer Likelihood level of a potential consequence.
Score Integer Score of the potential consequence. Calculated from severity rating multiplied with likelihood level.
Severitylevel Integer Level of the severity. These values are typically from 1 to the dimension of a risk matrix..
Severityrating Integer Severity rating of a potential consequence.

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

ContainingActionTaskId Integer It is possible to filter by task identifier which is handling this potential consequence in actions
ContainingDoneTasks Boolean Shows all potential consequences, which are handled by done tasks.
ContainingQualityControlId Integer It is possible to filter by quality control identifier which is referencing this potential consequence in controls
Likelihoodlevel Integer Likelihood level of a potential consequence
Score Integer Score of the potential consequence. Calculated from severity rating multiplied with likelihood level
Severitylevel Integer Level of the severity. These values are typically from 1 to the dimension of a risk matrix.
Severityrating Integer Severity rating of a potential consequence

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

Potential consequence identifier

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

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

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

Date and time of creation

>{Datetime}</CreatedAt>
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}</ConsequenceType>
7
          <Comment
Comment

Comment to the potential consequence

>{String}</Comment>
8
          <Totals
Totals

This field is greyed out because it is an expandable field. You have to add $expand=PotentialConsequence.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=PotentialConsequence.Totals in your request URI to get this field

>{Integer}</ActionsCount>
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=PotentialConsequence.Totals in your request URI to get this field

>{Integer}</ControlsCount>
11
          </Totals>
12
          <Severity>
13
               <SeverityId
SeverityId

Identifier for a consequence severity

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

Severity rating of a potential consequence

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

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

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

Translated label

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

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

Quality severity document id

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

Likelihood identifier

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

Likelihood level of a potential consequence

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

Translation of likelihood label

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

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

Fulldocid of likelihood

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

Quality consequence identifier

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

Name of the quality consequence area

>{String}</Name>
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}</LowerThreshold>
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}</UpperThreshold>
30
               <QualityConsequenceAreaLink
QualityConsequenceAreaLink

Quality consequence area reference

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

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

>
33
               <ScoreLogEntry
ScoreLogEntry

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

>
34
                    <ScoreLogEntryId
ScoreLogEntryId

Score log entry identifier

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

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

Risk score in score log

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

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

API reference to the item

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

>{Docref-customlink}</ScoreLogEntryLink>
37
               </ScoreLogEntry>
38
          </RecentScoreLogEntries>
39
          <PotentialConsequenceLink
PotentialConsequenceLink

API reference to the item

>{String}</PotentialConsequenceLink>
40
     </PotentialConsequence>
41
     <Paging
Paging

Detailed paging information for this list.

>
42
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
43
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
44
          <Page
Page

Page index

>{Integer}</Page>
45
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

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

>{String}</FirstPageKey>
46
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
47
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

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

>{String}</PreviousPageKey>
48
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
49
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

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

>{String}</NextPageKey>
50
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
51
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

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

>{String}</LastPageKey>
52
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
53
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
54
     </Paging>
55
</PotentialConsequences>
1
{
2
     "potentialConsequences": [
3
          {
4
               "potentialConsequenceId
PotentialConsequenceId

Potential consequence identifier

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

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

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

Date and time of creation

": "{Datetime}",
7
               "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}",
8
               "comment
Comment

Comment to the potential consequence

": "{String}",
9
               "totals
Totals

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

": {
10
                    "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=PotentialConsequence.Totals in your request URI to get this field

": "{Integer}",
11
                    "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=PotentialConsequence.Totals in your request URI to get this field

": "{Integer}"
12
               },
13
               "severity": {
14
                    "severityId
SeverityId

Identifier for a consequence severity

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

Severity rating of a potential consequence

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

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

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

Translated label

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

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

Quality severity document id

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

Likelihood identifier

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

Likelihood level of a potential consequence

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

Translation of likelihood label

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

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

Fulldocid of likelihood

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

Quality consequence identifier

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

Name of the quality consequence area

": "{String}",
29
                    "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}",
30
                    "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}",
31
                    "qualityConsequenceAreaLink
QualityConsequenceAreaLink

Quality consequence area reference

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

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

": [
34
                    {
35
                         "scoreLogEntryId
ScoreLogEntryId

Score log entry identifier

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

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

Risk score in score log

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

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

API reference to the item

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

": "{Docref-customlink}"
38
                    }
39
               ],
40
               "potentialConsequenceLink
PotentialConsequenceLink

API reference to the item

": "{String}"
41
          }
42
     ],
43
     "paging
Paging

Detailed paging information for this list.

": {
44
          "pageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",
45
          "position
Position

Position of the first element in the list

": "{Integer}",
46
          "page
Page

Page index

": "{Integer}",
47
          "firstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

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

": "{String}",
48
          "firstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",
49
          "previousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

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

": "{String}",
50
          "previousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",
51
          "nextPageKey
NextPageKey

Page key to use for navigating to next page in the list

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

": "{String}",
52
          "nextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",
53
          "lastPageKey
LastPageKey

Page key to use for navigating to last page in the list

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

": "{String}",
54
          "lastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",
55
          "size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"
56
     }
57
}

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