FindPersons

Returns a list of xMatters Users based on specified search criteria.

Sample SOAP Request One (blank search; returns all Users in system)

Sample SOAP Request Two (targetName search)

Sample SOAP Request Three (attribute/custom field search)

Request Parameters

Name

Description

Type

Optional

searchParameters

Supported search parameters:

  • attribute: searches for Users based on name/value pairs of attributes
  • customField: searches for Users based on name/values pairs of Custom Fields
  • targetName: searches for Users based on Users' target names
  • roleName: searches for Users assigned to a specific Role

If no parameters are specified, ALL Users are returned.

PersonSearchParameters

no

Sample SOAP Response

Response Parameters

Name

Description

Type

matchingPersons

List of Users matching the specified search criteria

SoapPersons

serverTimestamp

Time corresponding to the server time when the request was made (this should match the associated persisted audit event)

string

status

Final status of the request

string

Standard SOAP Parameters

SOAP Response Status Messages