API

Quality management APIs

POST quality/risk-assessments

Create a risk assessment

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

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
<RiskAssessment>
2
     <Name
Name

Required/mandatory field

Name of the risk assessment

>{String}</Name>
3
     <Scope
Scope

Scope of the risk assessment

This field is optional.

>{String}</Scope>
4
     <NextAssessmentDate
NextAssessmentDate

Date when update of the current risk assessment is planned

This field is optional.

>{Date}</NextAssessmentDate>
5
     <ReAssessmentInterval
ReAssessmentInterval

Re-assessment interval

Applicable domain values can be found here

This field is optional.

>{Integer}</ReAssessmentInterval>
6
     <Limitations
Limitations

Limitations of the risk assessment

This field is optional.

>{String}</Limitations>
7
     <Folder
Folder

This field is optional.

>
8
          <FolderId
FolderId

File folder id for a spesific file container or forlder.

Minimum value: 100000

This field is optional.

>{Integer}</FolderId>
9
     </Folder>
10
     <Location
Location

This field is optional.

>
11
          <LocationId
LocationId

Location identifier

Minimum value: 10000

This field is optional.

>{Integer}</LocationId>
12
     </Location>
13
     <Responsible
Responsible

This field is optional.

>
14
          <EmployeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

>{Integer}</EmployeeId>
15
     </Responsible>
16
     <Context
Context

This field is optional.

>
17
          <Source
Source

This field is optional.

>
18
               <ObjectId
ObjectId

Identifier of the object

Minimum value: 1

This field is optional.

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

Type of object

This field is optional.

>{String}</ObjectType>
20
          </Source>
21
     </Context>
22
</RiskAssessment>
1
{
2
     "riskAssessment": {
3
          "name
Name

Required/mandatory field

Name of the risk assessment

": "{String}",
4
          "scope
Scope

Scope of the risk assessment

This field is optional.

": "{String}",
5
          "nextAssessmentDate
NextAssessmentDate

Date when update of the current risk assessment is planned

This field is optional.

": "{Date}",
6
          "reAssessmentInterval
ReAssessmentInterval

Re-assessment interval

Applicable domain values can be found here

This field is optional.

": "{Integer}",
7
          "limitations
Limitations

Limitations of the risk assessment

This field is optional.

": "{String}",
8
          "folder
Folder

This field is optional.

": {
9
               "folderId
FolderId

File folder id for a spesific file container or forlder.

Minimum value: 100000

This field is optional.

": "{Integer}"
10
          },
11
          "location
Location

This field is optional.

": {
12
               "locationId
LocationId

Location identifier

Minimum value: 10000

This field is optional.

": "{Integer}"
13
          },
14
          "responsible
Responsible

This field is optional.

": {
15
               "employeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

": "{Integer}"
16
          },
17
          "context
Context

This field is optional.

": {
18
               "source
Source

This field is optional.

": {
19
                    "objectId
ObjectId

Identifier of the object

Minimum value: 1

This field is optional.

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

Type of object

This field is optional.

": "{String}"
21
               }
22
          }
23
     }
24
}

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
<RiskAssessment>
2
     <RiskAssessmentId
RiskAssessmentId

Risk assessment identifier

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

Status of risk assessment

Possible domain values can be found here

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

Name of the risk assessment

>{String}</Name>
5
     <CreatedAt
CreatedAt

Date and time when risk assessment was created

>{Datetime}</CreatedAt>
6
     <Scope
Scope

Scope of the risk assessment

>{String}</Scope>
7
     <Limitations
Limitations

Limitations of the risk assessment

>{String}</Limitations>
8
     <AssessmentDate
AssessmentDate

When current assessment was prepared

>{Date}</AssessmentDate>
9
     <NextAssessmentDate
NextAssessmentDate

Date when update of the current risk assessment is planned

>{Date}</NextAssessmentDate>
10
     <ReAssessmentInterval
ReAssessmentInterval

Re-assessment interval

Possible domain values can be found here

>{Integer}</ReAssessmentInterval>
11
     <IsTemplate
IsTemplate

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

>{Boolean}</IsTemplate>
12
     <Folder>
13
          <FolderId
FolderId

File folder id for a spesific file container or forlder.

>{Integer}</FolderId>
14
          <Name
Name

Verbose folder text in english.

>{String}</Name>
15
          <FolderLink
FolderLink

Company folder id

>{String}</FolderLink>
16
     </Folder>
17
     <InitialRiskAssessment>
18
          <RiskAssessmentId
RiskAssessmentId

Identifier of the first assessment in this line of reassessments

>{Integer}</RiskAssessmentId>
19
          <RiskAssessmentLink
RiskAssessmentLink

API reference to the object

>{String}</RiskAssessmentLink>
20
          <Score
Score

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

>{Integer}</Score>
21
          <QualityConsequenceArea>
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}</LowerThreshold>
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}</UpperThreshold>
24
          </QualityConsequenceArea>
25
          <Score
Score

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

>{Integer}</Score>
26
          <QualityConsequenceArea>
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
          </QualityConsequenceArea>
30
          <EmployeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

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

Location identifier

>{Integer}</LocationId>
35
          <ShortName
ShortName

Unique abbreviation/short name of the location

>{String}</ShortName>
36
          <LocationLink
LocationLink

Location reference

>{String}</LocationLink>
37
          <AcceptedRisksCount
AcceptedRisksCount

Count of accepted risks that belong to this risk assessment

>{Integer}</AcceptedRisksCount>
38
          <RisksCount
RisksCount

Count of all risks that belong to this risk assessment

>{Integer}</RisksCount>
39
          <ParticipantsCount
ParticipantsCount

Count of participants

>{Integer}</ParticipantsCount>
40
          <ActionsCount
ActionsCount

Number of actions related to this risk assessment

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

Number of controls related to this risk assessment

>{Integer}</ControlsCount>
42
          <Source>
43
               <ObjectId
ObjectId

Identifier of the object

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

Type of object

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

API reference to the object

>{String}</ObjectLink>
46
          </Source>
47
     </InitialRiskAssessment>
48
</RiskAssessment>
1
{
2
     "riskAssessment": {
3
          "riskAssessmentId
RiskAssessmentId

Risk assessment identifier

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

Status of risk assessment

Possible domain values can be found here

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

Name of the risk assessment

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

Date and time when risk assessment was created

": "{Datetime}",
7
          "scope
Scope

Scope of the risk assessment

": "{String}",
8
          "limitations
Limitations

Limitations of the risk assessment

": "{String}",
9
          "assessmentDate
AssessmentDate

When current assessment was prepared

": "{Date}",
10
          "nextAssessmentDate
NextAssessmentDate

Date when update of the current risk assessment is planned

": "{Date}",
11
          "reAssessmentInterval
ReAssessmentInterval

Re-assessment interval

Possible domain values can be found here

": "{Integer}",
12
          "isTemplate
IsTemplate

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

": "{Boolean}",
13
          "folder": {
14
               "folderId
FolderId

File folder id for a spesific file container or forlder.

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

Verbose folder text in english.

": "{String}",
16
               "folderLink
FolderLink

Company folder id

": "{String}"
17
          },
18
          "initialRiskAssessment": {
19
               "riskAssessmentId
RiskAssessmentId

Identifier of the first assessment in this line of reassessments

": "{Integer}",
20
               "riskAssessmentLink
RiskAssessmentLink

API reference to the object

": "{String}",
21
               "score
Score

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

": "{Integer}",
22
               "qualityConsequenceArea": {
23
                    "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}",
24
                    "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}"
25
               },
26
               "score
Score

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

": "{Integer}",
27
               "qualityConsequenceArea": {
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
               },
31
               "employeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

": "{String}",
35
               "locationId
LocationId

Location identifier

": "{Integer}",
36
               "shortName
ShortName

Unique abbreviation/short name of the location

": "{String}",
37
               "locationLink
LocationLink

Location reference

": "{String}",
38
               "acceptedRisksCount
AcceptedRisksCount

Count of accepted risks that belong to this risk assessment

": "{Integer}",
39
               "risksCount
RisksCount

Count of all risks that belong to this risk assessment

": "{Integer}",
40
               "participantsCount
ParticipantsCount

Count of participants

": "{Integer}",
41
               "actionsCount
ActionsCount

Number of actions related to this risk assessment

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

Number of controls related to this risk assessment

": "{Integer}",
43
               "source": {
44
                    "objectId
ObjectId

Identifier of the object

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

Type of object

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

API reference to the object

": "{String}"
47
               }
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 107293 HTTP 400 Positive score cannot be lower than zero
Error 107294 HTTP 400 Negative score cannot be bigger than zero