[Index]
Model ref.: device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber
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": { "ExternalAccessPolicy": { "__type_requested": "Microsoft.Rtc.Management.ADConnect.Collections.UserPolicy", "required": false, "name": "ExternalAccessPolicy", "title": "ExternalAccessPolicy", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "Identity": { "readonly": true, "required": false, "type": "string", "name": "Identity", "title": "Identity" }, "DisplayName": { "__type_requested": "String", "required": false, "description": "Active Directory display name for the new contact object. This is the name that will also be displayed in Skype for Business.", "title": "DisplayName", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "DisplayName" }, "HostingProvider": { "__type_requested": "Microsoft.Rtc.Management.Deploy.Fqdn", "required": false, "name": "HostingProvider", "title": "HostingProvider", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "ScopeToSite": { "__type_requested": "SwitchParameter", "required": false, "description": "If present, the new number will be scoped to the same site as the contact object's home pool. If the ScopeToSite parameter is not included, the new number will be assigned to the global scope.", "title": "ScopeToSite", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "ScopeToSite" }, "Regions": { "__type_requested": "MultiValuedProperty", "required": true, "description": "Dial plan regions associated with the dial-in number. If a region is not included in at least one dial plan, then it cannot be associated with a dial-in conferencing access number. To specify multiple regions, use a comma-separated list: -Regions \"Northwest\", \"Southwest\"", "title": "Regions", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array", "name": "Regions" }, "SecondaryLanguages": { "__type_requested": "MultiValuedProperty", "required": true, "description": "Optional collection of languages that can also be used for making dial-in conferencing announcements. Secondary languages must be configured as a comma-separated list of language codes; for example, the following syntax sets French Canadian and French as secondary languages; -SecondaryLanguages \"fr-CA\", \"fr-FR\".\nA single access number can have as many as four secondary languages.", "title": "SecondaryLanguages", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array", "name": "SecondaryLanguages" }, "HostingProviderProxyFqdn": { "__type_requested": "Fqdn", "required": false, "description": "Fully qualified domain name of the hosting provider that hosts your dial-in conferencing service.", "title": "HostingProviderProxyFqdn", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "HostingProviderProxyFqdn" }, "LineUri": { "required": true, "type": "string", "name": "LineUri", "title": "LineUri" }, "DisplayNumber": { "__type_requested": "String", "required": true, "description": "Phone number as displayed in meeting invitations and on the dial-in conferencing webpage. The DisplayNumber can be formatted any way you prefer; for example 1-800-555-1234; 1-(800)-555-1234; or 1.800.555.1234.", "title": "DisplayNumber", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "DisplayNumber" }, "Tenant": { "__type_requested": "Guid", "required": false, "description": "Globally unique identifier (GUID) of the Skype for Business Online tenant account for which the new dial-in conferencing access number is being created. For example:\n-Tenant \"38aad667-af54-4397-aaa7-e94c79ec2308\"\nYou can return the tenant ID for each of your tenants by running this command:\nGet-CsTenant | Select-Object DisplayName, TenantID", "title": "Tenant", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Tenant" }, "IsValid": { "__type_requested": "bool", "required": false, "name": "IsValid", "title": "IsValid", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "PrimaryUri": { "__type_requested": "String", "required": true, "description": "Unique SIP address to be assigned to the new contact object. When specifying the PrimaryUri you must include the \"sip:\" prefix. For example: -PrimaryUri \"sip:[email protected]\". Note that the sip: prefix must be entered in all lowercase letters.", "title": "PrimaryUri", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "PrimaryUri" }, "PrimaryLanguage": { "__type_requested": "String", "required": true, "description": "Primary language used for making dial-in conferencing announcements. The language must be configured using one of the available dial-in conferencing language codes; for example, en-US for U.S. English; fr-FR for French; etc. To return a list of the available language codes, type the following command at the Windows PowerShell prompt:\nGet-CsDialInConferencingLanguageList | Select-Object -ExpandProperty Languages.", "title": "PrimaryLanguage", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "PrimaryLanguage" }, "ObjectState": { "__type_requested": "Microsoft.Rtc.Management.ADConnect.Interface.ObjectState", "required": false, "name": "ObjectState", "title": "ObjectState", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "Pool": { "__type_requested": "Fqdn", "required": true, "description": "Home pool for the new contact object.", "title": "Pool", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Pool" } }, "schema_version": "1150" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber/add/ |
|
The GUI Add form of device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber 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/CsDialInConferencingAccessNumber/ | 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/CsDialInConferencingAccessNumber/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber/[pkid1]", "/api/device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber/[pkid1]", "/api/v0/device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber/?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/CsDialInConferencingAccessNumber |
|
{"hrefs": ["/api/device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber |
|
{"hrefs": ["/api/device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber/[pkid1]", "/api/device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber/export/ |
|
{ "hrefs":["/api/device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber/[pkid1]", "/api/device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber/[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/CsDialInConferencingAccessNumber and the JSON format can be used to import instances of device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber.
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber | POST | /api/device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber/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/CsDialInConferencingAccessNumber/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/CsDialInConferencingAccessNumber/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber/ |
|
The device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber schema and all instances as JSON. |
(The list will return 0 to 3 device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": "DisplayName", "maximum_limit": 2000, "skip": 0, "current": "/api/device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber/?skip=0&limit=3&order_by=DisplayName&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/CsDialInConferencingAccessNumber/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber/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/CsDialInConferencingAccessNumber", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber/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/CsDialInConferencingAccessNumber/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber", "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": "DisplayName", "title": "DisplayName" }, { "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/CsDialInConferencingAccessNumber. | GET | /api/device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber/[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/CsDialInConferencingAccessNumber/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber | 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/CsDialInConferencingAccessNumber; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber/[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/CsDialInConferencingAccessNumber and the JSON format can be used to import instances of device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber/[pkid]/ | hierarchy=[hierarchy] | The device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/skypeforbusinesshybrid/CsDialInConferencingAccessNumber/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |