[Index]

API Reference for relation/GS_HuntGroupVoicemail_PilotData_Rel

Model ref.: relation/GS_HuntGroupVoicemail_PilotData_Rel

The full URL would include the host-proxy name: https://[host-proxy].

Variables are enclosed in square brackets.

[hierarchy] is the hierarchy.
1. as UUID. For example: 6t0ggef2c0deab00hb595101
2. in dot notation. E.g. ProviderName.CustomerName.LocationName

For [auth_token]:
1. The VOSS portal will extract the [auth_token] from the URLs and send these as an Authorization header.
2. Model schemas show that the auth_token parameter is still supported.

For a list of available UUIDs and their dot notations:
GET /api/v0/data/HierarchyNode/?format=json

[pkid] is the ID of the resource instance. Refer to the List reference below.
[filename] refers to a file

GET http://[host-proxy]/api/relation/GS_HuntGroupVoicemail_PilotData_Rel/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema",
     "type": "object",
     "properties": {
          "huntListName": {
               "type": "string",
               "title": "Hunt List"
          },
          "HgPilot": {
               "type": "string",
               "title": "Hunt Group Pilot"
          },
          "searchScope": {
               "type": "string",
               "title": "Search Scope"
          },
          "cos": {
               "type": "string",
               "title": "Class Of Service"
          },
          "phoneSystem": {
               "type": "string",
               "title": "Phone System"
          },
          "voicemailPilot": {
               "type": "string",
               "title": "Voicemail Pilot"
          },
          "cucUserOid": {
               "type": "string",
               "title": "CUC User OID"
          },
          "pin": {
               "is_password": true,
               "type": "string",
               "title": "Mailbox PIN"
          },
          "autoUpdate": {
               "type": "boolean",
               "description": "If set, MWI members will be synced with Line Group members",
               "title": "Automatically update MWI members"
          },
          "autoAlternateExt": {
               "type": "boolean",
               "description": "If set, alternate extensions will be synced with Line Group members or MWI Members",
               "title": "Automatically update alternate extensions"
          },
          "syncAlternateExtToMwi": {
               "type": "boolean",
               "description": "If set, alternate extensions will be synced with MWI Members. If not set, alternate extensions will be synced with Line Group Members. If MWI's are synced to the line group, alternate extensions can only be synced to the line group or manually managed",
               "title": "Sync Alternate Extensions with MWI"
          },
          "message": {
               "type": "string",
               "title": "Status"
          },
          "hnType": {
               "type": "string",
               "title": "Hierarchy Node Type"
          },
          "cucBkey": {
               "type": "string",
               "title": "CUC Cluster"
          },
          "cucmBkey": {
               "type": "string",
               "title": "CUCM Cluster"
          },
          "mwi": {
               "title": "Mwi",
               "type": "array",
               "items": {
                    "type": "object",
                    "properties": {
                         "DisplayName": {
                              "description": " The unique text name of this notification MWI to be used when displaying entries in the administrative console, e.g. Cisco Unity Connection Administration. For example, \"Office Phone\" or \" Lab Phone.\" ",
                              "title": "Display Name",
                              "minItems": 0,
                              "required": true,
                              "type": "string",
                              "name": "DisplayName"
                         },
                         "ObjectId": {
                              "description": " The primary key for this table. A globally unique, system-generated identifier for a NotificationMwi object. - template parameter [2]",
                              "title": "Object Id",
                              "minItems": 0,
                              "readonly": true,
                              "type": "string",
                              "name": "ObjectId"
                         },
                         "MwiOn": {
                              "minItems": 0,
                              "title": "Mwi On",
                              "type": "boolean",
                              "description": " A flag indicating whether the MWI is on or off. This is the state of the MWI from the perspective of Cisco Unity Connection.",
                              "name": "MwiOn"
                         },
                         "IncludeVoiceMessages": {
                              "minItems": 0,
                              "title": "Include Voice Messages",
                              "type": "boolean",
                              "description": " A flag indicating whether the MWI should be set for a voice message.",
                              "name": "IncludeVoiceMessages"
                         },
                         "IncludeFaxMessages": {
                              "minItems": 0,
                              "title": "Include Fax Messages",
                              "type": "boolean",
                              "description": " A flag indicating whether the MWI should be set for a FAX message.",
                              "name": "IncludeFaxMessages"
                         },
                         "URI": {
                              "minItems": 0,
                              "title": "URI",
                              "type": "string",
                              "name": "URI",
                              "format": "uri",
                              "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
                              "choices": []
                         },
                         "UserURI": {
                              "minItems": 0,
                              "title": "User URI",
                              "type": "string",
                              "name": "UserURI",
                              "format": "uri",
                              "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
                              "choices": []
                         },
                         "UsePrimaryExtension": {
                              "minItems": 0,
                              "title": "Use Primary Extension",
                              "type": "boolean",
                              "description": "If set to true (1), the subscriber's primary extension is used (and will be the value contained in MwiExtension)",
                              "name": "UsePrimaryExtension"
                         },
                         "PhoneSystemURI": {
                              "minItems": 0,
                              "title": "Phone System URI",
                              "type": "string",
                              "name": "PhoneSystemURI",
                              "format": "uri",
                              "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
                              "choices": []
                         },
                         "PortURI": {
                              "minItems": 0,
                              "title": "Port URI",
                              "type": "string",
                              "name": "PortURI",
                              "format": "uri",
                              "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
                              "choices": []
                         },
                         "SubscriberObjectId": {
                              "target": "/api/device/cuc/User/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
                              "format": "uri",
                              "minItems": 0,
                              "required": true,
                              "name": "SubscriberObjectId",
                              "target_attr": "ObjectId",
                              "title": "Subscriber Object Id",
                              "type": [
                                   "string"
                              ],
                              "description": " The unique identifier of the Subscriber object to which this MWI belongs. - template parameter [1]",
                              "target_model_type": "device/cuc/User",
                              "choices": []
                         },
                         "MwiExtension": {
                              "description": " The phone number (extension) of the MWI to activate.",
                              "title": "Mwi Extension",
                              "minItems": 0,
                              "required": true,
                              "type": "string",
                              "name": "MwiExtension"
                         },
                         "MediaSwitchDisplayName": {
                              "minItems": 0,
                              "title": "Media Switch Display Name",
                              "type": "string",
                              "description": "The text name of the Media Switch.",
                              "name": "MediaSwitchDisplayName"
                         },
                         "MediaPortObjectId": {
                              "minItems": 0,
                              "title": "Media Port Object Id",
                              "type": "string",
                              "description": " The unique identifier of the MediaPort object Cisco Unity Connection uses to set MWI.",
                              "name": "MediaPortObjectId"
                         },
                         "IncludeTextMessages": {
                              "minItems": 0,
                              "title": "Include Text Messages",
                              "type": "boolean",
                              "description": " A flag indicating whether the MWI should be set for a text message.",
                              "name": "IncludeTextMessages"
                         },
                         "MediaSwitchObjectId": {
                              "target": "/api/device/cuc/PhoneSystem/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
                              "format": "uri",
                              "minItems": 0,
                              "required": true,
                              "name": "MediaSwitchObjectId",
                              "target_attr": "ObjectId",
                              "title": "Media Switch Object Id",
                              "type": [
                                   "string"
                              ],
                              "description": " The unique identifier of the MediaSwitch object to use for activating/deactivating the MWI.",
                              "target_model_type": "device/cuc/PhoneSystem",
                              "choices": []
                         },
                         "Active": {
                              "minItems": 0,
                              "title": "Active",
                              "type": "boolean",
                              "description": " Is this active?",
                              "name": "Active"
                         }
                    }
               }
          }
     }
}

Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/relation/GS_HuntGroupVoicemail_PilotData_Rel/add/	hierarchy=[hierarchy] format=json	The GUI Add form of relation/GS_HuntGroupVoicemail_PilotData_Rel 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/GS_HuntGroupVoicemail_PilotData_Rel	hierarchy=[hierarchy]	(For payload specification)

Response is a transaction pkid for the create action.

Use the GET call to

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/GS_HuntGroupVoicemail_PilotData_Rel/	hierarchy=[hierarchy]	{"hrefs":["/api/relation/GS_HuntGroupVoicemail_PilotData_Rel/[pkid1]", "/api/relation/GS_HuntGroupVoicemail_PilotData_Rel/[pkid2]", ...]}

For the instance pkids [pkid1],[pkid2], ... that can be added to the DELETE call (the instance pkids to delete), refer to the List GET call for: relation/GS_HuntGroupVoicemail_PilotData_Rel
```
GET http://[host-proxy]/api/relation/GS_HuntGroupVoicemail_PilotData_Rel/?hierarchy=[hierarchy]&format=json
```

Task	Call	URL	Parameters	Payload
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/GS_HuntGroupVoicemail_PilotData_Rel; optionally with tag_version at [version] and Configuration Template as [configtemplate].	POST	/api/relation/GS_HuntGroupVoicemail_PilotData_Rel/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	{ "hrefs":["/api/relation/GS_HuntGroupVoicemail_PilotData_Rel/[pkid1]", "/api/relation/GS_HuntGroupVoicemail_PilotData_Rel/[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/GS_HuntGroupVoicemail_PilotData_Rel and the JSON format can be used to import instances of relation/GS_HuntGroupVoicemail_PilotData_Rel.

To get the list of all instance pkids [pkid1],[pkid2], ..., use the List GET call for relation/GS_HuntGroupVoicemail_PilotData_Rel:

 GET http://[host-proxy]/api/relation/GS_HuntGroupVoicemail_PilotData_Rel/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Get a compressed format of the Bulk Load spreadsheet template for relation/GS_HuntGroupVoicemail_PilotData_Rel	POST	/api/relation/GS_HuntGroupVoicemail_PilotData_Rel/export_bulkload_template/	hierarchy=[hierarchy] modeltype=relation/GS_HuntGroupVoicemail_PilotData_Rel	The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz

Task	Call	URL	Parameters	Response
Configuration Template	GET	/api/relation/GS_HuntGroupVoicemail_PilotData_Rel/configuration_template/	hierarchy=[hierarchy]	POST call to create the Configuration Template Configuration Template schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
List	GET	/api/relation/GS_HuntGroupVoicemail_PilotData_Rel/	hierarchy=[hierarchy] format=json schema=true	The relation/GS_HuntGroupVoicemail_PilotData_Rel schema and all instances as JSON.

(The list will return 0 to 3 relation/GS_HuntGroupVoicemail_PilotData_Rel instances)

GET http://[host]/api/relation/GS_HuntGroupVoicemail_PilotData_Rel/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

{
     "pagination": {
          "skip": 0,
          "limit": 3,
          "maximum_limit": 2000,
          "total": 0,
          "total_limit": null,
          "order_by": "huntListName",
          "direction": "asc",
          "current": "/api/relation/GS_HuntGroupVoicemail_PilotData_Rel/?skip=0&limit=3&order_by=huntListName&direction=asc&traversal=down"
     },
     "operations": [
          "bulk_update",
          "add",
          "list",
          "get",
          "export_bulkload_template",
          "remove",
          "configuration_template",
          "update",
          "field_display_policy",
          "help",
          "export"
     ],
     "meta": {
          "model_type": "relation/GS_HuntGroupVoicemail_PilotData_Rel",
          "summary_attrs": [
               {
                    "name": "huntListName",
                    "title": "Hunt List"
               },
               {
                    "name": "HgPilot",
                    "title": "Hunt Group Pilot"
               },
               {
                    "name": "hierarchy_friendly_name",
                    "title": "Located At",
                    "allow_filtering": true
               }
          ],
          "tagged_versions": [],
          "tags": [],
          "title": "",
          "business_key": {},
          "api_version": "21.2",
          "cached": true,
          "references": {
               "children": [],
               "parent": [
                    {
                         "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
                         "pkid": "6t0ggef2c0deab00hb595101"
                    }
               ],
               "device": [
                    {
                         "href": "",
                         "pkid": ""
                    }
               ],
               "foreign_key": [],
               "self": [
                    {
                         "href": "/api/relation/GS_HuntGroupVoicemail_PilotData_Rel/None/",
                         "pkid": null
                    }
               ]
          },
          "model_specific_actions": [
               "add",
               "list",
               "get",
               "export_bulkload_template",
               "remove",
               "configuration_template",
               "update",
               "export"
          ],
          "schema_version": null,
          "actions": [
               {
                    "add": {
                         "method": "GET",
                         "class": "add",
                         "href": "/api/relation/GS_HuntGroupVoicemail_PilotData_Rel/add/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Add"
                    }
               },
               {
                    "remove": {
                         "method": "DELETE",
                         "class": "delete",
                         "href": "/api/relation/GS_HuntGroupVoicemail_PilotData_Rel/?hierarchy=[hierarchy]",
                         "support_async": true,
                         "title": "Delete"
                    }
               },
               {
                    "export": {
                         "method": "POST",
                         "class": "export",
                         "href": "/api/relation/GS_HuntGroupVoicemail_PilotData_Rel/export/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Export",
                         "view": "/api/view/ExportData/add/?auth_token=[authtoken],
                         "submit": "payload"
                    }
               },
               {
                    "export_bulkload_template": {
                         "method": "POST",
                         "class": "bulkload_template",
                         "href": "/api/relation/GS_HuntGroupVoicemail_PilotData_Rel/export_bulkload_template/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Export Bulk Load Template"
                    }
               },
               {
                    "configuration_template": {
                         "method": "GET",
                         "class": "config",
                         "href": "/api/relation/GS_HuntGroupVoicemail_PilotData_Rel/configuration_template/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Configuration Template"
                    }
               },
               {
                    "list": {
                         "method": "GET",
                         "class": "list",
                         "href": "/api/relation/GS_HuntGroupVoicemail_PilotData_Rel/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "List"
                    }
               }
          ]
     },
     "resources": []
}

Instance API Reference

[pkid] is the ID of the resource instance.
If a payload is required, inspect the schema for payload details.

Task	Call	URL	Parameters	Payload
Modify	PUT	/api/relation/GS_HuntGroupVoicemail_PilotData_Rel/[pkid]	hierarchy=[hierarchy]	(For payload specification)

For Bulk modification, refer to the Bulk Modify section.

Task	Call	URL	Parameters	Response
Delete	DELETE	/api/relation/GS_HuntGroupVoicemail_PilotData_Rel/[pkid]	hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Get a selected [export_format] of the schema and a single instance with [pkid] of relation/GS_HuntGroupVoicemail_PilotData_Rel; optionally with tag_version at [version] and Configuration Template as [configtemplate].	GET	/api/relation/GS_HuntGroupVoicemail_PilotData_Rel/[pkid]/export	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	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/GS_HuntGroupVoicemail_PilotData_Rel and the JSON format can be used to import instances of relation/GS_HuntGroupVoicemail_PilotData_Rel.

For Bulk Export, refer to the Bulk Export section.

Task	Call	URL	Parameters	Response
Get	GET	/api/relation/GS_HuntGroupVoicemail_PilotData_Rel/[pkid]	hierarchy=[hierarchy]	The relation/GS_HuntGroupVoicemail_PilotData_Rel instance with [pkid].

API Reference for relation/GS_HuntGroupVoicemail_PilotData_Rel

GET http://[host-proxy]/api/relation/GS_HuntGroupVoicemail_PilotData_Rel/schema/?hierarchy=[hierarchy]&format=json&schema=1

Get the Add form

Create

Bulk Delete

Bulk Export

Export Bulk Load Template

Configuration Template

List

GET http://[host]/api/relation/GS_HuntGroupVoicemail_PilotData_Rel/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

Instance API Reference

Modify

Delete

Export

Get