Quality management APIs
Updates the symbol's embedded media
| HTTP method | PUT |
| URI | https://api.rambase.net/quality/symbols/{qualitySymbolId}/embedded-medias/{embeddedMediaId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {qualitySymbolId} |
Quality symbol identifier
Integer, minimum 100000 |
| - URI parameter {embeddedMediaId} |
Embedded media identifier
Integer, minimum 100000 |
| Successful HTTP status code | 200 |
| API resource identifier | 6809, 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.
EmbeddedMedia
This field is optional.
>Height
Height of the image in pixels
Minimum value: 0
This field is optional.
>{Decimal}</Height>Width
Width of image in pixels
Minimum value: 0
This field is optional.
>{Decimal}</Width>Left
Position of embedded image from the left side of frame in px
This field is optional.
>{Decimal}</Left>Top
Position of embedded image from the top of frame in px
This field is optional.
>{Decimal}</Top>HighlightShapes
If true, shapes should be highlighted (Called show_mask in v3)
This field is optional.
>{Boolean}</HighlightShapes>Rotation
Number of degree used for programatically rotating of images (0, 90, 180, 270)
Minimum value: 0
This field is optional.
>{Decimal}</Rotation>EmbeddedMedia
This field is optional.
": {Height
Height of the image in pixels
Minimum value: 0
This field is optional.
": "{Decimal}",Width
Width of image in pixels
Minimum value: 0
This field is optional.
": "{Decimal}",Left
Position of embedded image from the left side of frame in px
This field is optional.
": "{Decimal}",Top
Position of embedded image from the top of frame in px
This field is optional.
": "{Decimal}",HighlightShapes
If true, shapes should be highlighted (Called show_mask in v3)
This field is optional.
": "{Boolean}",Rotation
Number of degree used for programatically rotating of images (0, 90, 180, 270)
Minimum value: 0
This field is optional.
": "{Decimal}"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: