• <Web Interface website> - is the URI for the Web Interface website.
• <server name> - is the name of the server.
If the server name contains reserved characters, those characters must be percent encoded in the URI. Use the Servers operation request to return the URI safe version of the server name.
• <repository name> - is the name of the database.
If the database name contains reserved characters, those characters must be percent encoded in the URI. Use the Repositories operation request to return the URI safe version of the database name.
• <model name> - is the name of the model.
If the model name contains reserved characters, those characters must be percent encoded in the URI. Use the Models operation request to return the URI safe version of the model name.
The REST service cannot work with Models that have the percentage character (%) in their names.
• <version> - is the version number of the model, as it appears in Model Explorer.
• <item id> - is the id of the Modeler item, against which the Diagram or DiagramImageMap operation is being run.
You can find out the ids of items through operation requests such as ChildItems operation request.
Returned XML
A Diagram request returns the image of a diagram.
A DiagramImageMap returns the image map that defines the hot spots and links on the diagram. The map relates to the full size of the image, so if the diagram is scaled the map has to be scaled accordingly.
Example
In this example, the following Diagram request returns the image of the ClassDiagram1 class diagram (the item id of ClassDiagram1 is e475d03c-9ed2-45b8-b943-e08d3892651b).
In this example, the following DiagramImageMap request returns the image map for the ClassDiagram1 class diagram (the item id of ClassDiagram1 is e475d03c-9ed2-45b8-b943-e08d3892651b).
