API

Quality management APIs

POST quality/issues/{qualityIssueId}/other-relations

Create a new quality issue relation.

HTTP method POST
URI https://api.rambase.net/quality/issues/{qualityIssueId}/other-relations
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 4587, 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
<OtherRelation
OtherRelation

This field is optional.

>
2
     <Name
Name

A multipurpose tag to put on a quality issue. Could be an object reference or a custom label

This field is optional.

>{String}</Name>
3
     <Object
Object

This field is optional.

>
4
          <ObjectType
ObjectType

Type of object

This field is optional.

>{String}</ObjectType>
5
          <ObjectId
ObjectId

Identifier of the object

Minimum value: 1

This field is optional.

>{Integer}</ObjectId>
6
          <ItemId
ItemId

Item-number of the object

Minimum value: 1

This field is optional.

>{Integer}</ItemId>
7
     </Object>
8
</OtherRelation>
1
{
2
     "otherRelation
OtherRelation

This field is optional.

": {
3
          "name
Name

A multipurpose tag to put on a quality issue. Could be an object reference or a custom label

This field is optional.

": "{String}",
4
          "object
Object

This field is optional.

": {
5
               "objectType
ObjectType

Type of object

This field is optional.

": "{String}",
6
               "objectId
ObjectId

Identifier of the object

Minimum value: 1

This field is optional.

": "{Integer}",
7
               "itemId
ItemId

Item-number of the object

Minimum value: 1

This field is optional.

": "{Integer}"
8
          }
9
     }
10
}

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.
$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
<OtherRelation>
2
     <OtherRelationId
OtherRelationId

Relation identifier

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

Date and time of creation

>{Datetime}</AddedAt>
4
     <Description
Description

Description of the object

>{String}</Description>
5
     <Name
Name

A multipurpose tag to put on a quality issue. Could be an object reference or a custom label

>{String}</Name>
6
     <Object>
7
          <Status
Status

Status of the item/object.

>{Integer}</Status>
8
          <Database
Database

Company code/database the object belongs to

>{String}</Database>
9
          <ObjectId
ObjectId

Identifier of the object

>{Integer}</ObjectId>
10
          <ObjectType
ObjectType

Type of object

>{String}</ObjectType>
11
          <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>
12
          <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
13
          <ItemId
ItemId

Item-number of the object

>{Integer}</ItemId>
14
          <ItemType
ItemType

Type of item

>{String}</ItemType>
15
          <ItemLink
ItemLink

API reference to the item

>{String}</ItemLink>
16
     </Object>
17
</OtherRelation>
1
{
2
     "otherRelation": {
3
          "otherRelationId
OtherRelationId

Relation identifier

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

Date and time of creation

": "{Datetime}",
5
          "description
Description

Description of the object

": "{String}",
6
          "name
Name

A multipurpose tag to put on a quality issue. Could be an object reference or a custom label

": "{String}",
7
          "object": {
8
               "status
Status

Status of the item/object.

": "{Integer}",
9
               "database
Database

Company code/database the object belongs to

": "{String}",
10
               "objectId
ObjectId

Identifier of the object

": "{Integer}",
11
               "objectType
ObjectType

Type of object

": "{String}",
12
               "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

": "{String}",
13
               "objectLink
ObjectLink

API reference to the object

": "{String}",
14
               "itemId
ItemId

Item-number of the object

": "{Integer}",
15
               "itemType
ItemType

Type of item

": "{String}",
16
               "itemLink
ItemLink

API reference to the item

": "{String}"
17
          }
18
     }
19
}

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