API

Quality management APIs

GET quality/risks/{riskId}/related-issues/{relatedIssueId}

Get single related QHSES issue

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

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

>{Date}</DueDate>
12
          <Responsible
Responsible

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

>
13
               <EmployeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

>{String}</EmployeeLink>
17
          </Responsible>
18
          <Assignee
Assignee

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

>
19
               <EmployeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

>{String}</EmployeeLink>
23
          </Assignee>
24
          <QualityIssueLink
QualityIssueLink

API reference to the object

>{String}</QualityIssueLink>
25
     </QualityIssue>
26
     <RelatedIssueLink
RelatedIssueLink

API reference to the item

>{String}</RelatedIssueLink>
27
</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

": "{Date}",
13
               "responsible
Responsible

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

": {
14
                    "employeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

": "{String}"
18
               },
19
               "assignee
Assignee

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

": {
20
                    "employeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

": "{String}"
24
               },
25
               "qualityIssueLink
QualityIssueLink

API reference to the object

": "{String}"
26
          },
27
          "relatedIssueLink
RelatedIssueLink

API reference to the item

": "{String}"
28
     }
29
}

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 101566 HTTP 404 User not found
Error 107959 HTTP 400 You have only admittance to issues connected to your account