API

Quality management APIs

PUT quality/risk-assessments/{riskAssessmentId}

Updates risk assessment

HTTP method PUT
URI https://api.rambase.net/quality/risk-assessments/{riskAssessmentId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {riskAssessmentId} Risk assessment identifier
Integer, minimum 100000
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 5111, version 11

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
RiskAssessment

This field is optional.

>
2
     <Name
Name

Name of the risk assessment

This field is optional.

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

This field is optional.

>
8
          <LocationId
LocationId

Location identifier

Minimum value: 10000

This field is optional.

>{Integer}</LocationId>
9
     </Location>
10
     <Responsible
Responsible

This field is optional.

>
11
          <EmployeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

>{Integer}</EmployeeId>
12
     </Responsible>
13
     <Context
Context

This field is optional.

>
14
          <Source
Source

This field is optional.

>
15
               <ObjectId
ObjectId

Identifier of the object

Minimum value: 1

This field is optional.

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

Type of object

This field is optional.

>{String}</ObjectType>
17
          </Source>
18
     </Context>
19
</RiskAssessment>
1
{
2
     "riskAssessment
RiskAssessment

This field is optional.

": {
3
          "name
Name

Name of the risk assessment

This field is optional.

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

This field is optional.

": {
9
               "locationId
LocationId

Location identifier

Minimum value: 10000

This field is optional.

": "{Integer}"
10
          },
11
          "responsible
Responsible

This field is optional.

": {
12
               "employeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

": "{Integer}"
13
          },
14
          "context
Context

This field is optional.

": {
15
               "source
Source

This field is optional.

": {
16
                    "objectId
ObjectId

Identifier of the object

Minimum value: 1

This field is optional.

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

Type of object

This field is optional.

": "{String}"
18
               }
19
          }
20
     }
21
}

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

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