[Index]
Model ref.: device/skypeforbusinesshybrid/CsTrustedApplicationPool
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": { "AudioPortCount": { "__type_requested": "System.Nullable[uint16]", "required": false, "description": "The number of ports available in the port range for audio connections.\nDefault: 0", "title": "AudioPortCount", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "AudioPortCount" }, "AppSharingPortCount": { "__type_requested": "System.Nullable[uint16]", "required": false, "description": "The number of ports available in the port range for application sharing connections.\nDefault: 0", "title": "AppSharingPortCount", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "AppSharingPortCount" }, "Version": { "__type_requested": "uint32", "required": false, "name": "Version", "title": "Version", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "FileStore": { "__type_requested": "string", "required": false, "name": "FileStore", "title": "FileStore", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "OutboundOnly": { "__type_requested": "$true | $false", "required": false, "description": "Specifies whether a trusted application can initiate a connection to a server within the pool. Set this value to True if you want all connections to be initiated by the server rather than the application.\nDefault: False", "title": "OutboundOnly", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "OutboundOnly" }, "AppSharingPortStart": { "__type_requested": "System.Nullable[uint16]", "required": false, "description": "The number of the first port in the port range available for application sharing connections.", "title": "AppSharingPortStart", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "AppSharingPortStart" }, "ComputerFqdn": { "__type_requested": "Fqdn", "required": false, "description": "Creating a trusted application pool will automatically create a trusted application computer that is part of that pool. By default the computer will receive the same FQDN as the pool. Enter a value in this parameter to specify an FQDN for the computer that is different from the pool FQDN. If you plan to add more computers to the pool, you must enter a value for this parameter that is different from the pool FQDN.", "title": "ComputerFqdn", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "ComputerFqdn" }, "RequiresReplication": { "__type_requested": "$true | $false", "required": false, "description": "Determines whether replication is required for this pool. Set this value to False if replication is not required. You would usually set this parameter to False for Microsoft Outlook Web Access and manually-provisioned applications.\nDefault: True", "title": "RequiresReplication", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "RequiresReplication" }, "VideoPortCount": { "__type_requested": "System.Nullable[uint16]", "required": false, "description": "The number of ports available in the port range for video connections.\nDefault: 0", "title": "VideoPortCount", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "VideoPortCount" }, "Applications": { "__type_requested": "System.Collections.Generic.IList[string]", "required": false, "name": "Applications", "title": "Applications", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array" }, "TreatAsAuthenticated": { "__type_requested": "$true | $false", "required": false, "description": "Determines whether authentication is required for trusted applications connecting to servers within the pool. Set this parameter to False if you want to require trusted applications to be authenticated. The default value of True allows the trusted applications to connect under the assumption they've already been authenticated.\nDefault: True", "title": "TreatAsAuthenticated", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "TreatAsAuthenticated" }, "Identity": { "__type_requested": "System.String", "required": true, "description": "The FQDN of the new pool. Note that while the Identity value for creating a pool is the pool FQDN, the value that will be stored as the Identity with the new pool is actually an automatically generated service ID of the pool. The Identity entered here will be saved as the PoolFqdn.", "title": "Identity", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Identity" }, "AudioPortStart": { "__type_requested": "System.Nullable[uint16]", "required": false, "description": "The number of the first port in the port range available for audio connections.", "title": "AudioPortStart", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "AudioPortStart" }, "Registrar": { "__type_requested": "String", "required": false, "description": "The service ID or FQDN of the Registrar service for the pool.\nNote that even though this parameter is optional, if you attempt to create a new trusted application endpoint (by using the New-CsTrustedApplicationEndpoint cmdlet) and assign the endpoint to a pool that does not have a Registrar dependency, you'll receive an error and the endpoint will not be created. In addition, you cannot remove a trusted application pool that is not associated with a Registrar.", "title": "Registrar", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Registrar" }, "PoolFqdn": { "__type_requested": "string", "required": false, "name": "PoolFqdn", "title": "PoolFqdn", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "The FQDN of the pool you want to retrieve. This behaves the same as the Identity parameter, except that Identity also accepts a service ID." }, "ThrottleAsServer": { "__type_requested": "$true | $false", "required": false, "description": "Set this parameter to false to throttle connections between the servers within the pool and trusted applications as clients. This places greater restrictions on the connections than the default True, which throttles connections as servers. Throttling a connection places restrictions on the number of transactions that can occur at once.\nDefault: True", "title": "ThrottleAsServer", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "ThrottleAsServer" }, "VideoPortStart": { "__type_requested": "System.Nullable[uint16]", "required": false, "description": "The number of the first port in the port range available for video connections.", "title": "VideoPortStart", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "VideoPortStart" }, "DependentServiceList": { "__type_requested": "System.Collections.Generic.IList[string]", "required": false, "name": "DependentServiceList", "title": "DependentServiceList", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array" }, "Site": { "__type_requested": "String", "required": false, "description": "The Site ID of the site on which this pool is homed. Call the Get-CsSite cmdlet to retrieve the SiteId property of a site. Keep in mind that you must use the SiteId property rather than the Identity of the site. Also note that you must not precede the SiteId with the string \"site:\", you must enter only the SiteId. In addition, although you enter the SiteId retrieved from the Get-CsSite cmdlet, the SiteId property of the new trusted application pool will contain the site Identity. For example, if the SiteId for the site is Main and the site Identity is site:Redmond1, you must enter -Site Main in your call to the New-CsTrustedApplicationPool cmdlet, but a subsequent call to the Get-CsTrustedApplicationPool cmdlet will show the SiteId as site:Redmond1.\nIf the pool specified in the Identity already exists you do not need to specify a Site. If the pool doesn't exist, this parameter is required.", "title": "Site", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Site" }, "ServiceId": { "__type_requested": "string", "required": false, "name": "ServiceId", "title": "ServiceId", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "SiteId": { "__type_requested": "string", "required": false, "name": "SiteId", "title": "SiteId", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "Role": { "__type_requested": "string", "required": false, "name": "Role", "title": "Role", "__type_mapping_type": "String", "readonly": true, "type": "string" } }, "schema_version": "1150" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/device/skypeforbusinesshybrid/CsTrustedApplicationPool/add/ |
|
The GUI Add form of device/skypeforbusinesshybrid/CsTrustedApplicationPool 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/skypeforbusinesshybrid/CsTrustedApplicationPool/ | 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/skypeforbusinesshybrid/CsTrustedApplicationPool/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/skypeforbusinesshybrid/CsTrustedApplicationPool/[pkid1]", "/api/device/skypeforbusinesshybrid/CsTrustedApplicationPool/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsTrustedApplicationPool/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/skypeforbusinesshybrid/CsTrustedApplicationPool/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/skypeforbusinesshybrid/CsTrustedApplicationPool/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/skypeforbusinesshybrid/CsTrustedApplicationPool/[pkid1]", "/api/v0/device/skypeforbusinesshybrid/CsTrustedApplicationPool/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsTrustedApplicationPool/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/skypeforbusinesshybrid/CsTrustedApplicationPool |
|
{"hrefs": ["/api/device/skypeforbusinesshybrid/CsTrustedApplicationPool/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/skypeforbusinesshybrid/CsTrustedApplicationPool |
|
{"hrefs": ["/api/device/skypeforbusinesshybrid/CsTrustedApplicationPool/[pkid1]", "/api/device/skypeforbusinesshybrid/CsTrustedApplicationPool/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/skypeforbusinesshybrid/CsTrustedApplicationPool; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/skypeforbusinesshybrid/CsTrustedApplicationPool/export/ |
|
{ "hrefs":["/api/device/skypeforbusinesshybrid/CsTrustedApplicationPool/[pkid1]", "/api/device/skypeforbusinesshybrid/CsTrustedApplicationPool/[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/skypeforbusinesshybrid/CsTrustedApplicationPool and the JSON format can be used to import instances of device/skypeforbusinesshybrid/CsTrustedApplicationPool.
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsTrustedApplicationPool/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/skypeforbusinesshybrid/CsTrustedApplicationPool | POST | /api/device/skypeforbusinesshybrid/CsTrustedApplicationPool/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/skypeforbusinesshybrid/CsTrustedApplicationPool/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/device/skypeforbusinesshybrid/CsTrustedApplicationPool/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/skypeforbusinesshybrid/CsTrustedApplicationPool/ |
|
The device/skypeforbusinesshybrid/CsTrustedApplicationPool schema and all instances as JSON. |
(The list will return 0 to 3 device/skypeforbusinesshybrid/CsTrustedApplicationPool instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": null, "maximum_limit": 2000, "skip": 0, "current": "/api/device/skypeforbusinesshybrid/CsTrustedApplicationPool/?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": "1150", "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/skypeforbusinesshybrid/CsTrustedApplicationPool/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/skypeforbusinesshybrid/CsTrustedApplicationPool/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/skypeforbusinesshybrid/CsTrustedApplicationPool/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/skypeforbusinesshybrid/CsTrustedApplicationPool", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/skypeforbusinesshybrid/CsTrustedApplicationPool/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/skypeforbusinesshybrid/CsTrustedApplicationPool/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/skypeforbusinesshybrid/CsTrustedApplicationPool/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/skypeforbusinesshybrid/CsTrustedApplicationPool/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/skypeforbusinesshybrid/CsTrustedApplicationPool/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/skypeforbusinesshybrid/CsTrustedApplicationPool/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/skypeforbusinesshybrid/CsTrustedApplicationPool/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/skypeforbusinesshybrid/CsTrustedApplicationPool", "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": "20.1.1", "tagged_versions": [] }, "resources": [] }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for device/skypeforbusinesshybrid/CsTrustedApplicationPool. | GET | /api/device/skypeforbusinesshybrid/CsTrustedApplicationPool/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/skypeforbusinesshybrid/CsTrustedApplicationPool as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/skypeforbusinesshybrid/CsTrustedApplicationPool/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/device/skypeforbusinesshybrid/CsTrustedApplicationPool/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/skypeforbusinesshybrid/CsTrustedApplicationPool/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsTrustedApplicationPool/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/skypeforbusinesshybrid/CsTrustedApplicationPool | 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/skypeforbusinesshybrid/CsTrustedApplicationPool; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/skypeforbusinesshybrid/CsTrustedApplicationPool/[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/skypeforbusinesshybrid/CsTrustedApplicationPool and the JSON format can be used to import instances of device/skypeforbusinesshybrid/CsTrustedApplicationPool.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/skypeforbusinesshybrid/CsTrustedApplicationPool/[pkid]/ | hierarchy=[hierarchy] | The device/skypeforbusinesshybrid/CsTrustedApplicationPool instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/skypeforbusinesshybrid/CsTrustedApplicationPool/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/skypeforbusinesshybrid/CsTrustedApplicationPool. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/skypeforbusinesshybrid/CsTrustedApplicationPool/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |