Quality management APIs
Updates a quality consequence area
| HTTP method | PUT |
| URI | https://api.rambase.net/quality/consequence-areas/{consequenceAreaId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {consequenceAreaId} |
Quality consequence identifier
Integer, minimum 100000 |
| Successful HTTP status code | 200 |
| API resource identifier | 4304, version 7 |
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.
QualityConsequenceArea
This field is optional.
>Name
Title of the quality consequence area
This field is optional.
>{String}</Name>SortIndex
Sort index to decide order of the quality consequence areas shown to the users
Minimum value: 1
This field is optional.
>{Integer}</SortIndex>Description
Description
This field is optional.
>{String}</Description>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
Minimum value: 1
This field is optional.
>{Integer}</LowerThreshold>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
Minimum value: 2
This field is optional.
>{Integer}</UpperThreshold>QualityConsequenceArea
This field is optional.
": {Name
Title of the quality consequence area
This field is optional.
": "{String}",SortIndex
Sort index to decide order of the quality consequence areas shown to the users
Minimum value: 1
This field is optional.
": "{Integer}",Description
Description
This field is optional.
": "{String}",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
Minimum value: 1
This field is optional.
": "{Integer}",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
Minimum value: 2
This field is optional.
": "{Integer}"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. |
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.
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 |