API Reference for device/exchangehybrid/OrganizationRelationship

Model ref.: device/exchangehybrid/OrganizationRelationship

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

        {
     "$schema": "http://json-schema.org/draft-03/schema", 
     "type": "object", 
     "properties": {
          "OrganizationContact": {
               "__type_requested": "System.String", 
               "required": false, 
               "description": "The OrganizationContact parameter specifies the email address that can be used to contact the external organization, for example, [email protected].", 
               "title": "OrganizationContact", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "OrganizationContact"
          }, 
          "MailTipsAccessScope": {
               "__type_requested": "", 
               "required": false, 
               "description": "The MailTipsAccessScope parameter specifies a Security Distribution group in the organization that contains users for whom recipient-specific MailTips are returned over this organization relationship. The recipient-specific MailTips are:\nAuto Reply\nMailbox Full\nCustom\nIf a group is specified, these MailTips are returned only for those recipients that are members of the specified group. If a group isn't specified, recipient-specific MailTips are returned for all recipients in the organization. By default, no group is specified.\nThis restriction only applies to mailboxes, mail users, and mail contacts. It doesn't apply to distribution groups.", 
               "title": "MailTipsAccessScope", 
               "__type_mapping_type": "Unknown", 
               "name": "MailTipsAccessScope", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "TargetAutodiscoverEpr": {
               "__type_requested": "System.Uri", 
               "required": false, 
               "description": "The TargetAutodiscoverEpr parameter specifies the Autodiscover URL of Exchange Web Services for the external organization, for example, https://contoso.com/autodiscover/autodiscover.svc/wssecurity. Exchange uses the Autodiscover service to automatically detect the correct Client Access server endpoint for external requests.", 
               "title": "TargetAutodiscoverEpr", 
               "__type_mapping_type": "Unknown", 
               "name": "TargetAutodiscoverEpr", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "OrganizationId": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "OrganizationId", 
               "title": "OrganizationId", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "TargetOwaURL": {
               "__type_requested": "System.Uri", 
               "required": false, 
               "description": "The TargetOwaURL parameter specifies the Microsoft Office Outlook Web App URL of the external organization defined in the organization relationship. It is used for Outlook Web App redirection in a cross-premise Exchange scenario. Configuring this attribute enables users in the organization to use their current Outlook Web App URL to access Outlook Web App in the external organization.", 
               "title": "TargetOwaURL", 
               "__type_mapping_type": "Unknown", 
               "name": "TargetOwaURL", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "AdminDisplayName": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "AdminDisplayName", 
               "title": "AdminDisplayName", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "PSShowComputerName": {
               "__type_requested": "System.Boolean", 
               "required": false, 
               "name": "PSShowComputerName", 
               "title": "PSShowComputerName", 
               "__type_mapping_type": "Boolean", 
               "readonly": true, 
               "type": "boolean"
          }, 
          "DomainNames": {
               "__type_requested": "MultiValuedProperty", 
               "required": true, 
               "description": "This parameter is available only in on-premises Exchange 2013.\nThe DomainNames parameter specifies the SMTP domains of the external organization. If adding multiple domain names, separate each entry with a comma.", 
               "title": "DomainNames", 
               "items": {
                    "type": "string"
               }, 
               "__type_mapping_type": "String[]", 
               "readonly": false, 
               "type": "array", 
               "name": "DomainNames"
          }, 
          "DeliveryReportEnabled": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "The DeliveryReportEnabled parameter specifies whether Delivery Report data should be shared over this organization relationship.\nThe accepted values are $true or $false. The default value is $false.\nIf set to $true, this means the following two things:\nThe organization has agreed to share all Delivery Report data with the organization specified in the organization relationship.\nThis organization relationship should be used to retrieve Delivery Report information from the organization referenced in the organization relationship.\nFor message tracking to work in a cross-premise, Exchange scenario, the DeliveryReportEnabled parameter must be set to $true on both sides of the organization relationship. If one, or both, of the members of the organization relationship specifies the DeliveryReportEnabled parameter as $false, tracking between the organizations won't work in either direction.", 
               "title": "DeliveryReportEnabled", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "DeliveryReportEnabled"
          }, 
          "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"
          }, 
          "FreeBusyAccessScope": {
               "__type_requested": "", 
               "required": false, 
               "description": "The FreeBusyAccessScope parameter specifies a security distribution group in the internal organization that contains users that can have their free/busy information accessed by an external organization. You can use the following values:\nDistinguished name (DN)\nCanonical name\nGUID\nName\nDisplay name", 
               "title": "FreeBusyAccessScope", 
               "__type_mapping_type": "Unknown", 
               "name": "FreeBusyAccessScope", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "TargetApplicationUri": {
               "__type_requested": "System.Uri", 
               "required": false, 
               "description": "The TargetApplicationUri parameter specifies the target Uniform Resource Identifier (URI) of the external organization. The TargetApplicationUri parameter is specified by Exchange when requesting a delegated token for the external organization to fetch free and busy information, for example, mail.contoso.com.", 
               "title": "TargetApplicationUri", 
               "__type_mapping_type": "Unknown", 
               "name": "TargetApplicationUri", 
               "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 identity of the organizational relationship. You can use the following values:\nCanonical name\nGUID\nName"
          }, 
          "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"
          }, 
          "Name": {
               "__type_requested": "String", 
               "required": true, 
               "description": "The Name parameter specifies the meaningful name of the organization relationship.", 
               "title": "Name", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "Name"
          }, 
          "MailboxMoveEnabled": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "This parameter is available only in on-premises Exchange 2013.\nThe MailboxMoveEnabled parameter specifies whether the organization relationship is used for moving mailboxes to the external organization. If this parameter isn't set, the move requests require an administrator to provide a remote credential for the remote organization. The valid values for this parameter are $true or $false. The default value is $false.", 
               "title": "MailboxMoveEnabled", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "MailboxMoveEnabled"
          }, 
          "WhenCreatedUTC": {
               "__type_requested": "System.DateTime", 
               "__type_mapping_type": "DateTime", 
               "name": "WhenCreatedUTC", 
               "title": "WhenCreatedUTC", 
               "format": "date-time", 
               "required": false, 
               "readonly": true, 
               "type": "string"
          }, 
          "FreeBusyAccessEnabled": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "The FreeBusyAccessEnabled parameter specifies whether this organization relationship should be used for retrieving free/busy information from the external organization. The valid values for this parameter are $true or $false. The default value is $false.", 
               "title": "FreeBusyAccessEnabled", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "FreeBusyAccessEnabled"
          }, 
          "Enabled": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "The Enabled parameter specifies whether to enable the sharing relationship. This parameter can be used to completely stop sharing for a particular relationship. The valid values for this parameter are $true or $false. The default value is $true.", 
               "title": "Enabled", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "Enabled"
          }, 
          "MailTipsAccessEnabled": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "The MailTipsAccessEnabled parameter specifies whether MailTips data for users in this organization are returned over this organization relationship. The accepted values are $true or $false. The default value is $false.", 
               "title": "MailTipsAccessEnabled", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "MailTipsAccessEnabled"
          }, 
          "WhenCreated": {
               "__type_requested": "System.DateTime", 
               "__type_mapping_type": "DateTime", 
               "name": "WhenCreated", 
               "title": "WhenCreated", 
               "format": "date-time", 
               "required": false, 
               "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"
          }, 
          "MailTipsAccessLevel": {
               "__type_requested": "System.String", 
               "required": false, 
               "description": "The MailTipsAccessLevel parameter specifies the level of MailTips data that's externally shared over this organization relationship. This parameter can have the following values:\nAll All MailTips are returned, but the recipients in the remote organization are considered external. For the Auto Reply MailTip, the external Auto Reply message is returned.\nLimited Only those MailTips that could prevent a non-delivery report (NDR) or an Auto Reply are returned. Custom MailTips, the Large Audience MailTip, and Moderated Recipient MailTips won't be returned.\nNone No MailTips are returned to the remote organization.\nThe default value is None.", 
               "title": "MailTipsAccessLevel", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "MailTipsAccessLevel"
          }, 
          "FreeBusyAccessLevel": {
               "__type_requested": "System.String", 
               "required": false, 
               "description": "The FreeBusyAccessLevel parameter specifies the maximum amount of detail returned to the requesting organization.\nYou can use the following values:\nNone No free/busy access\nAvailabilityOnly Free/busy access with time only\nLimitedDetails Free/busy access with time, subject, and location", 
               "title": "FreeBusyAccessLevel", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "FreeBusyAccessLevel"
          }, 
          "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"
          }, 
          "ObjectCategory": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "ObjectCategory", 
               "title": "ObjectCategory", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "TargetSharingEpr": {
               "__type_requested": "", 
               "required": false, 
               "description": "The TargetSharingEpr parameter specifies the URL of the target Exchange Web Services for the external organization. If the TargetSharingEpr parameter is used, Exchange always uses this URL to reach the external Client Access server and doesn't use the TargetAutodiscoverEpr parameter information to locate the Client Access server.", 
               "title": "TargetSharingEpr", 
               "__type_mapping_type": "Unknown", 
               "name": "TargetSharingEpr", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "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"
          }, 
          "ArchiveAccessEnabled": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "The ArchiveAccessEnabled parameter specifies whether the organization relationship has been configured to provide remote archive access. Valid input for the ArchiveAccessEnabled parameter is $true or $false. The default value is $false. When the ArchiveAccessEnabled parameter is set to $true, the external organization specified in the organization relationship provides remote access to mailbox archives.", 
               "title": "ArchiveAccessEnabled", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "ArchiveAccessEnabled"
          }, 
          "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"
          }, 
          "PhotosEnabled": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "The PhotosEnabled parameter specifies whether photo data for users in this organization are returned over this organization relationship. The accepted values are $true or $false. The default value is $false.", 
               "title": "PhotosEnabled", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "PhotosEnabled"
          }
     }, 
     "schema_version": "15312"
}

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

Task	Call	URL	Parameters	Response
Bulk Modify	GET	/api/device/exchangehybrid/OrganizationRelationship/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/OrganizationRelationship device/exchangehybrid/OrganizationRelationship schema to create POST payload.

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

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

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

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

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

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

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

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

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

GET http://[host-proxy]/api/device/exchangehybrid/OrganizationRelationship/?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/OrganizationRelationship	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/OrganizationRelationship; optionally with tag_version at [version] and Configuration Template as [configtemplate].	GET	/api/device/exchangehybrid/OrganizationRelationship/[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

For Bulk Export, refer to the Bulk Export section.

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

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

Task	Call	URL	Parameters	Payload
Powershell Test	POST	/api/device/exchangehybrid/OrganizationRelationship/[pkid]/+powershell_test	hierarchy=[hierarchy]	If payload required:

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

API Reference for device/exchangehybrid/OrganizationRelationship

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

Help

Instance API Reference

Modify

Delete

Clone

Move

Export

Get

Help

Powershell Test

Purge