System Group APIs

Get system group

OVERVIEW

 

Overview

This API call is used to get a system group object in the system. 

Request

GET /api/3/groups/<GROUPID>

Request Parameters

Parameter Description
GROUPID The ID of the system group

 

Example

GET http://example.com/context/api/3/groups/1

Response

HTTP response 200

Response Body

XML format

<group>
    <groupID>1060</groupID>
    <name>High-India3</name>
    <description>b</description>
    <guid>High-India3</guid>
    <type>system</sourcetype>
    <createddate>23 May 2018 05:41</createddate>
</group>

JSON format

{
    "groupID": 1060,
    "name": "High-India3",
    "description": "b",
    "guid": "High-India3",
    "type": "system",
    "createddate": "23 May 2018 05:41"
}

Error messages

 

Summary Ref Code (before V4) Ref Code (V4)
Group id is required 125 125
Group id is not in proper format 124 124
The group does not exist within the system 126 126

Comments


0 Comments

Last Updated: Nov 08,2024