SA REST API : System Architect REST API : Return diagram instances for the given diagram type
  
Return diagram instances for the given diagram type
Syntax
http://<Machine Name|IP>:<Port>/SARest/SQL/<Server Name>/<Encyclopedia Name>/<Workspace ID>/Diagrams/<Type Name>
Parameter values
relationships=true
Causes relationship data to be included:
<Relation Type="contains" Class="Definition" MinorType="Entity" DDID="11905" href="..."/>
Optional parameters
gt=value
For adding a WHERE 'order by field' > 'value' statement to the report to be executed.
gtddid=last_Identity_value_from_last_request
Requires specification of parameter rowcount. Do not use with parameter page.
orderby=name/property/identity
(Or other field available by default.) To specify how records should be ordered.
page=numeric
Page number; requires specification of parameter rowcount.
rowcount=maximum number of items to return
These parameters are specified like this:
query url...?rowcount=n
query url...?rowcount=n&gtddid=n
Example
http://localhost:8889/SARest/SQL/MySQLServer/Samples/1/Diagrams/Business-spa-Process
Results
<Encyclopedia name="Samples">
<Diagrams>
<Business-spa-Process _image_jpeg="http://localhost:8889/SARest/SQL/MySQLServer/Samples/1/Diagrams/Business-spa-Process/12246/Image/JPEG" _image_png="http://localhost:8889/SARest/SQL/MySQLServer/Samples/1/Diagrams/Business-spa-Process/12246/Image/PNG" _image_wmf="http://localhost:8889/SARest/SQL/MySQLServer/Samples/1/Diagrams/Business-spa-Process/12246/Image/WMF">
<href>http://localhost:8889/SARest/SQL/MySQLServer/Samples/1/Diagrams/Business-spa-Process/12246</href>
<Name>\Test\</Name>
<Identity>12246</Identity>
<WorkspaceId>1</WorkspaceId>
<Type>142</Type>
<SAVersion>2</SAVersion>
<prp_Use-spa-Automatic-spa-Gradient-spa-Fills>T</prp_Use-spa-Automatic-spa-Gradient-spa-Fills>
<prp_Vertical-spa-Pools-spa-and-spa-Lanes>F</prp_Vertical-spa-Pools-spa-and-spa-Lanes>
<prp_Check-spa-Connections>F</prp_Check-spa-Connections>
<prp_Diagram-spa-Status>Working</prp_Diagram-spa-Status>
<Symbols>
<Process>
<Name>Process_1</Name>
<Identity>12247</Identity>
<WorkspaceId>1</WorkspaceId>
<Type>777</Type>
<SAVersion>1</SAVersion>
<prp_Process-spa-Stereotype>process</prp_Process-spa-Stereotype>
<href>http://localhost:8889/SARest/SQL/MySQLServer/Samples/1/Diagrams/Business-spa-Process/12246/12247</href>
</Process>
</Symbols>
</Business-spa-Process>
</Diagrams>
</Encyclopedia>
Comments
None.
Parent topic
System Architect REST API