Quality management APIs

GET quality/issues/{qualityIssueId}/consequences/{consequenceId}

Gets a quality issue consequence.

HTTP method	GET
URI	https://api.rambase.net/quality/issues/{qualityIssueId}/consequences/{consequenceId}
Supported formats	Xml, Html, Json (ex. $format=json)
- URI parameter {qualityIssueId}	Quality issue identifier Integer, minimum 100000
- URI parameter {consequenceId}	Quality issue consequence identifier Integer, minimum 1
Successful HTTP status code	200
API resource identifier	4384, 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.

Format:

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.

Format:

                                        <QualityIssueConsequence>
                                    

<QualityIssueConsequenceId

QualityIssueConsequenceId

Quality issue consequence identifier

>{Integer}</QualityIssueConsequenceId>

<CreatedAt

CreatedAt

Time and date when this quality issue consequence was created

>{Datetime}</CreatedAt>

<UpdatedAt

UpdatedAt

Time and date when this quality issue consequence was updated

>{Datetime}</UpdatedAt>

<Comment

Comment

Comment to the consequence

>{String}</Comment>

                                             <ConsequenceArea>
                                    

<ConsequenceAreaId

ConsequenceAreaId

Quality consequence identifier

>{Integer}</ConsequenceAreaId>

<Name

Name

Title of the quality consequence area

>{String}</Name>

<TranslatedName

TranslatedName

Title of the quality consequence area

This field is greyed out because it is an expandable field. You have to add $expand=ConsequenceArea.TranslatedName in your request URI to get this field

>{String}</TranslatedName>

<ConsequenceAreaLink

ConsequenceAreaLink

Quality consequence area reference

>{String}</ConsequenceAreaLink>

                                             </ConsequenceArea>
                                    

                                             <ConsequenceSeverity>
                                    

<QualitySeverityId

QualitySeverityId

Identifier for a consequence severity

>{Integer}</QualitySeverityId>

<Label

Label

Label of the severity

>{String}</Label>

<TranslatedLabel

TranslatedLabel

Translated label

This field is greyed out because it is an expandable field. You have to add $expand=ConsequenceSeverity.TranslatedLabel in your request URI to get this field

>{String}</TranslatedLabel>

<Rating

Rating

A number representing the level of impact this consequence has. Used in calculating a risk score.

>{Integer}</Rating>

<QualitySeverityLink

QualitySeverityLink

Document reference to severity

>{String}</QualitySeverityLink>

                                             </ConsequenceSeverity>
                                    

                                             <AreaConsequenceType>
                                    

<AreaConsequenceTypeId

AreaConsequenceTypeId

Identifier for this quality incident consequence.

>{Integer}</AreaConsequenceTypeId>

                                                  <ConsequenceType>
                                    

<ConsequenceTypeId

ConsequenceTypeId

Consequence type is a text that shortly describes the direct consequence of an incidient. I.E "broken arm".

>{Integer}</ConsequenceTypeId>

<Name

Name

Consequence type is a text that shortly describes the direct consequence of an incidient. I.E "broken arm".

Possible domain values can be found here

>{Integer}</Name>

<ConsequenceTypeLink

ConsequenceTypeLink

Consequence type is a text that shortly describes the direct consequence of an incidient. I.E "broken arm".

>{String}</ConsequenceTypeLink>

                                                  </ConsequenceType>
                                    

<AreaConsequenceTypeLink

AreaConsequenceTypeLink

Document reference to incident consequence

>{String}</AreaConsequenceTypeLink>

                                             </AreaConsequenceType>
                                    

                                        </QualityIssueConsequence>
                                    

{

                                             "qualityIssueConsequence": {
                                    

"qualityIssueConsequenceId

QualityIssueConsequenceId

Quality issue consequence identifier

": "{Integer}",

"createdAt

CreatedAt

Time and date when this quality issue consequence was created

": "{Datetime}",

"updatedAt

UpdatedAt

Time and date when this quality issue consequence was updated

": "{Datetime}",

"comment

Comment

Comment to the consequence

": "{String}",

                                                  "consequenceArea": {
                                    

"consequenceAreaId

ConsequenceAreaId

Quality consequence identifier

": "{Integer}",

"name

Name

Title of the quality consequence area

": "{String}",

"translatedName

TranslatedName

Title of the quality consequence area

This field is greyed out because it is an expandable field. You have to add $expand=ConsequenceArea.TranslatedName in your request URI to get this field

": "{String}",

"consequenceAreaLink

ConsequenceAreaLink

Quality consequence area reference

": "{String}"

},

                                                  "consequenceSeverity": {
                                    

"qualitySeverityId

QualitySeverityId

Identifier for a consequence severity

": "{Integer}",

"label

Label

Label of the severity

": "{String}",

"translatedLabel

TranslatedLabel

Translated label

This field is greyed out because it is an expandable field. You have to add $expand=ConsequenceSeverity.TranslatedLabel in your request URI to get this field

": "{String}",

"rating

Rating

A number representing the level of impact this consequence has. Used in calculating a risk score.

": "{Integer}",

"qualitySeverityLink

QualitySeverityLink

Document reference to severity

": "{String}"

},

                                                  "areaConsequenceType": {
                                    

"areaConsequenceTypeId

AreaConsequenceTypeId

Identifier for this quality incident consequence.

": "{Integer}",

                                                       "consequenceType": {
                                    

"consequenceTypeId

ConsequenceTypeId

Consequence type is a text that shortly describes the direct consequence of an incidient. I.E "broken arm".

": "{Integer}",

"name

Name

Consequence type is a text that shortly describes the direct consequence of an incidient. I.E "broken arm".

Possible domain values can be found here

": "{Integer}",

"consequenceTypeLink

ConsequenceTypeLink

Consequence type is a text that shortly describes the direct consequence of an incidient. I.E "broken arm".

": "{String}"

},

"areaConsequenceTypeLink

AreaConsequenceTypeLink

Document reference to incident consequence

": "{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 105664 HTTP 404	Could not find incident consequence
Error 105814 HTTP 400	Wrong type of consequence.