API Reference for device/exchangehybrid/RoleGroup

Model ref.: device/exchangehybrid/RoleGroup

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/exchangehybrid/RoleGroup/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema", 
     "type": "object", 
     "properties": {
          "LinkedGroup": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "LinkedGroup", 
               "title": "LinkedGroup", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "DisplayName": {
               "__type_requested": "String", 
               "required": false, 
               "description": "The DisplayName parameter specifies the friendly name of the role group. If the name contains spaces, enclose the name in quotation marks (\"). This parameter can have a maximum length of 256 characters.", 
               "title": "DisplayName", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "DisplayName"
          }, 
          "LinkedDomainController": {
               "__type_requested": "String", 
               "required": true, 
               "description": "This parameter is available only in on-premises Exchange 2013.\nThe LinkedDomainController parameter specifies the fully qualified domain name (FQDN) or IP address of the domain controller in the forest where the foreign USG resides. The domain controller you specify is used to get security information for the foreign USG specified by the LinkedForeignGroup parameter.\nIf you use the LinkedDomainController parameter, you must specify a foreign USG with the LinkedForeignGroup parameter, and you can't use the Members parameter.", 
               "title": "LinkedDomainController", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "LinkedDomainController"
          }, 
          "OrganizationId": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "OrganizationId", 
               "title": "OrganizationId", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "LinkedCredential": {
               "__type_requested": "PSCredential", 
               "required": false, 
               "description": "This parameter is available only in on-premises Exchange 2013.\nThe LinkedCredential parameter specifies credentials to use to access the domain controller specified by the LinkedDomainController parameter.\nThis parameter requires the creation and passing of a credential object. This credential object is created by using the Get-Credential cmdlet. For more information, see Get-Credential (http://go.microsoft.com/fwlink/p/?linkId=142122).", 
               "title": "LinkedCredential", 
               "__type_mapping_type": "Unknown", 
               "name": "LinkedCredential", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "Capabilities": {
               "__type_requested": "Deserialized.Microsoft.Exchange.Data.Directory.ADMultiValuedProperty`1[[Microsoft.Exchange.Data.Directory.Capability,", 
               "required": false, 
               "name": "Capabilities", 
               "title": "Capabilities", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "WhenCreatedUTC": {
               "__type_requested": "System.DateTime", 
               "__type_mapping_type": "DateTime", 
               "name": "WhenCreatedUTC", 
               "title": "WhenCreatedUTC", 
               "format": "date-time", 
               "required": false, 
               "readonly": true, 
               "type": "string"
          }, 
          "RecipientOrganizationalUnitScope": {
               "__type_requested": "OrganizationalUnitIdParameter", 
               "required": false, 
               "description": "This parameter is available only in on-premises Exchange 2013.\nThe RecipientOrganizationalUnitScope parameter specifies the organizational unit (OU) scope added to the role assignments created when the role group is created. If you use the RecipientOrganizationalUnitScope parameter, you can't use the CustomRecipientWriteScope parameter. To specify an OU, use the syntax: domain/ou. If the OU name contains spaces, enclose the domain and OU in quotation marks (\").", 
               "title": "RecipientOrganizationalUnitScope", 
               "__type_mapping_type": "Unknown", 
               "name": "RecipientOrganizationalUnitScope", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "PSShowComputerName": {
               "__type_requested": "System.Boolean", 
               "required": false, 
               "name": "PSShowComputerName", 
               "title": "PSShowComputerName", 
               "__type_mapping_type": "Boolean", 
               "readonly": true, 
               "type": "boolean"
          }, 
          "Name": {
               "__type_requested": "String", 
               "required": true, 
               "description": "The Name parameter specifies the name of the new role group. The name can have a maximum of 64 characters. If the name contains spaces, enclose the name in quotation marks (\").\nIf you create a linked role group, we recommend that you include the name of the foreign forest in the name of the role group so that you can more easily associate the linked role group and the associated foreign forest. This is especially important if you have multiple forests.", 
               "title": "Name", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "Name"
          }, 
          "LinkedForeignGroup": {
               "__type_requested": "UniversalSecurityGroupIdParameter", 
               "required": true, 
               "description": "This parameter is available only in on-premises Exchange 2013.\nThe LinkedForeignGroup parameter specifies the name of the foreign USG you want to link this role group to. If the foreign USG name contains spaces, enclose the name in quotation marks (\").\nIf you use the LinkedForeignGroup parameter, you must specify a domain controller in the LinkedDomainController parameter, and you can't use the Members parameter.", 
               "title": "LinkedForeignGroup", 
               "__type_mapping_type": "Unknown", 
               "name": "LinkedForeignGroup", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "Description": {
               "__type_requested": "String", 
               "required": false, 
               "description": "The Description parameter specifies the description that's displayed when the role group is viewed using the Get-RoleGroup cmdlet. Enclose the description in quotation marks (\").", 
               "title": "Description", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "Description"
          }, 
          "ObjectClass": {
               "__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,", 
               "required": false, 
               "name": "ObjectClass", 
               "title": "ObjectClass", 
               "items": {
                    "type": "string"
               }, 
               "__type_mapping_type": "String[]", 
               "readonly": true, 
               "type": "array"
          }, 
          "PSComputerName": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "PSComputerName", 
               "title": "PSComputerName", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "ManagedBy": {
               "__type_requested": "MultiValuedProperty", 
               "required": false, 
               "description": "The ManagedBy parameter specifies the users or USGs who can modify the configuration of a role group or add and remove members to or from a role group.\nYou can use the name, distinguished name (DN), or primary SMTP address of the user or USG that you want to add. If the name of the user or USG contains spaces, enclose the name in quotation marks (\").\nIf you want to add more than one user or USG, separate them using commas.", 
               "title": "ManagedBy", 
               "items": {
                    "type": "string"
               }, 
               "__type_mapping_type": "String[]", 
               "readonly": false, 
               "type": "array", 
               "name": "ManagedBy"
          }, 
          "PartnerManaged": {
               "__type_requested": "SwitchParameter", 
               "required": false, 
               "description": "This parameter is reserved for internal Microsoft use.", 
               "title": "PartnerManaged", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "PartnerManaged"
          }, 
          "Members": {
               "__type_requested": "MultiValuedProperty", 
               "required": false, 
               "description": "The Members parameter specifies the mailboxes or USGs to add as a member of the role group. You can use the name, DN, or primary SMTP address of the user or USG you want to add. If the name of the user or USG contains spaces, enclose the name in quotation marks (\"). If you want to add more than one user or USG, separate them using commas.\nIf you use the Members parameter, you can't use the LinkedForeignGroup, LinkedDomainController, or LinkedCredential parameters.", 
               "title": "Members", 
               "items": {
                    "type": "string"
               }, 
               "__type_mapping_type": "String[]", 
               "readonly": false, 
               "type": "array", 
               "name": "Members"
          }, 
          "CustomConfigWriteScope": {
               "__type_requested": "ManagementScopeIdParameter", 
               "required": false, 
               "description": "This parameter is available only in on-premises Exchange 2013.\nThe CustomConfigWriteScope parameter specifies the existing configuration-based management scope to associate with management role assignments created with this role group. If the management scope name contains spaces, enclose the name in quotation marks (\"). Use the Get-ManagementScope cmdlet to retrieve a list of existing management scopes.", 
               "title": "CustomConfigWriteScope", 
               "__type_mapping_type": "Unknown", 
               "name": "CustomConfigWriteScope", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "CustomRecipientWriteScope": {
               "__type_requested": "ManagementScopeIdParameter", 
               "required": false, 
               "description": "The CustomRecipientWriteScope parameter specifies the existing recipient-based management scope to associate with management role assignments created with this role group. If the management scope name contains spaces, enclose the name in quotation marks (\").\nUse the Get-ManagementScope cmdlet to retrieve a list of existing management scopes.\nIf you use the CustomRecipientWriteScope parameter, you can't use the RecipientOrganizationalUnitScope parameter.", 
               "title": "CustomRecipientWriteScope", 
               "__type_mapping_type": "Unknown", 
               "name": "CustomRecipientWriteScope", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "Identity": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "Identity", 
               "title": "Identity", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string", 
               "description": "The Identity parameter specifies the role group to retrieve. If the name of the role group contains spaces, enclose the name in quotation marks (\").\nIf the Identity parameter isn't specified, all role groups are returned."
          }, 
          "DistinguishedName": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "DistinguishedName", 
               "title": "DistinguishedName", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "OriginatingServer": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "OriginatingServer", 
               "title": "OriginatingServer", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "RoleAssignments": {
               "__type_requested": "Deserialized.Microsoft.Exchange.Data.Directory.ADMultiValuedProperty`1[[Microsoft.Exchange.Data.Directory.ADObjectId,", 
               "required": false, 
               "name": "RoleAssignments", 
               "title": "RoleAssignments", 
               "items": {
                    "type": "string"
               }, 
               "__type_mapping_type": "String[]", 
               "readonly": true, 
               "type": "array"
          }, 
          "Roles": {
               "__type_requested": "Deserialized.Microsoft.Exchange.Data.Directory.ADMultiValuedProperty`1[[Microsoft.Exchange.Data.Directory.ADObjectId,", 
               "required": false, 
               "description": "The Roles parameter specifies the management roles to assign to the role group when it's created. If a role name contains spaces, enclose the name in quotation marks (\"). If you want to assign more that one role, separate the role names with commas.\nFor a list of built-in management roles that you can assign to a role group, see Built-in management roles.", 
               "title": "Roles", 
               "items": {
                    "type": "string"
               }, 
               "__type_mapping_type": "String[]", 
               "readonly": false, 
               "type": "array", 
               "name": "Roles"
          }, 
          "LinkedPartnerOrganizationId": {
               "__type_requested": "String", 
               "required": true, 
               "description": "This parameter is reserved for internal Microsoft use.", 
               "title": "LinkedPartnerOrganizationId", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "LinkedPartnerOrganizationId"
          }, 
          "WhenCreated": {
               "__type_requested": "System.DateTime", 
               "__type_mapping_type": "DateTime", 
               "name": "WhenCreated", 
               "title": "WhenCreated", 
               "format": "date-time", 
               "required": false, 
               "readonly": true, 
               "type": "string"
          }, 
          "RoleGroupType": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "RoleGroupType", 
               "title": "RoleGroupType", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "Organization": {
               "__type_requested": "OrganizationIdParameter", 
               "required": false, 
               "description": "The Organization parameter is reserved for internal Microsoft use.", 
               "title": "Organization", 
               "__type_mapping_type": "Unknown", 
               "name": "Organization", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "ExchangeVersion": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "ExchangeVersion", 
               "title": "ExchangeVersion", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "ValidationOrganization": {
               "__type_requested": "String", 
               "required": false, 
               "description": "This parameter is reserved for internal Microsoft use.", 
               "title": "ValidationOrganization", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "ValidationOrganization"
          }, 
          "LinkedPartnerGroupId": {
               "__type_requested": "String", 
               "required": true, 
               "description": "This parameter is reserved for internal Microsoft use.", 
               "title": "LinkedPartnerGroupId", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "LinkedPartnerGroupId"
          }, 
          "ExternalDirectoryObjectId": {
               "__type_requested": "String", 
               "required": false, 
               "description": "This parameter is reserved for internal Microsoft use.", 
               "title": "ExternalDirectoryObjectId", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "ExternalDirectoryObjectId"
          }, 
          "DomainController": {
               "__type_requested": "Fqdn", 
               "required": false, 
               "description": "This parameter is available only in on-premises Exchange 2013.\nThe DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.", 
               "title": "DomainController", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "DomainController"
          }, 
          "SamAccountName": {
               "__type_requested": "String", 
               "required": false, 
               "description": "This parameter is available only in on-premises Exchange 2013.\nThe SamAccountName parameter specifies the logon name used to support clients and servers running older versions of the operating system, such as Microsoft Windows NT 4.0, Windows 98, Windows 95, and LAN Manager. This attribute must contain fewer than 20 characters.\nIf you don't specify this parameter, Active Directory creates a value for the SamAccountName parameter automatically, based on the user principal name (UPN).", 
               "title": "SamAccountName", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "SamAccountName"
          }, 
          "ObjectCategory": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "ObjectCategory", 
               "title": "ObjectCategory", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "WellKnownObjectGuid": {
               "__type_requested": "Guid", 
               "required": false, 
               "description": "This parameter is reserved for internal Microsoft use.", 
               "title": "WellKnownObjectGuid", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "WellKnownObjectGuid"
          }, 
          "IsValid": {
               "__type_requested": "System.Boolean", 
               "required": false, 
               "name": "IsValid", 
               "title": "IsValid", 
               "__type_mapping_type": "Boolean", 
               "readonly": true, 
               "type": "boolean"
          }, 
          "WhenChanged": {
               "__type_requested": "System.DateTime", 
               "__type_mapping_type": "DateTime", 
               "name": "WhenChanged", 
               "title": "WhenChanged", 
               "format": "date-time", 
               "required": false, 
               "readonly": true, 
               "type": "string"
          }, 
          "WhenChangedUTC": {
               "__type_requested": "System.DateTime", 
               "__type_mapping_type": "DateTime", 
               "name": "WhenChangedUTC", 
               "title": "WhenChangedUTC", 
               "format": "date-time", 
               "required": false, 
               "readonly": true, 
               "type": "string"
          }, 
          "ObjectState": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "ObjectState", 
               "title": "ObjectState", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "RunspaceId": {
               "__type_requested": "System.Guid", 
               "required": false, 
               "name": "RunspaceId", 
               "title": "RunspaceId", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "Guid": {
               "__type_requested": "System.Guid", 
               "required": false, 
               "name": "Guid", 
               "title": "Guid", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "Id": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "Id", 
               "title": "Id", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }
     }, 
     "schema_version": "15312"
}

Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/device/exchangehybrid/RoleGroup/add/	hierarchy=[hierarchy] format=json	The GUI Add form of device/exchangehybrid/RoleGroup 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/exchangehybrid/RoleGroup	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/exchangehybrid/RoleGroup/	hierarchy=[hierarchy]	{"hrefs":["/api/device/exchangehybrid/RoleGroup/[pkid1]", "/api/device/exchangehybrid/RoleGroup/[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/exchangehybrid/RoleGroup
```
GET http://[host-proxy]/api/device/exchangehybrid/RoleGroup/?hierarchy=[hierarchy]&format=json
```

Task	Call	URL	Parameters	Response
Bulk Modify	GET	/api/device/exchangehybrid/RoleGroup/bulk_update/?schema=&schema_rules=true	hierarchy=[hierarchy] format=json pkids=pkid1,pkid2,...	In JSON format: POST call to update the instances of device/exchangehybrid/RoleGroup device/exchangehybrid/RoleGroup schema to create POST payload.

Task	Call	URL	Parameters	Payload
Bulk Modify	POST	/api/device/exchangehybrid/RoleGroup/bulk_update/	hierarchy=[hierarchy] format=json	For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/exchangehybrid/RoleGroup/[pkid1]", "/api/v0/device/exchangehybrid/RoleGroup/[pkid2]",...]}}

To get a list of model instance pkids that are available to Bulk Modify, use the GET call:

GET http://[host-proxy]/api/device/exchangehybrid/RoleGroup/?hierarchy=[hierarchy]&format=json

The POST payload is in JSON format (refer to the Payload example) and contains:
- data in name-value update pairs according to the returned schema
- meta (empty - for a valid payload)
- request_meta with the hrefs list of instances to update

Task	Call	URL	Parameters	Payload
Move the instance with [pkid] to [target_hierarchy]	POST	/api/tool/DataMove/?model_type=device/exchangehybrid/RoleGroup	hierarchy=[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/exchangehybrid/RoleGroup/[pkid]"]}
Bulk Move	POST	/api/tool/DataMove/?model_type=device/exchangehybrid/RoleGroup	hierarchy==[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/exchangehybrid/RoleGroup/[pkid1]", "/api/device/exchangehybrid/RoleGroup/[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/exchangehybrid/RoleGroup/?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/exchangehybrid/RoleGroup; optionally with tag_version at [version] and Configuration Template as [configtemplate].	POST	/api/device/exchangehybrid/RoleGroup/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	{ "hrefs":["/api/device/exchangehybrid/RoleGroup/[pkid1]", "/api/device/exchangehybrid/RoleGroup/[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/exchangehybrid/RoleGroup and the JSON format can be used to import instances of device/exchangehybrid/RoleGroup.

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

 GET http://[host-proxy]/api/device/exchangehybrid/RoleGroup/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Get a compressed format of the Bulk Load spreadsheet template for device/exchangehybrid/RoleGroup	POST	/api/device/exchangehybrid/RoleGroup/export_bulkload_template/	hierarchy=[hierarchy] modeltype=device/exchangehybrid/RoleGroup	The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz

Task	Call	URL	Parameters	Response
Configuration Template	GET	/api/device/exchangehybrid/RoleGroup/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/exchangehybrid/RoleGroup/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
List	GET	/api/device/exchangehybrid/RoleGroup/	hierarchy=[hierarchy] format=json schema=true	The device/exchangehybrid/RoleGroup schema and all instances as JSON.

(The list will return 0 to 3 device/exchangehybrid/RoleGroup instances)

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

{
     "operations": [
          "move"
     ], 
     "pagination": {
          "direction": "asc", 
          "order_by": "DisplayName", 
          "maximum_limit": 2000, 
          "skip": 0, 
          "current": "/api/device/exchangehybrid/RoleGroup/?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": "15312", 
          "references": {
               "device": [
                    {
                         "pkid": "", 
                         "href": ""
                    }
               ], 
               "children": [], 
               "parent": [
                    {
                         "pkid": "6t0ggef2c0deab00hb595101", 
                         "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
                    }
               ], 
               "foreign_key": []
          }, 
          "actions": [
               {
                    "add": {
                         "support_async": false, 
                         "class": "add", 
                         "href": "/api/device/exchangehybrid/RoleGroup/add/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Add"
                    }
               }, 
               {
                    "remove": {
                         "support_async": true, 
                         "class": "delete", 
                         "href": "/api/device/exchangehybrid/RoleGroup/?hierarchy=[hierarchy]", 
                         "method": "DELETE", 
                         "title": "Delete"
                    }
               }, 
               {
                    "bulk_update_form": {
                         "support_async": false, 
                         "class": "update", 
                         "href": "/api/device/exchangehybrid/RoleGroup/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/exchangehybrid/RoleGroup", 
                         "method": "POST", 
                         "view": "/api/tool/DataMove/?auth_token=[authtoken]
                    }
               }, 
               {
                    "export": {
                         "title": "Export", 
                         "support_async": false, 
                         "submit": "payload", 
                         "class": "export", 
                         "href": "/api/device/exchangehybrid/RoleGroup/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/exchangehybrid/RoleGroup/export_bulkload_template/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Export Bulk Load Template"
                    }
               }, 
               {
                    "configuration_template": {
                         "support_async": false, 
                         "class": "config", 
                         "href": "/api/device/exchangehybrid/RoleGroup/configuration_template/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Configuration Template"
                    }
               }, 
               {
                    "field_display_policy": {
                         "support_async": false, 
                         "class": "display_policy", 
                         "href": "/api/device/exchangehybrid/RoleGroup/field_display_policy/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Field Display Policy"
                    }
               }, 
               {
                    "list": {
                         "support_async": false, 
                         "class": "list", 
                         "href": "/api/device/exchangehybrid/RoleGroup/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "List"
                    }
               }, 
               {
                    "help": {
                         "support_async": false, 
                         "class": "help", 
                         "href": "/api/device/exchangehybrid/RoleGroup/help?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Help"
                    }
               }, 
               {
                    "purge": {
                         "support_async": false, 
                         "class": "purge", 
                         "href": "/api/device/exchangehybrid/RoleGroup/purge/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Purge"
                    }
               }
          ], 
          "model_type": "device/exchangehybrid/RoleGroup", 
          "model_specific_actions": [
               "get", 
               "list", 
               "add", 
               "remove", 
               "update", 
               "bulk_update_form", 
               "clone", 
               "configuration_template", 
               "export", 
               "export_bulkload_template", 
               "field_display_policy", 
               "help", 
               "move"
          ], 
          "summary_attrs": [
               {
                    "name": "DisplayName", 
                    "title": "DisplayName"
               }, 
               {
                    "name": "Description", 
                    "title": "Description"
               }, 
               {
                    "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/exchangehybrid/RoleGroup.	GET	/api/device/exchangehybrid/RoleGroup/help	hierarchy=[hierarchy]	On-line help of Model ref.: device/exchangehybrid/RoleGroup as HTML

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/exchangehybrid/RoleGroup/[pkid]	hierarchy=[hierarchy]	(For payload specification)

For Bulk modification, refer to the Bulk Modify section.

Task	Call	URL	Parameters	Response
Delete	DELETE	/api/device/exchangehybrid/RoleGroup/[pkid]	hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Clone instance with [pkid]. The schema rules are applied.	GET	/api/device/exchangehybrid/RoleGroup/[pkid]/clone/?schema=&schema_rules=true	hierarchy=[hierarchy]	A JSON payload with: A POST action URL. The unchanged model [pkid] payload to be modified to create a new instance.

For the instance pkids that can cloned, refer to the List GET call for device/exchangehybrid/RoleGroup

GET http://[host-proxy]/api/device/exchangehybrid/RoleGroup/?hierarchy=[hierarchy]&format=json

Use the POST action in the response with a modification of the response payload to create the clone.

Task	Call	URL	Parameters	Payload
Move	POST	/api/tool/DataMove/[pkid]/?model_type=device/exchangehybrid/RoleGroup	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/exchangehybrid/RoleGroup; optionally with tag_version at [version] and Configuration Template as [configtemplate].	GET	/api/device/exchangehybrid/RoleGroup/[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/exchangehybrid/RoleGroup and the JSON format can be used to import instances of device/exchangehybrid/RoleGroup.

For Bulk Export, refer to the Bulk Export section.

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

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

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

API Reference for device/exchangehybrid/RoleGroup

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

Get the Add form

Create

Bulk Delete

Bulk Modify

Move

Bulk Export

Export Bulk Load Template

Configuration Template

Field Display Policy

List

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

Help

Instance API Reference

Modify

Delete

Clone

Move

Export

Get

Help

Purge