[Index]
Wrapper relation for device/cucm/MeetMe.
Model ref.: relation/MeetMeREL
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": {
"pattern": {
"description": " Enter a Meet-Me number or a range of numbers. To configure a range, the dash must appear within brackets and follow a digit; for example, to configure the range 1000 to 1050, enter 10[0-5]0. ",
"title": "Directory Number or Pattern",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "string"
},
"shadow": {
"type": "object",
"properties": {
"name": {
"is_password": false,
"title": "Name",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
}
},
"title": "Shadow"
},
"minimumSecurityLevel": {
"description": " Choose the minimum Meet-Me conference security level for this Meet-Me number or pattern from the drop-down list box. \n \n \n \n Choose Authenticated to block participants with nonsecure phones from joining the conference. \n \n Choose Encrypted to block participants with authenticated or nonsecure phones from joining the conference. \n \n Choose Non Secure to allow all participants to join the conference. \n \n \n \n \n Note\u00a0\u00a0\u00a0 \n To use this feature, ensure that you have a secure conference bridge that is configured and available. \n \n \n ",
"title": "Minimum Security Level",
"minItems": 1,
"required": true,
"choices": [
{
"value": "Non Secure",
"title": "Non Secure"
},
{
"value": "Authenticated",
"title": "Authenticated"
},
{
"value": "Encrypted",
"title": "Encrypted"
}
],
"maxItems": 1,
"type": "string"
},
"description": {
"description": " The description can include up to 50 characters in any language, but it cannot include double quotation marks (\"), percentage sign (%), ampersand (&), or angle brackets (<>). ",
"title": "Description",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"routePartitionName": {
"description": " To use a partition to restrict access to the Meet-Me number or pattern, choose the desired partition from the drop-down list box. If you do not want to restrict access to the Meet-Me number or pattern, choose <None> for the partition. You can configure the number of partitions that are displayed in this drop-down list box by using the Max List Box Items enterprise parameter. If more partitions exist than the Max List Box Items enterprise parameter specifies, the Find button is displayed next to the drop-down list box. Click the Find button to display the Find and List Partitions window. \n \n \n \n Note\u00a0\u00a0\u00a0 \n To set the maximum list box items, choose System > Enterprise Parameters and update the Max List Box Items field under CCMAdmin Parameters. \n \n \n \n \n \n \n Note\u00a0\u00a0\u00a0 \n Make sure that the combination of Meet-Me number or pattern and partition is unique within the \n Cisco Unified Communications Manager cluster. \n \n \n ",
"format": "uri",
"minItems": 0,
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/RoutePartition",
"title": "Partition",
"type": [
"string",
"null"
],
"target": "/api/device/cucm/RoutePartition/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
}
},
"schema_version": "1.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/MeetMeREL/add/ |
|
The GUI Add form of relation/MeetMeREL 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/relation/MeetMeREL | 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/relation/MeetMeREL/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/MeetMeREL/[pkid1]", "/api/relation/MeetMeREL/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/MeetMeREL/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=relation/MeetMeREL |
|
{"hrefs": ["/api/relation/MeetMeREL/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=relation/MeetMeREL |
|
{"hrefs": ["/api/relation/MeetMeREL/[pkid1]", "/api/relation/MeetMeREL/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/MeetMeREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/MeetMeREL/export/ |
|
{ "hrefs":["/api/relation/MeetMeREL/[pkid1]", "/api/relation/MeetMeREL/[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 relation/MeetMeREL and the JSON format can be used to import instances of relation/MeetMeREL.
GET http://[host-proxy]/api/relation/MeetMeREL/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/MeetMeREL | POST | /api/relation/MeetMeREL/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/relation/MeetMeREL/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/relation/MeetMeREL/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/MeetMeREL/ |
|
The relation/MeetMeREL schema and all instances as JSON. |
(The list will return 0 to 3 relation/MeetMeREL instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"move",
"list",
"update",
"remove",
"add",
"bulk_update",
"export"
],
"pagination": {
"direction": "asc",
"order_by": "pattern",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/relation/MeetMeREL/?skip=0&limit=3&order_by=pattern&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 0
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "1.0",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"self": [
{
"pkid": null,
"href": "/api/relation/MeetMeREL/None/"
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/relation/MeetMeREL/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/MeetMeREL/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=relation/MeetMeREL",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/MeetMeREL/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/relation/MeetMeREL/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/relation/MeetMeREL/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/relation/MeetMeREL/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/relation/MeetMeREL/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/MeetMeREL/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/MeetMeREL",
"model_specific_actions": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"move",
"list",
"update",
"remove",
"add",
"export"
],
"summary_attrs": [
{
"name": "pattern",
"title": "Directory Number or Pattern"
},
{
"name": "description",
"title": "Description"
},
{
"name": "routePartitionName",
"title": "Partition"
},
{
"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 relation/MeetMeREL. | GET | /api/relation/MeetMeREL/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/MeetMeREL as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/MeetMeREL/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/MeetMeREL/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=relation/MeetMeREL | 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 relation/MeetMeREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/MeetMeREL/[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 relation/MeetMeREL and the JSON format can be used to import instances of relation/MeetMeREL.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/MeetMeREL/[pkid] | hierarchy=[hierarchy] | The relation/MeetMeREL instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/MeetMeREL/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/MeetMeREL. |