SA REST API : System Architect REST API : Return specific properties for definition instances
  
Return specific properties for definition instances
Syntax
http://<Machine Name|IP>:<Port>/SARest/SQL/<Server Name>/<Encyclopedia Name>/<Workspace ID>?fields=Encyclopedia/Definitions/<Type Name>/(<Property Name>|<Property Name>)
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
Return the name and GUID properties for all application definitions:
http://localhost:8889/SARest/SQL/MySQLServer/Samples/1?fields=Encyclopedia/Definitions/Application/(Name|prp_GUID)
Results
Encyclopedia name="Samples">
<Definitions>
<Application>
<Name>Business Applications</Name>
<prp_GUID>03e2422f-2327-49c4-aaee-8070f31a555c</prp_GUID>
</Application>
<Application>
<Name>Call Center</Name>
<prp_GUID>9fa6ac10-8486-4baa-9cba-6fa8f58d5959</prp_GUID>
</Application>
<Application>
<Name>Content Management</Name>
<prp_GUID>22328980-b60a-46de-9906-ca985ffe5a25</prp_GUID>
</Application>
<Application>
<Name>Credit Card Booking</Name>
<prp_GUID>83844f0a-fdd3-11d4-84d1-00a0240f30d4</prp_GUID>
</Application>
</Definitions>
<Workspace Name="Root" ID="1" Baseline="0" Description="" Path="\\Root"/>
</Encyclopedia>
Comments
Use pipe character to delimit the list of property names.
Parent topic
System Architect REST API