[Index]
Model ref.: device/exchangeonline/IntraOrganizationConnector
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{ "$schema": "http://json-schema.org/draft-03/schema", "type": "object", "properties": { "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" }, "DiscoveryEndpoint": { "__type_requested": "System.Uri", "required": true, "description": "The DiscoveryEndpoint parameter specifies the externally-accessible URL that's used for the Autodiscover service for the domain that's configured in the Intra-Organization connector.", "title": "DiscoveryEndpoint", "__type_mapping_type": "Unknown", "name": "DiscoveryEndpoint", "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" }, "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" }, "TargetAddressDomains": { "__type_requested": "MultiValuedProperty", "required": true, "description": "The TargetAddressDomains parameter specifies the domain namespaces that will be used in the Intra-organization connector. These domains must have valid Autodiscover endpoints defined in their organizations. The domains and their associated Autodiscover endpoints are used by the Intra-Organization connector for feature and service connectivity.\nYou specify multiple domain values separated by commas.", "title": "TargetAddressDomains", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array", "name": "TargetAddressDomains" }, "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 Intra-Organization connector that you want to view. You can use any value that uniquely identifies the connector. For example:\nName\nDistinguished name (DN)\nGUID" }, "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 a friendly name for the Intra-Organization connector. If the value contains spaces, enclose the value in double quotation marks.", "title": "Name", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Name" }, "Enabled": { "__type_requested": "$true | $false", "required": false, "description": "The Enabled parameter enables or disabled the Intra-organization connector. The valid values for this parameter are $true or $false. The default value is $true.\nWhen you set the value to $false, you completely stop connectivity for the specific connection.", "title": "Enabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "Enabled" }, "WhenCreated": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "WhenCreated", "title": "WhenCreated", "format": "date-time", "required": false, "readonly": true, "type": "string" }, "ExchangeVersion": { "__type_requested": "System.String", "required": false, "name": "ExchangeVersion", "title": "ExchangeVersion", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "DomainController": { "__type_requested": "Fqdn", "required": false, "description": "This parameter is available only in on-premises Exchange 2016.\nThe DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.", "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" }, "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": "2017.1" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/device/exchangeonline/IntraOrganizationConnector/add/ |
|
The GUI Add form of device/exchangeonline/IntraOrganizationConnector 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/exchangeonline/IntraOrganizationConnector | hierarchy=[hierarchy] |
|
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/exchangeonline/IntraOrganizationConnector/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/exchangeonline/IntraOrganizationConnector/[pkid1]", "/api/device/exchangeonline/IntraOrganizationConnector/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/exchangeonline/IntraOrganizationConnector/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/exchangeonline/IntraOrganizationConnector/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/exchangeonline/IntraOrganizationConnector/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/exchangeonline/IntraOrganizationConnector/[pkid1]", "/api/v0/device/exchangeonline/IntraOrganizationConnector/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/exchangeonline/IntraOrganizationConnector/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/exchangeonline/IntraOrganizationConnector |
|
{"hrefs": ["/api/device/exchangeonline/IntraOrganizationConnector/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/exchangeonline/IntraOrganizationConnector |
|
{"hrefs": ["/api/device/exchangeonline/IntraOrganizationConnector/[pkid1]", "/api/device/exchangeonline/IntraOrganizationConnector/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/exchangeonline/IntraOrganizationConnector; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/exchangeonline/IntraOrganizationConnector/export/ |
|
{ "hrefs":["/api/device/exchangeonline/IntraOrganizationConnector/[pkid1]", "/api/device/exchangeonline/IntraOrganizationConnector/[pkid2]",...]}} |
For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip Content-Language:en Content-Type:application/x-zip
For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx Content-Language:en Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx Content-Language:en Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
The XLSX format can be used to bulk load instances of device/exchangeonline/IntraOrganizationConnector and the JSON format can be used to import instances of device/exchangeonline/IntraOrganizationConnector.
GET http://[host-proxy]/api/device/exchangeonline/IntraOrganizationConnector/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/exchangeonline/IntraOrganizationConnector | POST | /api/device/exchangeonline/IntraOrganizationConnector/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Configuration Template | GET | /api/device/exchangeonline/IntraOrganizationConnector/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/device/exchangeonline/IntraOrganizationConnector/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/exchangeonline/IntraOrganizationConnector/ |
|
The device/exchangeonline/IntraOrganizationConnector schema and all instances as JSON. |
(The list will return 0 to 3 device/exchangeonline/IntraOrganizationConnector instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": "Name", "maximum_limit": 2000, "skip": 0, "current": "/api/device/exchangeonline/IntraOrganizationConnector/?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": "2017.1", "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/exchangeonline/IntraOrganizationConnector/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/exchangeonline/IntraOrganizationConnector/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/exchangeonline/IntraOrganizationConnector/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true", "method": "GET", "title": "Bulk Modify" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/exchangeonline/IntraOrganizationConnector", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/exchangeonline/IntraOrganizationConnector/export/?hierarchy=[hierarchy]", "method": "POST", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "export_bulkload_template": { "support_async": false, "class": "bulkload_template", "href": "/api/device/exchangeonline/IntraOrganizationConnector/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/exchangeonline/IntraOrganizationConnector/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/exchangeonline/IntraOrganizationConnector/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/exchangeonline/IntraOrganizationConnector/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/exchangeonline/IntraOrganizationConnector/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/exchangeonline/IntraOrganizationConnector/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/exchangeonline/IntraOrganizationConnector", "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/exchangeonline/IntraOrganizationConnector. | GET | /api/device/exchangeonline/IntraOrganizationConnector/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/exchangeonline/IntraOrganizationConnector as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/exchangeonline/IntraOrganizationConnector/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/device/exchangeonline/IntraOrganizationConnector/[pkid] | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/exchangeonline/IntraOrganizationConnector/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/exchangeonline/IntraOrganizationConnector/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/exchangeonline/IntraOrganizationConnector | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a selected [export_format] of the schema and a single instance with [pkid] of device/exchangeonline/IntraOrganizationConnector; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/exchangeonline/IntraOrganizationConnector/[pkid]/export |
|
The response is an attachment. Refer to the list below. |
For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx Content-Language:en Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx Content-Language:en Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=json, the response is a time stamped zip file of data in JSON and a response format:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip Content-Language:en Content-Type:application/x-zip
The XLSX format can be used to bulk load instances of device/exchangeonline/IntraOrganizationConnector and the JSON format can be used to import instances of device/exchangeonline/IntraOrganizationConnector.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/exchangeonline/IntraOrganizationConnector/[pkid] | hierarchy=[hierarchy] | The device/exchangeonline/IntraOrganizationConnector instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/exchangeonline/IntraOrganizationConnector/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/exchangeonline/IntraOrganizationConnector. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/exchangeonline/IntraOrganizationConnector/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |