API

Quality management APIs

POST quality/issues/{qualityIssueId}/causes

Creates a new quality issue cause.

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

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
<QualityCause>
2
     <Title
Title

Required/mandatory field

Title of this cause

>{String}</Title>
3
     <DirectCauseCategory
DirectCauseCategory

Direct cause category.

Applicable domain values can be found here

This field is optional.

>{Integer}</DirectCauseCategory>
4
     <RootCauseCategory
RootCauseCategory

Root cause category.

Applicable domain values can be found here

This field is optional.

>{Integer}</RootCauseCategory>
5
     <Comment
Comment

Comment to a cause

This field is optional.

>{String}</Comment>
6
     <ParentCause
ParentCause

This field is optional.

>
7
          <QualityCauseId
QualityCauseId

Cause identifier

Minimum value: 1

This field is optional.

>{Integer}</QualityCauseId>
8
     </ParentCause>
9
</QualityCause>
1
{
2
     "qualityCause": {
3
          "title
Title

Required/mandatory field

Title of this cause

": "{String}",
4
          "directCauseCategory
DirectCauseCategory

Direct cause category.

Applicable domain values can be found here

This field is optional.

": "{Integer}",
5
          "rootCauseCategory
RootCauseCategory

Root cause category.

Applicable domain values can be found here

This field is optional.

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

Comment to a cause

This field is optional.

": "{String}",
7
          "parentCause
ParentCause

This field is optional.

": {
8
               "qualityCauseId
QualityCauseId

Cause identifier

Minimum value: 1

This field is optional.

": "{Integer}"
9
          }
10
     }
11
}

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
<QualityCause>
2
     <QualityCauseId
QualityCauseId

Cause identifier

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

Date and time when this cause was created

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

Title of this cause

>{String}</Title>
5
     <DirectCauseCategory
DirectCauseCategory

Direct cause category.

Possible domain values can be found here

>{Integer}</DirectCauseCategory>
6
     <RootCauseCategory
RootCauseCategory

Root cause category.

Possible domain values can be found here

>{Integer}</RootCauseCategory>
7
     <Comment
Comment

Comment to a cause

>{String}</Comment>
8
     <ParentCause>
9
          <QualityCauseId
QualityCauseId

Cause identifier

>{Integer}</QualityCauseId>
10
          <QualityCauseLink
QualityCauseLink

Document reference of a cause

>{String}</QualityCauseLink>
11
     </ParentCause>
12
</QualityCause>
1
{
2
     "qualityCause": {
3
          "qualityCauseId
QualityCauseId

Cause identifier

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

Date and time when this cause was created

": "{Datetime}",
5
          "title
Title

Title of this cause

": "{String}",
6
          "directCauseCategory
DirectCauseCategory

Direct cause category.

Possible domain values can be found here

": "{Integer}",
7
          "rootCauseCategory
RootCauseCategory

Root cause category.

Possible domain values can be found here

": "{Integer}",
8
          "comment
Comment

Comment to a cause

": "{String}",
9
          "parentCause": {
10
               "qualityCauseId
QualityCauseId

Cause identifier

": "{Integer}",
11
               "qualityCauseLink
QualityCauseLink

Document reference of a cause

": "{String}"
12
          }
13
     }
14
}

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 105778 HTTP 404 Issue not found.
Error 105887 HTTP 404 The cause not found.