API

Quality management APIs

POST quality/diagrams/{qualityDiagramId}/embedded-medias

Creates a diagram's embedded media

HTTP method POST
URI https://api.rambase.net/quality/diagrams/{qualityDiagramId}/embedded-medias
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {qualityDiagramId} Identifier of the diagram
Integer, minimum 100000
Successful HTTP status code 201
API resource identifier 6795, version 4

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
<EmbeddedMedia>
2
     <Height
Height

Height of the image in pixels

Minimum value: 0

This field is optional.

>{Decimal}</Height>
3
     <Width
Width

Width of image in pixels

Minimum value: 0

This field is optional.

>{Decimal}</Width>
4
     <NaturalHeight
NaturalHeight

Original height of image from media library in px (used to count apect ratio)

Minimum value: 0

This field is optional.

>{Decimal}</NaturalHeight>
5
     <NaturalWidth
NaturalWidth

Original width of image from media library in px (used to count apect ratio)

Minimum value: 0

This field is optional.

>{Decimal}</NaturalWidth>
6
     <Left
Left

Position of embedded image from the left side of frame in px

Default value: 0

This field is optional.

>{Decimal}</Left>
7
     <Top
Top

Position of embedded image from the top of frame in px

Default value: 0

This field is optional.

>{Decimal}</Top>
8
     <HighlightShapes
HighlightShapes

If true, shapes should be highlighted (Called show_mask in v3)

Default value: False

This field is optional.

>{Boolean}</HighlightShapes>
9
     <Rotation
Rotation

Number of degree used for programatically rotating of images (0, 90, 180, 270)

Minimum value: 0

This field is optional.

>{Decimal}</Rotation>
10
     <ParentEmbedding
ParentEmbedding

This field is optional.

>
11
          <ObjectType
ObjectType

Type of object

This field is optional.

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

Identifier of the object

This field is optional.

>{Integer}</ObjectId>
13
     </ParentEmbedding>
14
     <Media>
15
          <MediaId
MediaId

Required/mandatory field

Media identifier

Minimum value: 100000

>{Integer}</MediaId>
16
     </Media>
17
</EmbeddedMedia>
1
{
2
     "embeddedMedia": {
3
          "height
Height

Height of the image in pixels

Minimum value: 0

This field is optional.

": "{Decimal}",
4
          "width
Width

Width of image in pixels

Minimum value: 0

This field is optional.

": "{Decimal}",
5
          "naturalHeight
NaturalHeight

Original height of image from media library in px (used to count apect ratio)

Minimum value: 0

This field is optional.

": "{Decimal}",
6
          "naturalWidth
NaturalWidth

Original width of image from media library in px (used to count apect ratio)

Minimum value: 0

This field is optional.

": "{Decimal}",
7
          "left
Left

Position of embedded image from the left side of frame in px

Default value: 0

This field is optional.

": "{Decimal}",
8
          "top
Top

Position of embedded image from the top of frame in px

Default value: 0

This field is optional.

": "{Decimal}",
9
          "highlightShapes
HighlightShapes

If true, shapes should be highlighted (Called show_mask in v3)

Default value: False

This field is optional.

": "{Boolean}",
10
          "rotation
Rotation

Number of degree used for programatically rotating of images (0, 90, 180, 270)

Minimum value: 0

This field is optional.

": "{Decimal}",
11
          "parentEmbedding
ParentEmbedding

This field is optional.

": {
12
               "objectType
ObjectType

Type of object

This field is optional.

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

Identifier of the object

This field is optional.

": "{Integer}"
14
          },
15
          "media": {
16
               "mediaId
MediaId

Required/mandatory field

Media identifier

Minimum value: 100000

": "{Integer}"
17
          }
18
     }
19
}

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
<EmbeddedMedia>
2
     <EmbeddedMediaId
EmbeddedMediaId

Embedded media identifier

>{Integer}</EmbeddedMediaId>
3
     <IsReadOnly
IsReadOnly

True if embedded object is used by several objects. Copy to make changes.

>{Boolean}</IsReadOnly>
4
     <Height
Height

Height of the image in pixels

>{Decimal}</Height>
5
     <Width
Width

Width of image in pixels

>{Decimal}</Width>
6
     <NaturalHeight
NaturalHeight

Original height of image from media library in px (used to count apect ratio)

>{Decimal}</NaturalHeight>
7
     <NaturalWidth
NaturalWidth

Original width of image from media library in px (used to count apect ratio)

>{Decimal}</NaturalWidth>
8
     <Top
Top

Position of embedded image from the top of frame in px

>{Decimal}</Top>
9
     <Left
Left

Position of embedded image from the left side of frame in px

>{Decimal}</Left>
10
     <HighlightShapes
HighlightShapes

If true, shapes should be highlighted (Called show_mask in v3)

>{Boolean}</HighlightShapes>
11
     <Rotation
Rotation

Number of degree used for programatically rotating of images (0, 90, 180, 270)

>{Decimal}</Rotation>
12
     <ParentEmbedding>
13
          <ObjectType
ObjectType

Type of object

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

Identifier of the object

>{Integer}</ObjectId>
15
     </ParentEmbedding>
16
     <Media>
17
          <MediaId
MediaId

Media identifier

>{Integer}</MediaId>
18
          <FileStorageGuid
FileStorageGuid

Guid reference to file service

>{String}</FileStorageGuid>
19
          <MediaLink
MediaLink

Media reference

>{String}</MediaLink>
20
     </Media>
21
</EmbeddedMedia>
1
{
2
     "embeddedMedia": {
3
          "embeddedMediaId
EmbeddedMediaId

Embedded media identifier

": "{Integer}",
4
          "isReadOnly
IsReadOnly

True if embedded object is used by several objects. Copy to make changes.

": "{Boolean}",
5
          "height
Height

Height of the image in pixels

": "{Decimal}",
6
          "width
Width

Width of image in pixels

": "{Decimal}",
7
          "naturalHeight
NaturalHeight

Original height of image from media library in px (used to count apect ratio)

": "{Decimal}",
8
          "naturalWidth
NaturalWidth

Original width of image from media library in px (used to count apect ratio)

": "{Decimal}",
9
          "top
Top

Position of embedded image from the top of frame in px

": "{Decimal}",
10
          "left
Left

Position of embedded image from the left side of frame in px

": "{Decimal}",
11
          "highlightShapes
HighlightShapes

If true, shapes should be highlighted (Called show_mask in v3)

": "{Boolean}",
12
          "rotation
Rotation

Number of degree used for programatically rotating of images (0, 90, 180, 270)

": "{Decimal}",
13
          "parentEmbedding": {
14
               "objectType
ObjectType

Type of object

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

Identifier of the object

": "{Integer}"
16
          },
17
          "media": {
18
               "mediaId
MediaId

Media identifier

": "{Integer}",
19
               "fileStorageGuid
FileStorageGuid

Guid reference to file service

": "{String}",
20
               "mediaLink
MediaLink

Media reference

": "{String}"
21
          }
22
     }
23
}

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: