API

Quality management APIs

POST quality/risks

Add new risk

HTTP method POST
URI https://api.rambase.net/quality/risks
Supported formats Xml, Html, Json (ex. $format=json)
Custom fields Custom fields supported
Successful HTTP status code 201
API resource identifier 5206, version 4

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
<Risk>
2
     <Title
Title

Required/mandatory field

Title of the risk

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

Description of the risk

This field is optional.

>{String}</Description>
4
     <RiskAssessment
RiskAssessment

This field is optional.

>
5
          <RiskAssessmentId
RiskAssessmentId

Risk assessment identifier

Minimum value: 100000

This field is optional.

>{Integer}</RiskAssessmentId>
6
     </RiskAssessment>
7
     <Owner>
8
          <EmployeeId
EmployeeId

Required/mandatory field

Employee identifier

Minimum value: 100

>{Integer}</EmployeeId>
9
     </Owner>
10
     <Context
Context

This field is optional.

>
11
          <Source
Source

This field is optional.

>
12
               <ObjectId
ObjectId

Identifier of the object

This field is optional.

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

Type of object

This field is optional.

>{String}</ObjectType>
14
               <ItemId
ItemId

Item-number of the object

This field is optional.

>{Integer}</ItemId>
15
          </Source>
16
     </Context>
17
</Risk>
1
{
2
     "risk": {
3
          "title
Title

Required/mandatory field

Title of the risk

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

Description of the risk

This field is optional.

": "{String}",
5
          "riskAssessment
RiskAssessment

This field is optional.

": {
6
               "riskAssessmentId
RiskAssessmentId

Risk assessment identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
7
          },
8
          "owner": {
9
               "employeeId
EmployeeId

Required/mandatory field

Employee identifier

Minimum value: 100

": "{Integer}"
10
          },
11
          "context
Context

This field is optional.

": {
12
               "source
Source

This field is optional.

": {
13
                    "objectId
ObjectId

Identifier of the object

This field is optional.

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

Type of object

This field is optional.

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

Item-number of the object

This field is optional.

": "{Integer}"
16
               }
17
          }
18
     }
19
}

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

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

>
8
          <PotentialConsequenceId
PotentialConsequenceId

Potential consequence identifier

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

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

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

Quality consequence identifier

>{Integer}</QualityConsequenceAreaId>
12
               <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>
13
               <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>
14
               <QualityConsequenceAreaLink
QualityConsequenceAreaLink

Quality consequence area reference

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

API reference to the item

>{String}</PotentialConsequenceLink>
17
          <PotentialConsequenceId
PotentialConsequenceId

Potential consequence identifier

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

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

>{Integer}</Score>
19
          <QualityConsequenceArea>
20
               <QualityConsequenceAreaId
QualityConsequenceAreaId

Quality consequence identifier

>{Integer}</QualityConsequenceAreaId>
21
               <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>
22
               <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>
23
               <QualityConsequenceAreaLink
QualityConsequenceAreaLink

Quality consequence area reference

>{String}</QualityConsequenceAreaLink>
24
          </QualityConsequenceArea>
25
          <PotentialConsequenceLink
PotentialConsequenceLink

API reference to the item

>{String}</PotentialConsequenceLink>
26
          <RiskAssessmentId
RiskAssessmentId

Risk assessment identifier

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

Status of risk assessment

Possible domain values can be found here

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

Name of the risk assessment

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

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

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

API reference to the object

>{String}</RiskAssessmentLink>
31
          <EmployeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

>{String}</EmployeeLink>
35
          <Source>
36
               <ObjectId
ObjectId

Identifier of the object

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

Type of object

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

API reference to the object

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

Item-number of the object

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

API reference to the item

>{String}</ItemLink>
41
          </Source>
42
          <PotentialConsequencesCount
PotentialConsequencesCount

Shows count of all consequence types belonging to this risk

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

Shows count of all controls belonging to this risk

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

Shows all actions count belonging to this risk.

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

Shows count of done actions belonging to this risk

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

Shows count of the notes added to the risk

>{Integer}</NotesCount>
47
     </Description>
48
</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

": {
9
               "potentialConsequenceId
PotentialConsequenceId

Potential consequence identifier

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

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

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

Quality consequence identifier

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

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

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

Quality consequence area reference

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

API reference to the item

": "{String}",
18
               "potentialConsequenceId
PotentialConsequenceId

Potential consequence identifier

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

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

": "{Integer}",
20
               "qualityConsequenceArea": {
21
                    "qualityConsequenceAreaId
QualityConsequenceAreaId

Quality consequence identifier

": "{Integer}",
22
                    "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}",
23
                    "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}",
24
                    "qualityConsequenceAreaLink
QualityConsequenceAreaLink

Quality consequence area reference

": "{String}"
25
               },
26
               "potentialConsequenceLink
PotentialConsequenceLink

API reference to the item

": "{String}",
27
               "riskAssessmentId
RiskAssessmentId

Risk assessment identifier

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

Status of risk assessment

Possible domain values can be found here

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

Name of the risk assessment

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

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

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

API reference to the object

": "{String}",
32
               "employeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

": "{String}",
36
               "source": {
37
                    "objectId
ObjectId

Identifier of the object

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

Type of object

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

API reference to the object

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

Item-number of the object

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

API reference to the item

": "{String}"
42
               },
43
               "potentialConsequencesCount
PotentialConsequencesCount

Shows count of all consequence types belonging to this risk

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

Shows count of all controls belonging to this risk

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

Shows all actions count belonging to this risk.

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

Shows count of done actions belonging to this risk

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

Shows count of the notes added to the risk

": "{Integer}"
48
          }
49
     }
50
}

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