API

Quality management APIs

POST quality/issues/{qualityIssueId}/consequences

Creates a quality issue consequence.

HTTP method POST
URI https://api.rambase.net/quality/issues/{qualityIssueId}/consequences
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 4510, version 11

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>
2
     <Comment
Comment

Comment to the consequence

This field is optional.

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

When set to true creates potential risk without severity and likelihood for given consequence are.

Default value: False

This field is optional.

>{Boolean}</AlsoCreateRisk>
4
     <ConsequenceArea>
5
          <ConsequenceAreaId
ConsequenceAreaId

Required/mandatory field

Quality consequence identifier

Minimum value: 100000

>{Integer}</ConsequenceAreaId>
6
     </ConsequenceArea>
7
     <ConsequenceSeverity>
8
          <QualitySeverityId
QualitySeverityId

Required/mandatory field

Identifier for a consequence severity

Minimum value: 1

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

This field is optional.

>
11
          <AreaConsequenceTypeId
AreaConsequenceTypeId

Identifier for this quality incident consequence.

Minimum value: 1

This field is optional.

>{Integer}</AreaConsequenceTypeId>
12
     </AreaConsequenceType>
13
</QualityIssueConsequence>
1
{
2
     "qualityIssueConsequence": {
3
          "comment
Comment

Comment to the consequence

This field is optional.

": "{String}",
4
          "alsoCreateRisk
AlsoCreateRisk

When set to true creates potential risk without severity and likelihood for given consequence are.

Default value: False

This field is optional.

": "{Boolean}",
5
          "consequenceArea": {
6
               "consequenceAreaId
ConsequenceAreaId

Required/mandatory field

Quality consequence identifier

Minimum value: 100000

": "{Integer}"
7
          },
8
          "consequenceSeverity": {
9
               "qualitySeverityId
QualitySeverityId

Required/mandatory field

Identifier for a consequence severity

Minimum value: 1

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

This field is optional.

": {
12
               "areaConsequenceTypeId
AreaConsequenceTypeId

Identifier for this quality incident consequence.

Minimum value: 1

This field is optional.

": "{Integer}"
13
          }
14
     }
15
}

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.
$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]

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.

Format:
1
<QualityIssueConsequence>
2
     <QualityIssueConsequenceId
QualityIssueConsequenceId

Quality issue consequence identifier

>{Integer}</QualityIssueConsequenceId>
3
     <CreatedAt
CreatedAt

Time and date when this quality issue consequence was created

>{Datetime}</CreatedAt>
4
     <UpdatedAt
UpdatedAt

Time and date when this quality issue consequence was updated

>{Datetime}</UpdatedAt>
5
     <Comment
Comment

Comment to the consequence

>{String}</Comment>
6
     <ConsequenceArea>
7
          <ConsequenceAreaId
ConsequenceAreaId

Quality consequence identifier

>{Integer}</ConsequenceAreaId>
8
          <Name
Name

Title of the quality consequence area

>{String}</Name>
9
          <ConsequenceAreaLink
ConsequenceAreaLink

Quality consequence area reference

>{String}</ConsequenceAreaLink>
10
     </ConsequenceArea>
11
     <ConsequenceSeverity>
12
          <QualitySeverityId
QualitySeverityId

Identifier for a consequence severity

>{Integer}</QualitySeverityId>
13
          <Label
Label

Label of the severity

>{String}</Label>
14
          <Rating
Rating

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

>{Integer}</Rating>
15
          <QualitySeverityLink
QualitySeverityLink

Document reference to severity

>{String}</QualitySeverityLink>
16
     </ConsequenceSeverity>
17
     <AreaConsequenceType>
18
          <AreaConsequenceTypeId
AreaConsequenceTypeId

Identifier for this quality incident consequence.

>{Integer}</AreaConsequenceTypeId>
19
          <ConsequenceType>
20
               <ConsequenceTypeId
ConsequenceTypeId

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

>{Integer}</ConsequenceTypeId>
21
               <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>
22
               <ConsequenceTypeLink
ConsequenceTypeLink

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

>{String}</ConsequenceTypeLink>
23
          </ConsequenceType>
24
          <AreaConsequenceTypeLink
AreaConsequenceTypeLink

Document reference to incident consequence

>{String}</AreaConsequenceTypeLink>
25
     </AreaConsequenceType>
26
</QualityIssueConsequence>
1
{
2
     "qualityIssueConsequence": {
3
          "qualityIssueConsequenceId
QualityIssueConsequenceId

Quality issue consequence identifier

": "{Integer}",
4
          "createdAt
CreatedAt

Time and date when this quality issue consequence was created

": "{Datetime}",
5
          "updatedAt
UpdatedAt

Time and date when this quality issue consequence was updated

": "{Datetime}",
6
          "comment
Comment

Comment to the consequence

": "{String}",
7
          "consequenceArea": {
8
               "consequenceAreaId
ConsequenceAreaId

Quality consequence identifier

": "{Integer}",
9
               "name
Name

Title of the quality consequence area

": "{String}",
10
               "consequenceAreaLink
ConsequenceAreaLink

Quality consequence area reference

": "{String}"
11
          },
12
          "consequenceSeverity": {
13
               "qualitySeverityId
QualitySeverityId

Identifier for a consequence severity

": "{Integer}",
14
               "label
Label

Label of the severity

": "{String}",
15
               "rating
Rating

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

": "{Integer}",
16
               "qualitySeverityLink
QualitySeverityLink

Document reference to severity

": "{String}"
17
          },
18
          "areaConsequenceType": {
19
               "areaConsequenceTypeId
AreaConsequenceTypeId

Identifier for this quality incident consequence.

": "{Integer}",
20
               "consequenceType": {
21
                    "consequenceTypeId
ConsequenceTypeId

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

": "{Integer}",
22
                    "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}",
23
                    "consequenceTypeLink
ConsequenceTypeLink

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

": "{String}"
24
               },
25
               "areaConsequenceTypeLink
AreaConsequenceTypeLink

Document reference to incident consequence

": "{String}"
26
          }
27
     }
28
}

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.