API

Quality management APIs

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

Updates a quality issue consequence.

HTTP method PUT
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 4534, version 3

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:
1
<QualityIssueConsequence
QualityIssueConsequence

This field is optional.

>
2
     <Comment
Comment

Comment to the consequence

This field is optional.

>
{String}</Comment>
3
     <ConsequenceArea
ConsequenceArea

This field is optional.

>
4
          <ConsequenceAreaId
ConsequenceAreaId

Quality consequence identifier

Minimum value: 100000

This field is optional.

>
{Integer}</ConsequenceAreaId>
5
     </ConsequenceArea>
6
     <ConsequenceSeverity
ConsequenceSeverity

This field is optional.

>
7
          <QualitySeverityId
QualitySeverityId

Identifier for a consequence severity

Minimum value: 1

This field is optional.

>
{Integer}</QualitySeverityId>
8
     </ConsequenceSeverity>
9
     <AreaConsequenceType
AreaConsequenceType

This field is optional.

>
10
          <AreaConsequenceTypeId
AreaConsequenceTypeId

Identifier for this quality incident consequence.

Minimum value: 1

This field is optional.

>
{Integer}</AreaConsequenceTypeId>
11
     </AreaConsequenceType>
12
</QualityIssueConsequence>
1
{
2
     "qualityIssueConsequence
QualityIssueConsequence

This field is optional.

":
{
3
          "comment
Comment

Comment to the consequence

This field is optional.

":
"{String}",
4
          "consequenceArea
ConsequenceArea

This field is optional.

":
{
5
               "consequenceAreaId
ConsequenceAreaId

Quality consequence identifier

Minimum value: 100000

This field is optional.

":
"{Integer}"
6
          },
7
          "consequenceSeverity
ConsequenceSeverity

This field is optional.

":
{
8
               "qualitySeverityId
QualitySeverityId

Identifier for a consequence severity

Minimum value: 1

This field is optional.

":
"{Integer}"
9
          },
10
          "areaConsequenceType
AreaConsequenceType

This field is optional.

":
{
11
               "areaConsequenceTypeId
AreaConsequenceTypeId

Identifier for this quality incident consequence.

Minimum value: 1

This field is optional.

":
"{Integer}"
12
          }
13
     }
14
}

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.

Format:
1
1

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 105816 HTTP 400 Missing serverity
Error 105817 HTTP 400 Missing consequence
Error 105664 HTTP 404 Could not find incident consequence