API Reference for device/exchange/ManagementRoleAssignment

Model ref.: device/exchange/ManagementRoleAssignment

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

        {
     "$schema": "http://json-schema.org/draft-03/schema", 
     "type": "object", 
     "properties": {
          "WhenCreatedUTC": {
               "__type_requested": "System.DateTime", 
               "__type_mapping_type": "DateTime", 
               "name": "WhenCreatedUTC", 
               "title": "WhenCreatedUTC", 
               "format": "date-time", 
               "required": false, 
               "readonly": true, 
               "type": "string"
          }, 
          "OrganizationId": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "OrganizationId", 
               "title": "OrganizationId", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "RecipientRelativeWriteScope": {
               "__type_requested": "None | NotApplicable | Organization | MyGAL | Self | MyDirectReports | OU | CustomRecipientScope | MyDistributionGroups | MyExecutive | ExclusiveRecipientScope | MailboxICanDelegate", 
               "required": false, 
               "description": "The RecipientRelativeWriteScope parameter specifies the type of restriction to apply to a recipient scope. The available types are None, Organization, MyGAL, Self, and MyDistributionGroups. The RecipientRelativeWriteScope parameter is automatically set when the CustomRecipientWriteScope or RecipientOrganizationalUnitScope parameters are used.\nEven though the NotApplicable, OU, MyDirectReports, CustomRecipientScope, MyExecutive, MailboxICanDelegate and ExclusiveRecipientScope values appear in the syntax block for this parameter, they can't be used directly on the command line. They are used internally by the cmdlet.", 
               "title": "RecipientRelativeWriteScope", 
               "__type_mapping_type": "Unknown", 
               "name": "RecipientRelativeWriteScope", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "EffectiveUserName": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "EffectiveUserName", 
               "title": "EffectiveUserName", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "SecurityGroup": {
               "__type_requested": "SecurityGroupIdParameter", 
               "required": true, 
               "description": "The SecurityGroup parameter specifies the name of the management role group or universal USG to assign the management role to.\nIf you specify the SecurityGroup parameter, you can't specify the Policy, Computer, or User parameters. If the role group or USG name contains spaces, enclose the name in quotation marks (\").", 
               "title": "SecurityGroup", 
               "__type_mapping_type": "Unknown", 
               "name": "SecurityGroup", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "RecipientWriteScope": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "RecipientWriteScope", 
               "title": "RecipientWriteScope", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string", 
               "description": "The RecipientWriteScope parameter returns only the role assignments associated with the recipient scope restriction type specified. The valid values are None, MyGAL, Self, OU, CustomRecipientScope, MyDistributionGroups, and ExclusiveRecipientScope."
          }, 
          "Role": {
               "__type_requested": "System.String", 
               "required": true, 
               "description": "The Role parameter specifies the existing role to assign. If the role name contains spaces, enclose the name in quotation marks (\").", 
               "title": "Role", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "Role"
          }, 
          "RoleAssignmentDelegationType": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "RoleAssignmentDelegationType", 
               "title": "RoleAssignmentDelegationType", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "Policy": {
               "__type_requested": "MailboxPolicyIdParameter", 
               "required": true, 
               "description": "The Policy parameter specifies the name of the management role assignment policy to assign the management role to.\nThe IsEndUserRole property of the role you specify using the Role parameter must be set to $true.\nIf you specify the Policy parameter, you can't specify the SecurityGroup, Computer, or User parameters. If the policy name contains spaces, enclose the name in quotation marks (\").", 
               "title": "Policy", 
               "__type_mapping_type": "Unknown", 
               "name": "Policy", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "RecipientOrganizationalUnitScope": {
               "__type_requested": "OrganizationalUnitIdParameter", 
               "required": false, 
               "description": "The RecipientOrganizationalUnitScope parameter specifies the OU to scope the new role assignment to. If you use the RecipientOrganizationalUnitScope parameter, you can't use the CustomRecipientWriteScope or ExclusiveRecipientWriteScope parameters. 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": false, 
               "description": "The Name parameter specifies a name for the new management role assignment. The maximum length of the name is 64 characters. If the management role assignment name contains spaces, enclose the name in quotation marks (\"). If you don't specify a name, one will be created automatically.", 
               "title": "Name", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "Name"
          }, 
          "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"
          }, 
          "DataObject": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "DataObject", 
               "title": "DataObject", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "Computer": {
               "__type_requested": "ComputerIdParameter", 
               "required": true, 
               "description": "The Computer parameter specifies the name of the computer to assign the management role to.\nIf you specify the Computer parameter, you can't specify the SecurityGroup, User, or Policy parameters.", 
               "title": "Computer", 
               "__type_mapping_type": "Unknown", 
               "name": "Computer", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "User": {
               "__type_requested": "System.String", 
               "required": true, 
               "description": "The User parameter specifies the name or alias of the user to assign the management role to.\nIf you specify the User parameter, you can't specify the SecurityGroup, Computer, or Policy parameters. If the value contains spaces, enclose the name in quotation marks (\").", 
               "title": "User", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "User"
          }, 
          "CustomConfigWriteScope": {
               "__type_requested": "", 
               "required": false, 
               "description": "The CustomConfigWriteScope parameter specifies the existing configuration scope to associate with this management role assignment. If you use the CustomConfigWriteScope parameter you can't use the ExclusiveConfigWriteScope parameter. If the management scope name contains spaces, enclose the name in quotation marks (\").", 
               "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"
          }, 
          "ExclusiveConfigWriteScope": {
               "__type_requested": "ManagementScopeIdParameter", 
               "required": false, 
               "description": "The ExclusiveConfigWriteScope parameter specifies the exclusive configuration-based management scope to associate with the new role assignment. If you use the ExclusiveConfigWriteScope parameter, you can't use the CustomConfigWriteScope parameter. If the scope name contains spaces, enclose the name in quotation marks (\").", 
               "title": "ExclusiveConfigWriteScope", 
               "__type_mapping_type": "Unknown", 
               "name": "ExclusiveConfigWriteScope", 
               "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 name of the role assignment to retrieve. If the name of the role assignment contains spaces, enclose it in quotation marks (\"). If the RoleAssignee parameter is used, you can't use the Identity parameter."
          }, 
          "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"
          }, 
          "RoleAssignee": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "RoleAssignee", 
               "title": "RoleAssignee", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string", 
               "description": "The RoleAssignee parameter specifies the role group, assignment policy, user, or universal security group (USG) for which you want to view role assignments. If the RoleAssignee parameter is used, you can't use the Identity parameter.\nBy default, the command returns both direct role assignments to the role assignee, and indirect role assignments granted to a role assignee through role groups or assignment policies.\nIf the name of the user or USG contains spaces, enclose it in quotation marks (\")."
          }, 
          "Enabled": {
               "__type_requested": "System.Boolean", 
               "required": false, 
               "name": "Enabled", 
               "title": "Enabled", 
               "__type_mapping_type": "Boolean", 
               "readonly": true, 
               "type": "boolean", 
               "description": "The Enabled parameter specifies whether enabled or disabled role assignments should be returned. To return enabled role assignments, specify a value of $true. To return disabled role assignments, specify a value of $false."
          }, 
          "RoleAssigneeName": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "RoleAssigneeName", 
               "title": "RoleAssigneeName", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "RoleAssigneeType": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "RoleAssigneeType", 
               "title": "RoleAssigneeType", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string", 
               "description": "The RoleAssigneeType parameter specifies the type of role assignee to return. The valid values are User, SecurityGroup, RoleAssignmentPolicy, ForeignSecurityPrincipal, RoleGroup,LinkedRoleGroup, and Computer."
          }, 
          "WhenCreated": {
               "__type_requested": "System.DateTime", 
               "__type_mapping_type": "DateTime", 
               "name": "WhenCreated", 
               "title": "WhenCreated", 
               "format": "date-time", 
               "required": false, 
               "readonly": true, 
               "type": "string"
          }, 
          "IgnoreDehydratedFlag": {
               "__type_requested": "SwitchParameter", 
               "required": false, 
               "description": "This parameter is reserved for internal Microsoft use.", 
               "title": "IgnoreDehydratedFlag", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "IgnoreDehydratedFlag"
          }, 
          "ExclusiveRecipientWriteScope": {
               "__type_requested": "ManagementScopeIdParameter", 
               "required": false, 
               "description": "The ExclusiveRecipientWriteScope parameter specifies the exclusive recipient-based management scope to associate with the new role assignment. If you use the ExclusiveRecipientWriteScope parameter, you can't use the CustomRecipientWriteScope or RecipientOrganizationalUnitScope parameters. If the scope name contains spaces, enclose the name in quotation marks (\").", 
               "title": "ExclusiveRecipientWriteScope", 
               "__type_mapping_type": "Unknown", 
               "name": "ExclusiveRecipientWriteScope", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly 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"
          }, 
          "UnScopedTopLevel": {
               "__type_requested": "SwitchParameter", 
               "required": false, 
               "description": "The UnScopedTopLevel switch specifies that the role provided with the Role parameter is an unscoped top level management role. You can only create a role assignment using the UnScopedTopLevel switch if the role specified using the Role parameter is an unscoped top level role.", 
               "title": "UnScopedTopLevel", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "UnScopedTopLevel"
          }, 
          "Delegating": {
               "__type_requested": "SwitchParameter", 
               "required": false, 
               "description": "The Delegating parameter specifies whether the user or USG assigned to the role can delegate the role to other users or groups. You don't have to specify a value with the Delegating parameter.", 
               "title": "Delegating", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "Delegating"
          }, 
          "AssignmentChain": {
               "__type_requested": "", 
               "required": false, 
               "name": "AssignmentChain", 
               "title": "AssignmentChain", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "ConfigWriteScope": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "ConfigWriteScope", 
               "title": "ConfigWriteScope", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string", 
               "description": "The ConfigWriteScope parameter specifies the type of management configuration scope to include in the results returned by the cmdlet. The valid values are None, OrganizationConfig, CustomConfigScope, and ExclusiveConfigScope."
          }, 
          "DomainController": {
               "__type_requested": "Fqdn", 
               "required": false, 
               "description": "The 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"
          }, 
          "ObjectCategory": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "ObjectCategory", 
               "title": "ObjectCategory", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "CustomRecipientWriteScope": {
               "__type_requested": "", 
               "required": false, 
               "description": "The CustomRecipientWriteScope parameter specifies the existing recipient-based management scope to associate with this management role assignment. If the management scope name contains spaces, enclose the name in quotation marks (\"). If you use the CustomRecipientWriteScope parameter, you can't use the RecipientOrganizationalUnitScope or ExclusiveRecipientWriteScope parameters.", 
               "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"
          }, 
          "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"
          }, 
          "RecipientReadScope": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "RecipientReadScope", 
               "title": "RecipientReadScope", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "ObjectState": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "ObjectState", 
               "title": "ObjectState", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "AssignmentMethod": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "AssignmentMethod", 
               "title": "AssignmentMethod", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string", 
               "description": "The AssignmentMethod parameter specifies the type of role assignment to include in the results returned by the cmdlet. You can specify one or more of the following values:\nDirect\nSecurityGroup\nRoleGroup\nRoleAssignmentPolicy\nIf you provide more than one value, separate each value with a comma.\nYou must specify a value with the RoleAssignee parameter if you use the AssignmentMethod parameter."
          }, 
          "IsValid": {
               "__type_requested": "System.Boolean", 
               "required": false, 
               "name": "IsValid", 
               "title": "IsValid", 
               "__type_mapping_type": "Boolean", 
               "readonly": true, 
               "type": "boolean"
          }, 
          "ConfigReadScope": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "ConfigReadScope", 
               "title": "ConfigReadScope", 
               "__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"
          }
     }, 
     "schema_version": "15312"
}

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

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

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

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

 GET http://[host-proxy]/api/device/exchange/ManagementRoleAssignment/?hierarchy=[hierarchy]

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

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

(The list will return 0 to 3 device/exchange/ManagementRoleAssignment instances)

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

{
     "operations": [
          "move"
     ], 
     "pagination": {
          "direction": "asc", 
          "order_by": "Name", 
          "maximum_limit": 2000, 
          "skip": 0, 
          "current": "/api/device/exchange/ManagementRoleAssignment/?skip=0&limit=3&order_by=Name&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/exchange/ManagementRoleAssignment/add/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Add"
                    }
               }, 
               {
                    "remove": {
                         "support_async": true, 
                         "class": "delete", 
                         "href": "/api/device/exchange/ManagementRoleAssignment/?hierarchy=[hierarchy]", 
                         "method": "DELETE", 
                         "title": "Delete"
                    }
               }, 
               {
                    "bulk_update_form": {
                         "support_async": false, 
                         "class": "update", 
                         "href": "/api/device/exchange/ManagementRoleAssignment/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/exchange/ManagementRoleAssignment", 
                         "method": "POST", 
                         "view": "/api/tool/DataMove/?auth_token=[authtoken]
                    }
               }, 
               {
                    "export": {
                         "title": "Export", 
                         "support_async": false, 
                         "submit": "payload", 
                         "class": "export", 
                         "href": "/api/device/exchange/ManagementRoleAssignment/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/exchange/ManagementRoleAssignment/export_bulkload_template/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Export Bulk Load Template"
                    }
               }, 
               {
                    "configuration_template": {
                         "support_async": false, 
                         "class": "config", 
                         "href": "/api/device/exchange/ManagementRoleAssignment/configuration_template/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Configuration Template"
                    }
               }, 
               {
                    "field_display_policy": {
                         "support_async": false, 
                         "class": "display_policy", 
                         "href": "/api/device/exchange/ManagementRoleAssignment/field_display_policy/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Field Display Policy"
                    }
               }, 
               {
                    "list": {
                         "support_async": false, 
                         "class": "list", 
                         "href": "/api/device/exchange/ManagementRoleAssignment/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "List"
                    }
               }, 
               {
                    "help": {
                         "support_async": false, 
                         "class": "help", 
                         "href": "/api/device/exchange/ManagementRoleAssignment/help?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Help"
                    }
               }, 
               {
                    "purge": {
                         "support_async": false, 
                         "class": "purge", 
                         "href": "/api/device/exchange/ManagementRoleAssignment/purge/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Purge"
                    }
               }
          ], 
          "model_type": "device/exchange/ManagementRoleAssignment", 
          "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": "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/exchange/ManagementRoleAssignment.	GET	/api/device/exchange/ManagementRoleAssignment/help	hierarchy=[hierarchy]	On-line help of Model ref.: device/exchange/ManagementRoleAssignment 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/exchange/ManagementRoleAssignment/[pkid]	hierarchy=[hierarchy]	(For payload specification)

For Bulk modification, refer to the Bulk Modify section.

Task	Call	URL	Parameters	Response
Delete	DELETE	/api/device/exchange/ManagementRoleAssignment/[pkid]	hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Clone instance with [pkid]. The schema rules are applied.	GET	/api/device/exchange/ManagementRoleAssignment/[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/exchange/ManagementRoleAssignment

GET http://[host-proxy]/api/device/exchange/ManagementRoleAssignment/?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/exchange/ManagementRoleAssignment	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/exchange/ManagementRoleAssignment; optionally with tag_version at [version] and Configuration Template as [configtemplate].	GET	/api/device/exchange/ManagementRoleAssignment/[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/exchange/ManagementRoleAssignment and the JSON format can be used to import instances of device/exchange/ManagementRoleAssignment.

For Bulk Export, refer to the Bulk Export section.

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

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

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

API Reference for device/exchange/ManagementRoleAssignment

GET http://[host-proxy]/api/device/exchange/ManagementRoleAssignment/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/exchange/ManagementRoleAssignment/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

Help

Instance API Reference

Modify

Delete

Clone

Move

Export

Get

Help

Purge