[Index]
Model ref.: device/cuc/SmppProvider
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": { "IsEnabled": { "minItems": 0, "title": "Is Enabled", "type": "boolean", "description": " A flag indicating whether the SMPP is enabled and available to all applicable subscribers to use for SMS (SMPP) message notifications.\n", "name": "IsEnabled" }, "TextName": { "minItems": 0, "title": "Text Name", "type": "string", "description": " The unique text name of the SMPP Provider that represents the service provider in Cisco Unity Connection applications and is used when displaying entries in the administrative console, e.g. Cisco Unity Connection Administration.", "name": "TextName" }, "URI": { "name": "URI", "title": "URI", "minItems": 0, "format": "uri", "choices": [], "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "ObjectId": { "description": " The primary key for this table. A globally unique, system generated identifier for a SMPP Provider object. - template parameter [1]", "title": "Object Id", "minItems": 0, "readonly": true, "type": "string", "name": "ObjectId" } }, "schema_version": "14.0" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/cuc/SmppProvider/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/cuc/SmppProvider/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/SmppProvider/[pkid1]", "/api/v0/device/cuc/SmppProvider/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/SmppProvider/?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/SmppProvider |
|
{"hrefs": ["/api/device/cuc/SmppProvider/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/SmppProvider |
|
{"hrefs": ["/api/device/cuc/SmppProvider/[pkid1]", "/api/device/cuc/SmppProvider/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/SmppProvider; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cuc/SmppProvider/export/ |
|
{ "hrefs":["/api/device/cuc/SmppProvider/[pkid1]", "/api/device/cuc/SmppProvider/[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/SmppProvider and the JSON format can be used to import instances of device/cuc/SmppProvider.
GET http://[host-proxy]/api/device/cuc/SmppProvider/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/cuc/SmppProvider | POST | /api/device/cuc/SmppProvider/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/SmppProvider/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/SmppProvider/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/cuc/SmppProvider/ |
|
The device/cuc/SmppProvider schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/SmppProvider instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": "ObjectId", "maximum_limit": 2000, "skip": 0, "current": "/api/device/cuc/SmppProvider/?skip=0&limit=3&order_by=ObjectId&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 4 }, "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": [ { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/cuc/SmppProvider/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/SmppProvider", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cuc/SmppProvider/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/SmppProvider/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/cuc/SmppProvider/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/cuc/SmppProvider/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/cuc/SmppProvider/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/cuc/SmppProvider/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/cuc/SmppProvider/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/cuc/SmppProvider", "model_specific_actions": [ "list", "get", "bulk_update_form", "clone", "configuration_template", "export", "export_bulkload_template", "field_display_policy", "help", "move" ], "summary_attrs": [ { "name": "ObjectId", "title": "Object Id" }, { "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": "61b1585ceadb826afd81db4c", "meta": { "tags": [], "cached": true, "title": "79e436ca-4b9d-4b17-979c-d76981ab4b01", "business_key": {}, "schema_version": "", "summary": "false", "references": { "device": [ { "pkid": "61b15650eadb826afd81b7c1", "href": "/api/v0/data/UnityConnection/61b15650eadb826afd81b7c1" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "61b1585ceadb826afd81db4c", "href": "/api/device/cuc/SmppProvider/61b1585ceadb826afd81db4c/" } ], "parent": [ { "pkid": "61b1529aeadb826afd8146c6", "href": "/api/data/HierarchyNode/61b1529aeadb826afd8146c6" } ], "foreign_key": [] }, "actions": [ { "clone": { "support_async": false, "class": "clone", "href": "/api/device/cuc/SmppProvider/61b1585ceadb826afd81db4c/clone/?schema=&schema_rules=true", "method": "GET", "title": "Clone" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/61b1585ceadb826afd81db4c/?model_type=device/cuc/SmppProvider", "method": "POST", "view": "/api/tool/DataMove/" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cuc/SmppProvider/61b1585ceadb826afd81db4c/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "get": { "support_async": false, "class": "get", "href": "/api/device/cuc/SmppProvider/61b1585ceadb826afd81db4c/", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/cuc/SmppProvider/61b1585ceadb826afd81db4c/help", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/cuc/SmppProvider/61b1585ceadb826afd81db4c/purge/", "method": "POST", "title": "Purge" } } ], "model_type": "device/cuc/SmppProvider", "path": [ "6t0ggef2c0deab00hb595101", "61b0e48541e9336d6e1ee12e", "61b12e93eadb826afd7b5dad", "61b12ed1eadb826afd7b6ddc", "61b1529aeadb826afd8146c6", "61b1585ceadb826afd81db4c" ], "summary_attrs": [ { "name": "ObjectId", "title": "Object Id" }, { "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": { "TextName": "SMPP_Provider", "ObjectId": "79e436ca-4b9d-4b17-979c-d76981ab4b01", "IsEnabled": true, "URI": "/vmrest/smppproviders/79e436ca-4b9d-4b17-979c-d76981ab4b01", "hierarchy_friendly_name": "Overton (Customer)", "summary_device": "Dedicated CUCxn, 10.120.9.246, 8443, hcs.CS-P.CS-NB.Overton", "hierarchy_path": "sys.hcs.CS-P.CS-NB.Overton" } }, { "pkid": "61b13291eadb826afd7c8ff0", "meta": { "tags": [], "cached": true, "title": "81706368-0f3a-4e85-a807-21ba04a72266", "business_key": {}, "schema_version": "", "summary": "false", "references": { "device": [ { "pkid": "61b12f56eadb826afd7b8db9", "href": "/api/v0/data/UnityConnection/61b12f56eadb826afd7b8db9" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "61b13291eadb826afd7c8ff0", "href": "/api/device/cuc/SmppProvider/61b13291eadb826afd7c8ff0/" } ], "parent": [ { "pkid": "61b12edfeadb826afd7b715a", "href": "/api/data/HierarchyNode/61b12edfeadb826afd7b715a" } ], "foreign_key": [] }, "actions": [ { "clone": { "support_async": false, "href": "/api/device/cuc/SmppProvider/61b13291eadb826afd7c8ff0/clone/?schema=&schema_rules=true", "title": "Clone", "class": "clone", "method": "GET" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/61b13291eadb826afd7c8ff0/?model_type=device/cuc/SmppProvider", "method": "POST", "view": "/api/tool/DataMove/" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cuc/SmppProvider/61b13291eadb826afd7c8ff0/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "get": { "support_async": false, "href": "/api/device/cuc/SmppProvider/61b13291eadb826afd7c8ff0/", "title": "Get", "class": "get", "method": "GET" } }, { "help": { "support_async": false, "href": "/api/device/cuc/SmppProvider/61b13291eadb826afd7c8ff0/help", "title": "Help", "class": "help", "method": "GET" } }, { "purge": { "support_async": false, "href": "/api/device/cuc/SmppProvider/61b13291eadb826afd7c8ff0/purge/", "title": "Purge", "class": "purge", "method": "POST" } } ], "model_type": "device/cuc/SmppProvider", "path": [ "6t0ggef2c0deab00hb595101", "61b0e48541e9336d6e1ee12e", "61b12e93eadb826afd7b5dad", "61b12ed1eadb826afd7b6ddc", "61b12edfeadb826afd7b715a", "61b13291eadb826afd7c8ff0" ], "summary_attrs": [ { "name": "ObjectId", "title": "Object Id" }, { "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": { "TextName": "SMPP_Provider", "ObjectId": "81706368-0f3a-4e85-a807-21ba04a72266", "IsEnabled": true, "URI": "/vmrest/smppproviders/81706368-0f3a-4e85-a807-21ba04a72266", "hierarchy_friendly_name": "AAAGlobal (Customer)", "summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-NB.AAAGlobal", "hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal" } }, { "pkid": "61b134bbeadb826afd7d02e6", "meta": { "tags": [], "cached": true, "title": "81706368-0f3a-4e85-a807-21ba04a72266", "business_key": {}, "schema_version": "", "summary": "false", "references": { "device": [ { "pkid": "61b12fa5eadb826afd7ba3e2", "href": "/api/v0/data/UnityConnection/61b12fa5eadb826afd7ba3e2" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "61b134bbeadb826afd7d02e6", "href": "/api/device/cuc/SmppProvider/61b134bbeadb826afd7d02e6/" } ], "parent": [ { "pkid": "61b12edfeadb826afd7b715a", "href": "/api/data/HierarchyNode/61b12edfeadb826afd7b715a" } ], "foreign_key": [] }, "actions": [ { "clone": { "support_async": false, "method": "GET", "href": "/api/device/cuc/SmppProvider/61b134bbeadb826afd7d02e6/clone/?schema=&schema_rules=true", "class": "clone", "title": "Clone" } }, { "move": { "title": "Move", "support_async": true, "method": "POST", "href": "/api/tool/DataMove/61b134bbeadb826afd7d02e6/?model_type=device/cuc/SmppProvider", "class": "move", "view": "/api/tool/DataMove/" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "method": "GET", "href": "/api/device/cuc/SmppProvider/61b134bbeadb826afd7d02e6/export/", "class": "export", "view": "/api/view/ExportData/add/" } }, { "get": { "support_async": false, "method": "GET", "href": "/api/device/cuc/SmppProvider/61b134bbeadb826afd7d02e6/", "class": "get", "title": "Get" } }, { "help": { "support_async": false, "method": "GET", "href": "/api/device/cuc/SmppProvider/61b134bbeadb826afd7d02e6/help", "class": "help", "title": "Help" } }, { "purge": { "support_async": false, "method": "POST", "href": "/api/device/cuc/SmppProvider/61b134bbeadb826afd7d02e6/purge/", "class": "purge", "title": "Purge" } } ], "model_type": "device/cuc/SmppProvider", "path": [ "6t0ggef2c0deab00hb595101", "61b0e48541e9336d6e1ee12e", "61b12e93eadb826afd7b5dad", "61b12ed1eadb826afd7b6ddc", "61b12edfeadb826afd7b715a", "61b134bbeadb826afd7d02e6" ], "summary_attrs": [ { "name": "ObjectId", "title": "Object Id" }, { "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": { "TextName": "SMPP_Provider", "ObjectId": "81706368-0f3a-4e85-a807-21ba04a72266", "IsEnabled": true, "URI": "/vmrest/smppproviders/81706368-0f3a-4e85-a807-21ba04a72266", "hierarchy_friendly_name": "AAAGlobal (Customer)", "summary_device": "Dedicated CUCxn, 192.168.100.21, 8443, hcs.CS-P.CS-NB.AAAGlobal", "hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal" } } ] }
(Show the first instance)
{ "pkid": "61b1585ceadb826afd81db4c", "meta": { "tags": [], "cached": true, "cache_control_policy": "cache_then_device", "title": "79e436ca-4b9d-4b17-979c-d76981ab4b01", "business_key": {}, "schema_version": "11.5", "references": { "parent": [ { "pkid": "61b1529aeadb826afd8146c6", "href": "/api/data/HierarchyNode/61b1529aeadb826afd8146c6" } ], "self": [ { "pkid": "61b1585ceadb826afd81db4c", "href": "/api/device/cuc/SmppProvider/61b1585ceadb826afd81db4c/" } ], "foreign_key": [], "device": [ { "pkid": "61b15650eadb826afd81b7c1", "href": "/api/v0/data/UnityConnection/61b15650eadb826afd81b7c1" } ], "owner": [ { "pkid": "" } ], "children": [] }, "actions": [ { "clone": { "support_async": false, "class": "clone", "href": "/api/device/cuc/SmppProvider/61b1585ceadb826afd81db4c/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true", "method": "GET", "title": "Clone" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/61b1585ceadb826afd81db4c/?hierarchy=[hierarchy]&model_type=device/cuc/SmppProvider", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cuc/SmppProvider/61b1585ceadb826afd81db4c/export/?hierarchy=[hierarchy]", "method": "GET", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "get": { "support_async": false, "class": "get", "href": "/api/device/cuc/SmppProvider/61b1585ceadb826afd81db4c/?hierarchy=[hierarchy]", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/cuc/SmppProvider/61b1585ceadb826afd81db4c/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/cuc/SmppProvider/61b1585ceadb826afd81db4c/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/cuc/SmppProvider", "path": [ "6t0ggef2c0deab00hb595101", "61b0e48541e9336d6e1ee12e", "61b12e93eadb826afd7b5dad", "61b12ed1eadb826afd7b6ddc", "61b1529aeadb826afd8146c6", "61b1585ceadb826afd81db4c" ], "summary_attrs": [ { "name": "ObjectId", "title": "Object Id" }, { "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": { "IsEnabled": true, "TextName": "SMPP_Provider", "URI": "/vmrest/smppproviders/79e436ca-4b9d-4b17-979c-d76981ab4b01", "ObjectId": "79e436ca-4b9d-4b17-979c-d76981ab4b01" } }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for device/cuc/SmppProvider. | GET | /api/device/cuc/SmppProvider/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cuc/SmppProvider as HTML |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cuc/SmppProvider/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/SmppProvider/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cuc/SmppProvider | 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/SmppProvider; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cuc/SmppProvider/[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/SmppProvider and the JSON format can be used to import instances of device/cuc/SmppProvider.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/cuc/SmppProvider/[pkid]/ | hierarchy=[hierarchy] | The device/cuc/SmppProvider instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/cuc/SmppProvider/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cuc/SmppProvider. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/cuc/SmppProvider/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |