[Index]
Model ref.: device/msgraph/Groups
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"properties": {
"mailNickname": {
"required": true,
"type": "string",
"name": "mailNickname",
"title": "Mail Nickname"
},
"groupTypes": {
"items": {
"type": "string"
},
"type": "array",
"name": "groupTypes",
"title": "Group Types"
},
"displayName": {
"required": true,
"type": "string",
"name": "displayName",
"title": "Display Name"
},
"description": {
"type": "string",
"name": "description",
"title": "Description"
},
"assignedLicenses": {
"items": {
"type": "object",
"properties": {
"skuId": {
"readonly": true,
"type": "string",
"name": "SkuId",
"title": "SKU ID"
},
"disabledPlans": {
"items": {
"type": "string"
},
"readonly": true,
"type": "array",
"name": "disabledPlans",
"title": "Disabled Plans"
}
}
},
"type": "array",
"name": "assignedLicenses",
"title": "Assigned Licenses"
},
"securityEnabled": {
"type": "boolean",
"name": "securityEnabled",
"title": "Is Security Enabled"
},
"mail": {
"required": true,
"type": "string",
"name": "mail",
"title": "Mail"
},
"id": {
"type": "string",
"name": "id",
"title": "Id"
},
"mailEnabled": {
"type": "boolean",
"name": "mailEnabled",
"title": "Is Mail Enabled"
}
},
"schema_version": "1.0"
}
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/msgraph/Groups |
|
{"hrefs": ["/api/device/msgraph/Groups/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/msgraph/Groups |
|
{"hrefs": ["/api/device/msgraph/Groups/[pkid1]", "/api/device/msgraph/Groups/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/msgraph/Groups; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/msgraph/Groups/export/ |
|
{ "hrefs":["/api/device/msgraph/Groups/[pkid1]", "/api/device/msgraph/Groups/[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/Groups and the JSON format can be used to import instances of device/msgraph/Groups.
GET http://[host-proxy]/api/device/msgraph/Groups/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/device/msgraph/Groups/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/device/msgraph/Groups/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Migration Template | GET | /api/device/msgraph/Groups/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/msgraph/Groups/ |
|
The device/msgraph/Groups schema and all instances as JSON. |
(The list will return 0 to 3 device/msgraph/Groups instances)
{
"operations": [
"list"
],
"pagination": {
"direction": "asc",
"order_by": "displayName",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/msgraph/Groups/?skip=0&limit=3&order_by=displayName&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 57
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "1.0",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/msgraph/Groups",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/msgraph/Groups/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/device/msgraph/Groups/+tag/?hierarchy=[hierarchy]",
"class": "tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/msgraph/Groups/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/msgraph/Groups/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"migration": {
"support_async": false,
"class": "migration",
"href": "/api/device/msgraph/Groups/migration/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Migration Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/msgraph/Groups/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/msgraph/Groups/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/msgraph/Groups/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/msgraph/Groups",
"model_specific_actions": [
"list",
"get",
"move",
"export",
"configuration_template",
"field_display_policy",
"help",
"migration",
"tag"
],
"summary_attrs": [
{
"name": "displayName",
"title": "Display Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "mail",
"title": "Mail"
},
{
"name": "mailNickname",
"title": "Mail Nickname"
},
{
"name": "mailEnabled",
"title": "Is Mail Enabled"
},
{
"name": "securityEnabled",
"title": "Is Security Enabled"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": [
{
"pkid": "655efe1240d96fe47c254d63",
"meta": {
"tags": [],
"cached": true,
"title": "AAA_Team",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "655efa9c40d96fe47c23f429",
"href": "/api/v0/data/MSGraph/655efa9c40d96fe47c23f429"
}
],
"self": [
{
"pkid": "655efe1240d96fe47c254d63",
"href": "/api/device/msgraph/Groups/655efe1240d96fe47c254d63/"
}
],
"parent": [
{
"pkid": "655ef9d340d96fe47c238be3",
"href": "/api/data/HierarchyNode/655ef9d340d96fe47c238be3"
}
],
"foreign_key": []
},
"actions": [
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/655efe1240d96fe47c254d63/?model_type=device/msgraph/Groups",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/msgraph/Groups/655efe1240d96fe47c254d63/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/device/msgraph/Groups/655efe1240d96fe47c254d63/+tag/",
"class": "tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/msgraph/Groups/655efe1240d96fe47c254d63/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/msgraph/Groups/655efe1240d96fe47c254d63/help",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/msgraph/Groups/655efe1240d96fe47c254d63/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/msgraph/Groups",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"655ef9d340d96fe47c238be3",
"655efe1240d96fe47c254d63"
],
"summary_attrs": [
{
"name": "displayName",
"title": "Display Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "mail",
"title": "Mail"
},
{
"name": "mailNickname",
"title": "Mail Nickname"
},
{
"name": "mailEnabled",
"title": "Is Mail Enabled"
},
{
"name": "securityEnabled",
"title": "Is Security Enabled"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"mailNickname": "AAA_Team",
"groupTypes": [
"Unified"
],
"displayName": "AAA_Team",
"description": "Team of AAAs",
"hierarchy": "655ef9d340d96fe47c238be3",
"securityEnabled": false,
"mailEnabled": true,
"mail": "[email protected]",
"hierarchy_friendly_name": "VossAutoBuild (Customer)",
"summary_device": "Connection parameters for Microsoft Graph Auto Build Tenant, Auto Build Tenant, hcs.CS-P.CS-NB.VossAutoBuild",
"id": "c2e659ae-6449-4a23-bd86-a026be5dcc97",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.VossAutoBuild"
}
},
{
"pkid": "655efe2740d96fe47c2557f4",
"meta": {
"tags": [],
"cached": true,
"title": "All Company",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "655efa9c40d96fe47c23f429",
"href": "/api/v0/data/MSGraph/655efa9c40d96fe47c23f429"
}
],
"self": [
{
"pkid": "655efe2740d96fe47c2557f4",
"href": "/api/device/msgraph/Groups/655efe2740d96fe47c2557f4/"
}
],
"parent": [
{
"pkid": "655ef9d340d96fe47c238be3",
"href": "/api/data/HierarchyNode/655ef9d340d96fe47c238be3"
}
],
"foreign_key": []
},
"actions": [
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/655efe2740d96fe47c2557f4/?model_type=device/msgraph/Groups",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/msgraph/Groups/655efe2740d96fe47c2557f4/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"class": "tag",
"href": "/api/device/msgraph/Groups/655efe2740d96fe47c2557f4/+tag/",
"method": "PATCH",
"view": "/api/view/TagNameForm/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/device/msgraph/Groups/655efe2740d96fe47c2557f4/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/device/msgraph/Groups/655efe2740d96fe47c2557f4/help",
"title": "Help",
"class": "help",
"method": "GET"
}
},
{
"purge": {
"support_async": false,
"href": "/api/device/msgraph/Groups/655efe2740d96fe47c2557f4/purge/",
"title": "Purge",
"class": "purge",
"method": "POST"
}
}
],
"model_type": "device/msgraph/Groups",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"655ef9d340d96fe47c238be3",
"655efe2740d96fe47c2557f4"
],
"summary_attrs": [
{
"name": "displayName",
"title": "Display Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "mail",
"title": "Mail"
},
{
"name": "mailNickname",
"title": "Mail Nickname"
},
{
"name": "mailEnabled",
"title": "Is Mail Enabled"
},
{
"name": "securityEnabled",
"title": "Is Security Enabled"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"mailNickname": "allcompany",
"groupTypes": [
"Unified"
],
"displayName": "All Company",
"description": "This is the default group for everyone in the network",
"hierarchy": "655ef9d340d96fe47c238be3",
"securityEnabled": false,
"mailEnabled": true,
"mail": "[email protected]",
"hierarchy_friendly_name": "VossAutoBuild (Customer)",
"summary_device": "Connection parameters for Microsoft Graph Auto Build Tenant, Auto Build Tenant, hcs.CS-P.CS-NB.VossAutoBuild",
"id": "842e1dbd-4509-4d75-b268-eecc6f327891",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.VossAutoBuild"
}
},
{
"pkid": "655efe1040d96fe47c254c9f",
"meta": {
"tags": [],
"cached": true,
"title": "All_STAFF",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "655efa9c40d96fe47c23f429",
"href": "/api/v0/data/MSGraph/655efa9c40d96fe47c23f429"
}
],
"self": [
{
"pkid": "655efe1040d96fe47c254c9f",
"href": "/api/device/msgraph/Groups/655efe1040d96fe47c254c9f/"
}
],
"parent": [
{
"pkid": "655ef9d340d96fe47c238be3",
"href": "/api/data/HierarchyNode/655ef9d340d96fe47c238be3"
}
],
"foreign_key": []
},
"actions": [
{
"move": {
"title": "Move",
"support_async": true,
"method": "POST",
"href": "/api/tool/DataMove/655efe1040d96fe47c254c9f/?model_type=device/msgraph/Groups",
"class": "move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/device/msgraph/Groups/655efe1040d96fe47c254c9f/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"class": "tag",
"href": "/api/device/msgraph/Groups/655efe1040d96fe47c254c9f/+tag/",
"method": "PATCH",
"view": "/api/view/TagNameForm/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/device/msgraph/Groups/655efe1040d96fe47c254c9f/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/device/msgraph/Groups/655efe1040d96fe47c254c9f/help",
"class": "help",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"method": "POST",
"href": "/api/device/msgraph/Groups/655efe1040d96fe47c254c9f/purge/",
"class": "purge",
"title": "Purge"
}
}
],
"model_type": "device/msgraph/Groups",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"655ef9d340d96fe47c238be3",
"655efe1040d96fe47c254c9f"
],
"summary_attrs": [
{
"name": "displayName",
"title": "Display Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "mail",
"title": "Mail"
},
{
"name": "mailNickname",
"title": "Mail Nickname"
},
{
"name": "mailEnabled",
"title": "Is Mail Enabled"
},
{
"name": "securityEnabled",
"title": "Is Security Enabled"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"mailNickname": "All_STAFF",
"displayName": "All_STAFF",
"hierarchy": "655ef9d340d96fe47c238be3",
"securityEnabled": false,
"mailEnabled": true,
"mail": "[email protected]",
"hierarchy_friendly_name": "VossAutoBuild (Customer)",
"summary_device": "Connection parameters for Microsoft Graph Auto Build Tenant, Auto Build Tenant, hcs.CS-P.CS-NB.VossAutoBuild",
"id": "097f6211-4a8d-4144-ba3c-422da49507ce",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.VossAutoBuild"
}
}
]
}
(Show the first instance)
{
"pkid": "655efe1240d96fe47c254d63",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "AAA_Team",
"business_key": {},
"schema_version": "",
"references": {
"parent": [
{
"pkid": "655ef9d340d96fe47c238be3",
"href": "/api/data/HierarchyNode/655ef9d340d96fe47c238be3"
}
],
"self": [
{
"pkid": "655efe1240d96fe47c254d63",
"href": "/api/device/msgraph/Groups/655efe1240d96fe47c254d63/"
}
],
"foreign_key": [],
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "655efa9c40d96fe47c23f429",
"href": "/api/v0/data/MSGraph/655efa9c40d96fe47c23f429"
}
],
"children": []
},
"actions": [
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/655efe1240d96fe47c254d63/?hierarchy=[hierarchy]&model_type=device/msgraph/Groups",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/msgraph/Groups/655efe1240d96fe47c254d63/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/device/msgraph/Groups/655efe1240d96fe47c254d63/+tag/?hierarchy=[hierarchy]",
"class": "tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/msgraph/Groups/655efe1240d96fe47c254d63/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/msgraph/Groups/655efe1240d96fe47c254d63/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/msgraph/Groups/655efe1240d96fe47c254d63/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/msgraph/Groups",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"655ef9d340d96fe47c238be3",
"655efe1240d96fe47c254d63"
],
"summary_attrs": [
{
"name": "displayName",
"title": "Display Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "mail",
"title": "Mail"
},
{
"name": "mailNickname",
"title": "Mail Nickname"
},
{
"name": "mailEnabled",
"title": "Is Mail Enabled"
},
{
"name": "securityEnabled",
"title": "Is Security Enabled"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"mailNickname": "AAA_Team",
"groupTypes": [
"Unified"
],
"displayName": "AAA_Team",
"description": "Team of AAAs",
"hierarchy": "655ef9d340d96fe47c238be3",
"securityEnabled": false,
"mail": "[email protected]",
"id": "c2e659ae-6449-4a23-bd86-a026be5dcc97",
"mailEnabled": true
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/msgraph/Groups. | GET | /api/device/msgraph/Groups/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/msgraph/Groups as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/msgraph/Groups | 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/Groups; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/msgraph/Groups/[pkid]/export |
|
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/Groups and the JSON format can be used to import instances of device/msgraph/Groups.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/device/msgraph/Groups/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/msgraph/Groups/[pkid] | hierarchy=[hierarchy] | The device/msgraph/Groups instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/msgraph/Groups/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/msgraph/Groups. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/msgraph/Groups/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |