REST API - View a group
GET /groups/{group_id}
- This method allows information for a specified group to be obtained.
example /groups/220
Notes
See Service Manager REST API Convention
- If successful, an HTTP status cod 200 is returned:
- A URL link (HREF) to the resource is provided.
- All fields are provided, including e_field_name and available_field_x, except for certain sensitive fields reserved for EasyVista.
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
You can use the parameters detailed below in the HTTP request string.
Minimum version | Parameter | Type | Description / Example | ||
---|---|---|---|---|---|
fields | string | Sélection de champs à afficher
|
|||
Oxygen 1.7 - Build 2018.1.131.0 | formatDate | string | Format display of Date fields in the HTTP request result. ![]()
|
Fields that could be used in optional parameters
- You can use all the fields from the AM_GROUP table.
HTTP status codes for the method
StatusHeader
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 with a status code 200 returned
"HREF": "https://{your_server}/api/v1/{your_account}/groups/220",
"AUTHORIZED_TRANSFER_LIST": "0",
"AVAILABLE_FIELD_1": "",
"AVAILABLE_FIELD_2": "",
"AVAILABLE_FIELD_3": "",
"AVAILABLE_FIELD_4": "",
"AVAILABLE_FIELD_5": "",
"AVAILABLE_FIELD_6": "",
"CHAT_ENABLED": "0",
"CHAT_GROUP_NAME": "",
"CITY": "",
"COMMENT_GROUP": {
"HREF": " https://{your_server}/api/v1/{your_account}/groups/220/comment_group"
},
"COUNTRY_ID": "",
"DISCUSSION_ENABLED": "0",
"EMAIL": "group_via_rest@easyvista.com",
"END_DATE": "",
"FO_CHAT_ENABLED": "",
"GROUP_EN": "Group created via REST",
"GROUP_FR": "Groupe créé via REST",
"GROUP_GE": "[Groupe créé via REST]",
"GROUP_GUID": "{CBB367B6-50B2-4CF6-9FAC-B3C15E6416E0}",
"GROUP_ID": "220",
"GROUP_IT": "[Groupe créé via REST]",
"GROUP_L1": "",
"GROUP_L2": "",
"GROUP_L3": "",
"GROUP_L4": "",
"GROUP_L5": "",
"GROUP_L6": "",
"GROUP_LEVEL": "2",
"GROUP_PO": "[Groupe créé via REST]",
"GROUP_SP": "[Groupe créé via REST]",
"LANGUAGE_ID": "",
"MAIL_ALERT": "1",
"MANAGER_ID": "",
"PHONE_NUMBER": "",
"SLA_ID": "",
"START_DATE": "",
"STATE_ID": "",
"STREET_ADDRESS_1": "",
"STREET_ADDRESS_2": "",
"SUPPLIER_PATH": "",
"SUPPLIER_ID": "",
"ZIP_CODE": ""
}
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)" } } |