SA REST API : System Architect REST API : Return definition instances for the given definition type
  
Return definition instances for the given definition type
Syntax
http://<Machine Name|IP>:<Port>/SARest/SQL/<Server Name>/<Encyclopedia Name>/<Workspace ID>/Definitions/<Type Name>
Parameter values
relationships=true
Causes relationship data to be included:
<Relation Type="is child in" Class="Definition" MinorType="Relationship" DDID="12013" 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/Definitions/Application
Results
<Encyclopedia Name="Samples">
<Definitions>
<Application>
<href>http://localhost:8889/SARest/SQL/MySQLServer/Samples/1/Definitions/Application/4077</href>
<Name>Content Management</Name>
<Identity>4077</Identity>
<WorkspaceId>1</WorkspaceId>
<Type>309</Type>
<SAVersion>9</SAVersion>
<WorkspaceFlags/>
<ChangeRequest/>
<prp_Application-spa-Type>COTS</prp_Application-spa-Type>
<prp_Application-spa-Interface>"Call Center" "Document Imaging System"
<Application Name="Call Center" DDID="4074" MinorType="Application" Class="3" href="http://localhost:8889/SARest/SQL/MySQLServer/Samples/1/Definitions/Application/4074"/>
<Application Name="Document Imaging System" DDID="4083" MinorType="Application" Class="3" href="http://localhost:8889/SARest/SQL/MySQLServer/Samples/1/Definitions/Application/4083"/>
</prp_Application-spa-Interface>
<prp_Effective-spa-Date>1/1/2003</prp_Effective-spa-Date>
<prp_Perpetual-spa-License-spa-Cost>200</prp_Perpetual-spa-License-spa-Cost>
<prp_Build-spa-Cost>1000</prp_Build-spa-Cost>
<prp_Initial-spa-Date>3/11/2009</prp_Initial-spa-Date>
<prp_Last-spa-Change-spa-Date>7/22/2010</prp_Last-spa-Change-spa-Date>
<prp_Initial-spa-Audit>JR</prp_Initial-spa-Audit>
<prp_Last-spa-Change-spa-Audit>IBM</prp_Last-spa-Change-spa-Audit>
<prp_GUID>22328980-b60a-46de-9906-ca985ffe5a25</prp_GUID>
</Application>
</Definitions>
</Encyclopedia>
Comments
None.
Parent topic
System Architect REST API