Quality management APIs
Creates a new relation to other quality issue.
| HTTP method | POST |
| URI | https://api.rambase.net/quality/issues/{qualityIssueId}/related-issues |
| 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 | 4624, 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.
RelationType
Required/mandatory field
What type of relation it is
Applicable domain values can be found here
>{Integer}</RelationType>QualityIssueId
Required/mandatory field
Quality issue identifier
Minimum value: 100000
>{Integer}</QualityIssueId>RelationType
Required/mandatory field
What type of relation it is
Applicable domain values can be found here
": "{Integer}",QualityIssueId
Required/mandatory field
Quality issue identifier
Minimum value: 100000
": "{Integer}"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.
RelatedIssueId
Relation identifier
>{Integer}</RelatedIssueId>RelationType
What type of relation it is
Possible domain values can be found here
>{Integer}</RelationType>AddedAt
Date and time of creation
>{Datetime}</AddedAt>QualityIssueId
Quality issue identifier
>{Integer}</QualityIssueId>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>Description
Description of quality issue
>{String}</Description>Title
Title of the issue
>{String}</Title>DueDate
Time and date when this issue should be resolved
>{Datetime}</DueDate>UserId
User identifier
>{Integer}</UserId>FirstName
First name of the user
>{String}</FirstName>Name
Name of the user
>{String}</Name>UserLink
User reference
>{String}</UserLink>EmployeeId
Employee identifier
>{Integer}</EmployeeId>LastName
Last name of employee
>{String}</LastName>FirstName
First name of employee
>{String}</FirstName>EmployeeLink
Employee reference
>{String}</EmployeeLink>QualityIssueLink
API reference to the object
>{String}</QualityIssueLink>RelatedIssueId
Relation identifier
": "{Integer}",RelationType
What type of relation it is
Possible domain values can be found here
": "{Integer}",AddedAt
Date and time of creation
": "{Datetime}",QualityIssueId
Quality issue identifier
": "{Integer}",Status
Status of quality issue. 1: Registering, 2: Analyzing, 4: Pending actions, 8: Reviewing, 9: Closed
Possible domain values can be found here
": "{Integer}",Description
Description of quality issue
": "{String}",Title
Title of the issue
": "{String}",DueDate
Time and date when this issue should be resolved
": "{Datetime}",UserId
User identifier
": "{Integer}",FirstName
First name of the user
": "{String}",Name
Name of the user
": "{String}",UserLink
User reference
": "{String}"EmployeeId
Employee identifier
": "{Integer}",LastName
Last name of employee
": "{String}",FirstName
First name of employee
": "{String}",EmployeeLink
Employee reference
": "{String}"QualityIssueLink
API reference to the object
": "{String}"
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 101015 HTTP 404 | Permission not found |
| Error 101420 HTTP 404 | Setting definition not found |
| Error 105978 HTTP 400 | Relation to the other object should be added using different API. |
| Error 105979 HTTP 400 | Cannot add relation to itself. |
| Error 100018 HTTP 404 | Document {0} not found |