[Index]
Model ref.: device/exchangehybrid/AvailabilityAddressSpace
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": { "UserName": { "__type_requested": "System.String", "required": true, "name": "UserName", "title": "UserName", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "AdminDisplayName": { "__type_requested": "System.String", "required": true, "name": "AdminDisplayName", "title": "AdminDisplayName", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "TargetAutodiscoverEpr": { "__type_requested": "Uri", "required": true, "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 Autodiscover to automatically detect the correct server endpoint for external requests.", "title": "TargetAutodiscoverEpr", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "TargetAutodiscoverEpr" }, "OrganizationId": { "__type_requested": "System.String", "required": true, "name": "OrganizationId", "title": "OrganizationId", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "ForestName": { "__type_requested": "System.String", "required": true, "name": "ForestName", "title": "ForestName", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The ForestName parameter specifies the SMTP domain name of the target forest for users whose free/busy data must be retrieved. If your users are distributed among multiple SMTP domains in the target forest, run the Add-AvailabilityAddressSpace command once for each SMTP domain." }, "WhenCreatedUTC": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "WhenCreatedUTC", "title": "WhenCreatedUTC", "format": "date-time", "required": true, "readonly": false, "type": "string" }, "PSShowComputerName": { "__type_requested": "System.Boolean", "required": false, "name": "PSShowComputerName", "title": "PSShowComputerName", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "ObjectClass": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,", "required": true, "name": "ObjectClass", "title": "ObjectClass", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array" }, "PSComputerName": { "__type_requested": "System.String", "required": false, "name": "PSComputerName", "title": "PSComputerName", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "UseServiceAccount": { "__type_requested": "System.Boolean", "required": true, "name": "UseServiceAccount", "title": "UseServiceAccount", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "This parameter is available only in on-premises Exchange 2013.\nThe UseServiceAccount parameter, when assigned a value of $true, uses the local Availability service account for authorization." }, "ObjectState": { "__type_requested": "System.String", "required": true, "name": "ObjectState", "title": "ObjectState", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "Identity": { "__type_requested": "System.String", "required": true, "name": "Identity", "title": "Identity", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The Identity parameter specifies the availability address space entry to be retrieved." }, "DistinguishedName": { "__type_requested": "System.String", "required": true, "name": "DistinguishedName", "title": "DistinguishedName", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "OriginatingServer": { "__type_requested": "System.String", "required": true, "name": "OriginatingServer", "title": "OriginatingServer", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "Name": { "__type_requested": "System.String", "required": true, "name": "Name", "title": "Name", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "ProxyUrl": { "__type_requested": "Uri", "required": true, "description": "This parameter is available only in on-premises Exchange 2013.\nThe ProxyUrl parameter specifies whether to direct a Microsoft Exchange Server 2007 Client Access server to proxy its free/busy requests through an Exchange Server 2013 Client Access server when requesting federated free/busy data for a user in another organization.\nBefore you can configure this setting, you must create the proper trust relationships and sharing relationships. For more information, see New-FederationTrust.", "title": "ProxyUrl", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "ProxyUrl" }, "ExchangeVersion": { "__type_requested": "System.String", "required": true, "name": "ExchangeVersion", "title": "ExchangeVersion", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "ObjectCategory": { "__type_requested": "System.String", "required": true, "name": "ObjectCategory", "title": "ObjectCategory", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "AccessMethod": { "__type_requested": "System.String", "required": true, "name": "AccessMethod", "title": "AccessMethod", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The AccessMethod parameter specifies the availability access method and can have the following values:\nPerUserFB This value causes the command to access the free/busy data in the defined per-user free/busy proxy account or group, or in the All Exchange Servers group. The PerUserFB value requires trust between the two forests. You must use either the UseServiceAccount parameter or Credentials parameter.\nOrgWideFB This value causes the command to access the free/busy data in the per-user free/busy proxy account or group in the target forest. You must use either the UseServiceAccount parameter or Credentials parameter.\nOrgWideFBBasic This value is reserved for internal Microsoft use.\nInternalProxy This value is used to proxy a request to the Client Access server in the site with the latest version of Exchange.\nPublicFolder This value causes the command to access free/busy data on servers running Microsoft Exchange Server 2003. The Exchange Inter-Organization Replication tool must be running between the two forests." }, "WhenChanged": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "WhenChanged", "title": "WhenChanged", "format": "date-time", "required": true, "readonly": false, "type": "string" }, "WhenChangedUTC": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "WhenChangedUTC", "title": "WhenChangedUTC", "format": "date-time", "required": true, "readonly": false, "type": "string" }, "ParentPathId": { "__type_requested": "System.String", "required": true, "name": "ParentPathId", "title": "ParentPathId", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "WhenCreated": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "WhenCreated", "title": "WhenCreated", "format": "date-time", "required": true, "readonly": false, "type": "string" }, "IsValid": { "__type_requested": "System.Boolean", "required": true, "name": "IsValid", "title": "IsValid", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean" }, "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": true, "name": "Guid", "title": "Guid", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "Id": { "__type_requested": "System.String", "required": true, "name": "Id", "title": "Id", "__type_mapping_type": "String", "readonly": false, "type": "string" } }, "schema_version": "15312" }
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk delete [pkid1],[pkid2]... | DELETE | /api/device/exchangehybrid/AvailabilityAddressSpace/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/exchangehybrid/AvailabilityAddressSpace/[pkid1]", "/api/device/exchangehybrid/AvailabilityAddressSpace/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/exchangehybrid/AvailabilityAddressSpace/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/exchangehybrid/AvailabilityAddressSpace/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/exchangehybrid/AvailabilityAddressSpace/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/exchangehybrid/AvailabilityAddressSpace/[pkid1]", "/api/v0/device/exchangehybrid/AvailabilityAddressSpace/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/exchangehybrid/AvailabilityAddressSpace/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/exchangehybrid/AvailabilityAddressSpace |
|
{"hrefs": ["/api/device/exchangehybrid/AvailabilityAddressSpace/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/exchangehybrid/AvailabilityAddressSpace |
|
{"hrefs": ["/api/device/exchangehybrid/AvailabilityAddressSpace/[pkid1]", "/api/device/exchangehybrid/AvailabilityAddressSpace/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/exchangehybrid/AvailabilityAddressSpace; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/exchangehybrid/AvailabilityAddressSpace/export/ |
|
{ "hrefs":["/api/device/exchangehybrid/AvailabilityAddressSpace/[pkid1]", "/api/device/exchangehybrid/AvailabilityAddressSpace/[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/AvailabilityAddressSpace and the JSON format can be used to import instances of device/exchangehybrid/AvailabilityAddressSpace.
GET http://[host-proxy]/api/device/exchangehybrid/AvailabilityAddressSpace/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/exchangehybrid/AvailabilityAddressSpace | POST | /api/device/exchangehybrid/AvailabilityAddressSpace/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/exchangehybrid/AvailabilityAddressSpace/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/device/exchangehybrid/AvailabilityAddressSpace/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/exchangehybrid/AvailabilityAddressSpace/ |
|
The device/exchangehybrid/AvailabilityAddressSpace schema and all instances as JSON. |
(The list will return 0 to 3 device/exchangehybrid/AvailabilityAddressSpace instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": "Name", "maximum_limit": 2000, "skip": 0, "current": "/api/device/exchangehybrid/AvailabilityAddressSpace/?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": [ { "remove": { "support_async": true, "class": "delete", "href": "/api/device/exchangehybrid/AvailabilityAddressSpace/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/exchangehybrid/AvailabilityAddressSpace/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/AvailabilityAddressSpace", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/exchangehybrid/AvailabilityAddressSpace/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/AvailabilityAddressSpace/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/exchangehybrid/AvailabilityAddressSpace/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/exchangehybrid/AvailabilityAddressSpace/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/exchangehybrid/AvailabilityAddressSpace/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/exchangehybrid/AvailabilityAddressSpace/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/exchangehybrid/AvailabilityAddressSpace/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/exchangehybrid/AvailabilityAddressSpace", "model_specific_actions": [ "powershell_add", "get", "list", "remove", "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/AvailabilityAddressSpace. | GET | /api/device/exchangehybrid/AvailabilityAddressSpace/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/exchangehybrid/AvailabilityAddressSpace as HTML |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/device/exchangehybrid/AvailabilityAddressSpace/[pkid] | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/exchangehybrid/AvailabilityAddressSpace/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/exchangehybrid/AvailabilityAddressSpace/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/exchangehybrid/AvailabilityAddressSpace | 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/AvailabilityAddressSpace; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/exchangehybrid/AvailabilityAddressSpace/[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/exchangehybrid/AvailabilityAddressSpace and the JSON format can be used to import instances of device/exchangehybrid/AvailabilityAddressSpace.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/exchangehybrid/AvailabilityAddressSpace/[pkid] | hierarchy=[hierarchy] | The device/exchangehybrid/AvailabilityAddressSpace instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/exchangehybrid/AvailabilityAddressSpace/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/exchangehybrid/AvailabilityAddressSpace. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Powershell Add | POST | /api/device/exchangehybrid/AvailabilityAddressSpace/[pkid]/+powershell_add | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/exchangehybrid/AvailabilityAddressSpace/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |