[Index]
Model ref.: device/exchangeonline/Group
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": { "RecipientTypeDetails": { "__type_requested": "System.String", "required": true, "name": "RecipientTypeDetails", "title": "RecipientTypeDetails", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The RecipientTypeDetails parameter specifies the type of recipients returned. Recipient types are divided into recipient types and subtypes. Each recipient type contains all common properties for all subtypes. For example, the type UserMailbox represents a user account in Active Directory that has an associated mailbox. Because there are several mailbox types, each mailbox type is identified by the RecipientTypeDetails parameter. For example, a conference room mailbox has RecipientTypeDetails set to ConferenceRoomMailbox, whereas a user mailbox has RecipientTypeDetails set to UserMailbox.\nYou can select from the following values:\nArbitrationMailbox\nConferenceRoomMailbox\nContact\nDiscoveryMailbox\nDynamicDistributionGroup\nEquipmentMailbox\nExternalManagedContact\nExternalManagedDistributionGroup\nLegacyMailbox\nLinkedMailbox\nMailboxPlan\nMailContact\nMailForestContact\nMailNonUniversalGroup\nMailUniversalDistributionGroup\nMailUniversalSecurityGroup\nMailUser\nPublicFolder\nRoleGroup\nRoomList\nRoomMailbox\nSharedMailbox\nSystemAttendantMailbox\nSystemMailbox\nUser\nUserMailbox" }, "DisplayName": { "__type_requested": "System.String", "required": true, "name": "DisplayName", "title": "DisplayName", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The DisplayName parameter specifies the display name of the group. The display name is visible in the Exchange admin center and in address lists. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks (\").\nThis parameter is meaningful only if the group is mail-enabled." }, "IsDirSynced": { "__type_requested": "System.Boolean", "required": true, "name": "IsDirSynced", "title": "IsDirSynced", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean" }, "PhoneticDisplayName": { "__type_requested": "System.String", "required": true, "name": "PhoneticDisplayName", "title": "PhoneticDisplayName", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The PhoneticDisplayName parameter specifies an alternate spelling of the user's name that's used for text to speech in Unified Messaging (UM) environments. Typically, you use this parameter when the pronunciation and spelling of the user's name don't match. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks (\")." }, "Sid": { "__type_requested": "System.String", "required": true, "name": "Sid", "title": "Sid", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "WhenCreatedUTC": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "WhenCreatedUTC", "title": "WhenCreatedUTC", "format": "date-time", "required": true, "readonly": false, "type": "string" }, "PSShowComputerName": { "__type_requested": "System.Boolean", "required": false, "name": "PSShowComputerName", "title": "PSShowComputerName", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "SidHistory": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.Security.Principal.SecurityIdentifier,", "required": true, "name": "SidHistory", "title": "SidHistory", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "AdministrativeUnits": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.Directory.ADMultiValuedProperty`1[[Microsoft.Exchange.Data.Directory.ADObjectId,", "required": true, "name": "AdministrativeUnits", "title": "AdministrativeUnits", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array" }, "IsHierarchicalGroup": { "__type_requested": "System.Boolean", "required": true, "name": "IsHierarchicalGroup", "title": "IsHierarchicalGroup", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "The IsHierarchicalGroup parameter specifies whether the group is part of a hierarchical address book. Valid values are $true or $false. The default value is $false." }, "ObjectClass": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,", "required": true, "name": "ObjectClass", "title": "ObjectClass", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array" }, "PSComputerName": { "__type_requested": "System.String", "required": false, "name": "PSComputerName", "title": "PSComputerName", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "ManagedBy": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.Directory.ADMultiValuedProperty`1[[Microsoft.Exchange.Data.Directory.ADObjectId,", "required": true, "name": "ManagedBy", "title": "ManagedBy", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array", "description": "The ManagedBy parameter specifies an owner for the group. A group must have at least one owner. If you don't use this parameter to specify the owner when you create the group, the user account that created the group is the owner. The group owner is able to:\nModify the properties of the group\nAdd or remove group members\nDelete the group\nApprove member depart or join requests (if available)\nApprove messages sent to the group if moderation is enabled, but no moderators are specified.\nThe owner you specify for this parameter must be a mailbox, mail user or mail-enabled security group (a mail-enabled security principal that can have permissions assigned). You can use any value that uniquely identifies the owner. For example:\nName\nDisplay name\nAlias\nDistinguished name (DN)\nCanonical DN\n<domain name>\\<account name>\nEmail address\nGUID\nLegacyExchangeDN\nSamAccountName\nUser ID or user principal name (UPN)\nTo enter multiple owners and overwrite all existing entries, use the following syntax: <owner1>,<owner2>.... If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: \"<owner1>\",\"<owner2>\"....\nTo add or remove owners without affecting other existing entries, use the following syntax: @{Add=\"<owner1>\",\"<owner2>\"...; Remove=\"<owner3>\",\"<owner4>\"...}.\n\nAn owner that you specify with this parameter isn't automatically a member of the group. You need to manually add the owner as a member." }, "Members": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.Directory.ADMultiValuedProperty`1[[Microsoft.Exchange.Data.Directory.ADObjectId,", "required": true, "name": "Members", "title": "Members", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array" }, "Identity": { "__type_requested": "System.String", "required": true, "name": "Identity", "title": "Identity", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The Identity parameter specifies the group object that you want to view. You can use any value that uniquely identifies the group.\nFor example:\nName\nDisplay name\nDistinguished name (DN)\nCanonical DN\nGUID" }, "RecipientType": { "__type_requested": "System.String", "required": true, "name": "RecipientType", "title": "RecipientType", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "SimpleDisplayName": { "__type_requested": "System.String", "required": true, "name": "SimpleDisplayName", "title": "SimpleDisplayName", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The SimpleDisplayName parameter is used to display an alternative description of the object when only a limited set of characters is permitted. Valid characters are:\na - z\nA - Z\n0 - 9\n\"<space>\", \"\"\", \"'\", \"(\", \")\", \"+\", \",\", \"-\", \".\", \"/\", \":\", and \"?\".\nThis parameter is meaningful only if the group is mail-enabled." }, "OriginatingServer": { "__type_requested": "System.String", "required": true, "name": "OriginatingServer", "title": "OriginatingServer", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "Name": { "__type_requested": "System.String", "required": true, "name": "Name", "title": "Name", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The Name parameter specifies the unique name of the group. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks (\")." }, "Notes": { "__type_requested": "System.String", "required": true, "name": "Notes", "title": "Notes", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks (\")." }, "WindowsEmailAddress": { "__type_requested": "System.String", "required": true, "name": "WindowsEmailAddress", "title": "WindowsEmailAddress", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The WindowsEmailAddress parameter specifies the Windows email address for this recipient. This is a common Active Directory attribute that's present in all environments, including environments without Exchange. Using the WindowsEmailAddress parameter on a recipient has one of the following results:\nIn on-premises environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is set to the value True for the recipient), the WindowsEmailAddress parameter has no effect on the WindowsEmailAddress property or the primary email address value.\nIn cloud environments or in on-premises environments where the recipient isn't subject to email address policies (the EmailAddressPolicyEnabled property is set to the value False for the recipient), the WindowsEmailAddress parameter updates the WindowsEmailAddress property and the primary email address to the same value.\nThe WindowsEmailAddress property is visible for the recipient in Active Directory Users and Computers in the E-mail attribute. The attribute common name is E-mail-Addresses, and the Ldap-Display-Name is mail. If you modify this attribute in Active Directory, the recipient's primary email address is not updated to the same value." }, "WhenCreated": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "WhenCreated", "title": "WhenCreated", "format": "date-time", "required": true, "readonly": false, "type": "string" }, "ExchangeVersion": { "__type_requested": "System.String", "required": true, "name": "ExchangeVersion", "title": "ExchangeVersion", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "RunspaceId": { "__type_requested": "System.Guid", "required": false, "name": "RunspaceId", "title": "RunspaceId", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "GroupType": { "__type_requested": "System.String", "required": true, "name": "GroupType", "title": "GroupType", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "SamAccountName": { "__type_requested": "System.String", "required": true, "name": "SamAccountName", "title": "SamAccountName", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "ObjectCategory": { "__type_requested": "System.String", "required": true, "name": "ObjectCategory", "title": "ObjectCategory", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "IsValid": { "__type_requested": "System.Boolean", "required": true, "name": "IsValid", "title": "IsValid", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean" }, "OrganizationId": { "__type_requested": "System.String", "required": true, "name": "OrganizationId", "title": "OrganizationId", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "DistinguishedName": { "__type_requested": "System.String", "required": true, "name": "DistinguishedName", "title": "DistinguishedName", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "WhenChanged": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "WhenChanged", "title": "WhenChanged", "format": "date-time", "required": true, "readonly": false, "type": "string" }, "WhenChangedUTC": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "WhenChangedUTC", "title": "WhenChangedUTC", "format": "date-time", "required": true, "readonly": false, "type": "string" }, "ObjectState": { "__type_requested": "System.String", "required": true, "name": "ObjectState", "title": "ObjectState", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "SeniorityIndex": { "__type_requested": "Int32", "required": true, "name": "SeniorityIndex", "title": "SeniorityIndex", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "description": "The SeniorityIndex parameter specifies the order in which this group will display in a hierarchical address book. A group with a value of 2 will display higher in an address book than a group with a value of 1." }, "Guid": { "__type_requested": "System.Guid", "required": true, "name": "Guid", "title": "Guid", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "Id": { "__type_requested": "System.String", "required": true, "name": "Id", "title": "Id", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "OrganizationalUnit": { "__type_requested": "System.String", "required": true, "name": "OrganizationalUnit", "title": "OrganizationalUnit", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example:\nName\nCanonical name\nDistinguished name (DN)\nGUID" } }, "schema_version": "2017.1" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/exchangeonline/Group/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/exchangeonline/Group/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/exchangeonline/Group/[pkid1]", "/api/v0/device/exchangeonline/Group/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/exchangeonline/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/exchangeonline/Group |
|
{"hrefs": ["/api/device/exchangeonline/Group/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/exchangeonline/Group |
|
{"hrefs": ["/api/device/exchangeonline/Group/[pkid1]", "/api/device/exchangeonline/Group/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/exchangeonline/Group; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/exchangeonline/Group/export/ |
|
{ "hrefs":["/api/device/exchangeonline/Group/[pkid1]", "/api/device/exchangeonline/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/exchangeonline/Group and the JSON format can be used to import instances of device/exchangeonline/Group.
GET http://[host-proxy]/api/device/exchangeonline/Group/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/exchangeonline/Group | POST | /api/device/exchangeonline/Group/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Configuration Template | GET | /api/device/exchangeonline/Group/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/device/exchangeonline/Group/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/exchangeonline/Group/ |
|
The device/exchangeonline/Group schema and all instances as JSON. |
(The list will return 0 to 3 device/exchangeonline/Group instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": "DisplayName", "maximum_limit": 2000, "skip": 0, "current": "/api/device/exchangeonline/Group/?skip=0&limit=3&order_by=DisplayName&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 0 }, "meta": { "tags": [], "cached": true, "title": "", "business_key": {}, "schema_version": "2017.1", "references": { "device": [ { "pkid": "", "href": "" } ], "children": [], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [] }, "actions": [ { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/exchangeonline/Group/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true", "method": "GET", "title": "Bulk Modify" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/exchangeonline/Group", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/exchangeonline/Group/export/?hierarchy=[hierarchy]", "method": "POST", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "export_bulkload_template": { "support_async": false, "class": "bulkload_template", "href": "/api/device/exchangeonline/Group/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/exchangeonline/Group/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/exchangeonline/Group/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/exchangeonline/Group/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/exchangeonline/Group/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/exchangeonline/Group/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/exchangeonline/Group", "model_specific_actions": [ "get", "list", "update", "bulk_update_form", "clone", "configuration_template", "export", "export_bulkload_template", "field_display_policy", "help", "move" ], "summary_attrs": [ { "name": "DisplayName", "title": "DisplayName" }, { "name": "Name", "title": "Name" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "resources": [] }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for device/exchangeonline/Group. | GET | /api/device/exchangeonline/Group/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/exchangeonline/Group as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/exchangeonline/Group/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/exchangeonline/Group/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/exchangeonline/Group/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/exchangeonline/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/exchangeonline/Group; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/exchangeonline/Group/[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/exchangeonline/Group and the JSON format can be used to import instances of device/exchangeonline/Group.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/exchangeonline/Group/[pkid]/ | hierarchy=[hierarchy] | The device/exchangeonline/Group instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/exchangeonline/Group/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/exchangeonline/Group. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/exchangeonline/Group/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |