API

Quality management APIs

POST quality/documents/{qualityDocumentId}/versions/{qualityDocumentVersionId}/embedded-diagrams

Creates a new embedded diagram

HTTP method POST
URI https://api.rambase.net/quality/documents/{qualityDocumentId}/versions/{qualityDocumentVersionId}/embedded-diagrams
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {qualityDocumentId} Identifier of the quality document
Integer, minimum 1
- URI parameter {qualityDocumentVersionId} Quality Document Version identifier
Integer, minimum 1
Successful HTTP status code 201
API resource identifier 6848, 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
<EmbeddedDiagram
EmbeddedDiagram

This field is optional.

>
2
     <SourceDiagram
SourceDiagram

This field is optional.

>
3
          <QualityDiagramId
QualityDiagramId

Identifier of the diagram

Minimum value: 100000

This field is optional.

>{Integer}</QualityDiagramId>
4
     </SourceDiagram>
5
     <ParentEmbedding
ParentEmbedding

This field is optional.

>
6
          <ObjectType
ObjectType

Type of object

This field is optional.

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

Identifier of the object

This field is optional.

>{Integer}</ObjectId>
8
     </ParentEmbedding>
9
</EmbeddedDiagram>
1
{
2
     "embeddedDiagram
EmbeddedDiagram

This field is optional.

": {
3
          "sourceDiagram
SourceDiagram

This field is optional.

": {
4
               "qualityDiagramId
QualityDiagramId

Identifier of the diagram

Minimum value: 100000

This field is optional.

": "{Integer}"
5
          },
6
          "parentEmbedding
ParentEmbedding

This field is optional.

": {
7
               "objectType
ObjectType

Type of object

This field is optional.

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

Identifier of the object

This field is optional.

": "{Integer}"
9
          }
10
     }
11
}

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
1

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: