[Index]
Model ref.: device/cuc/SmsDevice
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": {
"DisplayName": {
"description": " The preferred text name of the notification device to be used when displaying entries in the administrative console, e.g. Cisco Unity Connection Administration. For example, \"Home Phone,\" Pager 2,\" \"Work Phone, \" etc. ",
"title": "Display Name",
"minItems": 0,
"required": true,
"type": "string",
"name": "DisplayName"
},
"SmppProviderObjectId": {
"description": " The unique identifier of the SMPPProvider object that is used by this notification device.",
"name": "SmppProviderObjectId",
"format": "uri",
"minItems": 0,
"required": true,
"choices": [],
"target_attr": "ObjectId",
"target_model_type": "device/cuc/SmppProvider",
"title": "Smpp Provider Object Id",
"type": [
"string"
],
"target": "/api/device/cuc/SmppProvider/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"UserURI": {
"name": "UserURI",
"title": "User URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"RecipientAddress": {
"minItems": 0,
"title": "Recipient Address",
"type": "string",
"description": " The phone number of the SMS-compatible device to receive the message. In CUSA, this is referred to as the \"To:\" field.",
"name": "RecipientAddress"
},
"SendCount": {
"minItems": 0,
"title": "Send Count",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection will include a count of each voice mail, fax, and e-mail message with the notification message. When the subscriber receives the notification, the message count appears as a line for each type of message. ",
"name": "SendCount"
},
"MaxSubject": {
"minItems": 0,
"title": "Max Subject",
"type": "integer",
"description": " The maximum number of characters allowed in the 'subject' of a notification message.",
"name": "MaxSubject"
},
"MaxBody": {
"minItems": 0,
"title": "Max Body",
"type": "integer",
"description": " The maximum number of characters allowed in the 'body' of a notification message.",
"name": "MaxBody"
},
"SubscriberObjectId": {
"description": " The unique identifier of the Subscriber object to which this notification device belongs. - template parameter [1]",
"name": "SubscriberObjectId",
"format": "uri",
"minItems": 0,
"required": true,
"choices": [],
"target_attr": "ObjectId",
"target_model_type": "device/cuc/User",
"title": "Subscriber Object Id",
"type": [
"string"
],
"target": "/api/device/cuc/User/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"ScheduleSetObjectId": {
"title": "Schedule Set Object Id",
"type": "string",
"description": "ObjectId of the ScheduleSet for when the notification rule is active.",
"name": "ScheduleSetObjectId"
},
"SenderAddress": {
"minItems": 0,
"title": "Sender Address",
"type": "string",
"description": " The return phone number for the message notification. Typically, this column contains the number that the subscriber calls to check messages (i.e., pilot number for Cisco Unity Connection voice mail). If the SMPP Provider requires a source address for the server sending the message, the SMSC will overwrite this data with an IP address. In CUSA, this is referred to as the \"From:\" field.",
"name": "SenderAddress"
},
"Active": {
"minItems": 0,
"title": "Active",
"type": "boolean",
"description": " A flag indicating whether the device is active or inactive (enabled/disabled).",
"name": "Active"
},
"RepeatInterval": {
"title": "Repeat Interval",
"type": "integer",
"description": "The amount of time (in minutes) Cisco Unity Connection will wait before re-notifying a subscriber of new messages.",
"name": "RepeatInterval"
},
"ObjectId": {
"description": " The primary key for this table. A globally unique, system-generated identifier for a NotificationDeviceSMS object. - template parameter [2]",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"DeviceName": {
"description": " The \"DeviceName\" of the notification device.",
"title": "Device Name",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "DeviceName"
},
"EventList": {
"title": "Event List",
"type": "string",
"description": "Comma separated list of events that trigger notification rules to be evaluated.",
"name": "EventList"
},
"SendCallerId": {
"minItems": 0,
"title": "Send Caller Id",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection will include the caller id (if available) with the notification message. ",
"name": "SendCallerId"
},
"URI": {
"name": "URI",
"title": "URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"StaticText": {
"minItems": 0,
"title": "Static Text",
"type": "string",
"description": " The text message that the subscriber wants to receive in a Text Pager notification. For Text Pager notifications only. The SA refers to this as the \"Send:\" field.\nTypically holds email address. Also holds text for text pagers. SA text pager calls this 'send text'. It is empty for numeric pagers.",
"name": "StaticText"
},
"Undeletable": {
"minItems": 0,
"title": "Undeletable",
"type": "boolean",
"description": "Device cannot be deleted.",
"name": "Undeletable"
},
"FailDeviceObjectId": {
"title": "Fail Device Object Id",
"type": "string",
"description": "ObjectId of the NotificationDevice that Cisco Unity Connection will use if attempted notification to this device fails.",
"name": "FailDeviceObjectId"
},
"InitialDelay": {
"title": "Initial Delay",
"type": "integer",
"description": "The amount of time (in minutes) from the time when a message is received until message notification triggers.",
"name": "InitialDelay"
},
"RepeatNotify": {
"title": "Repeat Notify",
"type": "boolean",
"description": "A flag indicating whether Cisco Unity Connection begins a notification process immediately upon the arrival of each message that matches the specified critera.",
"name": "RepeatNotify"
}
},
"schema_version": "14.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/device/cuc/SmsDevice/add/ |
|
The GUI Add form of device/cuc/SmsDevice 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/cuc/SmsDevice/ | 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/cuc/SmsDevice/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/cuc/SmsDevice/[pkid1]", "/api/device/cuc/SmsDevice/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/cuc/SmsDevice/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cuc/SmsDevice/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cuc/SmsDevice/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/SmsDevice/[pkid1]", "/api/v0/device/cuc/SmsDevice/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/SmsDevice/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/cuc/SmsDevice |
|
{"hrefs": ["/api/device/cuc/SmsDevice/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/SmsDevice |
|
{"hrefs": ["/api/device/cuc/SmsDevice/[pkid1]", "/api/device/cuc/SmsDevice/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/SmsDevice; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cuc/SmsDevice/export/ |
|
{ "hrefs":["/api/device/cuc/SmsDevice/[pkid1]", "/api/device/cuc/SmsDevice/[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/cuc/SmsDevice and the JSON format can be used to import instances of device/cuc/SmsDevice.
GET http://[host-proxy]/api/device/cuc/SmsDevice/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cuc/SmsDevice | POST | /api/device/cuc/SmsDevice/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/cuc/SmsDevice/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/device/cuc/SmsDevice/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cuc/SmsDevice/ |
|
The device/cuc/SmsDevice schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/SmsDevice instances)
{
"operations": [
"move"
],
"pagination": {
"direction": "asc",
"order_by": "DisplayName",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/cuc/SmsDevice/?skip=0&limit=3&order_by=DisplayName&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 1
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "14.0",
"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/cuc/SmsDevice/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/cuc/SmsDevice/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/cuc/SmsDevice/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/cuc/SmsDevice",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/SmsDevice/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/cuc/SmsDevice/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/cuc/SmsDevice/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/cuc/SmsDevice/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/cuc/SmsDevice/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/SmsDevice/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/SmsDevice/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/SmsDevice",
"model_specific_actions": [
"add",
"list",
"update",
"get",
"remove",
"bulk_update_form",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"help",
"move"
],
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": [
{
"pkid": "610a2e39e04a4a0014aa53a3",
"meta": {
"tags": [],
"cached": true,
"title": "SMS2Modded",
"business_key": {},
"schema_version": "12.5",
"summary": "false",
"references": {
"device": [
{
"pkid": "6109c0bfe04a4a00149d7d52",
"href": "/api/v0/data/UnityConnection/6109c0bfe04a4a00149d7d52"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "610a2e39e04a4a0014aa53a3",
"href": "/api/device/cuc/SmsDevice/610a2e39e04a4a0014aa53a3/"
}
],
"parent": [
{
"pkid": "6109c297e04a4a00149e0152",
"href": "/api/data/HierarchyNode/6109c297e04a4a00149e0152"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/cuc/SmsDevice/610a2e39e04a4a0014aa53a3/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/cuc/SmsDevice/610a2e39e04a4a0014aa53a3/",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/SmsDevice/610a2e39e04a4a0014aa53a3/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/610a2e39e04a4a0014aa53a3/?model_type=device/cuc/SmsDevice",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/SmsDevice/610a2e39e04a4a0014aa53a3/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/SmsDevice/610a2e39e04a4a0014aa53a3/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/SmsDevice/610a2e39e04a4a0014aa53a3/help",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/SmsDevice/610a2e39e04a4a0014aa53a3/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/SmsDevice",
"path": [
"6t0ggef2c0deab00hb595101",
"61097058e04a4a001501b18c",
"6109bff5e04a4a00149d4e1d",
"6109c032e04a4a00149d5e4d",
"6109c040e04a4a00149d61cf",
"6109c297e04a4a00149e0152",
"610a2e39e04a4a0014aa53a3"
],
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"DisplayName": "SMS2Modded",
"SmppProviderObjectId": "81706368-0f3a-4e85-a807-21ba04a72266",
"UserURI": "/vmrest/users/89a19b05-0459-41fc-b6d6-54e1cf8ebff9",
"RecipientAddress": "741852963",
"SendCount": true,
"hierarchy_friendly_name": "LOC002 (Site)",
"MaxSubject": 64,
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal.LOC002",
"DeviceName": "Other",
"SubscriberObjectId": "89a19b05-0459-41fc-b6d6-54e1cf8ebff9",
"ScheduleSetObjectId": "1729b420-bf89-47e2-a44a-ff5e81761566",
"Active": true,
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-NB.AAAGlobal",
"RepeatInterval": 0,
"ObjectId": "e4da22be-6263-452b-ae79-6451790a593e",
"MaxBody": 512,
"EventList": "NewVoiceMail",
"SendCallerId": true,
"URI": "/vmrest/users/89a19b05-0459-41fc-b6d6-54e1cf8ebff9/notificationdevices/smsdevices/e4da22be-6263-452b-ae79-6451790a593e",
"Undeletable": false,
"InitialDelay": 0,
"RepeatNotify": false
}
}
]
}
(Show the first instance)
{
"pkid": "610a2e39e04a4a0014aa53a3",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "SMS2Modded",
"business_key": {},
"schema_version": "12.5",
"references": {
"parent": [
{
"pkid": "6109c297e04a4a00149e0152",
"href": "/api/data/HierarchyNode/6109c297e04a4a00149e0152"
}
],
"self": [
{
"pkid": "610a2e39e04a4a0014aa53a3",
"href": "/api/device/cuc/SmsDevice/610a2e39e04a4a0014aa53a3/"
}
],
"foreign_key": [],
"device": [
{
"pkid": "6109c0bfe04a4a00149d7d52",
"href": "/api/v0/data/UnityConnection/6109c0bfe04a4a00149d7d52"
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/cuc/SmsDevice/610a2e39e04a4a0014aa53a3/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/cuc/SmsDevice/610a2e39e04a4a0014aa53a3/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/SmsDevice/610a2e39e04a4a0014aa53a3/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/610a2e39e04a4a0014aa53a3/?hierarchy=[hierarchy]&model_type=device/cuc/SmsDevice",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/SmsDevice/610a2e39e04a4a0014aa53a3/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/SmsDevice/610a2e39e04a4a0014aa53a3/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/SmsDevice/610a2e39e04a4a0014aa53a3/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/SmsDevice/610a2e39e04a4a0014aa53a3/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/SmsDevice",
"path": [
"6t0ggef2c0deab00hb595101",
"61097058e04a4a001501b18c",
"6109bff5e04a4a00149d4e1d",
"6109c032e04a4a00149d5e4d",
"6109c040e04a4a00149d61cf",
"6109c297e04a4a00149e0152",
"610a2e39e04a4a0014aa53a3"
],
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"MaxBody": 512,
"MaxSubject": 64,
"DisplayName": "SMS2Modded",
"ObjectId": "e4da22be-6263-452b-ae79-6451790a593e",
"DeviceName": "Other",
"EventList": "NewVoiceMail",
"SubscriberObjectId": "89a19b05-0459-41fc-b6d6-54e1cf8ebff9",
"ScheduleSetObjectId": "1729b420-bf89-47e2-a44a-ff5e81761566",
"SendCallerId": true,
"SmppProviderObjectId": "81706368-0f3a-4e85-a807-21ba04a72266",
"UserURI": "/vmrest/users/89a19b05-0459-41fc-b6d6-54e1cf8ebff9",
"RecipientAddress": "741852963",
"RepeatNotify": false,
"SendCount": true,
"Active": true,
"RepeatInterval": 0,
"InitialDelay": 0,
"Undeletable": false,
"URI": "/vmrest/users/89a19b05-0459-41fc-b6d6-54e1cf8ebff9/notificationdevices/smsdevices/e4da22be-6263-452b-ae79-6451790a593e"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cuc/SmsDevice. | GET | /api/device/cuc/SmsDevice/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cuc/SmsDevice as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/cuc/SmsDevice/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/device/cuc/SmsDevice/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cuc/SmsDevice/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/SmsDevice/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cuc/SmsDevice | 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/cuc/SmsDevice; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cuc/SmsDevice/[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/cuc/SmsDevice and the JSON format can be used to import instances of device/cuc/SmsDevice.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cuc/SmsDevice/[pkid]/ | hierarchy=[hierarchy] | The device/cuc/SmsDevice instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cuc/SmsDevice/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cuc/SmsDevice. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cuc/SmsDevice/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |