API

Quality management APIs

POST quality/risks/{riskId}/related-issues

Add new related QHSES issue

HTTP method POST
URI https://api.rambase.net/quality/risks/{riskId}/related-issues
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {riskId} Identifier of the risk
Integer, minimum 100000
Successful HTTP status code 201
API resource identifier 5340, version 2

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
<RelatedIssue>
2
     <QualityIssue>
3
          <QualityIssueId
QualityIssueId

Required/mandatory field

Quality issue identifier

Minimum value: 100000

>
{Integer}</QualityIssueId>
4
     </QualityIssue>
5
</RelatedIssue>
1
{
2
     "relatedIssue": {
3
          "qualityIssue": {
4
               "qualityIssueId
QualityIssueId

Required/mandatory field

Quality issue identifier

Minimum value: 100000

":
"{Integer}"
5
          }
6
     }
7
}

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
<RelatedIssue>
2
     <RelatedIssueId
RelatedIssueId

Identifier of the relation with related issues

>
{Integer}</RelatedIssueId>
3
     <AddedAt
AddedAt

Date and time when relation was added

>
{Datetime}</AddedAt>
4
     <QualityIssue>
5
          <QualityIssueId
QualityIssueId

Quality issue identifier

>
{Integer}</QualityIssueId>
6
          <Status
Status

Status of quality issue. 1: Registering, 2: Analyzing, 4: Pending actions, 8: Reviewing, 9: Closed

Possible domain values can be found here

>
{Integer}</Status>
7
          <Description
Description

Description of quality issue

>
{String}</Description>
8
          <Type
Type

Quality issue type. I.E "Incident", "Observation" or "Improvement proposal"

Possible domain values can be found here

>
{Integer}</Type>
9
          <Title
Title

Title of the issue

>
{String}</Title>
10
          <Category
Category

Category of the quality issue. Together with type this should apply information on which field/area of a system the quality issue is addressing

Possible domain values can be found here

>
{Integer}</Category>
11
          <DueDate
DueDate

Time and date when this issue should be resolved

>
12
               <EmployeeId
EmployeeId

Employee identifier

>
{Integer}</EmployeeId>
13
               <LastName
LastName

Last name of employee

>
{String}</LastName>
14
               <FirstName
FirstName

First name of employee

>
{String}</FirstName>
15
               <EmployeeLink
EmployeeLink

Employee reference

>
{String}</EmployeeLink>
16
               <EmployeeId
EmployeeId

Employee identifier

>
{Integer}</EmployeeId>
17
               <LastName
LastName

Last name of employee

>
{String}</LastName>
18
               <FirstName
FirstName

First name of employee

>
{String}</FirstName>
19
               <EmployeeLink
EmployeeLink

Employee reference

>
{String}</EmployeeLink>
20
          </DueDate>
21
          <QualityIssueLink
QualityIssueLink

API reference to the object

>
{String}</QualityIssueLink>
22
     </QualityIssue>
23
     <RelatedIssueLink
RelatedIssueLink

API reference to the item

>
{String}</RelatedIssueLink>
24
</RelatedIssue>
1
{
2
     "relatedIssue": {
3
          "relatedIssueId
RelatedIssueId

Identifier of the relation with related issues

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

Date and time when relation was added

":
"{Datetime}",
5
          "qualityIssue": {
6
               "qualityIssueId
QualityIssueId

Quality issue identifier

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

Status of quality issue. 1: Registering, 2: Analyzing, 4: Pending actions, 8: Reviewing, 9: Closed

Possible domain values can be found here

":
"{Integer}",
8
               "description
Description

Description of quality issue

":
"{String}",
9
               "type
Type

Quality issue type. I.E "Incident", "Observation" or "Improvement proposal"

Possible domain values can be found here

":
"{Integer}",
10
               "title
Title

Title of the issue

":
"{String}",
11
               "category
Category

Category of the quality issue. Together with type this should apply information on which field/area of a system the quality issue is addressing

Possible domain values can be found here

":
"{Integer}",
12
               "dueDate
DueDate

Time and date when this issue should be resolved

":
{
13
                    "employeeId
EmployeeId

Employee identifier

":
"{Integer}",
14
                    "lastName
LastName

Last name of employee

":
"{String}",
15
                    "firstName
FirstName

First name of employee

":
"{String}",
16
                    "employeeLink
EmployeeLink

Employee reference

":
"{String}",
17
                    "employeeId
EmployeeId

Employee identifier

":
"{Integer}",
18
                    "lastName
LastName

Last name of employee

":
"{String}",
19
                    "firstName
FirstName

First name of employee

":
"{String}",
20
                    "employeeLink
EmployeeLink

Employee reference

":
"{String}"
21
               },
22
               "qualityIssueLink
QualityIssueLink

API reference to the object

":
"{String}"
23
          },
24
          "relatedIssueLink
RelatedIssueLink

API reference to the item

":
"{String}"
25
     }
26
}

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 107959 HTTP 400 You have only admittance to issues connected to your account