Quality management APIs
Creates a new quality issue risk.
| HTTP method | POST |
| URI | https://api.rambase.net/quality/issues/{qualityIssueId}/risks |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {qualityIssueId} |
Quality issue identifier
Integer, minimum 100000 |
| Successful HTTP status code | 201 |
| API resource identifier | 4549, 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.
Comment
Comment to the risk
This field is optional.
>{String}</Comment>ConsequenceAreaId
Required/mandatory field
Quality consequence identifier
Minimum value: 100000
>{Integer}</ConsequenceAreaId>QualitySeverityId
Required/mandatory field
Identifier for a consequence severity
Minimum value: 1
>{Integer}</QualitySeverityId>QualityLikelihoodId
Required/mandatory field
Likelihood identifier
Minimum value: 1
>{Integer}</QualityLikelihoodId>Comment
Comment to the risk
This field is optional.
": "{String}",ConsequenceAreaId
Required/mandatory field
Quality consequence identifier
Minimum value: 100000
": "{Integer}"QualitySeverityId
Required/mandatory field
Identifier for a consequence severity
Minimum value: 1
": "{Integer}"QualityLikelihoodId
Required/mandatory field
Likelihood identifier
Minimum value: 1
": "{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. |
| $lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
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.
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 101606 HTTP 404 | Module not found |
| Error 101420 HTTP 404 | Setting definition not found |
| Error 106156 HTTP 400 | Department cannot be empty. |
| Error 106155 HTTP 400 | OccuredAt cannot be empty. |
| Error 105858 HTTP 400 | Responsible cannot be empty. |