Quality management APIs
Updates the diagram's embedded shape
| HTTP method | PUT |
| URI | https://api.rambase.net/quality/diagrams/{qualityDiagramId}/embedded-medias/{embeddedMediaId}/shapes/{shapeId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {qualityDiagramId} |
Identifier of the diagram
Integer, minimum 100000 |
| - URI parameter {embeddedMediaId} |
Embedded media identifier
Integer, minimum 100000 |
| - URI parameter {shapeId} |
Embedded media shape identifier
Integer, minimum 1 |
| Successful HTTP status code | 200 |
| API resource identifier | 6802, 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.
Shape
This field is optional.
>Title
Title of the shape
This field is optional.
>{String}</Title>Height
Height of the shape. Values between 0 and 1 where 1 is 100% of the height of the frame
Minimum value: 0
This field is optional.
>{Decimal}</Height>Width
Width of the shape. Values between 0 and 1 where 0 is zero width and 1 is 100% of the frame
Minimum value: 0
This field is optional.
>{Decimal}</Width>Top
Vertical position of the top left corner of the shape. Values from 0 to 1 - height, where 0 is in the very top and 1-height is to the bottom
This field is optional.
>{Decimal}</Top>Left
Horizontal position of the shape between 0 and 1 - width where 0 is leftmost and 1 - width is rightmost position
This field is optional.
>{Decimal}</Left>Rotation
Rotation of the shape in degrees
Minimum value: 0
This field is optional.
>{Decimal}</Rotation>Scale
Scale of the shape
Minimum value: 0
This field is optional.
>{Decimal}</Scale>ShowBorder
True if borders on the shapes should be rendered
This field is optional.
>{Boolean}</ShowBorder>Type
Type of the shape. Possible values: arrow, cross, ellipse, rectangle, text
Applicable domain values can be found here
This field is optional.
>{Integer}</Type>Color
This field is optional.
>HexColor
Hex color id. Ex. #112233
Input must match the following regular expression pattern: ^#[0-9a-fA-F]{6}$
This field is optional.
>{String}</HexColor>ColorReference
This field is optional.
>ColorId
Color identifier
Minimum value: 100000
This field is optional.
>{Integer}</ColorId>Link
This field is optional.
>LinkId
Link identifier
Minimum value: 100000
This field is optional.
>{Integer}</LinkId>Shape
This field is optional.
": {Title
Title of the shape
This field is optional.
": "{String}",Height
Height of the shape. Values between 0 and 1 where 1 is 100% of the height of the frame
Minimum value: 0
This field is optional.
": "{Decimal}",Width
Width of the shape. Values between 0 and 1 where 0 is zero width and 1 is 100% of the frame
Minimum value: 0
This field is optional.
": "{Decimal}",Top
Vertical position of the top left corner of the shape. Values from 0 to 1 - height, where 0 is in the very top and 1-height is to the bottom
This field is optional.
": "{Decimal}",Left
Horizontal position of the shape between 0 and 1 - width where 0 is leftmost and 1 - width is rightmost position
This field is optional.
": "{Decimal}",Rotation
Rotation of the shape in degrees
Minimum value: 0
This field is optional.
": "{Decimal}",Scale
Scale of the shape
Minimum value: 0
This field is optional.
": "{Decimal}",ShowBorder
True if borders on the shapes should be rendered
This field is optional.
": "{Boolean}",Type
Type of the shape. Possible values: arrow, cross, ellipse, rectangle, text
Applicable domain values can be found here
This field is optional.
": "{Integer}",Color
This field is optional.
": {HexColor
Hex color id. Ex. #112233
Input must match the following regular expression pattern: ^#[0-9a-fA-F]{6}$
This field is optional.
": "{String}",ColorReference
This field is optional.
": {ColorId
Color identifier
Minimum value: 100000
This field is optional.
": "{Integer}"Link
This field is optional.
": {LinkId
Link identifier
Minimum value: 100000
This field is optional.
": "{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. |
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. Fields colored in grey is expandable fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
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: