[Index]
Model ref.: device/exchange/AdSiteLink
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": true, "readonly": false, "type": "string" }, "OrganizationId": { "__type_requested": "System.String", "required": true, "name": "OrganizationId", "title": "OrganizationId", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "ExchangeCost": { "__type_requested": "Int32", "required": true, "name": "ExchangeCost", "title": "ExchangeCost", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "description": "The ExchangeCost parameter specifies an Exchange-specific cost for the IP site link. This cost is used instead of the Active Directory-assigned cost. To clear the value of the ExchangeCost parameter and revert to using the cost of the IP site link specified in Active Directory, set the value of the ExchangeCost parameter to $null." }, "Sites": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.Directory.ADMultiValuedProperty`1[[Microsoft.Exchange.Data.Directory.ADObjectId,", "required": true, "name": "Sites", "title": "Sites", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array" }, "AdminDisplayName": { "__type_requested": "System.String", "required": true, "name": "AdminDisplayName", "title": "AdminDisplayName", "__type_mapping_type": "String", "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" }, "ADCost": { "__type_requested": "System.Int32", "required": true, "name": "ADCost", "title": "ADCost", "__type_mapping_type": "Integer", "readonly": false, "type": "integer" }, "Cost": { "__type_requested": "System.Int32", "required": true, "name": "Cost", "title": "Cost", "__type_mapping_type": "Integer", "readonly": false, "type": "integer" }, "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 name or GUID of the IP site link for which you want to view configuration information." }, "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", "description": "The Name parameter specifies a unique name for the IP site link. The name that you assign overwrites the current identity of the IP site link." }, "MaxMessageSize": { "__type_requested": "System.String", "required": true, "name": "MaxMessageSize", "title": "MaxMessageSize", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The MaxMessageSize parameter specifies the maximum size of a message that can pass across the Active Directory IP site link. The default value is unlimited.\nWhen you enter a value, qualify the value with one of the following units:\nB (bytes)\nKB (kilobytes)\nMB (megabytes)\nGB (gigabytes)\nTB (terabytes)\nUnqualified values are treated as bytes.\nThe valid input range for this parameter is from 64 KB through Int64. To remove the message size limit on an Active Directory IP site link, enter a value of unlimited." }, "WhenCreated": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "WhenCreated", "title": "WhenCreated", "format": "date-time", "required": true, "readonly": false, "type": "string" }, "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" }, "IsValid": { "__type_requested": "System.Boolean", "required": true, "name": "IsValid", "title": "IsValid", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean" }, "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" }, "ObjectState": { "__type_requested": "System.String", "required": true, "name": "ObjectState", "title": "ObjectState", "__type_mapping_type": "String", "readonly": false, "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": true, "name": "Guid", "title": "Guid", "__type_mapping_type": "String", "readonly": false, "type": "string" } }, "schema_version": "15312" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/exchange/AdSiteLink/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/exchange/AdSiteLink/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/exchange/AdSiteLink/[pkid1]", "/api/v0/device/exchange/AdSiteLink/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/exchange/AdSiteLink/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/exchange/AdSiteLink |
|
{"hrefs": ["/api/device/exchange/AdSiteLink/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/exchange/AdSiteLink |
|
{"hrefs": ["/api/device/exchange/AdSiteLink/[pkid1]", "/api/device/exchange/AdSiteLink/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/exchange/AdSiteLink; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/exchange/AdSiteLink/export/ |
|
{ "hrefs":["/api/device/exchange/AdSiteLink/[pkid1]", "/api/device/exchange/AdSiteLink/[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/AdSiteLink and the JSON format can be used to import instances of device/exchange/AdSiteLink.
GET http://[host-proxy]/api/device/exchange/AdSiteLink/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/exchange/AdSiteLink | POST | /api/device/exchange/AdSiteLink/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/exchange/AdSiteLink/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/device/exchange/AdSiteLink/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/exchange/AdSiteLink/ |
|
The device/exchange/AdSiteLink schema and all instances as JSON. |
(The list will return 0 to 3 device/exchange/AdSiteLink instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": "Name", "maximum_limit": 2000, "skip": 0, "current": "/api/device/exchange/AdSiteLink/?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": [ { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/exchange/AdSiteLink/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/AdSiteLink", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/exchange/AdSiteLink/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/AdSiteLink/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/exchange/AdSiteLink/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/exchange/AdSiteLink/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/exchange/AdSiteLink/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/exchange/AdSiteLink/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/exchange/AdSiteLink/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/exchange/AdSiteLink", "model_specific_actions": [ "get", "list", "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": "20.1.1", "tagged_versions": [] }, "resources": [] }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for device/exchange/AdSiteLink. | GET | /api/device/exchange/AdSiteLink/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/exchange/AdSiteLink as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/exchange/AdSiteLink/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/exchange/AdSiteLink/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/exchange/AdSiteLink/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/exchange/AdSiteLink | 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/AdSiteLink; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/exchange/AdSiteLink/[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/exchange/AdSiteLink and the JSON format can be used to import instances of device/exchange/AdSiteLink.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/exchange/AdSiteLink/[pkid]/ | hierarchy=[hierarchy] | The device/exchange/AdSiteLink instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/exchange/AdSiteLink/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/exchange/AdSiteLink. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/exchange/AdSiteLink/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |