REST API - View the list of groups for an employee

Last modified on 2023/10/18 16:39

Minimum version Service Manager : 2023.2 - Build 2023.2.111.0

GET  /employees/{employee_id}/groups

  • This method allows the list of groups for a specified employee to be obtained.
          example    /employees/123/groups

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
employee_id integer Employee identifier

Optional parameters

None

HTTP status codes for the method

StatusHeader

   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.
Status400
400 Bad Request Request could not be run correctly due to malformed syntax.

example

{
 "error": "Nothing to update (check fieldnames)"
}

or when the "Suspend a ticket" method is called but the ticket is already suspended. The response returned is: { "error": "The request is already suspended. Operation aborted."}

or when the "Reopen a ticket" method is called but the ticket is not suspended. The response returned is: { "error": "The request is not suspended. Operation aborted."}

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 a status code 200 returned

{
   "HREF": "https://{your_server}/api/v1/{your_account}/groups/270",
   "records_count": 1,
   "employees": [
       "https://{your_server}/api/v1/{your_account}/employees/9477"
    ],
   "managers": [
       "https://{your_server}/api/v1/{your_account}/employees/9477"
    ]
}
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",  }  }
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:
Powered by XWiki © EasyVista 2024