SA REST API : System Architect REST API : Return definition instances using complex property filter
  
Return definition instances using complex property filter
Syntax
http://<Machine Name|IP>:<Port>/SARest/SQL/<Server Name>/<Encyclopedia Name>/<Workspace ID>?fields=Encyclopedia/Definitions/<Type Name>[<Property Name><Operator><Property Value>+AND+<Property Name><Operator><Property Value>]
Parameter values
Literal values can be delimited by double quotes or single quotes. If there are no whitespace characters in the literal, quotes can also be omitted. The following two expressions are also valid.
[State='Assigned']
[State=Assigned]
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 all application definitions whose rank >0 (that is, greater than 0) and build cost is greater than 100:
http://localhost:8889/SARest/SQL/MySQLServer/Samples/1?fields=Encyclopedia/Definitions/Application[Rank>0+AND+Build Cost>100]
Results
<Encyclopedia name="Samples">
<Definitions>
<Application>
<href>http://localhost:8889/SARest/SQL/MySQLServer/Samples/1/Definitions/Application/7207
</href>
<Name>Act10</Name>
<Identity>23708</Identity>
<WorkspaceId>1</WorkspaceId>
<Type>309</Type>
<SAVersion>7</SAVersion>
<WorkspaceFlags>1</WorkspaceFlags>
<ChangeRequest/>
<prp_Rank>2</prp_Rank>
<prp_Build-spa-Cost>200</prp_Build-spa-Cost>
<prp_Initial-spa-Date>9/17/2014</prp_Initial-spa-Date>
<prp_Last-spa-Change-spa-Date>9/25/2014</prp_Last-spa-Change-spa-Date>
<prp_Initial-spa-Time>8:41 AM</prp_Initial-spa-Time>
<prp_Last-spa-Change-spa-Time>9:09 AM</prp_Last-spa-Change-spa-Time>
<prp_Initial-spa-Audit>kpc</prp_Initial-spa-Audit>
<prp_Last-spa-Change-spa-Audit>kevinc</prp_Last-spa-Change-spa-Audit>
<prp_GUID>c964b830-9e69-4e83-928b-05dab8bc52b8</prp_GUID>
</Application>
</Definitions>
<Workspace Name="Root" ID="1" Baseline="0" Description="" Path="\\Root"/>
</Encyclopedia>
Comments
Valid operators are:
=
Equal
!=
Not equal
<>
Not equal
<
Less than
<=
Less than or equal to
>
Greater than
>=
Greater than or equal to
Parent topic
System Architect REST API