OpenManage Enterprise–Tech Release REST API Guide

Groups service

2.4.1 /api/GroupService/Groups

GET

Description

Get the groups

Privilege

VIEW

HTTP Response Codes

200

GET Usage Examples

Input: 
Output:
{
    "@odata.context": "/api/$metadata#Collection(GroupService.Group)",
    "@odata.count": 1,
    "value": [
        {
            "@odata.id": "/api/GroupService/Groups(1214)",
            "Id": 1214,
            "Name": "Dell Networking Switches",
            "Description": "Dell network switches",
            "GlobalStatus": 5000,
            "ParentId": 1164,
            "CreationTime": "2017-11-15 23:39:54.251",
            "UpdatedTime": "2017-11-17 20:55:00.200",
            "CreatedBy": "system",
            "UpdatedBy": "",
            "Visible": true,
            "DefinitionId": 7000,
            "DefinitionDescription": "Dell network switches",
            "TypeId": 2000,
            "MembershipTypeId": 24,
            "Devices": [
                {
                    "@odata.id": "/api/GroupService/Groups(1214)/Devices"
                }
            ],
            "AllLeafDevices": [
                {
                    "@odata.id": "/api/GroupService/Groups(1214)/AllLeafDevices"
                }
            ],
            "GroupHierarchy": [
                {
                    "@odata.id": "/api/GroupService/Groups(1214)/GroupHierarchy"
                }
            ],
            "SubGroups": [
                {
                    "@odata.id": "/api/GroupService/Groups(1214)/SubGroups"
                }
            ],
            "GroupDevicesSummary": [
                {
                    "@odata.id": "/api/GroupService/Groups(1214)/GroupDevicesSummary"
                }
            ],
            "GroupQuery": [
                {
                    "@odata.id": "/api/GroupService/Groups(1214)/GroupQuery"
                }
            ],
            "DeviceStatusSummary": [
                {
                    "@odata.id": "/api/GroupService/Groups(1214)/DeviceStatusSummary"
                }
            ],
            "EventStatusSummary": [
                {
                    "@odata.id": "/api/GroupService/Groups(1214)/EventStatusSummary"
                }
            ]
        }]
}

2.4.2 /api/GroupService/Groups(groupId)/DeviceStatusSummary

GET

Description

Get Device Status counts per status value

Privilege

VIEW

HTTP Response Codes

200

GET Usage Examples

Input: 
Output:
{
    "@odata.context": "/api/$metadata#Collection(GroupService.StatusSummary)",
    "@odata.count": 4,
    "value": [
        {
            "StatusType": 4000,
            "Count": 15
        },
        {
            "StatusType": 3000,
            "Count": 2
        },
        {
            "StatusType": 2000,
            "Count": 30
        },
        {
            "StatusType": 1000,
            "Count": 12
        }
    ]
}

2.4.3 /api/GroupService/Groups(groupId)/EventStatusSummary

GET

Description

Get Event Status counts per status value

Privilege

VIEW

HTTP Response Codes

200

GET Usage Examples

Input: 
Output:
{
    "@odata.context": "/api/$metadata#Collection(GroupService.StatusSummary)",
    "@odata.count": 2,
    "value": [
        {
            "StatusType": 16,
            "Count": 184
        },
        {
            "StatusType": 8,
            "Count": 3
        }
    ]
}

2.4.4 /api/GroupService/GroupAudits

GET

Description

Get group and group hierarchy changes

Privilege

VIEW

HTTP Response Codes

200

GET Usage Examples

Input: 
Parameter for AuditDateTime – when present, get all changes starting from the time specified otherwise get all changes (available).  Time is in UTC – sample:
?$filter=AuditDateTime eq '2017-11-29 19:17: 54'
Output:
{
    "@odata.context": "/api/$metadata#Collection(GroupService.GroupAudit)",
    "@odata.count": 36,
    "value": [
        {
            "@odata.id": "/api/GroupService/GroupAudits(61)",
            "AuditId": 61,
            "Id": 9114,
            "Name": "disc-226-10",
            "Description": "Discovery: disc-226-10",
            "GlobalStatus": 4000,
            "ParentId": 1764,
            "CreationTime": "2017-11-29 17:52:41.423",
            "UpdatedTime": "2017-11-29 20:25:00.373",
            "CreatedBy": "system",
            "UpdatedBy": "",
            "Visible": true,
            "DefinitionId": 9064,
            "DefinitionDescription": "Discovery: disc-226-10",
            "TypeId": 4000,
            "MembershipTypeId": 12,
            "GroupOperation": 1,
            "GroupHierarchyOperation": 1,
            "AuditDateTime": "2017-11-29 17:52:41.493296"
        },
…
Where GroupOperation and GroupHierarchyOperation denote changes to the group or hierarchy with the following enumeration:
		Create: 1,
       Update: 2,
       Delete: 3,
       No_op: 4

2.4.5 / api/GroupService/Actions/GroupService.CreateGroup

POST

Description

Create a new group

Privilege

GROUP_MANAGEMENT

HTTP Response Codes

200

POST Usage Examples

Input For static group: 
{  
   "GroupModel":{  
      "Name":"Test Group",
      "MembershipTypeId":12,
      "ParentId":1914
   }
}
Input For dynamic group:
{
	"GroupModel":
	{
		"Id": 0,
		"Name": "test2", 
		"Description": "test2",
		"GlobalStatus": 0,
		"DefinitionId": 0,
		"MembershipTypeId":24,
		"ParentId": 1914
	},
	"GroupModelExtension":
	{
		"FilterId":1,
		"ContextId":2,
		"Conditions":
		[{
			"LogicalOperatorId":1,
			"LeftParen": false,
			"FieldId":9,
			"OperatorId":1,
			"Value":"2000",
			"RightParen": false
		}]
	}
}
Output:
19264

2.4.6 /api/GroupService/Actions/GroupService.UpdateGroup

POST

Description

Update a group

Privilege

GROUP_MANAGEMENT

HTTP Response Codes

200

POST Usage Examples

Input for static group: 
{  
   "GroupModel":{  
      "Name":"Test Group Edit",
      "Description":"",
      "MembershipTypeId":12,
      "ParentId":1914,
      "Id":19214
   }
}
Input for dynamic group:
{
	"GroupModel":
	{
		"Id": 23664,
		"Name": "test2b", 
		"Description": "GroupTest2b",
		"GlobalStatus": 0,
		"DefinitionId": 0,
		"MembershipTypeId":24,
		"ParentId": 0
	},
	"GroupModelExtension":
	{
		"FilterId":1,
		"ContextId":2,
		"Conditions":
		[{
			"LogicalOperatorId":1,
			"LeftParen": false,
			"FieldId":9,
			"OperatorId":1,
			"Value":"2000",
			"RightParen": false
		}]
	}
}
Output:
19264

2.4.7 /api/GroupService/Actions/GroupService.Clone

POST

Description

Clone a group

Privilege

GROUP_MANAGEMENT

HTTP Response Codes

200

POST Usage Examples

Input: 
{  
   "Id":19164,
   "Name":"s1 Clone",
   "Description":"",
   "ParentId":1914
}
Output:
39564

2.4.8 /api/GroupService/Actions/GroupService.AddMemberDevices

POST

Description

Add devices to a group

Privilege

GROUP_MANAGEMENT

HTTP Response Codes

204

POST Usage Examples

Input: 
{
 	"GroupId": 8814,
	"MemberDeviceIds": [5064]
}

2.4.9 /api/GroupService/Actions/GroupService.RemoveMemberDevices

POST

Description

Remove devices(s) from a group

Privilege

GROUP_MANAGEMENT

HTTP Response Codes

204

POST Usage Examples

Input: 
{  
   "GroupId":39564,
   "MemberDeviceIds": [  
      4864
   ]
}

2.4.10 /api/GroupService/Actions/GroupService.AddUserToGroups

POST

Description

Add users to a group

Privilege

GROUP_MANAGEMENT

HTTP Response Codes

204

POST Usage Examples

Input: 
{  
   "UserId":39614,
   "GroupIds":[  
      19214, 12641
   ]
}

2.4.11 /api/GroupService/Actions/GroupService.DeleteGroup

POST

Description

Delete a group

Privilege

GROUP_MANAGEMENT

HTTP Response Codes

204

POST Usage Examples

Input: 
{  
   "GroupIds": [  
      39564
   ]
}