REST API - View the list of employees in a group

Last modified on 2023/04/17 15:16

Contents

Notes
List of parameters / fields
- Mandatory parameters
- Optional parameters
HTTP status codes for the method
Example
- Result for 2 employees attached to a group (status code 200)
REST API Conventions

Minimum version Service Manager : 2023.2 - Build 2023.2.111.0

GET /groups/{group_id}/employees

This method allows the list of employees for a group to be obtained.
example /groups/220/employees

Notes

Open url.png See Service Manager REST API Conventions

If successful, an HTTP status code 200 is returned.
- Only an extract of the most useful fields selected by EasyVista is displayed for each record provided.
- A URL link (HREF) to each resource is provided so that the complete list of fields for a record can be obtained.

List of parameters / fields

Mandatory parameters

You must use the parameter below in the URL.

Parameter	Type	Description / Example
group_id	integer	Group identifier

Optional parameters

None

HTTP status codes for the method

StatusHeader

Note: A Timeout error code will be returned if the server does not respond to the REST Web service request within a given time (by default 60 seconds).

Code	Error		Description

Status200

200

OK (Successful)

Request successfully processed.

Status401

401

Unauthorized

Incorrect authentication process for accessing the resource: Incorrect login/password, invalid session, incorrect Service Manager account.

example

{
"error": "Invalid Login / Password"
}

Example

Result for 2 employees attached to a group (status code 200)

{
   "HREF": "https://{your_server}/api/v1/{your_account}/groups/220",
   "records_count": 2,
   "employees": [
       "https://{your_server}/api/v1/{your_account}/employees/9477",
       "https://{your_server}/api/v1/{your_account}/employees/9478"
    ],
   "managers": [
       "https://{your_server}/api/v1/{your_account}/employees/9477",
       "https://{your_server}/api/v1/{your_account}/employees/9478"
    ]
}

ConventionsAPI

REST API Conventions

Convention		Meaning
Orange		Parameters used in an HTTP request string which do not correspond to Service Manager database fields. example Method View a list of assets https://{your_server}/api/v1/{your_account}/assets?max_rows=3&fields=asset_tag

Black and Bold		Parameters used in the URL of an HTTP request which correspond to Service Manager database fields. example Method View an asset https://{your_server}/api/v1/{your_account}/assets/{asset_id}

Green		Parameters used in the body of an HTTP request which represent JSON object names corresponding to Service Manager database fields; they allow the value of a database field to be assigned or modified. example Method Close an incident/request { "closed": { "end_date": "11/20/2016 12:12:12", } }
Green		Parameters used in the body of an HTTP request which represent JSON object names not corresponding to Service Manager database fields. example Method Reopen an incident/request { "restarted": { "comment": "string (required)" } }

Tags: