API Reference for device/exchange/WebServicesVirtualDirectory

Model ref.: device/exchange/WebServicesVirtualDirectory

The full URL would include the host-proxy name: https://[host-proxy].

Variables are enclosed in square brackets.

[hierarchy] is the hierarchy.
1. as UUID. For example: 6t0ggef2c0deab00hb595101
2. in dot notation. E.g. ProviderName.CustomerName.LocationName

For a list of available UUIDs and their dot notations:
GET /api/v0/data/HierarchyNode/?format=json

[pkid] is the ID of the resource instance. Refer to the List reference below.
[filename] refers to a file

GET http://[host-proxy]/api/device/exchange/WebServicesVirtualDirectory/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema", 
     "type": "object", 
     "properties": {
          "CertificateAuthentication": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "name": "CertificateAuthentication", 
               "title": "CertificateAuthentication", 
               "__type_mapping_type": "Boolean", 
               "readonly": true, 
               "type": "boolean", 
               "description": "The CertificateAuthentication parameter specifies whether certificate authentication is enabled. This parameter affects the <Servername>/ews/management/ virtual directory. It doesn't affect the <Servername>/ews/ virtual directory."
          }, 
          "AdminDisplayName": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "AdminDisplayName", 
               "title": "AdminDisplayName", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "GzipLevel": {
               "__type_requested": "System.String", 
               "required": false, 
               "description": "The GzipLevel parameter sets Gzip configuration information for the Exchange Web Services virtual directory. This parameter can be set to the following values:\nOff This value results in no compression.\nLow This value results in static compression only. Don't use this setting for Exchange Web Services because Exchange Web Services content is dynamic. You'll get a warning if you set the GzipLevel parameter to this value. If you use this setting, it behaves the same as the Off setting.\nHigh This value results in static and dynamic compression. Content from Exchange Web Services is compressed if clients have indicated support for Gzip compression in their requests.\nError This value identifies errors in the Gzip compression configuration.", 
               "title": "GzipLevel", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "GzipLevel"
          }, 
          "OrganizationId": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "OrganizationId", 
               "title": "OrganizationId", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "InternalNLBBypassUrl": {
               "__type_requested": "", 
               "required": false, 
               "description": "The InternalNLBBypassUrl parameter specifies the URL of the Client Access server, regardless of whether it's behind a Network Load Balancing (NLB) array. Although the InternalUrl parameter is set to the URL of the NLB array, the InternalNLBBypassUrl parameter should always be set to the URL of the Client Access server.", 
               "title": "InternalNLBBypassUrl", 
               "__type_mapping_type": "Unknown", 
               "name": "InternalNLBBypassUrl", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "ExtendedProtectionTokenChecking": {
               "__type_requested": "System.String", 
               "required": false, 
               "description": "The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the specified Exchange virtual directory. Extended Protection for Authentication isn't enabled by default. The available settings are:\nNone Extended Protection for Authentication won't be used. Connections between the client and Exchange won't use Extended Protection for Authentication on this virtual directory. This is the default setting.\nAllow Extended Protection for Authentication will be used for connections between the client and Exchange on this virtual directory if both the client and server support Extended Protection for Authentication. Connections that don't support Extended Protection for Authentication on the client and server will work, but may not be as secure as a connection using Extended Protection for Authentication.\nIf you have a proxy server between the client and the Client Access server that's configured to terminate the client-to-proxy SSL channel, you must also configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter.\nRequire Extended Protection for Authentication will be used for all connections between clients and Exchange servers for this virtual directory. If either the client or server doesn't support Extended Protection for Authentication, the connection between the client and server will fail. If you set this option, you must also set a value for the ExtendedProtectionSPNList parameter.\nIf you have a proxy server between the client and the Client Access server that's configured to terminate the client-to-proxy SSL channel, you must also configure one or more SPNs using the parameter ExtendedProtectionSPNList.", 
               "title": "ExtendedProtectionTokenChecking", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "ExtendedProtectionTokenChecking"
          }, 
          "LiveIdBasicAuthentication": {
               "__type_requested": "System.Boolean", 
               "required": false, 
               "name": "LiveIdBasicAuthentication", 
               "title": "LiveIdBasicAuthentication", 
               "__type_mapping_type": "Boolean", 
               "readonly": true, 
               "type": "boolean", 
               "description": "This parameter is reserved for internal Microsoft use."
          }, 
          "Role": {
               "__type_requested": "ClientAccess | Mailbox", 
               "required": false, 
               "description": "The Role parameter specifies the configuration that should be used when the virtual directory is created. The following are the values that can be used with this parameter:\nFrontEnd Configures the virtual directory for use on a Client Access server.\nBackEnd Configures the virtual directory for use on a Mailbox server.", 
               "title": "Role", 
               "__type_mapping_type": "Unknown", 
               "name": "Role", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "WebSiteName": {
               "__type_requested": "String", 
               "required": false, 
               "description": "The WebSiteName parameter specifies the name of the website under which to create the virtual directory. This parameter shouldn't be used when you're creating a virtual directory under the default website.", 
               "title": "WebSiteName", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "WebSiteName"
          }, 
          "AppPoolIdForManagement": {
               "__type_requested": "String", 
               "required": false, 
               "description": "The AppPoolIdForManagement parameter specifies the pool of programs that manages the virtual directory.", 
               "title": "AppPoolIdForManagement", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "AppPoolIdForManagement"
          }, 
          "PSShowComputerName": {
               "__type_requested": "System.Boolean", 
               "required": false, 
               "name": "PSShowComputerName", 
               "title": "PSShowComputerName", 
               "__type_mapping_type": "Boolean", 
               "readonly": true, 
               "type": "boolean"
          }, 
          "DigestAuthentication": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "The DigestAuthentication parameter specifies whether Digest authentication is enabled on the virtual directory.", 
               "title": "DigestAuthentication", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "DigestAuthentication"
          }, 
          "ApplicationRoot": {
               "__type_requested": "String", 
               "required": false, 
               "description": "The ApplicationRoot parameter sets the metabase path of the virtual directory. By default, this path is the same as the website in which the virtual directory is created.", 
               "title": "ApplicationRoot", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "ApplicationRoot"
          }, 
          "ExternalAuthenticationMethods": {
               "__type_requested": "Deserialized.Microsoft.Exchange.Data.Directory.ADMultiValuedProperty`1[[Microsoft.Exchange.Data.Directory.SystemConfiguration.AuthenticationMethod,", 
               "required": false, 
               "name": "ExternalAuthenticationMethods", 
               "title": "ExternalAuthenticationMethods", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "MRSProxyEnabled": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "The MRSProxyEnabled parameter specifies whether to enable MRSProxy for the Client Access server. MRSProxy is a service that runs on Client Access servers in a remote forest and helps to proxy a mailbox move. For more information, see Mailbox Moves in Exchange 2013.", 
               "title": "MRSProxyEnabled", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "MRSProxyEnabled"
          }, 
          "PSComputerName": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "PSComputerName", 
               "title": "PSComputerName", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "InternalUrl": {
               "__type_requested": "System.Uri", 
               "required": false, 
               "description": "The InternalUrl parameter specifies the host name of the Exchange server for a connection from inside the firewall. This setting is also important when SSL is used.", 
               "title": "InternalUrl", 
               "__type_mapping_type": "Unknown", 
               "name": "InternalUrl", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "AdfsAuthentication": {
               "__type_requested": "System.Boolean", 
               "required": false, 
               "name": "AdfsAuthentication", 
               "title": "AdfsAuthentication", 
               "__type_mapping_type": "Boolean", 
               "readonly": true, 
               "type": "boolean"
          }, 
          "WindowsAuthentication": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "The WindowsAuthentication parameter specifies whether Integrated Windows authentication is permitted on the new Exchange Web Services virtual directory.", 
               "title": "WindowsAuthentication", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "WindowsAuthentication"
          }, 
          "Path": {
               "__type_requested": "String", 
               "required": false, 
               "description": "The Path parameter sets the path of the virtual directory in the metabase.", 
               "title": "Path", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "Path"
          }, 
          "OAuthAuthentication": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "The OAuthAuthentication parameter specifies whether OAuth authentication is enabled.", 
               "title": "OAuthAuthentication", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "OAuthAuthentication"
          }, 
          "ExtendedProtectionSPNList": {
               "__type_requested": "MultiValuedProperty", 
               "required": false, 
               "description": "The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the specified virtual directory.\nThe possible values are:\nNull This is the default value.\nSingle SPN or comma delimited list of valid SPNs By default, you must specify the fully qualified domain name (FQDN) (for example mail.contoso.com) for each SPN. If you want to add an SPN that's not an FQDN (for example, ContosoMail), you must also use the ExtendedProtectionTokenChecking parameter with the AllowDotlessSPN value. You specify the domain in SPN format. The SPN format is <protocol>/<FQDN>. For example, a valid entry could be HTTP/mail.contoso.com.", 
               "title": "ExtendedProtectionSPNList", 
               "items": {
                    "type": "string"
               }, 
               "__type_mapping_type": "String[]", 
               "readonly": false, 
               "type": "array", 
               "name": "ExtendedProtectionSPNList"
          }, 
          "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": "System.String", 
               "required": false, 
               "name": "Name", 
               "title": "Name", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "WSSecurityAuthentication": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "The WSSecurityAuthentication parameter specifies whether Web Services Security authentication is enabled on the Exchange Web Services virtual directory. This parameter can be used with the BasicAuthentication, DigestAuthentication, and WindowsAuthentication parameters.", 
               "title": "WSSecurityAuthentication", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "WSSecurityAuthentication"
          }, 
          "WhenCreatedUTC": {
               "__type_requested": "System.DateTime", 
               "__type_mapping_type": "DateTime", 
               "name": "WhenCreatedUTC", 
               "title": "WhenCreatedUTC", 
               "format": "date-time", 
               "required": false, 
               "readonly": true, 
               "type": "string"
          }, 
          "LiveIdNegotiateAuthentication": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "name": "LiveIdNegotiateAuthentication", 
               "title": "LiveIdNegotiateAuthentication", 
               "__type_mapping_type": "Boolean", 
               "readonly": true, 
               "type": "boolean", 
               "description": "This parameter is reserved for internal Microsoft use."
          }, 
          "Server": {
               "__type_requested": "System.String", 
               "required": false, 
               "description": "The Server parameter specifies the Exchange server on which you want to create the virtual directory. You can use any value that uniquely identifies the server, for example:\nName\nFQDN\nDistinguished name (DN)\nExchange Legacy DN\nIf you don't use the Server parameter, the virtual directory is created on the server where the Remote PowerShell session is established This will always be a Mailbox server. If you want to create the virtual directory on a Client Access server or another Mailbox server, you must use the Server parameter.", 
               "title": "Server", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "Server"
          }, 
          "WhenCreated": {
               "__type_requested": "System.DateTime", 
               "__type_mapping_type": "DateTime", 
               "name": "WhenCreated", 
               "title": "WhenCreated", 
               "format": "date-time", 
               "required": false, 
               "readonly": true, 
               "type": "string"
          }, 
          "InternalAuthenticationMethods": {
               "__type_requested": "Deserialized.Microsoft.Exchange.Data.Directory.ADMultiValuedProperty`1[[Microsoft.Exchange.Data.Directory.SystemConfiguration.AuthenticationMethod,", 
               "required": false, 
               "name": "InternalAuthenticationMethods", 
               "title": "InternalAuthenticationMethods", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "AdminDisplayVersion": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "AdminDisplayVersion", 
               "title": "AdminDisplayVersion", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "MetabasePath": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "MetabasePath", 
               "title": "MetabasePath", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "ExchangeVersion": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "ExchangeVersion", 
               "title": "ExchangeVersion", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "ExternalUrl": {
               "__type_requested": "", 
               "required": false, 
               "description": "The ExternalUrl parameter specifies the host name used to connect to the Exchange server from outside the firewall. This setting is also important when Secure Sockets Layer (SSL) is used.", 
               "title": "ExternalUrl", 
               "__type_mapping_type": "Unknown", 
               "name": "ExternalUrl", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "BasicAuthentication": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "The BasicAuthentication parameter specifies whether Basic authentication is enabled on the Exchange Web Services virtual directory.", 
               "title": "BasicAuthentication", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "BasicAuthentication"
          }, 
          "DomainController": {
               "__type_requested": "Fqdn", 
               "required": false, 
               "description": "The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.", 
               "title": "DomainController", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "DomainController"
          }, 
          "ObjectCategory": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "ObjectCategory", 
               "title": "ObjectCategory", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "IsValid": {
               "__type_requested": "System.Boolean", 
               "required": false, 
               "name": "IsValid", 
               "title": "IsValid", 
               "__type_mapping_type": "Boolean", 
               "readonly": true, 
               "type": "boolean"
          }, 
          "ExtendedProtectionFlags": {
               "__type_requested": "MultiValuedProperty", 
               "required": false, 
               "description": "The ExtendedProtectionFlags parameter is used to customize the options you use if you're using Extended Protection for Authentication. The possible values are:\nNone Default setting.\nProxy Specifies that a proxy is terminating the SSL channel. A Service Principal Name (SPN) must be registered in the ExtendedProtectionSPNList parameter if proxy mode is configured.\nProxyCoHosting Specifies that both HTTP and HTTPS traffic may be accessing the Client Access server and that a proxy is located between at least some of the clients and the Client Access server.\nAllowDotlessSPN Specifies whether you want to support valid SPNs that aren't in the fully qualified domain name (FQDN) format, for example ContosoMail. You specify valid SPNs with the ExtendedProtectionSPNList parameter. This option makes extended protection less secure because dotless certificates aren't unique, so it isn't possible to ensure that the client-to-proxy connection was established over a secure channel.\nNoServiceNameCheck Specifies that the SPN list won't be checked to validate a channel binding token. This option makes Extended Protection for Authentication less secure. We generally don't recommend this setting.", 
               "title": "ExtendedProtectionFlags", 
               "items": {
                    "type": "string"
               }, 
               "__type_mapping_type": "String[]", 
               "readonly": false, 
               "type": "array", 
               "name": "ExtendedProtectionFlags"
          }, 
          "AppPoolId": {
               "__type_requested": "String", 
               "required": false, 
               "description": "The AppPoolId parameter sets the pool of programs that can be used with the virtual directory.", 
               "title": "AppPoolId", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "AppPoolId"
          }, 
          "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"
          }, 
          "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"
          }, 
          "ObjectState": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "ObjectState", 
               "title": "ObjectState", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "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 GUID of the server, the name of the website, or the name of the virtual directory that you want to display."
          }, 
          "RunspaceId": {
               "__type_requested": "System.Guid", 
               "required": false, 
               "name": "RunspaceId", 
               "title": "RunspaceId", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "Guid": {
               "__type_requested": "System.Guid", 
               "required": false, 
               "name": "Guid", 
               "title": "Guid", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }
     }, 
     "schema_version": "15312"
}

Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/device/exchange/WebServicesVirtualDirectory/add/	hierarchy=[hierarchy] format=json	The GUI Add form of device/exchange/WebServicesVirtualDirectory as JSON

The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.

Task	Call	URL	Parameters	Payload
Create	POST	/api/device/exchange/WebServicesVirtualDirectory	hierarchy=[hierarchy]	(For payload specification)

Response is a transaction pkid for the create action.

Use the GET call to

tool/Transaction/[trans pkid]

to inspect the created resource and its instance pkid.

Task	Call	URL	Parameters	Payload
Bulk delete [pkid1],[pkid2]...	DELETE	/api/device/exchange/WebServicesVirtualDirectory/	hierarchy=[hierarchy]	{"hrefs":["/api/device/exchange/WebServicesVirtualDirectory/[pkid1]", "/api/device/exchange/WebServicesVirtualDirectory/[pkid2]", ...]}

For the instance pkids [pkid1],[pkid2], ... that can be added to the DELETE call (the instance pkids to delete), refer to the List GET call for: device/exchange/WebServicesVirtualDirectory
```
GET http://[host-proxy]/api/device/exchange/WebServicesVirtualDirectory/?hierarchy=[hierarchy]&format=json
```

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

Task	Call	URL	Parameters	Payload
Bulk Modify	POST	/api/device/exchange/WebServicesVirtualDirectory/bulk_update/	hierarchy=[hierarchy] format=json	For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/exchange/WebServicesVirtualDirectory/[pkid1]", "/api/v0/device/exchange/WebServicesVirtualDirectory/[pkid2]",...]}}

To get a list of model instance pkids that are available to Bulk Modify, use the GET call:

GET http://[host-proxy]/api/device/exchange/WebServicesVirtualDirectory/?hierarchy=[hierarchy]&format=json

The POST payload is in JSON format (refer to the Payload example) and contains:
- data in name-value update pairs according to the returned schema
- meta (empty - for a valid payload)
- request_meta with the hrefs list of instances to update

Task	Call	URL	Parameters	Payload
Move the instance with [pkid] to [target_hierarchy]	POST	/api/tool/DataMove/?model_type=device/exchange/WebServicesVirtualDirectory	hierarchy=[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/exchange/WebServicesVirtualDirectory/[pkid]"]}
Bulk Move	POST	/api/tool/DataMove/?model_type=device/exchange/WebServicesVirtualDirectory	hierarchy==[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/exchange/WebServicesVirtualDirectory/[pkid1]", "/api/device/exchange/WebServicesVirtualDirectory/[pkid2]",...]}

Move one or more model instances ([pkid1],[pkid2],...) from source hierarchy (pkid or dot notation) to target_hierarchy (pkid or dot notation). A move can only take place from a source hierarchy equal to or lower than target_hierarchy.
For a list of hierarchy pkids and their dot notation available from [hierarchy], use the GET call:
GET http://[host-proxy]/api/device/exchange/WebServicesVirtualDirectory/?hierarchy=[hierarchy]&format=json&schema_rules=true

Task	Call	URL	Parameters	Payload
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/exchange/WebServicesVirtualDirectory; optionally with tag_version at [version] and Configuration Template as [configtemplate].	POST	/api/device/exchange/WebServicesVirtualDirectory/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	{ "hrefs":["/api/device/exchange/WebServicesVirtualDirectory/[pkid1]", "/api/device/exchange/WebServicesVirtualDirectory/[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/WebServicesVirtualDirectory and the JSON format can be used to import instances of device/exchange/WebServicesVirtualDirectory.

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

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

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

Task	Call	URL	Parameters	Response
Configuration Template	GET	/api/device/exchange/WebServicesVirtualDirectory/configuration_template/	hierarchy=[hierarchy]	POST call to create the Configuration Template Configuration Template schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Field Display Policy	GET	/api/device/exchange/WebServicesVirtualDirectory/field_display_policy/	hierarchy=[hierarchy]	POST call to create the Field Display Policy Field Display Policy schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
List	GET	/api/device/exchange/WebServicesVirtualDirectory/	hierarchy=[hierarchy] format=json schema=true	The device/exchange/WebServicesVirtualDirectory schema and all instances as JSON.

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

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

{
     "operations": [
          "move"
     ], 
     "pagination": {
          "direction": "asc", 
          "order_by": null, 
          "maximum_limit": 2000, 
          "skip": 0, 
          "current": "/api/device/exchange/WebServicesVirtualDirectory/?skip=0&limit=3&order_by=None&direction=asc&traversal=default", 
          "limit": 3, 
          "total_limit": null, 
          "total": 0
     }, 
     "meta": {
          "tags": [], 
          "cached": true, 
          "title": "", 
          "business_key": {}, 
          "schema_version": "15312", 
          "references": {
               "device": [
                    {
                         "pkid": "", 
                         "href": ""
                    }
               ], 
               "children": [], 
               "parent": [
                    {
                         "pkid": "6t0ggef2c0deab00hb595101", 
                         "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
                    }
               ], 
               "foreign_key": []
          }, 
          "actions": [
               {
                    "add": {
                         "support_async": false, 
                         "class": "add", 
                         "href": "/api/device/exchange/WebServicesVirtualDirectory/add/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Add"
                    }
               }, 
               {
                    "remove": {
                         "support_async": true, 
                         "class": "delete", 
                         "href": "/api/device/exchange/WebServicesVirtualDirectory/?hierarchy=[hierarchy]", 
                         "method": "DELETE", 
                         "title": "Delete"
                    }
               }, 
               {
                    "bulk_update_form": {
                         "support_async": false, 
                         "class": "update", 
                         "href": "/api/device/exchange/WebServicesVirtualDirectory/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/WebServicesVirtualDirectory", 
                         "method": "POST", 
                         "view": "/api/tool/DataMove/?auth_token=[authtoken]
                    }
               }, 
               {
                    "export": {
                         "title": "Export", 
                         "support_async": false, 
                         "submit": "payload", 
                         "class": "export", 
                         "href": "/api/device/exchange/WebServicesVirtualDirectory/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/WebServicesVirtualDirectory/export_bulkload_template/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Export Bulk Load Template"
                    }
               }, 
               {
                    "configuration_template": {
                         "support_async": false, 
                         "class": "config", 
                         "href": "/api/device/exchange/WebServicesVirtualDirectory/configuration_template/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Configuration Template"
                    }
               }, 
               {
                    "field_display_policy": {
                         "support_async": false, 
                         "class": "display_policy", 
                         "href": "/api/device/exchange/WebServicesVirtualDirectory/field_display_policy/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Field Display Policy"
                    }
               }, 
               {
                    "list": {
                         "support_async": false, 
                         "class": "list", 
                         "href": "/api/device/exchange/WebServicesVirtualDirectory/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "List"
                    }
               }, 
               {
                    "help": {
                         "support_async": false, 
                         "class": "help", 
                         "href": "/api/device/exchange/WebServicesVirtualDirectory/help?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Help"
                    }
               }, 
               {
                    "purge": {
                         "support_async": false, 
                         "class": "purge", 
                         "href": "/api/device/exchange/WebServicesVirtualDirectory/purge/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Purge"
                    }
               }
          ], 
          "model_type": "device/exchange/WebServicesVirtualDirectory", 
          "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": [
               {
                    "allow_filtering": true, 
                    "name": "hierarchy_friendly_name", 
                    "title": "Located At"
               }
          ], 
          "api_version": "21.2", 
          "tagged_versions": []
     }, 
     "resources": []
}

Task	Call	URL	Parameters	Response
Get the on-line Help for device/exchange/WebServicesVirtualDirectory.	GET	/api/device/exchange/WebServicesVirtualDirectory/help	hierarchy=[hierarchy]	On-line help of Model ref.: device/exchange/WebServicesVirtualDirectory as HTML

Instance API Reference

[pkid] is the ID of the resource instance.
If a payload is required, inspect the schema for payload details.

Task	Call	URL	Parameters	Payload
Modify	PUT	/api/device/exchange/WebServicesVirtualDirectory/[pkid]	hierarchy=[hierarchy]	(For payload specification)

For Bulk modification, refer to the Bulk Modify section.

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

Task	Call	URL	Parameters	Response
Clone instance with [pkid]. The schema rules are applied.	GET	/api/device/exchange/WebServicesVirtualDirectory/[pkid]/clone/?schema=&schema_rules=true	hierarchy=[hierarchy]	A JSON payload with: A POST action URL. The unchanged model [pkid] payload to be modified to create a new instance.

For the instance pkids that can cloned, refer to the List GET call for device/exchange/WebServicesVirtualDirectory

GET http://[host-proxy]/api/device/exchange/WebServicesVirtualDirectory/?hierarchy=[hierarchy]&format=json

Use the POST action in the response with a modification of the response payload to create the clone.

Task	Call	URL	Parameters	Payload
Move	POST	/api/tool/DataMove/[pkid]/?model_type=device/exchange/WebServicesVirtualDirectory	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/WebServicesVirtualDirectory; optionally with tag_version at [version] and Configuration Template as [configtemplate].	GET	/api/device/exchange/WebServicesVirtualDirectory/[pkid]/export	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	The response is an attachment. Refer to the list below.

For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:

        Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:

        Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

For export_format=json, the response is a time stamped zip file of data in JSON and a response format:

        Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
        Content-Language:en
        Content-Type:application/x-zip

The XLSX format can be used to bulk load instances of device/exchange/WebServicesVirtualDirectory and the JSON format can be used to import instances of device/exchange/WebServicesVirtualDirectory.

For Bulk Export, refer to the Bulk Export section.

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

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

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

API Reference for device/exchange/WebServicesVirtualDirectory

GET http://[host-proxy]/api/device/exchange/WebServicesVirtualDirectory/schema/?hierarchy=[hierarchy]&format=json&schema=1

Get the Add form

Create

Bulk Delete

Bulk Modify

Move

Bulk Export

Export Bulk Load Template

Configuration Template

Field Display Policy

List

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

Help

Instance API Reference

Modify

Delete

Clone

Move

Export

Get

Help

Purge