Page Comparison

...

The base URL for API calls is:

http(s)://SERVER[:PORT]/flex/services/rest/latest

or in case of Zephyr Enterprise Cloud instances:

https://YOUR_SUBDOMAIN.yourzephyr.com/flex/services/rest/latest

Authentication

You can authenticate your requests by using one of the methods described in the Zephyr REST API topic.

Get a list of groups

Request URL

...

GET

...

http(s)://{ZEPHYR-SERVER}/flex/services/rest/v3/externalGroup/search?name=SEARCH_STRING&pagesize=100

Request parameters

name - (optional) a substring that is part of the sought-for name. If this parameter is not specified, all the groups will be fetched.
pagesize - (optional) the number of groups to be fetched. The default number is 100; the maximum number is 499.

...

Import one or more groups

Request URL

...

POST

...

http(s)://{ZEPHYR-SERVER}/flex/services/rest/v3/externalGroup/importGroupsAndUsers

Headers

Content-Type: application/json

...

{
    "names": [
        "Automation_QA"
    ]
}

Sample response

...

Response

On success, the operation returns status code 200 and a JSON object containing the job ID in the response body (for example, 100). To get the job details and progress, send the following GET request:

...

http://yourzephyr.com/flex/services/rest/v3/jobprogress/100

For information on other response codes, see below.

Synchronize one or more groups

...

{
    "names": [
       "crowd-administrators"
    ]
}

Sample response

101

On success, the operation returns status code 200 and a JSON object containing the job ID. To get the job details and progress, send the following GET request:

...