Quality management APIs
Gets a quality issue risk
HTTP method | GET |
URI | https://api.rambase.net/quality/issues/{qualityIssueId}/risks/{riskId} |
Supported formats | Xml, Html, Json (ex. $format=json) |
- URI parameter {qualityIssueId} |
Quality issue identifier
Integer, minimum 100000 |
- URI parameter {riskId} |
Quality issue risk identifier.
Integer, minimum 1 |
Successful HTTP status code | 200 |
API resource identifier | 4385, version 6 |
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.
$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.
QualityIssueRiskId
Quality issue risk identifier.
>{Integer}</QualityIssueRiskId>CreatedAt
Time and date when this quality issue risk was created
>{Datetime}</CreatedAt>UpdatedAt
Time and date when this quality issue risk was updated
>{Datetime}</UpdatedAt>Riskscore
Score of the risk - probability of occurence.
>{Integer}</Riskscore>Comment
Comment to the risk
>{String}</Comment>ConsequenceAreaId
Quality consequence identifier
>{Integer}</ConsequenceAreaId>Name
Title of the quality consequence area
>{String}</Name>ConsequenceAreaLink
Quality consequence area reference
>{String}</ConsequenceAreaLink>QualitySeverityId
Identifier for a consequence severity
>{Integer}</QualitySeverityId>Label
Label of the severity
>{String}</Label>Level
Severity describes how severe a consequence is.
>{Integer}</Level>Rating
A number representing the level of impact this consequence has. Used in calculating a risk score.
>{Integer}</Rating>QualitySeverityLink
Document reference to severity
>{String}</QualitySeverityLink>QualityLikelihoodId
Likelihood identifier
>{Integer}</QualityLikelihoodId>Level
Likelihood level. Values from 1 to X where X is the size of the risk matrix likelihood dimension
>{Integer}</Level>Label
Label of the likelihood.
>{String}</Label>QualityLikelihoodLink
Fulldocid of likelihood
>{String}</QualityLikelihoodLink>QualityIssueRiskId
Quality issue risk identifier.
": "{Integer}",CreatedAt
Time and date when this quality issue risk was created
": "{Datetime}",UpdatedAt
Time and date when this quality issue risk was updated
": "{Datetime}",Riskscore
Score of the risk - probability of occurence.
": "{Integer}",Comment
Comment to the risk
": "{String}",ConsequenceAreaId
Quality consequence identifier
": "{Integer}",Name
Title of the quality consequence area
": "{String}",ConsequenceAreaLink
Quality consequence area reference
": "{String}"QualitySeverityId
Identifier for a consequence severity
": "{Integer}",Label
Label of the severity
": "{String}",Level
Severity describes how severe a consequence is.
": "{Integer}",Rating
A number representing the level of impact this consequence has. Used in calculating a risk score.
": "{Integer}",QualitySeverityLink
Document reference to severity
": "{String}"QualityLikelihoodId
Likelihood identifier
": "{Integer}",Level
Likelihood level. Values from 1 to X where X is the size of the risk matrix likelihood dimension
": "{Integer}",Label
Label of the likelihood.
": "{String}",QualityLikelihoodLink
Fulldocid of likelihood
": "{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 105657 HTTP 404 | Could not find consequence area. |
Error 107242 HTTP 400 | Likelihood not found |
Error 105852 HTTP 400 | Wrong type of risk (consequence or risk). |