wsAdmin

The following methods are available in the wsAdmin service.

Link

This method will authenticate web service requests. Call this method prior to other web service calls. It will automatically populate the SOAP header with a validation token that enables subsequent web service calls.

Input Parameters

User: The built-in or Windows UserID to use for the context of all calls.

Password: The password for this UserID.

Returns

Boolean: Indication of success.

Link

This method will authenticate web service requests. Call this method prior to other web service calls. The return is a JSON string with the session ID.

Input parameters

User: The built-in or Windows UserID to use for the context of all calls.

Password: The password for this UserID.

Returns

JSON: The Session ID.

Link

This method will return various information about Process Director's database.

Input Parameters

Information: The specific information that should be returned. This parameter will accept any of the following values:

  • getMaxDBSize
  • getMaxSizeNoLog
  • getDBSize
  • getLogSize
  • getDBSizeNoLog
  • getMaxLogSize
  • getFreeSpace
Returns

Size: Size of the database in megabytes

Link

This method will get the number of disabled users in Process Director's database.

Input Parameters

None.

Returns

disabledUsers: The number of disabled users in the database.

Link

This method will return info on all local drives.

Input Parameters

None.

Returns

allDrives: The Drive Information for each local drive.

Link

This method will get the number of users currently logged in to Process Director.

Input Parameters

None.

Returns

loggedIn: The number of users logged in.

Link

This method will get the maximum possible number of users for Process Director's license.

Input Parameters

None.

Returns

possibleUsers: The number of possible users.

Link

This method will get the number of specific types of objects in Process Director's database.

Input Parameters

type: The type of object to be returned. This parameter accepts one of the following:

  • Workflow
  • timeline
  • Form
  • folder
  • document
Returns

objects: number of objects in the database.

Link

This method will return information about the server.

Input Parameters

Information: The specific server information to be returned by the web service. The parameter will accept one of the following:

  • CurrentMemory
  • PeakVirtual
  • CurrentVirtual
  • PeakMemory
  • ProcdessorTime
  • StartTime
  • PDVersion
Returns

ServerInfo:  Requested information about the server as specified in the input parameter.

Link

This method will return the number of active users in Process Director's database.

Input parameters

None.

Returns

activeUsers: number of active users in the database.

Link

This method will get the total number of groups in Process Director's database.

Input parameters

None.

Returns

groups: The number of groups in the database.

Link

This method will get the number of objects in Process Director's database.

Input parameters

None.

Returns

objects: number of objects in the database.

Link

This method will get the total number of users in Process Director's database.

Input parameters

None.

Returns

Users: The number of users in the database.

Link

This method will send a message to all users on a server.

Input parameters

message: The message to be sent to all users.

Returns

success: A Boolean value reflecting success of web services (FALSE if errors, TRUE if successful).

Link

This method will set the context UID for all future web service calls. For instance, this UID will be used as the current user for running Knowledge Views, permission checking, etc.

Input parameters

UID: The ID of the user to use for the context of all calls.

Returns

Boolean: indication of success.