[Index]
Model ref.: device/exchangehybrid/PowerShellVirtualDirectory
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": { "CertificateAuthentication": { "__type_requested": "$true | $false", "required": false, "description": "The CertificateAuthentication parameter specifies whether certificate authentication is enabled on the Windows PowerShell virtual directory. The valid values are $true and $false. The default value is $false.", "title": "CertificateAuthentication", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "CertificateAuthentication" }, "PSComputerName": { "__type_requested": "System.String", "required": false, "name": "PSComputerName", "title": "PSComputerName", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "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" }, "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 species 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 Configure the virtual directory for use on a Client Access server.\nBackEnd Configure 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" }, "LimitMaximumMemory": { "__type_requested": "$true | $false", "required": false, "description": "The LimitMaximumMemory parameter specifies whether to limit the amount of memory used by the application pool in the Windows PowerShell virtual directory. If this parameter is set to $true, the amount of memory made available to the application pool is limited to 70 percent of the total physical memory in the server. If this parameter is set to $false, the amount of memory isn't limited. The default value is $false.", "title": "LimitMaximumMemory", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "LimitMaximumMemory" }, "WebSiteName": { "__type_requested": "String", "required": false, "description": "The WebSiteName parameter specifies the name of the IIS website under which the Windows PowerShell virtual directory is created.", "title": "WebSiteName", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "WebSiteName" }, "PSShowComputerName": { "__type_requested": "System.Boolean", "required": false, "name": "PSShowComputerName", "title": "PSShowComputerName", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "Name": { "__type_requested": "String", "required": true, "description": "The Name parameter specifies the name of the new Windows PowerShell virtual directory. The name you provide will have the name of the website it's created under appended to it. If the name you provide contains spaces, enclose the name in quotation marks (\").", "title": "Name", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Name" }, "DigestAuthentication": { "__type_requested": "System.Boolean", "required": false, "name": "DigestAuthentication", "title": "DigestAuthentication", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "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" }, "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" }, "VirtualDirectoryType": { "__type_requested": "System.String", "required": false, "name": "VirtualDirectoryType", "title": "VirtualDirectoryType", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "RequireSSL": { "__type_requested": "$true | $false", "required": false, "description": "The RequireSSL parameter specifies whether the Windows PowerShell virtual directory should require that the client connection be made using Secure Sockets Layer (SSL). The valid values are $true and $false. The default value is $true.", "title": "RequireSSL", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "RequireSSL" }, "InternalUrl": { "__type_requested": "System.Uri", "required": false, "description": "The InternalUrl parameter specifies the internal URL that the Windows PowerShell virtual directory points to.", "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" }, "ExtendedProtectionTokenChecking": { "__type_requested": "System.String", "required": false, "name": "ExtendedProtectionTokenChecking", "title": "ExtendedProtectionTokenChecking", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "Path": { "__type_requested": "String", "required": false, "description": "The Path parameter specifies the directory that contains the system files for the Windows PowerShell virtual directory.", "title": "Path", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Path" }, "OAuthAuthentication": { "__type_requested": "System.Boolean", "required": false, "name": "OAuthAuthentication", "title": "OAuthAuthentication", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "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 name of the Windows PowerShell virtual directory to retrieve. If the virtual directory contains spaces, enclose the name in quotation marks (\"). You can't use the Identity parameter with the Server parameter." }, "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" }, "WindowsAuthentication": { "__type_requested": "$true | $false", "required": false, "description": "The WindowsAuthentication parameter specifies whether Integrated Windows authentication is enabled on the Windows PowerShell virtual directory. The valid values are $true and $false. The default value is $true.", "title": "WindowsAuthentication", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "WindowsAuthentication" }, "WSSecurityAuthentication": { "__type_requested": "System.Boolean", "required": false, "name": "WSSecurityAuthentication", "title": "WSSecurityAuthentication", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "LiveIdNegotiateAuthentication": { "__type_requested": "System.Boolean", "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 name on which the new Windows PowerShell virtual directory should be created.", "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 external URL that the Windows PowerShell virtual directory points to.", "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 Windows PowerShell virtual directory. The valid values are $true and $false. The default value is $true.", "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": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[Microsoft.Exchange.Data.Directory.SystemConfiguration.ExtendedProtectionFlag,", "required": false, "name": "ExtendedProtectionFlags", "title": "ExtendedProtectionFlags", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "AppPoolId": { "__type_requested": "String", "required": false, "description": "The AppPoolId parameter specifies the pool of programs that can be used with the Windows PowerShell 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" }, "ObjectState": { "__type_requested": "System.String", "required": false, "name": "ObjectState", "title": "ObjectState", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "ExtendedProtectionSPNList": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,", "required": false, "name": "ExtendedProtectionSPNList", "title": "ExtendedProtectionSPNList", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array" }, "AdminDisplayName": { "__type_requested": "System.String", "required": false, "name": "AdminDisplayName", "title": "AdminDisplayName", "__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": "15312" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/device/exchangehybrid/PowerShellVirtualDirectory/add/ |
|
The GUI Add form of device/exchangehybrid/PowerShellVirtualDirectory as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Create | POST | /api/device/exchangehybrid/PowerShellVirtualDirectory | 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/exchangehybrid/PowerShellVirtualDirectory/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/exchangehybrid/PowerShellVirtualDirectory/[pkid1]", "/api/device/exchangehybrid/PowerShellVirtualDirectory/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/exchangehybrid/PowerShellVirtualDirectory/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/exchangehybrid/PowerShellVirtualDirectory/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/exchangehybrid/PowerShellVirtualDirectory/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/exchangehybrid/PowerShellVirtualDirectory/[pkid1]", "/api/v0/device/exchangehybrid/PowerShellVirtualDirectory/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/exchangehybrid/PowerShellVirtualDirectory/?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/PowerShellVirtualDirectory |
|
{"hrefs": ["/api/device/exchangehybrid/PowerShellVirtualDirectory/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/exchangehybrid/PowerShellVirtualDirectory |
|
{"hrefs": ["/api/device/exchangehybrid/PowerShellVirtualDirectory/[pkid1]", "/api/device/exchangehybrid/PowerShellVirtualDirectory/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/exchangehybrid/PowerShellVirtualDirectory; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/exchangehybrid/PowerShellVirtualDirectory/export/ |
|
{ "hrefs":["/api/device/exchangehybrid/PowerShellVirtualDirectory/[pkid1]", "/api/device/exchangehybrid/PowerShellVirtualDirectory/[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/PowerShellVirtualDirectory and the JSON format can be used to import instances of device/exchangehybrid/PowerShellVirtualDirectory.
GET http://[host-proxy]/api/device/exchangehybrid/PowerShellVirtualDirectory/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/exchangehybrid/PowerShellVirtualDirectory | POST | /api/device/exchangehybrid/PowerShellVirtualDirectory/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/PowerShellVirtualDirectory/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/PowerShellVirtualDirectory/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/exchangehybrid/PowerShellVirtualDirectory/ |
|
The device/exchangehybrid/PowerShellVirtualDirectory schema and all instances as JSON. |
(The list will return 0 to 3 device/exchangehybrid/PowerShellVirtualDirectory instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": "Name", "maximum_limit": 2000, "skip": 0, "current": "/api/device/exchangehybrid/PowerShellVirtualDirectory/?skip=0&limit=3&order_by=Name&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 0 }, "meta": { "tags": [], "cached": true, "title": "", "business_key": {}, "schema_version": "15312", "references": { "device": [ { "pkid": "", "href": "" } ], "children": [], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [] }, "actions": [ { "add": { "support_async": false, "class": "add", "href": "/api/device/exchangehybrid/PowerShellVirtualDirectory/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/exchangehybrid/PowerShellVirtualDirectory/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/exchangehybrid/PowerShellVirtualDirectory/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/PowerShellVirtualDirectory", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/exchangehybrid/PowerShellVirtualDirectory/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/PowerShellVirtualDirectory/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/exchangehybrid/PowerShellVirtualDirectory/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/exchangehybrid/PowerShellVirtualDirectory/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/exchangehybrid/PowerShellVirtualDirectory/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/exchangehybrid/PowerShellVirtualDirectory/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/exchangehybrid/PowerShellVirtualDirectory/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/exchangehybrid/PowerShellVirtualDirectory", "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/exchangehybrid/PowerShellVirtualDirectory. | GET | /api/device/exchangehybrid/PowerShellVirtualDirectory/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/exchangehybrid/PowerShellVirtualDirectory as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/exchangehybrid/PowerShellVirtualDirectory/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/device/exchangehybrid/PowerShellVirtualDirectory/[pkid] | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/exchangehybrid/PowerShellVirtualDirectory/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/exchangehybrid/PowerShellVirtualDirectory/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/exchangehybrid/PowerShellVirtualDirectory | 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/PowerShellVirtualDirectory; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/exchangehybrid/PowerShellVirtualDirectory/[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/PowerShellVirtualDirectory and the JSON format can be used to import instances of device/exchangehybrid/PowerShellVirtualDirectory.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/exchangehybrid/PowerShellVirtualDirectory/[pkid] | hierarchy=[hierarchy] | The device/exchangehybrid/PowerShellVirtualDirectory instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/exchangehybrid/PowerShellVirtualDirectory/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/exchangehybrid/PowerShellVirtualDirectory. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/exchangehybrid/PowerShellVirtualDirectory/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |