API

Quality management APIs

GET quality/consequence-areas/{consequenceAreaId}/consequence-types/{areaConsequenceTypeId}

Resource to get an area consequence type.

HTTP method GET
URI https://api.rambase.net/quality/consequence-areas/{consequenceAreaId}/consequence-types/{areaConsequenceTypeId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {consequenceAreaId} Quality consequence identifier
Integer, minimum 100000
- URI parameter {areaConsequenceTypeId} Identifier for this quality incident consequence.
Integer, minimum 1
Successful HTTP status code 200
API resource identifier 4315, version 10

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
1

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:
1
<AreaConsequenceType>
2
     <AreaConsequenceTypeId
AreaConsequenceTypeId

Identifier for this quality incident consequence.

>{Integer}</AreaConsequenceTypeId>
3
     <Status
Status

Status describing the current state of this quality incident consequence.

Possible domain values can be found here

>{Integer}</Status>
4
     <SortIndex
SortIndex

Index for sorting in the UI

>{Integer}</SortIndex>
5
     <AddedAt
AddedAt

Date and time when this incident consequence was added.

>{Datetime}</AddedAt>
6
     <AddedBy>
7
          <UserId
UserId

User identifier

>{Integer}</UserId>
8
          <UserLink
UserLink

User reference

>{String}</UserLink>
9
     </AddedBy>
10
     <ConsequenceType>
11
          <ConsequenceTypeId
ConsequenceTypeId

Quality consequence identifier

>{Integer}</ConsequenceTypeId>
12
          <Name
Name

Name of quality consequence

Possible domain values can be found here

>{Integer}</Name>
13
          <TranslatedName
TranslatedName

Translated name of quality consequence

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

>{String}</TranslatedName>
14
          <ConsequenceTypeLink
ConsequenceTypeLink

Docref link for quality consequence DOV

>{String}</ConsequenceTypeLink>
15
     </ConsequenceType>
16
</AreaConsequenceType>
1
{
2
     "areaConsequenceType": {
3
          "areaConsequenceTypeId
AreaConsequenceTypeId

Identifier for this quality incident consequence.

": "{Integer}",
4
          "status
Status

Status describing the current state of this quality incident consequence.

Possible domain values can be found here

": "{Integer}",
5
          "sortIndex
SortIndex

Index for sorting in the UI

": "{Integer}",
6
          "addedAt
AddedAt

Date and time when this incident consequence was added.

": "{Datetime}",
7
          "addedBy": {
8
               "userId
UserId

User identifier

": "{Integer}",
9
               "userLink
UserLink

User reference

": "{String}"
10
          },
11
          "consequenceType": {
12
               "consequenceTypeId
ConsequenceTypeId

Quality consequence identifier

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

Name of quality consequence

Possible domain values can be found here

": "{Integer}",
14
               "translatedName
TranslatedName

Translated name of quality consequence

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

": "{String}",
15
               "consequenceTypeLink
ConsequenceTypeLink

Docref link for quality consequence DOV

": "{String}"
16
          }
17
     }
18
}

Possible error codes the response might return:

Error 105664 HTTP 404 Could not find incident consequence