We are rolling out a fix for cycle summary issue for our Zephyr for Jira Cloud customers (on October 16th 2018) post the recent 3.0 release. This change will automatically be pushed into your cloud instances and there will not be any downtime.
Support | Zephyr



SOAP API - Return list of all Users

Created on

Using the SOAP API method linked below, we can return a filtered list or all users from a Zephyr instance:

http://support.yourzephyr.com/api_help/4.7/javadocs/com/thed/service/soap/impl/ZephyrSoapServiceImpl.html#getUsersByCriteria(java.util.List, java.lang.Boolean, java.lang.String)

As with all ...ByCriteria filters in Zephyr API, there are three main components to the call:

1) searchCriteria - The filter criteria used when flag(2) is set to 'false'. Ignored if flag(2) is set to 'true'

2) returnAllDataFlag - Boolean value or 'true' (return all results) or 'false' (return filtered results)

3) token - Session token returned in separate login call

 

A call to return all users would look something like:

client.getUsersByCriteria(listOfCriteria, 'true', token);

In the call above, since the flag is set to 'true' the criteria is ignored and as long as the session token is valid the return will be a list of all users in the Zephyr Enterprise/Community server.

The returned object is of type 'RemoteUser' and details can be seen at the link below:

http://support.yourzephyr.com/api_help/4.7/javadocs/com/thed/rpc/bean/RemoteUser.html


Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request
Powered by Zendesk