[Index]
Model ref.: device/skypeforbusiness/CsConferenceDirectory
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": { "TargetServerIfMoving": { "__type_requested": "Microsoft.Rtc.Management.Core.WritableConfig.WritableServiceId", "required": false, "name": "TargetServerIfMoving", "title": "TargetServerIfMoving", "__type_mapping_type": "Complex.WritableServiceId", "readonly": true, "type": "object", "properties": { "PoolFqdn": { "type": "string", "name": "PoolFqdn", "title": "PoolFqdn" }, "Role": { "type": "string", "name": "Role", "title": "Role" }, "ServiceId": { "type": "object", "properties": { "XmlRoot": { "type": "string", "name": "XmlRoot", "title": "XmlRoot" }, "ScopeClass": { "type": "integer", "name": "ScopeClass", "title": "ScopeClass" }, "SiteId": { "type": "string", "name": "SiteId", "title": "SiteId" }, "RoleName": { "type": "string", "name": "RoleName", "title": "RoleName" }, "LocalName": { "type": "string", "name": "LocalName", "title": "LocalName" }, "FullName": { "type": "string", "name": "FullName", "title": "FullName" } } } } }, "HomePool": { "__type_requested": "String", "required": true, "description": "Fully qualified domain name (FQDN) of the Registrar pool where the new conference directory will be hosted. For example: -Identity atl-cs-001.litwareinc.com.", "title": "HomePool", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "HomePool" }, "Element": { "__type_requested": "System.Xml.Linq.XElement", "required": false, "name": "Element", "title": "Element", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "ServiceId": { "__type_requested": "Microsoft.Rtc.Management.Core.WritableConfig.WritableServiceId", "required": false, "name": "ServiceId", "title": "ServiceId", "__type_mapping_type": "Complex.WritableServiceId", "readonly": true, "type": "object", "properties": { "PoolFqdn": { "type": "string", "name": "PoolFqdn", "title": "PoolFqdn" }, "Role": { "type": "string", "name": "Role", "title": "Role" }, "ServiceId": { "type": "object", "properties": { "XmlRoot": { "type": "string", "name": "XmlRoot", "title": "XmlRoot" }, "ScopeClass": { "type": "integer", "name": "ScopeClass", "title": "ScopeClass" }, "SiteId": { "type": "string", "name": "SiteId", "title": "SiteId" }, "RoleName": { "type": "string", "name": "RoleName", "title": "RoleName" }, "LocalName": { "type": "string", "name": "LocalName", "title": "LocalName" }, "FullName": { "type": "string", "name": "FullName", "title": "FullName" } } } } }, "Fingerprint": { "__type_requested": "string", "required": false, "name": "Fingerprint", "title": "Fingerprint", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "Id": { "__type_requested": "uint32", "required": false, "name": "Id", "title": "Id", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "Identity": { "__type_requested": "System.String", "required": true, "description": "Unique numeric identifier for the new conference directory. Identities can be any integer value between 0 and 9999 inclusive; however, Identities must be unique. (For example, you cannot have two directories with the Identity 575.) You do not need to follow a numeric order when creating new directories. For example, you can create a directory with the Identity 999 followed by a directory with the Identity 2 followed by a directory with the Identity 438, and so on.", "title": "Identity", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Identity" } }, "schema_version": "1150" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/device/skypeforbusiness/CsConferenceDirectory/add/ |
|
The GUI Add form of device/skypeforbusiness/CsConferenceDirectory 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/skypeforbusiness/CsConferenceDirectory/ | 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/skypeforbusiness/CsConferenceDirectory/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/skypeforbusiness/CsConferenceDirectory/[pkid1]", "/api/device/skypeforbusiness/CsConferenceDirectory/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/skypeforbusiness/CsConferenceDirectory/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/skypeforbusiness/CsConferenceDirectory/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/skypeforbusiness/CsConferenceDirectory/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/skypeforbusiness/CsConferenceDirectory/[pkid1]", "/api/v0/device/skypeforbusiness/CsConferenceDirectory/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/skypeforbusiness/CsConferenceDirectory/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/skypeforbusiness/CsConferenceDirectory |
|
{"hrefs": ["/api/device/skypeforbusiness/CsConferenceDirectory/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/skypeforbusiness/CsConferenceDirectory |
|
{"hrefs": ["/api/device/skypeforbusiness/CsConferenceDirectory/[pkid1]", "/api/device/skypeforbusiness/CsConferenceDirectory/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/skypeforbusiness/CsConferenceDirectory; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/skypeforbusiness/CsConferenceDirectory/export/ |
|
{ "hrefs":["/api/device/skypeforbusiness/CsConferenceDirectory/[pkid1]", "/api/device/skypeforbusiness/CsConferenceDirectory/[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/skypeforbusiness/CsConferenceDirectory and the JSON format can be used to import instances of device/skypeforbusiness/CsConferenceDirectory.
GET http://[host-proxy]/api/device/skypeforbusiness/CsConferenceDirectory/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/skypeforbusiness/CsConferenceDirectory | POST | /api/device/skypeforbusiness/CsConferenceDirectory/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/skypeforbusiness/CsConferenceDirectory/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/device/skypeforbusiness/CsConferenceDirectory/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/skypeforbusiness/CsConferenceDirectory/ |
|
The device/skypeforbusiness/CsConferenceDirectory schema and all instances as JSON. |
(The list will return 0 to 3 device/skypeforbusiness/CsConferenceDirectory instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": null, "maximum_limit": 2000, "skip": 0, "current": "/api/device/skypeforbusiness/CsConferenceDirectory/?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/skypeforbusiness/CsConferenceDirectory/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/skypeforbusiness/CsConferenceDirectory/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/skypeforbusiness/CsConferenceDirectory/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/skypeforbusiness/CsConferenceDirectory", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/skypeforbusiness/CsConferenceDirectory/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/skypeforbusiness/CsConferenceDirectory/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/skypeforbusiness/CsConferenceDirectory/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/skypeforbusiness/CsConferenceDirectory/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/skypeforbusiness/CsConferenceDirectory/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/skypeforbusiness/CsConferenceDirectory/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/skypeforbusiness/CsConferenceDirectory/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/skypeforbusiness/CsConferenceDirectory", "model_specific_actions": [ "get", "list", "powershell_move", "add", "remove", "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/skypeforbusiness/CsConferenceDirectory. | GET | /api/device/skypeforbusiness/CsConferenceDirectory/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/skypeforbusiness/CsConferenceDirectory as HTML |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/device/skypeforbusiness/CsConferenceDirectory/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/skypeforbusiness/CsConferenceDirectory/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/skypeforbusiness/CsConferenceDirectory/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/skypeforbusiness/CsConferenceDirectory | 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/skypeforbusiness/CsConferenceDirectory; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/skypeforbusiness/CsConferenceDirectory/[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/skypeforbusiness/CsConferenceDirectory and the JSON format can be used to import instances of device/skypeforbusiness/CsConferenceDirectory.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/skypeforbusiness/CsConferenceDirectory/[pkid]/ | hierarchy=[hierarchy] | The device/skypeforbusiness/CsConferenceDirectory instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/skypeforbusiness/CsConferenceDirectory/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/skypeforbusiness/CsConferenceDirectory. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Powershell Move | POST | /api/device/skypeforbusiness/CsConferenceDirectory/[pkid]/+powershell_move/ | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/skypeforbusiness/CsConferenceDirectory/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |