API

Quality management APIs

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

Creates a new potential consequence

HTTP method POST
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
Successful HTTP status code 201
API resource identifier 5212, version 9

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

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

Applicable domain values can be found here

This field is optional.

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

Comment to the potential consequence

This field is optional.

>{String}</Comment>
4
     <Severity>
5
          <SeverityId
SeverityId

Required/mandatory field

Identifier for a consequence severity

Minimum value: 1

>{Integer}</SeverityId>
6
     </Severity>
7
     <Likelihood>
8
          <LikelihoodId
LikelihoodId

Required/mandatory field

Likelihood identifier

Minimum value: 1

>{Integer}</LikelihoodId>
9
     </Likelihood>
10
     <QualityConsequenceArea>
11
          <QualityConsequenceAreaId
QualityConsequenceAreaId

Required/mandatory field

Quality consequence identifier

Minimum value: 100000

>{Integer}</QualityConsequenceAreaId>
12
     </QualityConsequenceArea>
13
</PotentialConsequence>
1
{
2
     "potentialConsequence": {
3
          "consequenceType
ConsequenceType

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

Applicable domain values can be found here

This field is optional.

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

Comment to the potential consequence

This field is optional.

": "{String}",
5
          "severity": {
6
               "severityId
SeverityId

Required/mandatory field

Identifier for a consequence severity

Minimum value: 1

": "{Integer}"
7
          },
8
          "likelihood": {
9
               "likelihoodId
LikelihoodId

Required/mandatory field

Likelihood identifier

Minimum value: 1

": "{Integer}"
10
          },
11
          "qualityConsequenceArea": {
12
               "qualityConsequenceAreaId
QualityConsequenceAreaId

Required/mandatory field

Quality consequence identifier

Minimum value: 100000

": "{Integer}"
13
          }
14
     }
15
}

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.

$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
$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.
$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]

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.

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

>
7
          <ActionsCount
ActionsCount

Number of actions related to this potential consequence

>{Integer}</ActionsCount>
8
          <ControlsCount
ControlsCount

Number of controls linked to this potential consequence

>{Integer}</ControlsCount>
9
     </Comment>
10
     <Severity>
11
          <SeverityId
SeverityId

Identifier for a consequence severity

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

Severity rating of a potential consequence

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

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

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

Quality severity document id

>{String}</SeverityLink>
15
     </Severity>
16
     <Likelihood>
17
          <LikelihoodId
LikelihoodId

Likelihood identifier

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

Likelihood level of a potential consequence

>{Integer}</Level>
19
          <LikelihoodLink
LikelihoodLink

Fulldocid of likelihood

>{String}</LikelihoodLink>
20
     </Likelihood>
21
     <QualityConsequenceArea>
22
          <QualityConsequenceAreaId
QualityConsequenceAreaId

Quality consequence identifier

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

Name of the quality consequence area

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

>{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

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

Quality consequence area reference

>{String}</QualityConsequenceAreaLink>
27
          <ScoreLogEntry>
28
               <ScoreLogEntryId
ScoreLogEntryId

Score log entry identifier

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

Risk score in score log

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

API reference to the item

>{Docref-customlink}</ScoreLogEntryLink>
31
          </ScoreLogEntry>
32
     </QualityConsequenceArea>
33
</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

": {
8
               "actionsCount
ActionsCount

Number of actions related to this potential consequence

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

Number of controls linked to this potential consequence

": "{Integer}"
10
          },
11
          "severity": {
12
               "severityId
SeverityId

Identifier for a consequence severity

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

Severity rating of a potential consequence

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

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

": "{Integer}",
15
               "severityLink
SeverityLink

Quality severity document id

": "{String}"
16
          },
17
          "likelihood": {
18
               "likelihoodId
LikelihoodId

Likelihood identifier

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

Likelihood level of a potential consequence

": "{Integer}",
20
               "likelihoodLink
LikelihoodLink

Fulldocid of likelihood

": "{String}"
21
          },
22
          "qualityConsequenceArea": {
23
               "qualityConsequenceAreaId
QualityConsequenceAreaId

Quality consequence identifier

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

Name of the quality consequence area

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

": "{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

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

Quality consequence area reference

": "{String}",
28
               "scoreLogEntry": {
29
                    "scoreLogEntryId
ScoreLogEntryId

Score log entry identifier

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

Risk score in score log

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

API reference to the item

": "{Docref-customlink}"
32
               }
33
          }
34
     }
35
}

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 100027 HTTP 400 Missing mandatory parameter {0}
Error 101420 HTTP 404 Setting definition not found
Error 107222 HTTP 400 Updates are not allowed when risk assessment is in status 4 or above
Error 107293 HTTP 400 Positive score cannot be lower than zero
Error 107294 HTTP 400 Negative score cannot be bigger than zero