API

Quality management APIs

POST quality/documents/{qualityDocumentId}/versions/{qualityDocumentVersionId}/outgoing-links

Creating outgoing links for quality document version

HTTP method POST
URI https://api.rambase.net/quality/documents/{qualityDocumentId}/versions/{qualityDocumentVersionId}/outgoing-links
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {qualityDocumentId} Identifier of the quality document
Integer, minimum 1
- URI parameter {qualityDocumentVersionId} Identifier of the document version
Integer, minimum 1
Successful HTTP status code 200
API resource identifier 6675, 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
<OutgoingLink
OutgoingLink

This field is optional.

>
2
     <EmbeddedObject
EmbeddedObject

Reference to the object where link is placed
- Embedded media (EMB)
- Embedded diagram (EDA)
- Symbol (SYM)

This field is optional.

>
3
          <ObjectId
ObjectId

Identifier of the object

Minimum value: 100000

This field is optional.

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

Type of object

This field is optional.

>{String}</ObjectType>
5
     </EmbeddedObject>
6
     <LinkTo
LinkTo

This field is optional.

>
7
          <ExternalUrl
ExternalUrl

Url if linking to external url

This field is optional.

>{String}</ExternalUrl>
8
          <Anchor
Anchor

Guid, part of document/other

This field is optional.

>{String}</Anchor>
9
          <ObjectReference
ObjectReference

This field is optional.

>
10
               <ObjectId
ObjectId

Identifier of the object

Minimum value: 100000

This field is optional.

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

Type of object

This field is optional.

>{String}</ObjectType>
12
          </ObjectReference>
13
     </LinkTo>
14
     <LinkConfigurations
LinkConfigurations

This field is optional.

>
15
          <Configuration
Configuration

This field is optional.

>
16
               <Key
Key

Name of the configuration key

This field is optional.

>{String}</Key>
17
               <Value
Value

Value of the configuration key

This field is optional.

>{String}</Value>
18
          </Configuration>
19
     </LinkConfigurations>
20
</OutgoingLink>
1
{
2
     "outgoingLink
OutgoingLink

This field is optional.

": {
3
          "embeddedObject
EmbeddedObject

Reference to the object where link is placed
- Embedded media (EMB)
- Embedded diagram (EDA)
- Symbol (SYM)

This field is optional.

": {
4
               "objectId
ObjectId

Identifier of the object

Minimum value: 100000

This field is optional.

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

Type of object

This field is optional.

": "{String}"
6
          },
7
          "linkTo
LinkTo

This field is optional.

": {
8
               "externalUrl
ExternalUrl

Url if linking to external url

This field is optional.

": "{String}",
9
               "anchor
Anchor

Guid, part of document/other

This field is optional.

": "{String}",
10
               "objectReference
ObjectReference

This field is optional.

": {
11
                    "objectId
ObjectId

Identifier of the object

Minimum value: 100000

This field is optional.

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

Type of object

This field is optional.

": "{String}"
13
               }
14
          },
15
          "linkConfigurations
LinkConfigurations

This field is optional.

": [
16
               {
17
                    "key
Key

Name of the configuration key

This field is optional.

": "{String}",
18
                    "value
Value

Value of the configuration key

This field is optional.

": "{String}"
19
               }
20
          ]
21
     }
22
}

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
<OutgoingLink>
2
     <OutgoingLinkId
OutgoingLinkId

Link identifier

>{Integer}</OutgoingLinkId>
3
</OutgoingLink>
1
{
2
     "outgoingLink": {
3
          "outgoingLinkId
OutgoingLinkId

Link identifier

": "{Integer}"
4
     }
5
}

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 109351 HTTP 400 Link not found
Error 109358 HTTP 400 Not a valid referance for LinkFromEmbedded
Error 109356 HTTP 400 Not a valid referance for LinkTo
Error 109362 HTTP 400 Link to url cannot be used at the same time linking to a internal document