SA XT for web access > System Architect XT > System Architect XT Web Service > System Architect XT Web Service methods
  
System Architect XT Web Service methods
The System Architect XT Web Service feature exposes System Architect components that enable consumer applications to access and publish repository information over an intranet. The Web Service is read-only, and it allows client applications to call server side methods that access encyclopedia data using standard SOAP messages.
StartSession method
Start a System Architect XT Web Service session and checks out the required features from the license.
See StartSession method.
OpenEncyclopedia method
Opens a System Architect Enterprise Encyclopedia where the user is authorized by the System Architect catalog.
See OpenEncyclopedia method.
RunReport method
Runs a System Architect report and returns the report results as XML text.
See RunReport method.
GetXML method
Returns an XML string containing the property names and values for the repository object specified by the passed Identity (ddid).
See GetXML method.
GetMetadata method
Return an XML string containing a description of the properties for the repository object specified by the passed Identity (ddid).
See GetMetadata method.
GetSessions method
Returns an XML string containing an entry for each started session.
See GetSessions method.
EndSession method
Ends the System Architect XT Web Service session. Sessions are given an ID, and all resources used by a session, including the license slot, are free and become available to other users when this method is invoked.
See EndSession method.
GetWorkspaceTree
This method should be used on a workspace enabled encyclopedia. When a session is established on the server, a workspace enabled encyclopedia must be open. The GetWorkspaceTree method requires a SessionId and a SAWSEncy object. GetWorkspaceTree method will return list of workspaces for a workspace enabled encyclopedia.
See GetWorkspaceTree.
SetWorkspaceID
This method should be used for workspace enabled encyclopedia. A session must be established on the server, and a workspace enabled encyclopedia must be open. The SetWorkspaceID method requires a SessionId and WorkspaceID an Integer containing the identity of the desired workspace.
You can find the files that System Architect XT installs for the Web Service feature in the subfolder:
C:\Program Files\UNICOM Systems\System Architect Suite\SAXTWebService
For information on enabling the System Architect XT Web Service, see the System Architect and System Architect XT Installation Guide.
See SetWorkspaceID.
See also
System Architect XT Web Service