Silk Performance Manager API Help

Transcription

1 Silk Performance Manager 18.5 API Help

2 Micro Focus The Lawn Old Bath Road Newbury, Berkshire RG14 1QN UK Copyright Micro Focus. All rights reserved. MICRO FOCUS, the Micro Focus logo, and Silk Performance Manager are trademarks or registered trademarks of Micro Focus IP Development Limited or its subsidiaries or affiliated companies in the United States, United Kingdom, and other countries. All other marks are the property of their respective owners

3 Contents Introduction 1 Chapter 1 Setting up Web Services 3 Overview 3 Testing Your Configuration 4 Chapter 2 Web Service Session Handling 5 Creating a Session Via Authentication 5 Session Handling via SOAP 6 Ending a Session 6 Chapter 3 Web Service Overview 7 Overview 7 Web Service "sccsystem" 8 Web Service "sccentities" 8 Web Service "sccadminctrl" 13 Web Service "sventities" 13 Web Service "svdata" 17 Web Service "svmonconfctrl" 20 Chapter 4 Web Service API Documentation 23 Overview 23 Exceptions 23 Web Service "sccsystem" 24 Class description 24 long logonuser(string username, String plainpwd) 24 String encryptpassword(long sessionid, String plainpwd) 25 String converttoreadabletime(long time) 25 long convertfromreadabletime(string time) 25 Silk Performance Manager API Help i

4 AppModule[] getapplicationmodules(long sessionid) 26 Web Service "sccentities" 26 Class description 26 Project[] getprojects(long sessionid) 29 Project[] getprojectsforuser( ) 29 Location[] getlocations(long sessionid) 29 Location[] getlocationsforproject(long sessionid, int projectid) 30 public Project[] getallprojects(long sessionid, String projectname) 30 public Project getprojectbyid(long sessionid, int projectid) 30 public int createproject(long sessionid, Project project) 30 public void updateproject(long sessionid, Project project) 31 public void deleteprojects(long sessionid, int[] projectids) 31 public void activateprojects(long sessionid, int[] projectids) 31 public void deactivateprojects(long sessionid, int[] projectids) 31 public LocationDetails getlocationdetails(long sessionid, int locationid) 32 public int createlocation(long sessionid, LocationDetails locationdetails) 32 public void updatelocation(long sessionid, LocationDetails locationdetails) 32 public void setproxyusernameandpasswordforlocation(long sessionid, int locationid, String proxyusername, String proxypassword) 33 public void deletelocations(long sessionid, int[] locationids) 33 public User[] getusers(long sessionid, String login) 33 public void deleteusers(long sessionid, int[] useridstodelete) 34 public UserDetails getuserdetails(long sessionid, int userid) 34 public int createuser(long sessionid, UserDetails userdetails) 34 public void updateuser(long sessionid, UserDetails userdetails) 34 public int createusergroup(long sessionid, UserGroup usergroup) 35 public UserGroup getgroupbyname(long sessionid, String groupname) 35 public UserGroup getgroupbyid(long sessionid, int groupid) 35 public UserGroup[] getallusergroups(long sessionid) 35 public void updateusergroup(long sessionid, Usergroup usergroup) 36 public void deleteusergroup(long sessionid, int groupid) 36 public UserGroupMembership getmembershipsofgroup(long sessionid, int groupid) 36 public UserGroupMembership getmembershipsofuser(long sessionid, int userid) 36 public UserGroupMembership getallmemberships(long sessionid) 37 public void updatemembershipsofgroup(long sessionid, int groupid, UserGroupMembership[] memberships) 37 public void updatemembershipsofuser(long sessionid, int userid, User- ii Silk Performance Manager API Help

5 GroupMembership[] memberships) 37 public Role[] getallroles(long sessionid) 37 public Role getrolebyid(long sessionid, int roleid) 38 public void setpassword(long sessionid, int userid, String password) 38 public void encryptandsetpassword(long sessionid, int userid, String password) 38 public int createexecserver(long sessionid, ExecServer execserver) 38 public ExecServer getexecserverbyid(long sessionid, int execserverid) 39 public ExecServer[] getexecserversoflocation(long sessionid, int locationid) 39 public void updateexecserver(long sessionid, ExecServer execserver) 39 public void activateexecserver(long sessionid, int execserverid, int locationid) 40 public void deactivateexecserver(long sessionid, int execserverid) 40 public String[] getallresourcetags(long sessionid, int locationid, int execserverid) 40 public void addresourcetag(long sessionid, int locationid, int execserver- Id, String resourcetag) 40 public void removeresourcetag(long sessionid, int locationid, int exec- ServerId, String resourcetag) 41 public EssentialDescription[] getallessentials(long sessionid) 41 public EssentialGroup[] getessentialgroups(long sessionid) 41 public EssentialSubGroup[] getessentialsubgroups(long sessionid, int essentialgroupid) 42 public EssentialDescription[] getessentials(long sessionid, int parentid) 42 public FilePoolEntry[] getfilepoolentries(long sessionid, int projectid) 42 public boolean addlocationtoproject(long sessionid, int projectid, int locationid) 42 public boolean removelocationfromproject(long sessionid, int projectid, int locationid) 43 boolean ismixedmodeauthentication(long sessionid, int userid) 43 void setmixedmodeauthentication(long sessionid, int userid, boolean usemixedmode) 43 Web Service "sccadminctrl" 44 void setprojectstate(long sessionid, int projectid, boolean active) 44 Web Service "sventities" 44 Class description 44 Monitor[] getmonitors(long sessionid, int projectid) 48 Server[] getserversforproject(long sessionid, int projectid) 48 Transaction[] gettransactionsforproject( ) 48 Silk Performance Manager API Help iii

6 Transaction[] gettransactionsformonitor( ) 49 boolean TransactionIsReal(long sessionid, int transactionid) 49 Location[] getresultlocations(long sessionid, int userid) 49 ClientSideExecutionSet[] getclientsideexecutionsets( ) 50 ServerSideExecutionSet[] getserversideexecutionsets( ) 50 Measure[] getmeasures(long sessionid, int execsetid) 50 String[] getmeasurenamesforproject(long sessionid, int projectid) 50 ExecutionLogEntry[] getexecutionlog( ) 51 public Condition[] getconditions(long sessionid, int projectid) 52 public Condition getcondition(long sessionid, int conditionid) 53 public int createcondition(long sessionid, String name, int projectid, int transactionid, String measurement, String operator, double thresholdvalue, String measuretype, short locationrestriction) 53 public boolean updatecondition(long sessionid, Condition condition) 54 public boolean deletecondition(long sessionid, int conditionid) 54 public Rule[] getrules(long sessionid, int projectid) 54 public Rule getrule(long sessionid, int ruleid) 54 public int createrule(long sessionid, String name, int projectid, String actiontype, boolean active, short recurthreshold, long recur- Timespan, String severity, int conditionid) 55 public int createdefaultrule(long sessionid, int monitorid, String[] measures) 55 public int addruleexpressionpart(long sessionid, int ruleid, String operator, int conditionid) 56 public RuleExpressionPart[] getruleexpressionparts(long sessionid, int ruleid) 56 public boolean deleteruleexpressionpart(long sessionid, int ruleid, int position) 56 public boolean updateruleexpressionpart(long sessionid, int ruleid, int position, int conditionid, String operator) 57 public boolean moveruleexpressionpart(long sessionid, int ruleid, int position, int destination) 57 public boolean updaterule(long sessionid, int id, String name, boolean active, short recurthreshold, long recurtimespan, String severity) 58 public boolean deleterule(long sessionid, int ruleid) 58 public RuleIncident[] getruleincidents(long sessionid, int projectid) 58 public RuleIncident[] getruleincidents(long sessionid, int projectid, long starttimeutc, long endtimeutc) 59 public CustomIncident[] getcustomincidents(long sessionid, int projectid) 59 public CustomIncident[] getcustomincidents(long sessionid, int projectid, long starttimeutc, long endtimeutc) 59 iv Silk Performance Manager API Help

7 public CustomIncident getcustomincident(long sessionid, int customincidentid) 60 public int createcustomincident(long sessionid, String name, String description, int projectid, boolean invalidateinreports, String severity, long beginsat, long endsat) 60 public boolean updatecustomincident(long sessionid, CustomIncident customincident) 61 public boolean deletecustomincident(long sessionid, int customincidentid) 61 public String getpageurl(long sessionid, int projectid, long begintime, long endtime, int[] transactions, int[] locations, String report, String[] params) 61 public String getpageurl(long sessionid, int projectid,string report, String[] params) 67 public int createrulewithessentialaction(long sessionid, String name, int projectid, String essential, boolean active, short recurthreshold, long recurtimespan, String severity, int conditionid) 68 public EssentialDescription[] getactionessentials(long sessionid, int projectid) 69 public ActionSetting[] getactionsettings(long sessionid, int ruleid) 69 public ActionSettingSpec getactionsettingspec(long sessionid, int ruleid, String setting) 69 public String[] getactiontypeids() 69 public int[] getalertinglocations(long sessionid, int projectid) 70 public String[] getprofiles(long sessionid, int projectid, String essential- Name) 70 public void updateactionsettings(long sessionid, int ruleid, String action- Type, ActionSetting[] settings) 70 public void updateessentialactionsettings(long sessionid, int ruleid, String essential, ActionSetting[] settings) 71 Web Service "svdata" 71 Class description 71 DataPoint[] getclientmeasuredata( ) 72 DataPoint[] getclientmeasuredataacrossprojects( ) 73 DataPoint[] getservermeasuredata( ) 74 DataPoint[] getservermeasuredataacrossprojects( ) 75 DataPoint[] getmeasuredata( ) 76 DataPoint[] getlastclientdata( ) 77 DataPoint[] getlastserverdata( ) 78 DataPoint[] getlastdata( ) 78 DataPoint mergeseries(datapoint[] series) 79 Web Service "svmonconfctrl" 79 Class description 79 Silk Performance Manager API Help v

8 String runmonitorsinproject( ) 81 String setmonitorstate( ) 81 String runmonitor(long sessionid, int monitorid) 82 Schedule getprojectschedule( ) 82 Schedule getmonitorschedule(long sessionid, int monitorid) 82 String redefineschedule(long sessionid, Schedule schedule) 83 String adddefiniterun(long sessionid, int scheduleid, DefiniteRun definiterun) 83 RunExclusion[] getscheduleexclusions( ) 83 String addscheduleexclusion( ) 84 String removescheduleexclusion( ) 84 public void makeschedulelocal(long sessionid, int monitorid) 84 public void removeschedule(long sessionid, int monitorid) 85 public void setlocationsofschedule(long sessionid, int scheduleid, int[] locationids) 85 public int[] getlocationsofschedule(long sessionid, int scheduleid) 85 public int createmonitor(long sessionid, int projectid, String essential- Name, String name, boolean activate) 86 public int createmonitor(long sessionid, int projectid, String essential- Name, String name, String testscriptname, boolean activate) 86 public int createmonitor(long sessionid, int projectid, String essential- Name, String name, String testscriptname, String usergroup- Name, boolean activate) 87 public MonitorSettingSpec getmonitorsettingspec(long sessionid, int monitorid, String settingname) 87 public MonitorSetting[] getmonitorsettings(long sessionid, int monitorid) 88 public void updatemonitorsettings(long sessionid, int monitorid, MonitorSetting[] monitorsettings) 88 public void deletemonitor(long sessionid, int monitorid) 88 public String[] gettestscripts(long sessionid, int projectid, String essentialname) 89 public String[] getusergroupnames(long sessionid, int projectid, String essentialname, String scriptname) 89 Chapter 5 Accessing Web Services via Java 91 Introduction 91 Generating Stub Classes 92 Instantiating Stub Classes and Invoking Methods 93 Sample Transaction 93 Index 95 vi Silk Performance Manager API Help

9 Introduction About this manual In addition to offering access via HTML Web pages, Silk Performance Manager provides an additional option for querying data and applying configuration changes: Web services. Web services are available through SOAP calls (standardized XML messages) that are sent and received via a frontend server using the HTTP protocol, allowing SOAP-enabled clients to get fast, direct access to Performance Manager data and configuration settings. Silk Performance Manager API Help 1

10 INTRODUCTION 2 Silk Performance Manager API Help

11 1 Setting 1Chapter up Web Services Introduction What you will learn This chapter explains how to set up Web Services. This chapter contains the following sections: Section Page Overview 3 Testing Your Configuration 4 Overview Web Services don t require setup; they are enabled by default on each frontend server. For example, if is the URL that you use to access Silk Performance Manager, then is the base URL you use to access available Web Services. When you access the base URL using your browser, you are presented with a simple HTML list of all available Web Services. This list is provided by Apache Axis the SOAP stack that Silk Performance Manager uses ( ws.apache.org/axis/). This basic Web page provides links to WSDL (Web Service Description Language) standardized XML files, where each file describes the interface of a single Web Service. These files are not human readable. For this reason, SOAP-enabled clients (e.g., Silk Performer Java Explorer) read WSDL files and thereby retrieve information required for invoking methods on corresponding Web Services. Silk Performance Manager API Help 3

12 1 SETTING UP WEB SERVICES Testing Your Configuration Testing Your Configuration In general, SOAP clients use HTTP POST requests for method invocation of Web Services. However when method calls are not overly complex, you can also use GET requests for invocation. You can test your Performance Manager Web Service configuration directly from your Web browser (browsers generally use HTTP GET requests). The simple list of Web Services mentioned in the Overview section contains the service "Version" (an Axis service), which provides a single method "getversion()". You can invoke this method directly from your browser using the following URL format: The response you receive consists of an XML file (also not human readable) that contains the return value of the method an Axis version information string similar to: Apache Axis version: 1.1 Built on Jun 13, 2003 (09:19:43 EDT) Directly from your browser, you can also call Web Service methods that take parameters. If your installation starts and is properly connected to a database, you can login to Silk Performance Manager through a Web Service call. If you haven't changed the default login credentials of your Performance Manager installation, you can use the username "admin" and the password "admin". Use method "logonuser" of Web Service "sccsystem": sccsystem?method=logonuser&username=admin&plainpwd=admin When the login credentials you supply are correct, the response contains a session identifier that can be used in subsequent calls. The response should contain a line that resembles the following: <logonuserreturn xsi:type="xsd:long"> </ logonuserreturn> 4 Silk Performance Manager API Help

13 2 Web 2Chapter Service Session Handling What you will learn This chapter contains the following sections: Section Page Creating a Session Via Authentication 5 Session Handling via SOAP 6 Ending a Session 6 Creating a Session Via Authentication Silk Performance Manager data is protected against unauthorized access. Login credentials must be provided before data access is granted. This is true not only when working with the HTML front-end, but also for communication with Performance Manager via SOAP calls. The first step in querying data, or applying configuration changes for Performance Manager, is authentication. When authentication is successful, a user session is created that allows execution of subsequent operations in the context of that user login. When accessing Performance Manager via a Web browser, session information is not visible to the user; the browser (using cookies) handles session information. In contrast to using Performance Manager via HTML, SOAP calls must handle information manually. Silk Performance Manager API Help 5

14 2 WEB SERVICE SESSION HANDLING Session Handling via SOAP Session Handling via SOAP Authentication via Web Services is done through the SOAP call "logonuser()" of Web Service "sccsystem" (In the Testing Your Configuration section you'll find a sample that shows you how to invoke this method directly from your browser). The method call returns a session identifier that references the session created on the server and at the same time is used as a key to access Performance Manager in the context of that session. Each subsequent SOAP call that requires a session for execution takes such an identifier as one of its parameters, checks its validity, and executes in the context of the corresponding session. The following (Java) code sample shows simple access to Performance Manager via Web Services and demonstrates use of the session identifier: long sessionid = sccsystem.logonuser("admin", "admin"); Project[] projects = sccentities.getprojects(sessionid); Ending a Session A Performance Manager session created via Web Services cannot be ended explicitly. Instead, sessions end automatically when they're not used for a period of time. As soon as a session times out on a server, subsequent SOAP calls attempting to use the session throw exceptions. 6 Silk Performance Manager API Help

15 3 Web 3Chapter Service Overview What you will learn This chapter contains the following sections: Section Page Overview 7 Web Service "sccsystem" 8 Web Service "sccentities" 8 Web Service "sccadminctrl" 13 Web Service "sventities" 13 Web Service "svdata" 17 Web Service "svmonconfctrl" 20 Overview Available functionality is provided by the following Web Services: sccsystem sccentities sccadminctrl sventities svdata svmonconfctrl Silk Performance Manager API Help 7

16 3 WEB SERVICE OVERVIEW Web Service "sccsystem" This chapter offers a brief description of each of these services, lists the location of the corresponding WSDL documents, and gives a short description of the methods that are available with each service. For more detailed descriptions, see Chapter 5. The descriptions use pseudo-code syntax (closely related to Java syntax). Web Service "sccsystem" This is the root service. It provides an authentication method and simple utility methods. The service's WSDL file is available at /services/sccsystem?wsdl. long logonuser(string username, String plainpwd) Logs on with given username and password. String encryptpassword(long sessionid, String plainpwd) Takes a clear text password and returns the encrypted version. String converttoreadabletime(long time) Converts the given time (number of milliseconds since midnight, January 1, 1970 UTC) into a human readable string representation. long convertfromreadabletime(string time) Converts the given date/time to the number of milliseconds since midnight, January 1, 1970 UTC. AppModule[] getapplicationmodules(long sessionid) Retrieves the list of installed application modules (Performance Manager, etc.). Web Service "sccentities" This service provides read access to the two main entities that exist on the SCA level Project and Location. The service's WSDL file is available at /services/sccentities?wsdl. Project[] getprojects(long sessionid) Retrieves all defined projects. Project[] getprojectsforuser( long sessionid, int userid, int appmoduleid) 8 Silk Performance Manager API Help

17 3 WEB SERVICE OVERVIEW Web Service "sccentities" Retrieves all defined projects that meet the specified filter criteria. Location[] getlocations(long sessionid) Retrieves all defined locations. Location[] getlocationsforproject( long sessionid, int projectid) Retrieves all locations associated with the given project. void activateexecserver(long sessionid, int execserverid, int locationid) Activates an existing execution server if it is not already active. void activateprojects(long sessionid, int[] projectids) Activates the projects with the given Ids. boolean addlocationtoproject(long sessionid, int projectid, int locationid) Adds an association from a location to a project. void addresourcetag(long sessionid, int locationid, int execserverid, String resourcetag) Adds resource tags to an execution server. int createexecserver(long sessionid, ExecServer execserver) Creates a new executionsever for the given properties. int createlocation(long sessionid, LocationDetails locationdetails) Creates a new location with the data provided by the location details. int createproject(long sessionid, Project project) Creates a new Project with the given properties. int createuser(long sessionid, UserDetails userdetails) Creates a new user with the data of the given userdetails - the given sessionid is ignored and the login has to be unique. void deactivateexecserver(long sessionid, int execserverid) Deactivates an existing execution server if it is active. Silk Performance Manager API Help 9

18 3 WEB SERVICE OVERVIEW Web Service "sccentities" void deactivateprojects(long sessionid, int[] projectids) Deactivates the projects with the given IDs. void deletelocations(long sessionid, int[] locationids) Deletes the location identified by the locationid (only if no execution servers exist for the location). void deleteprojects(long sessionid, int[] projectids) Deletes projects with the given Ids (if the logged in user has the right to). void deleteusers(long sessionid, int[] useridstodelete) Deletes existing users (identified by the IDs). void encryptandsetpassword(long sessionid, int userid, String password) Sets the password for the user (the password is encrypted on the server and therefore is transmitted in plain text). EssentialDescription[] getallessentials(long sessionid) Queries all Essentials. Project[] getallprojects(long sessionid, String projectname) Retrieves all projects assigned to the logged in User (or all Projects if the user is an administrator) with the given name (wildcards * and?). String[] getallresourcetags(long sessionid, int locationid, int execserverid) Retrieves all resource tags of a location. EssentialGroup[] getessentialgroups(long sessionid) Queries all Essential Groups. EssentialDescription[] getessentials(long sessionid, int parentid) Queries all essentials which are children of the given subgroup. EssentialSubGroup[] getessentialsubgroups(long sessionid, int essentialgroupid) Queries all Essential Sub Groups. 10 Silk Performance Manager API Help

19 3 WEB SERVICE OVERVIEW Web Service "sccentities" ExecServer getexecserverbyid(long sessionid, int execserverid) Retrieves the Execution Server identified by the given ID. ExecServer[] getexecserversoflocation(long sessionid, int locationid) Retrieves the execution servers of a location. FilePoolEntry[] getfilepoolentries(long sessionid, int projectid) Retrieves information about the file pool entries. LocationDetails getlocationdetails(long sessionid, int locationid) Retrieves detailed information about the Location identified by the ID. Project getprojectbyid(long sessionid, int projectid) Retrieves the project with the given ID. UserDetails getuserdetails(long sessionid, int userid) Retrieves details of a user (identified by ID). User[] getusers(long sessionid, String login) Retrieves all users matching the given login name. boolean removelocationfromproject(long sessionid, int projectid, int locationid) Removes an association from a location to a project. void removeresourcetag(long sessionid, int locationid, int execserverid, String resourcetag) Removes resource tags from an execution server. void setpassword(long sessionid, int userid, String password) Sets the password for the user - the password has to be encrypted on the client (this call is for internal use only). void setproxyusernameandpasswordforlocation(long sessionid, int locationid, String proxyusername, String proxypassword) Sets proxy username and password for a location (identified by the locationid). void updateexecserver(long sessionid, ExecServer execserver) Silk Performance Manager API Help 11

20 3 WEB SERVICE OVERVIEW Web Service "sccentities" Updates the properties of an existing execution server. void updatelocation(long sessionid, LocationDetails locationdetails) Updates an existing location (identified by the ID) with the data provided by the location details. void updateproject(long sessionid, Project project) Updates an existing Project with the given properties. void updateuser(long sessionid, UserDetails userdetails) Updates the properties of an existing user. public int createusergroup(long sessionid, UserGroup usergroup) Creates a new Usergroup. public UserGroup getgroupbyname(long sessionid, String groupname) Retrieve user group by name. public UserGroup getgroupbyid(long sessionid, int groupid) Retrieves user group by ID. public UserGroup[] getallusergroups(long sessionid) Retrieves all user groups. public void updateusergroup(long sessionid, Usergroup usergroup) Updates an existing user group. public void deleteusergroup(long sessionid, int groupid) Deletes the user group identified by ID. public UserGroupMembership getmembershipsofgroup(long sessionid, int groupid) Retrieves all memberships of the user group identified by ID. public UserGroupMembership getmembershipsofuser(long sessionid, int userid) Retrieves all memberships of the user group identified by ID. public UserGroupMembership getallmemberships(long sessionid) Retrieves all memberships. public void updatemembershipsofgroup(long sessionid, int groupid, UserGroupMembership[] memberships) Updates the memberships of a group. All UserGroupMemberships have to be of the same group. public void updatemembershipsofuser(long sessionid, int userid, UserGroupMembership[] memberships) Updates the memberships of a user. All UserGroupMemberships have to be of the same user. 12 Silk Performance Manager API Help

21 3 WEB SERVICE OVERVIEW Web Service "sventities" public Role[] getallroles(long sessionid) Retrieves all Roles. public Role getrolebyid(long sessionid, int roleid) Retrieves a Role identified by ID. boolean ismixedmodeauthentication(long sessionid, int userid) Retrieves the information whether mixed mode authentication is active for a user. void setmixedmodeauthentication(long sessionid, int userid, boolean usemixedmode) Sets the authentication mode for a user. Web Service "sccadminctrl" This service provides methods for configuring entities on the SCA level. The service's WSDL file is available at /services/sccadminctrl?wsdl. void setprojectstate(long sessionid, int projectid, boolean active) Activates or deactivates the given project. Web Service "sventities" This service provides read access to several Silk Performance Manager Performance Manager entities. The service's WSDL file is available at /services/sventities?wsdl. Monitor[] getmonitors(long sessionid, int projectid) Retrieves all monitors for a given project. String getpageurl(long sessionid, int projectid, long begintime, long endtime, int[] transactions, int[] locations, String report, String[] params) a URL (except host:port) which can be used as bookmark. String getpageurl(long sessionid, int projectid, String report, String[] params) a URL (except host:port) which can be used as bookmark. Server[] getserversforproject(long sessionid, int projectid) Silk Performance Manager API Help 13

22 3 WEB SERVICE OVERVIEW Web Service "sventities" Retrieves all infrastructure servers where monitoring data exists for a given project. Transaction[] gettransactionsforproject(long sessionid, int projectid) Retrieves all transactions for a given project. Transaction[] gettransactionsformonitor(long sessionid, int monitorid) Retrieves all transactions for a given monitor. boolean moveruleexpressionpart(long sessionid, int ruleid, int position, int destination) Move rule expression part up or down. boolean updatecondition(long sessionid, Condition condition) Updates a condition with the given values. boolean updatecustomincident(long sessionid, CustomIncident customincident) Updates a custom incident with the given values. boolean updaterule(long sessionid, int id, java.lang.string name, boolean active, short recurthreshold, long recurtimespan, java.lang.string severity) Updates a rule with the given values. boolean updateruleexpressionpart(long sessionid, int ruleid, int position, int conditionid, String operator) Update values of rule expresson part. Location[] getresultlocations(long sessionid, int userid) Retrieves all locations where monitoring data exist for a given user. Rule getrule(long sessionid, int ruleid) Query rule with given ID. RuleExpressionPart[] getruleexpressionparts(long sessionid, int ruleid) all rule expression parts for rule. RuleIncident[] getruleincidents(long sessionid, int projectid) Query all incidents for the given project. 14 Silk Performance Manager API Help

23 3 WEB SERVICE OVERVIEW Web Service "sventities" RuleIncident[] getruleincidents(long sessionid, int projectid, long starttimeutc, long endtimeutc) Query all rule incidents for the given project within given timespan. Rule[] getrules(long sessionid, int projectid) Query all rules for given project. int addruleexpressionpart(long sessionid, int ruleid, String operator, int conditionid) Adds a rule expression part to rule with ruleid as last expression part. int createcondition(long sessionid, String name, int projectid, int transactionid, String measurement, String operator, double thresholdvalue, String measuretype, short locationrestriction) Create a condition from the given parameters. int createcustomincident(long sessionid, String name, String description, int projectid, boolean invalidateinreports, String severity, long beginsat, long endsat) Create a custom incident from the given parameters. int createdefaultrule(long sessionid, int monitorid, String[] measures) Create a default rule for a monitor from the given default conditions. int createrule(long sessionid, String name, int projectid, String actiontype, boolean active, short recurthreshold, long recurtimespan, String severity, int conditionid) Create a rule from the given parameters. int createrulewithessentialaction(long sessionid, java.lang.string name, int projectid, java.lang.string essential, boolean active, short recurthreshold, long recurtimespan, java.lang.string severity, int conditionid) Create a rule from the given parameters. EssentialDescription[] getactionessentials(long sessionid, int projectid) Get all action essentials. Silk Performance Manager API Help 15

24 3 WEB SERVICE OVERVIEW Web Service "sventities" ActionSetting[] getactionsettings(long sessionid, int ruleid) Get action settings for rule. ActionSettingSpec getactionsettingspec(long sessionid, int ruleid, String setting) Get detailed information about an action setting. String[] getactiontypeids() Get action type ids. int[] getalertinglocations(long sessionid, int projectid) Get locations which have an alerting execution server. String[] getprofiles(long sessionid, int projectid, String essentialname) Get the profiles available for this essential. void updateactionsettings(long sessionid, int ruleid, String actiontype, ActionSetting[] settings) Update action settings for a non essential action. void updateessentialactionsettings(long sessionid, int ruleid, String essential, ActionSetting[] settings) Update action settings for a essential action. boolean deletecondition(long sessionid, int conditionid) Deletes a condition specified by the given ID. boolean deletecustomincident(long sessionid, int customincidentid) Deletes a custom incident specified by the given ID. boolean deleterule(long sessionid, int ruleid) Deletes a condition specified by the given ID. boolean deleteruleexpressionpart(long sessionid, int ruleid, int position) Deletes rule expression part with the given position. ClientSideExecutionSet[] getclientsideexecutionsets(long sessionid, int transactionid) Retrieves all execution sets of client side monitoring transactions. Condition getcondition(long sessionid, int conditionid) Query condition with given ID. 16 Silk Performance Manager API Help

25 3 WEB SERVICE OVERVIEW Web Service "svdata" Condition[] getconditions(long sessionid, int projectid) Query all conditions for given project. CustomIncident getcustomincident(long sessionid, int customincidentid) Query custom incident with given ID. CustomIncident[] getcustomincidents(long sessionid, int projectid) Query all custom incidents for the given project. CustomIncident[] getcustomincidents(long sessionid, int projectid, long starttimeutc, long endtimeutc) Query all custom incidents for the given project within given timespan. ServerSideExecutionSet[] getserversideexecutionsets(long sessionid, int transactionid) Retrieves all execution sets of server side monitoring transactions. Measure[] getmeasures(long sessionid, int execsetid) Retrieves all measures for a given execution set. String[] getmeasurenamesforproject(long sessionid, int projectid) Retrieves all measure names available for a given project. ExecutionLogEntry[] getexecutionlog( long sessionid, int projectid, long from, long to, byte sortcol, boolean isascending, byte[] filtercolumns, int[] filterids, int maxlistsize, int actualpage) Queries execution log entries that meet the specified filter criteria. Web Service "svdata" This service provides functionality for querying monitor data. Silk Performance Manager API Help 17

26 3 WEB SERVICE OVERVIEW Web Service "svdata" The service's WSDL file is available at /services/svdata?wsdl. DataPoint[] getclientmeasuredata( long sessionid, String measurename, int projectid, int[] transactionids, int[] locationids, String starttime, String endtime, int mergespan) Queries monitoring data of client side monitoring transactions from the database. DataPoint[] getclientmeasuredataacrossprojects( long sessionid, String measurename, int projectid, int[] transactionids, int[] locationids, String starttime, String endtime, int mergespan) Queries monitoring data of client side monitoring transactions across multiple projects from the database. DataPoint[] getservermeasuredata( long sessionid, String measurename, int projectid, int[] transactionids, int[] serverids, String starttime, String endtime, int mergespan) Queries monitoring data of server side monitoring transactions from the database. DataPoint[] getservermeasuredataacrossprojects( long sessionid, String measurename, int projectid, int[] transactionids, int[] serverids, String starttime, String endtime, int mergespan) 18 Silk Performance Manager API Help

27 3 WEB SERVICE OVERVIEW Web Service "svdata" Queries monitoring data of server side monitoring transactions across multiple projects from the database. DataPoint[] getmeasuredata( long sessionid, String measurename, int projectid, String starttime, String endtime, int mergespan) Queries monitoring data from the database. Both, client and server side monitoring data is included. DataPoint getlastclientdata( long sessionid, String measurename, int projectid, int[] transactionids, int[] locationids) Queries the most recent monitoring data of client side monitoring transactions from the database. DataPoint getlastserverdata( long sessionid, String measurename, int projectid, int[] transactionids, int[] serverids) Queries the most recent monitoring data of server side monitoring transactions from the database. DataPoint getlastdata( long sessionid, String measurename, int projectid, int[] transactionids) Queries the most recent monitoring data from the database (including client and server side transactions). DataPoint mergeseries(datapoint[] series) Merges a specified series to a single DataPoint. Silk Performance Manager API Help 19

28 3 WEB SERVICE OVERVIEW Web Service "svmonconfctrl" Web Service "svmonconfctrl" This service enables the caller to query and apply changes to the active configuration. The service's WSDL file is available at /services/svmonconfctrl?wsdl. String runmonitorsinproject( long sessionid, int projectid, boolean onlyactive) Initiates a "Run-Once" of the monitors belonging to a given project. String setmonitorstate( long sessionid, int monitorid, boolean active) Activates or deactivates a given monitor. String runmonitor( long sessionid, int monitorid) Runs a single monitor. ScheduleSettings getprojectschedule( long sessionid, int projectid, boolean serverside) Retrieves the settings of the client or server side project schedule. ScheduleSettings getmonitorschedule( long sessionid, int monitorid) Retrieves the settings of a monitor's schedule. MonitorSetting[] getmonitorsettings(long sessionid, int monitorid) Get the settings of the monitor (such as browser type, name, etc.) MonitorSettingSpec getmonitorsettingspec(long sessionid, int monitorid, String settingname) Retrieves detailed information about a monitor setting (name, description, data type, etc.) 20 Silk Performance Manager API Help

29 3 WEB SERVICE OVERVIEW Web Service "svmonconfctrl" void updatemonitorsettings(long sessionid, int monitorid, MonitorSetting[] monitorsettings) Updates settings of the monitor (such as browser type, name, etc). String redefineschedule( long sessionid, ScheduleSettings schedule) Redefines the settings of a schedule specified by the ID of a given schedule. void removeschedule(long sessionid, int monitorid) If the monitor has a monitor schedule this schedule is removed and the project schedule is set instead. void setlocationsofschedule(long sessionid, int scheduleid, int[] locationids) Sets the locations of a schedule. RunExclusion[] getscheduleexclusions( long sessionid, int scheduleid) Retrieves all exclusions of a specified schedule. String addscheduleexclusion( long sessionid, int scheduleid, RunExclusion exclusion) Adds an exclusion to a specified schedule. String removescheduleexclusion( long sessionid, int scheduleid, int exclusionid) Removes an exclusion from a specified schedule. String[] gettestscripts(long sessionid, int projectid, String essentialname) Retrieves the names of the available test scripts for a given Essential / file pool entry. String[] getusergroupnames(long sessionid, int projectid, String essentialname, String scriptname) Retrieves the available usergroups for the Essential / file pool entry and test script. void makeschedulelocal(long sessionid, int monitorid) Silk Performance Manager API Help 21

30 3 WEB SERVICE OVERVIEW Web Service "svmonconfctrl" If the monitor does not have a monitor schedule the project schedule is duplicated and set as monitor schedule. int createmonitor( long sessionid, int projectid, String essentialname, String name, boolean activate) Creates a new monitor. int createmonitor(long sessionid, int projectid, String essentialname, String name, String testscriptname, boolean activate) Creates a new monitor with the given test script. int createmonitor(long sessionid, int projectid, String essentialname, String name, String testscriptname, String usergroupname, boolean activate) Creates a new monitor with the given test script and usergroup. void deletemonitor(long sessionid, int monitorid) Deletes the monitor with the given ID int[] getlocationsofschedule(long sessionid, int scheduleid) Retrieves the IDs of the locations of a schedule. 22 Silk Performance Manager API Help

31 4 Web 4Chapter Service API Documentation What you will learn This chapter contains the following sections: Section Page Overview 23 Web Service "sccsystem" 24 Web Service "sccentities" 26 Web Service "sccadminctrl" 44 Web Service "sventities" 44 Web Service "svdata" 71 Web Service "svmonconfctrl" 79 Overview This Application Programming Interface (API) description provides detailed information about the methods of each of the services, the methods' parameters, the return values, and the classes that are used as parameters and return values. Exceptions For the web services the following exception types are used. InvalidIdException Silk Performance Manager API Help 23

32 Web Service "sccsystem" Invalid session id. LoginException Current user does not have enough rights to perform operation. MissingValueException A required value is not set. NotExistingValueException Id does not exist, e.g. project id is unknown. ExistingKeyException A given value which should be unique is not unique, e.g. a name for a new condition. InvalidStateException Manipulated object is in invalid state for current operation, e.g. object is activated, but must be inactive for manipulation. InternalException Internal error on server, e.g. database error. Web Service "sccsystem" Class description Class AppModule int ID The application module's unique identifier (among all application modules) String name The name of the application module String description The description of the application module long logonuser(string username, String plainpwd) Logs on with a given username and password. The returned session identifier can be used in subsequent calls. It acts as a unique key. The session created with the method expires when it is not used for a period of time. Parameters String username The login username String plainpwd The password of the specified username 24 Silk Performance Manager API Help

33 Web Service "sccsystem" A unique identifier (used as a key) that identifies the session created with the method. String encryptpassword(long sessionid, String plainpwd) Takes a clear text password and returns the encrypted version. Parameters long sessionid The unique ID of the actual session String plainpwd The password of the specified username Throws Encrypted password of the specified clear text password. java.rmi.remoteexception String converttoreadabletime(long time) Converts a given time (number of milliseconds since midnight, January 1, 1970 UTC) to a human-readable string representation. The returned format is "YYYY-MM-DD HH:MM:SS.MMM". Parameters long time The time to convert (specified in milliseconds since midnight, January 1, 1970 UTC) Human-readable string representation of the given time (based on UTC). long convertfromreadabletime(string time) Converts a given date/time to the number of milliseconds since midnight, January 1, 1970 UTC. Parameters String time Date/time to be converted (based on UTC) using the format "YYYY-MM-DD HH:MM:SS.MMM". Number of milliseconds since midnight, January 1, 1970 UTC. Silk Performance Manager API Help 25

34 Web Service "sccentities" AppModule[] getapplicationmodules(long sessionid) Retrieves the list of application modules installed (Performance Manager, etc.). Parameters long sessionid The unique ID of the actual session An array of all installed application modules. Web Service "sccentities" Class description Class Project int ID The project's unique identifier (among all projects) String name The name of the project String description The project description boolean active Indicates an active/inactive project int[] appmoduleids The application module Ids (allowed values are: 1 ) Class Location int ID The location's unique identifier (among all locations) String name The name of the location boolean isactive Indicates if at least one active Execution Server exists for the location Class LocationDetails String proxyhostname Hostname of the proxy server int proxyport Port of the proxy server int proxytype Type of proxy server 0..no proxy 1..type http 2..type socks boolean usecentralproxyindicates whether the central proxy shall be used or not 26 Silk Performance Manager API Help

35 Web Service "sccentities" boolean isreal Deprecated. Should always be false. Used to indicate that this location is a real location, created by third party tool. Class ExecServer boolean active Indicates whether this execution server is activated or not int appmoduleid Application server module ID (1 for Performance Manager) String execserverhostname Hostname of this execution server int locationid ID of the location the execution server is assigned to int maxbandwidth Maximum bandwidth int maxconcurrentexecutions Maximum of concurrent executions on this execution server int problemalerttimeout Responsiveness timeout [s] int rmiproxyport Java RMI port of this execution server int rmiproxyportssljava RMI port of this execution server for ssl int state Current state of this execution server; allowed states: 0..inactive 1..active 2..failure boolean usessl Indicates whether SSL is used for connecting this execution server or not Class User int id Unique ID of this user String description Description String name Last name String firstname First name boolean islocked Indicates whether the user is locked or not Silk Performance Manager API Help 27

36 Web Service "sccentities" Class UserDetails (extends User) String login Login name String dateformat Date format (for example "EEE, MMM dd, yyyy - h:mm:ss a") String address for notifications int firstdayofweekfirst day of week (1..Sunday, 2..Monday,.., 7..Saturday) int pagerefreshtimedelay between automatical page refreshes int roleid Role ID of the user allowed values: 0..system administrator 1..domain administrator 2..project manager 3..analyst -2..interim user String separatorstring The prefered separator string of the user (for example "," or ";") String shortdateformatshort date format (for example "M/d/ yyyy, h:mm a") String timezoneid TimeZone ID (continent + "/" + city) int[] assignedprojectsthe ids of the projects assigned to the user Class UserGroup int Id ID of the user group String name Name of the user group boolean islocked Indicates whether the user group is locked or not String description Group description long createdat Timestamp of group creation String createdby Name of the user who created the group int[] projectassignmentsids of the projects assigned to this group Class UserGroupMembershi p int Id User ID int groupid Group ID 28 Silk Performance Manager API Help

37 Web Service "sccentities" int roleid ID of the role assigned to the user for the given user group String groupname Group name String rolename Role name Class Role int Id ID of the role String name Name of the role Project[] getprojects(long sessionid) Retrieves all defined projects. Parameters long sessionid The unique ID of the actual session An array of all found projects. Project[] getprojectsforuser( ) Retrieves all projects defined that meet the specified filter criteria. Parameters long sessionid The unique ID of the actual session int userid The unique identifier of the user whose projects should be returned, or -1 if the projects of the currently logged-in user should be returned. int appmoduleid The unique identifier of the application module to return projects for or -1 if projects for all modules should be returned. An array of all projects found. Location[] getlocations(long sessionid) Retrieves all defined locations. Parameters long sessionid The unique ID of the actual session An array of all found locations. Silk Performance Manager API Help 29

38 Web Service "sccentities" Location[] getlocationsforproject(long sessionid, int projectid) Retrieves all locations associated with the given project. Parameters long sessionid The unique ID of the actual session int projectid The identifier of the project that will be searched for locations An array of all locations associated with the given project. public Project[] getallprojects(long sessionid, String projectname) Retrieves all projects assigned to the logged in User (or all Projects if the user is an administrator) with the given name (wildcards * and? allowed). Parameters long sessionid The unique ID of that session created with logonuser() String projectname Name of the project to return (wildcards? and * are allowed) An array of all projects found. public Project getprojectbyid(long sessionid, int projectid) Retrieves the project with the given ID. Parameters long sessionid The unique ID of that session created with logonuser() int projectid ID of the project to return The project with the given ID if it exists and the logged in user has the right to retrieve it. public int createproject(long sessionid, Project project) Creates a new Project with the given properties. 30 Silk Performance Manager API Help

39 Web Service "sccentities" Parameters long sessionid The unique ID of that session created with logonuser() Project project Attributes of the new project to be created The ID of the created project. public void updateproject(long sessionid, Project project) Updates an existing Project with the given properties. Parameters long sessionid The unique ID of that session created with logonuser() Project project Attributes of the project to be changed public void deleteprojects(long sessionid, int[] projectids) Deletes projects with the given Ids (if the logged in user has the right to). Parameters long sessionid The unique ID of that session created with logonuser() int[] projectids ProjectIds to delete public void activateprojects(long sessionid, int[] projectids) Activates the projects with the given Ids. Parameters long sessionid The unique ID of that session created with logonuser() int[] projectids IDs of the projects to activate public void deactivateprojects(long sessionid, int[] projectids) Deactivates the projects with the given IDs Silk Performance Manager API Help 31

40 Web Service "sccentities" Parameters long sessionid The unique ID of that session created with logonuser() int[] projectids ProjectIds of the projects to deactivate public LocationDetails getlocationdetails(long sessionid, int locationid) Retrieves detailed information about the Location identified by the ID. Parameters long sessionid The unique ID of that session created with logonuser() int locationid The identifier of the location The location details of the given location. public int createlocation(long sessionid, LocationDetails locationdetails) Creates a new location with the data provided by the location details. Parameters long sessionid The unique ID of that session created with logonuser() locationdetails Properties of the location to create (ID is ignored and set by the system) The location ID assigned to the new location by the system. public void updatelocation(long sessionid, LocationDetails locationdetails) Updates an existing location (identified by the ID) with the data provided by the location details. Parameters long sessionid The unique ID of that session created with logonuser() locationdetails Properties of the location to create (ID identifies the location to update on the system ) 32 Silk Performance Manager API Help