Quality management APIs
Gets a consequence area.
| HTTP method | GET |
| 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 | 4303, 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.
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.
| $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] |
| $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 |
| $format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
| $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. |
| $select String, optional | Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information. |
| $expand String, optional | Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select 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.
QualityConsequenceAreaId
Quality consequence identifier
>{Integer}</QualityConsequenceAreaId>Status
Status: 1 - Registering, 2 - Analyzing, 3 - Pending actions, 8 - Reviewing, 9 - Closed
Possible domain values can be found here
>{Integer}</Status>Name
Title of the quality consequence area
>{String}</Name>Description
Description
>{String}</Description>SortIndex
Sort index to decide order of the quality consequence areas shown to the users
>{Integer}</SortIndex>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>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>UseDefaultRiskMatrix
If this value is true, this consequence areas severities, likelihoods and thresholds will be synchronized with the default matrix
>{Boolean}</UseDefaultRiskMatrix>AddedAt
Datetime of when this quality consequence area was added
>{Datetime}</AddedAt>UserId
User identifier
>{Integer}</UserId>FirstName
First name of the user
>{String}</FirstName>Name
Name of the user
>{String}</Name>UserLink
User reference
>{String}</UserLink>QualityConsequenceAreaId
Quality consequence identifier
": "{Integer}",Status
Status: 1 - Registering, 2 - Analyzing, 3 - Pending actions, 8 - Reviewing, 9 - Closed
Possible domain values can be found here
": "{Integer}",Name
Title of the quality consequence area
": "{String}",Description
Description
": "{String}",SortIndex
Sort index to decide order of the quality consequence areas shown to the users
": "{Integer}",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}",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}",UseDefaultRiskMatrix
If this value is true, this consequence areas severities, likelihoods and thresholds will be synchronized with the default matrix
": "{Boolean}",AddedAt
Datetime of when this quality consequence area was added
": "{Datetime}",UserId
User identifier
": "{Integer}",FirstName
First name of the user
": "{String}",Name
Name of the user
": "{String}",UserLink
User reference
": "{String}"
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 101566 HTTP 404 | User not found |