API Reference for device/msgraph/Group

The full URL would include the host-proxy name: https://[host-proxy].

Variables are enclosed in square brackets.

[hierarchy] is the hierarchy.
1. as UUID. For example: 6t0ggef2c0deab00hb595101
2. in dot notation. E.g. ProviderName.CustomerName.LocationName

For a list of available UUIDs and their dot notations:
GET /api/v0/data/HierarchyNode/?format=json

[pkid] is the ID of the resource instance. Refer to the List reference below.
[filename] refers to a file

GET http://[host-proxy]/api/device/msgraph/Group/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema",
     "type": "object",
     "properties": {
          "id": {
               "name": "id",
               "type": "string",
               "title": "Id"
          },
          "displayName": {
               "name": "displayName",
               "type": "string",
               "title": "Name",
               "required": true
          },
          "description": {
               "name": "description",
               "type": "string",
               "title": "Description",
               "required": true
          },
          "groupTypes": {
               "name": "groupTypes",
               "type": "array",
               "title": "Group Types",
               "items": {
                    "type": "string"
               }
          },
          "groupType": {
               "name": "groupType",
               "type": "string",
               "title": "Group Type",
               "description": "Group Type",
               "default": "Security",
               "choices": [
                    {
                         "value": "Security",
                         "title": "Security"
                    },
                    {
                         "value": "Microsoft 365",
                         "title": "Microsoft 365"
                    }
               ]
          },
          "isTeam": {
               "name": "isTeam",
               "type": "boolean",
               "title": "Is Team"
          },
          "mail": {
               "name": "mail",
               "type": "string",
               "title": "Mail"
          },
          "mailEnabled": {
               "name": "mailEnabled",
               "type": "boolean",
               "title": "Mail Enabled"
          },
          "mailNickname": {
               "name": "mailNickname",
               "type": "string",
               "title": "Mail Nickname"
          },
          "securityEnabled": {
               "name": "securityEnabled",
               "type": "boolean",
               "title": "Security Enabled"
          },
          "assignedLicenses": {
               "name": "assignedLicenses",
               "type": "array",
               "title": "Assigned Licenses",
               "items": {
                    "type": "object",
                    "properties": {
                         "disabledPlans": {
                              "name": "disabledPlans",
                              "type": "array",
                              "title": "Disabled Plans",
                              "items": {
                                   "type": "string"
                              }
                         },
                         "skuId": {
                              "name": "SkuId",
                              "type": "string",
                              "title": "SKU ID"
                         }
                    }
               }
          },
          "discoverySettings": {
               "name": "discoverySettings",
               "type": "object",
               "title": "Discovery Settings",
               "properties": {
                    "showInTeamsSearchAndSuggestions": {
                         "name": "showInTeamsSearchAndSuggestions",
                         "type": "boolean",
                         "title": "Show In Teams Search And Suggestions"
                    }
               }
          },
          "funSettings": {
               "name": "funSettings",
               "type": "object",
               "description": "Settings to configure use of Giphy, memes, and stickers in the team.",
               "title": "Fun Settings",
               "properties": {
                    "allowGiphy": {
                         "name": "allowGiphy",
                         "type": "boolean",
                         "title": "Giphy"
                    },
                    "giphyContentRating": {
                         "name": "giphyContentRating",
                         "type": "string",
                         "title": "Giphy Content Rating",
                         "description": "Giphy content rating",
                         "choices": [
                              {
                                   "value": "moderate",
                                   "title": "Moderate"
                              },
                              {
                                   "value": "strict",
                                   "title": "Strict"
                              }
                         ]
                    },
                    "allowStickersAndMemes": {
                         "name": "allowStickersAndMemes",
                         "type": "boolean",
                         "title": "Stickers and memes"
                    },
                    "allowCustomMemes": {
                         "name": "allowCustomMemes",
                         "type": "boolean",
                         "title": "Custom memes"
                    }
               }
          },
          "guestSettings": {
               "name": "guestSettings",
               "type": "object",
               "description": "Settings to configure whether guests can create, update, or delete channels in the team.",
               "title": "Guest Settings",
               "properties": {
                    "allowCreateUpdateChannels": {
                         "name": "allowCreateUpdateChannels",
                         "type": "boolean",
                         "title": "Guests can add and edit channels"
                    },
                    "allowDeleteChannels": {
                         "name": "allowDeleteChannels",
                         "type": "boolean",
                         "title": "Guests can delete channels"
                    }
               }
          },
          "memberSettings": {
               "name": "memberSettings",
               "description": "Settings to configure whether members can perform certain actions, for example, create channels and add bots, in the team.",
               "type": "object",
               "title": "Member Settings",
               "properties": {
                    "allowCreateUpdateChannels": {
                         "name": "allowCreateUpdateChannels",
                         "type": "boolean",
                         "title": "Add and edit channels"
                    },
                    "allowCreatePrivateChannels": {
                         "name": "allowCreatePrivateChannels",
                         "type": "boolean",
                         "title": "Add and edit private channels"
                    },
                    "allowDeleteChannels": {
                         "name": "allowDeleteChannels",
                         "type": "boolean",
                         "title": "Delete channels"
                    },
                    "allowAddRemoveApps": {
                         "name": "allowAddRemoveApps",
                         "type": "boolean",
                         "title": "Add, edit or remove apps"
                    },
                    "allowCreateUpdateRemoveTabs": {
                         "name": "allowCreateUpdateRemoveTabs",
                         "type": "boolean",
                         "title": "Add, edit or remove tabs"
                    },
                    "allowCreateUpdateRemoveConnectors": {
                         "name": "allowCreateUpdateRemoveConnectors",
                         "type": "boolean",
                         "title": "Add, edit or remove connectors"
                    }
               }
          },
          "messagingSettings": {
               "name": "messagingSettings",
               "description": "Settings to configure messaging and mentions in the team.",
               "type": "object",
               "title": "Messaging Settings",
               "properties": {
                    "allowUserEditMessages": {
                         "name": "allowUserEditMessages",
                         "type": "boolean",
                         "title": "Edit sent messages"
                    },
                    "allowUserDeleteMessages": {
                         "name": "allowUserDeleteMessages",
                         "type": "boolean",
                         "title": "Delete sent messages"
                    },
                    "allowOwnerDeleteMessages": {
                         "name": "allowOwnerDeleteMessages",
                         "type": "boolean",
                         "title": "Team owners can delete sent messages"
                    },
                    "allowTeamMentions": {
                         "name": "allowTeamMentions",
                         "type": "boolean",
                         "title": "Mention teams in messages"
                    },
                    "allowChannelMentions": {
                         "name": "allowChannelMentions",
                         "type": "boolean",
                         "title": "Mention channels in messages"
                    }
               }
          },
          "visibility": {
               "name": "visibility",
               "type": "string",
               "title": "Privacy",
               "description": "The visibility of the group and team. Defaults to Public.",
               "choices": [
                    {
                         "value": "public",
                         "title": "Public"
                    },
                    {
                         "value": "private",
                         "title": "Private"
                    }
               ]
          },
          "isMembershipLimitedToOwners": {
               "name": "isMembershipLimitedToOwners",
               "type": "boolean",
               "title": "Is Membership Limited To Owners"
          },
          "isArchived": {
               "name": "isArchived",
               "description": "Whether this team is in read-only mode.",
               "type": "boolean",
               "readonly": true,
               "title": "Is Archived"
          },
          "teamsTemplate": {
               "name": "teamsTemplate",
               "type": "string",
               "title": "Teams Template"
          },
          "members": {
               "name": "members",
               "type": "array",
               "title": "Members",
               "description": "Members and owners of the team. Changes to a team, such as adding or removing members, can take up to 10 minutes to appear in search results.",
               "items": {
                    "type": "object",
                    "properties": {
                         "username": {
                              "format": "uri",
                              "target": "/api/device/msgraph/MsolUser/choices/?field=UserPrincipalName&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
                              "target_attr": "UserPrincipalName",
                              "convert_to_primary_key": true,
                              "type": "string",
                              "name": "username",
                              "description": "Username.",
                              "title": "Username",
                              "target_model_type": "device/msgraph/MsolUser",
                              "choices": []
                         },
                         "role": {
                              "name": "role",
                              "type": "string",
                              "title": "Role",
                              "description": "Shows whether a user in the list is a team owner or member.",
                              "default": "member",
                              "choices": [
                                   {
                                        "value": "owner",
                                        "title": "Owner"
                                   },
                                   {
                                        "value": "member",
                                        "title": "Member"
                                   }
                              ]
                         },
                         "id": {
                              "name": "id",
                              "type": "string",
                              "title": "ID"
                         },
                         "displayName": {
                              "name": "displayName",
                              "type": "string",
                              "title": "Display Name"
                         }
                    }
               }
          },
          "channels": {
               "name": "channels",
               "type": "array",
               "description": "The collection of channels and messages associated with the team. Changes to a team, such as adding or removing members, can take up to 10 minutes to appear in search results.",
               "title": "Channels",
               "items": {
                    "type": "object",
                    "properties": {
                         "displayName": {
                              "type": "string",
                              "name": "displayName",
                              "description": "Display name of team channel member can be set on add and also be updated.",
                              "title": "Display Name"
                         },
                         "description": {
                              "name": "description",
                              "description": "Description of team channel member can be set on add and also be updated.",
                              "type": "string",
                              "title": "Description"
                         },
                         "membershipType": {
                              "name": "membershipType",
                              "type": "string",
                              "description": "Shows if a channel is a private, standard, or shared channel. You cannot update the Membership Type value for an existing channel.",
                              "default": "standard",
                              "title": "Membership Type",
                              "choices": [
                                   {
                                        "value": "standard",
                                        "title": "Standard"
                                   },
                                   {
                                        "value": "private",
                                        "title": "Private"
                                   },
                                   {
                                        "value": "shared",
                                        "title": "Shared"
                                   }
                              ]
                         },
                         "id": {
                              "name": "id",
                              "type": "string",
                              "description": "Id of team channel.",
                              "title": "ID"
                         },
                         "email": {
                              "name": "email",
                              "description": "Email of team channel.",
                              "type": "string",
                              "title": "Email"
                         }
                    }
               }
          }
     },
     "schema_version": "1.0"
}

Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/device/msgraph/Group/add/	hierarchy=[hierarchy] format=json	The GUI Add form of device/msgraph/Group as JSON

The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.

Task	Call	URL	Parameters	Payload
Create	POST	/api/device/msgraph/Group	hierarchy=[hierarchy]	(For payload specification)

Response is a transaction pkid for the create action.

Use the GET call to

tool/Transaction/[trans pkid]

to inspect the created resource and its instance pkid.

Task	Call	URL	Parameters	Payload
Bulk delete [pkid1],[pkid2]...	DELETE	/api/device/msgraph/Group/	hierarchy=[hierarchy]	{"hrefs":["/api/device/msgraph/Group/[pkid1]", "/api/device/msgraph/Group/[pkid2]", ...]}

For the instance pkids [pkid1],[pkid2], ... that can be added to the DELETE call (the instance pkids to delete), refer to the List GET call for: device/msgraph/Group
```
GET http://[host-proxy]/api/device/msgraph/Group/?hierarchy=[hierarchy]&format=json
```

Task	Call	URL	Parameters	Payload
Move the instance with [pkid] to [target_hierarchy]	POST	/api/tool/DataMove/?model_type=device/msgraph/Group	hierarchy=[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/msgraph/Group/[pkid]"]}
Bulk Move	POST	/api/tool/DataMove/?model_type=device/msgraph/Group	hierarchy==[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/msgraph/Group/[pkid1]", "/api/device/msgraph/Group/[pkid2]",...]}

Move one or more model instances ([pkid1],[pkid2],...) from source hierarchy (pkid or dot notation) to target_hierarchy (pkid or dot notation). A move can only take place from a source hierarchy equal to or lower than target_hierarchy.
For a list of hierarchy pkids and their dot notation available from [hierarchy], use the GET call:
GET http://[host-proxy]/api/device/msgraph/Group/?hierarchy=[hierarchy]&format=json&schema_rules=true

Task	Call	URL	Parameters	Payload
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/msgraph/Group; optionally with tag_version at [version] and Configuration Template as [configtemplate].	POST	/api/device/msgraph/Group/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	{ "hrefs":["/api/device/msgraph/Group/[pkid1]", "/api/device/msgraph/Group/[pkid2]",...]}}

For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:

        Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
        Content-Language:en
        Content-Type:application/x-zip

For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:

        Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:

        Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

The XLSX format can be used to bulk load instances of device/msgraph/Group and the JSON format can be used to import instances of device/msgraph/Group.

To get the list of all instance pkids [pkid1],[pkid2], ..., use the List GET call for device/msgraph/Group:

 GET http://[host-proxy]/api/device/msgraph/Group/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Tag	PATCH	/api/device/msgraph/Group/+tag/	hierarchy=[hierarchy] format=json

Task	Call	URL	Parameters	Response
Configuration Template	GET	/api/device/msgraph/Group/configuration_template/	hierarchy=[hierarchy]	POST call to create the Configuration Template Configuration Template schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Field Display Policy	GET	/api/device/msgraph/Group/field_display_policy/	hierarchy=[hierarchy]	POST call to create the Field Display Policy Field Display Policy schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Migration Template	GET	/api/device/msgraph/Group/migration/	hierarchy=[hierarchy] format=json

Task	Call	URL	Parameters	Response
List	GET	/api/device/msgraph/Group/	hierarchy=[hierarchy] format=json schema=true	The device/msgraph/Group schema and all instances as JSON.

(The list will return 0 to 3 device/msgraph/Group instances)

GET http://[host]/api/device/msgraph/Group/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

{
     "pagination": {
          "skip": 0,
          "limit": 3,
          "maximum_limit": 2000,
          "total": 0,
          "total_limit": null,
          "order_by": "displayName",
          "direction": "asc",
          "current": "/api/device/msgraph/Group/?skip=0&limit=3&order_by=displayName&direction=asc&traversal=down"
     },
     "operations": [
          "list",
          "add",
          "add_group",
          "add_team",
          "add_team_channel",
          "add_team_members"
     ],
     "meta": {
          "model_type": "device/msgraph/Group",
          "summary_attrs": [
               {
                    "name": "displayName",
                    "title": "Name"
               },
               {
                    "name": "groupType",
                    "title": "Group Type"
               },
               {
                    "name": "mail",
                    "title": "Mail"
               },
               {
                    "name": "isTeam",
                    "title": "Is Team"
               },
               {
                    "name": "hierarchy_friendly_name",
                    "title": "Located At",
                    "allow_filtering": true
               }
          ],
          "tagged_versions": [],
          "tags": [],
          "title": "",
          "business_key": {},
          "api_version": "21.2",
          "cached": true,
          "references": {
               "children": [],
               "parent": [
                    {
                         "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
                         "pkid": "6t0ggef2c0deab00hb595101"
                    }
               ],
               "device": [
                    {
                         "href": "",
                         "pkid": ""
                    }
               ],
               "foreign_key": []
          },
          "model_specific_actions": [
               "list",
               "add",
               "add_group",
               "add_team",
               "add_team_channel",
               "add_team_members",
               "get",
               "get_group",
               "get_team",
               "get_team_members",
               "get_team_channels",
               "update",
               "update_group",
               "update_team",
               "update_team_channel",
               "update_team_member",
               "remove",
               "remove_team_channel",
               "remove_team_member",
               "archive_team",
               "unarchive_team",
               "move",
               "export",
               "configuration_template",
               "field_display_policy",
               "help",
               "migration",
               "tag"
          ],
          "schema_version": "1.0",
          "actions": [
               {
                    "add": {
                         "method": "GET",
                         "class": "add",
                         "href": "/api/device/msgraph/Group/add/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Add"
                    }
               },
               {
                    "remove": {
                         "method": "DELETE",
                         "class": "delete",
                         "href": "/api/device/msgraph/Group/?hierarchy=[hierarchy]",
                         "support_async": true,
                         "title": "Delete"
                    }
               },
               {
                    "move": {
                         "method": "POST",
                         "class": "move",
                         "href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/msgraph/Group",
                         "support_async": true,
                         "title": "Move",
                         "view": "/api/tool/DataMove/?auth_token=[authtoken]
                    }
               },
               {
                    "export": {
                         "method": "POST",
                         "class": "export",
                         "href": "/api/device/msgraph/Group/export/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Export",
                         "view": "/api/view/ExportData/add/?auth_token=[authtoken],
                         "submit": "payload"
                    }
               },
               {
                    "tag": {
                         "method": "PATCH",
                         "class": "tag",
                         "href": "/api/device/msgraph/Group/+tag/?hierarchy=[hierarchy]",
                         "support_async": true,
                         "title": "Tag",
                         "view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
                    }
               },
               {
                    "configuration_template": {
                         "method": "GET",
                         "class": "config",
                         "href": "/api/device/msgraph/Group/configuration_template/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Configuration Template"
                    }
               },
               {
                    "field_display_policy": {
                         "method": "GET",
                         "class": "display_policy",
                         "href": "/api/device/msgraph/Group/field_display_policy/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Field Display Policy"
                    }
               },
               {
                    "migration": {
                         "method": "GET",
                         "class": "migration",
                         "href": "/api/device/msgraph/Group/migration/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Migration Template"
                    }
               },
               {
                    "list": {
                         "method": "GET",
                         "class": "list",
                         "href": "/api/device/msgraph/Group/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "List"
                    }
               },
               {
                    "help": {
                         "method": "GET",
                         "class": "help",
                         "href": "/api/device/msgraph/Group/help?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Help"
                    }
               },
               {
                    "add_group": {
                         "method": "POST",
                         "class": "custom",
                         "href": "/api/device/msgraph/Group/+add_group/?hierarchy=[hierarchy]",
                         "support_async": true,
                         "title": "Add Group"
                    }
               },
               {
                    "add_team": {
                         "method": "POST",
                         "class": "custom",
                         "href": "/api/device/msgraph/Group/+add_team/?hierarchy=[hierarchy]",
                         "support_async": true,
                         "title": "Add Team"
                    }
               },
               {
                    "add_team_channel": {
                         "method": "POST",
                         "class": "custom",
                         "href": "/api/device/msgraph/Group/+add_team_channel/?hierarchy=[hierarchy]",
                         "support_async": true,
                         "title": "Add Team Channel"
                    }
               },
               {
                    "add_team_members": {
                         "method": "POST",
                         "class": "custom",
                         "href": "/api/device/msgraph/Group/+add_team_members/?hierarchy=[hierarchy]",
                         "support_async": true,
                         "title": "Add Team Members"
                    }
               },
               {
                    "purge": {
                         "method": "POST",
                         "class": "purge",
                         "href": "/api/device/msgraph/Group/purge/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Purge"
                    }
               }
          ]
     },
     "resources": []
}

Task	Call	URL	Parameters	Response
Get the on-line Help for device/msgraph/Group.	GET	/api/device/msgraph/Group/help	hierarchy=[hierarchy]	On-line help of Model ref.: device/msgraph/Group as HTML

Task	Call	URL	Parameters	Response
Add Group	POST	/api/device/msgraph/Group/+add_group/	hierarchy=[hierarchy] format=json

Task	Call	URL	Parameters	Response
Add Team	POST	/api/device/msgraph/Group/+add_team/	hierarchy=[hierarchy] format=json

Task	Call	URL	Parameters	Response
Add Team Channel	POST	/api/device/msgraph/Group/+add_team_channel/	hierarchy=[hierarchy] format=json

Task	Call	URL	Parameters	Response
Add Team Members	POST	/api/device/msgraph/Group/+add_team_members/	hierarchy=[hierarchy] format=json

Task	Call	URL	Parameters	Response
Purge	POST	/api/device/msgraph/Group/purge/	hierarchy=[hierarchy] format=json

Instance API Reference

[pkid] is the ID of the resource instance.
If a payload is required, inspect the schema for payload details.

Task	Call	URL	Parameters	Payload
Modify	PUT	/api/device/msgraph/Group/[pkid]	hierarchy=[hierarchy]	(For payload specification)

For Bulk modification, refer to the Bulk Modify section.

Task	Call	URL	Parameters	Response
Delete	DELETE	/api/device/msgraph/Group/[pkid]	hierarchy=[hierarchy]

Task	Call	URL	Parameters	Payload
Move	POST	/api/tool/DataMove/[pkid]/?model_type=device/msgraph/Group	hierarchy=[hierarchy]	If payload required:

Task	Call	URL	Parameters	Response
Get a selected [export_format] of the schema and a single instance with [pkid] of device/msgraph/Group; optionally with tag_version at [version] and Configuration Template as [configtemplate].	GET	/api/device/msgraph/Group/[pkid]/export	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	The response is an attachment. Refer to the list below.

For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:

        Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:

        Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

For export_format=json, the response is a time stamped zip file of data in JSON and a response format:

        Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
        Content-Language:en
        Content-Type:application/x-zip

The XLSX format can be used to bulk load instances of device/msgraph/Group and the JSON format can be used to import instances of device/msgraph/Group.

For Bulk Export, refer to the Bulk Export section.

Task	Call	URL	Parameters	Payload
Tag	PATCH	/api/device/msgraph/Group/[pkid]/+tag	hierarchy=[hierarchy]	If payload required:

Task	Call	URL	Parameters	Response
Get	GET	/api/device/msgraph/Group/[pkid]	hierarchy=[hierarchy]	The device/msgraph/Group instance with [pkid].

Task	Call	URL	Parameters	Response
Help	GET	/api/device/msgraph/Group/[pkid]/help	hierarchy=[hierarchy]	The on-line Help for device/msgraph/Group.

Task	Call	URL	Parameters	Payload
Archive Team	POST	/api/device/msgraph/Group/[pkid]/+archive_team	hierarchy=[hierarchy]	If payload required:

Task	Call	URL	Parameters	Payload
Get Group	POST	/api/device/msgraph/Group/[pkid]/+get_group	hierarchy=[hierarchy]	If payload required:

Task	Call	URL	Parameters	Payload
Get Team	POST	/api/device/msgraph/Group/[pkid]/+get_team	hierarchy=[hierarchy]	If payload required:

Task	Call	URL	Parameters	Payload
Get Team Channels	POST	/api/device/msgraph/Group/[pkid]/+get_team_channels	hierarchy=[hierarchy]	If payload required:

Task	Call	URL	Parameters	Payload
Get Team Members	POST	/api/device/msgraph/Group/[pkid]/+get_team_members	hierarchy=[hierarchy]	If payload required:

Task	Call	URL	Parameters	Payload
Purge	POST	/api/device/msgraph/Group/[pkid]/purge	hierarchy=[hierarchy]	If payload required:

Task	Call	URL	Parameters	Payload
Remove Team Channel	POST	/api/device/msgraph/Group/[pkid]/+remove_team_channel	hierarchy=[hierarchy]	If payload required:

Task	Call	URL	Parameters	Payload
Remove Team Member	POST	/api/device/msgraph/Group/[pkid]/+remove_team_member	hierarchy=[hierarchy]	If payload required:

Task	Call	URL	Parameters	Payload
Unarchive Team	POST	/api/device/msgraph/Group/[pkid]/+unarchive_team	hierarchy=[hierarchy]	If payload required:

Task	Call	URL	Parameters	Payload
Update Group	POST	/api/device/msgraph/Group/[pkid]/+update_group	hierarchy=[hierarchy]	If payload required:

Task	Call	URL	Parameters	Payload
Update Team	POST	/api/device/msgraph/Group/[pkid]/+update_team	hierarchy=[hierarchy]	If payload required:

Task	Call	URL	Parameters	Payload
Update Team Channel	POST	/api/device/msgraph/Group/[pkid]/+update_team_channel	hierarchy=[hierarchy]	If payload required:

Task	Call	URL	Parameters	Payload
Update Team Member	POST	/api/device/msgraph/Group/[pkid]/+update_team_member	hierarchy=[hierarchy]	If payload required:

API Reference for device/msgraph/Group

GET http://[host-proxy]/api/device/msgraph/Group/schema/?hierarchy=[hierarchy]&format=json&schema=1

Get the Add form

Create

Bulk Delete

Move

Bulk Export

Tag

Configuration Template

Field Display Policy

Migration Template

List

GET http://[host]/api/device/msgraph/Group/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

Help

Add Group

Add Team

Add Team Channel

Add Team Members

Purge

Instance API Reference

Modify

Delete

Move

Export

Tag

Get

Help

Archive Team

Get Group

Get Team

Get Team Channels

Get Team Members

Purge

Remove Team Channel

Remove Team Member

Unarchive Team

Update Group

Update Team

Update Team Channel

Update Team Member