API

Quality management APIs

POST quality/consequence-areas/{consequenceAreaId}/consequence-types

Creates an area consequence type.

HTTP method POST
URI https://api.rambase.net/quality/consequence-areas/{consequenceAreaId}/consequence-types
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {consequenceAreaId} Quality consequence identifier
Integer, minimum 100000
Successful HTTP status code 201
API resource identifier 4314, 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:
1
<AreaConsequenceType>
2
     <SortIndex
SortIndex

Index for sorting in the UI

Minimum value: 1

This field is optional.

>{Integer}</SortIndex>
3
     <ConsequenceType>
4
          <ConsequenceTypeId
ConsequenceTypeId

Required/mandatory field

Quality consequence identifier

Minimum value: 100000

>{Integer}</ConsequenceTypeId>
5
     </ConsequenceType>
6
</AreaConsequenceType>
1
{
2
     "areaConsequenceType": {
3
          "sortIndex
SortIndex

Index for sorting in the UI

Minimum value: 1

This field is optional.

": "{Integer}",
4
          "consequenceType": {
5
               "consequenceTypeId
ConsequenceTypeId

Required/mandatory field

Quality consequence identifier

Minimum value: 100000

": "{Integer}"
6
          }
7
     }
8
}

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
<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
          <ConsequenceTypeLink
ConsequenceTypeLink

Docref link for quality consequence DOV

>{String}</ConsequenceTypeLink>
14
     </ConsequenceType>
15
</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
               "consequenceTypeLink
ConsequenceTypeLink

Docref link for quality consequence DOV

": "{String}"
15
          }
16
     }
17
}

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 107539 HTTP 400 Consequence type must be active in order to be used in incident consequence