[Index]
Model ref.: device/cucm/SipTrunkSecurityProfile
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": {
"digestAuthentication": {
"title": "Digest Authentication",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"x509SubjectName": {
"title": "X509Subject Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 4096,
"type": [
"string",
"null"
]
},
"name": {
"title": "Name",
"minItems": 1,
"required": true,
"maxItems": 1,
"maxLength": 75,
"type": "string"
},
"acceptPresenceSubscription": {
"title": "Accept Presence Subscription",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"acceptUnsolicitedNotification": {
"title": "Accept Unsolicited Notification",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"sipV150OutboundSdpOfferFiltering": {
"title": "Sip V150Outbound Sdp Offer Filtering",
"minItems": 1,
"required": true,
"choices": [
{
"value": "No Filtering",
"title": "No Filtering"
},
{
"value": "Remove MER V.150",
"title": "Remove MER V.150"
},
{
"value": "Remove Pre-MER V.150",
"title": "Remove Pre-MER V.150"
},
{
"value": "Use Default Filter",
"title": "Use Default Filter"
}
],
"default": "Use Default Filter",
"maxItems": 1,
"type": "string"
},
"acceptOutOfDialogRefer": {
"title": "Accept Out Of Dialog Refer",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"outgoingTransport": {
"title": "Outgoing Transport",
"minItems": 0,
"required": false,
"choices": [
{
"value": "TCP",
"title": "TCP"
},
{
"value": "UDP",
"title": "UDP"
},
{
"value": "TLS",
"title": "TLS"
},
{
"value": "TCP+UDP",
"title": "TCP+UDP"
}
],
"maxItems": 1,
"type": [
"string",
"null"
]
},
"securityMode": {
"title": "Security Mode",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Non Secure",
"title": "Non Secure"
},
{
"value": "Authenticated",
"title": "Authenticated"
},
{
"value": "Encrypted",
"title": "Encrypted"
}
],
"maxItems": 1,
"type": [
"string",
"null"
]
},
"applLevelAuthentication": {
"title": "Appl Level Authentication",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"allowChargingHeader": {
"title": "Allow Charging Header",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"noncePolicyTime": {
"description": "Only if digestAuthentication is enabled this value can be changed.",
"title": "Nonce Policy Time",
"minItems": 0,
"required": false,
"default": 600,
"maxItems": 1,
"type": "integer"
},
"allowReplaceHeader": {
"title": "Allow Replace Header",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"incomingPort": {
"title": "Incoming Port",
"minItems": 0,
"required": false,
"default": 5060,
"maxItems": 1,
"type": "integer"
},
"incomingTransport": {
"title": "Incoming Transport",
"minItems": 0,
"required": false,
"choices": [
{
"value": "TCP",
"title": "TCP"
},
{
"value": "UDP",
"title": "UDP"
},
{
"value": "TLS",
"title": "TLS"
},
{
"value": "TCP+UDP",
"title": "TCP+UDP"
}
],
"default": "TCP+UDP",
"maxItems": 1,
"type": "string"
},
"transmitSecurityStatus": {
"title": "Transmit Security Status",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"description": {
"title": "Description",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 100,
"type": [
"string",
"null"
]
}
},
"schema_version": "12.5"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/device/cucm/SipTrunkSecurityProfile/add/ |
|
The GUI Add form of device/cucm/SipTrunkSecurityProfile 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/cucm/SipTrunkSecurityProfile/ | 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/cucm/SipTrunkSecurityProfile/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/cucm/SipTrunkSecurityProfile/[pkid1]", "/api/device/cucm/SipTrunkSecurityProfile/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/cucm/SipTrunkSecurityProfile/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cucm/SipTrunkSecurityProfile/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cucm/SipTrunkSecurityProfile/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cucm/SipTrunkSecurityProfile/[pkid1]", "/api/v0/device/cucm/SipTrunkSecurityProfile/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cucm/SipTrunkSecurityProfile/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/cucm/SipTrunkSecurityProfile |
|
{"hrefs": ["/api/device/cucm/SipTrunkSecurityProfile/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cucm/SipTrunkSecurityProfile |
|
{"hrefs": ["/api/device/cucm/SipTrunkSecurityProfile/[pkid1]", "/api/device/cucm/SipTrunkSecurityProfile/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cucm/SipTrunkSecurityProfile; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cucm/SipTrunkSecurityProfile/export/ |
|
{ "hrefs":["/api/device/cucm/SipTrunkSecurityProfile/[pkid1]", "/api/device/cucm/SipTrunkSecurityProfile/[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/cucm/SipTrunkSecurityProfile and the JSON format can be used to import instances of device/cucm/SipTrunkSecurityProfile.
GET http://[host-proxy]/api/device/cucm/SipTrunkSecurityProfile/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cucm/SipTrunkSecurityProfile | POST | /api/device/cucm/SipTrunkSecurityProfile/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/cucm/SipTrunkSecurityProfile/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/device/cucm/SipTrunkSecurityProfile/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cucm/SipTrunkSecurityProfile/ |
|
The device/cucm/SipTrunkSecurityProfile schema and all instances as JSON. |
(The list will return 0 to 3 device/cucm/SipTrunkSecurityProfile instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"clone",
"move",
"list",
"update",
"remove",
"bulk_update_form",
"add",
"transform",
"export",
"export_bulkload_template"
],
"pagination": {
"direction": "asc",
"order_by": "name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/cucm/SipTrunkSecurityProfile/?skip=0&limit=3&order_by=name&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 8
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "12.5",
"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/cucm/SipTrunkSecurityProfile/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/cucm/SipTrunkSecurityProfile/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/cucm/SipTrunkSecurityProfile/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/cucm/SipTrunkSecurityProfile",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/SipTrunkSecurityProfile/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/cucm/SipTrunkSecurityProfile/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/cucm/SipTrunkSecurityProfile/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/cucm/SipTrunkSecurityProfile/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/cucm/SipTrunkSecurityProfile/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cucm/SipTrunkSecurityProfile/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cucm/SipTrunkSecurityProfile/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cucm/SipTrunkSecurityProfile",
"model_specific_actions": [
"reset",
"configuration_template",
"field_display_policy",
"help",
"get",
"clone",
"move",
"list",
"update",
"remove",
"add",
"export",
"apply",
"export_bulkload_template",
"bulk_update_form"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "20.1.1",
"tagged_versions": []
},
"resources": [
{
"pkid": "5fff570ace894e0015508567",
"meta": {
"tags": [],
"cached": true,
"title": "Non Secure SIP Conference Bridge",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "5fff5677ce894e0015506295",
"href": "/api/v0/data/CallManager/5fff5677ce894e0015506295"
}
],
"self": [
{
"pkid": "5fff570ace894e0015508567",
"href": "/api/device/cucm/SipTrunkSecurityProfile/5fff570ace894e0015508567/"
}
],
"parent": [
{
"pkid": "5fff560ace894e001550455c",
"href": "/api/data/HierarchyNode/5fff560ace894e001550455c"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/cucm/SipTrunkSecurityProfile/5fff570ace894e0015508567/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/cucm/SipTrunkSecurityProfile/5fff570ace894e0015508567/",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cucm/SipTrunkSecurityProfile/5fff570ace894e0015508567/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5fff570ace894e0015508567/?model_type=device/cucm/SipTrunkSecurityProfile",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/SipTrunkSecurityProfile/5fff570ace894e0015508567/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cucm/SipTrunkSecurityProfile/5fff570ace894e0015508567/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cucm/SipTrunkSecurityProfile/5fff570ace894e0015508567/help",
"method": "GET",
"title": "Help"
}
},
{
"apply": {
"title": "Apply",
"support_async": true,
"method": "POST",
"href": "/api/device/cucm/SipTrunkSecurityProfile/5fff570ace894e0015508567/+apply/",
"class": "custom",
"view": "/api/device/cucm/SipTrunkSecurityProfile/+apply/schema/"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cucm/SipTrunkSecurityProfile/5fff570ace894e0015508567/purge/",
"method": "POST",
"title": "Purge"
}
},
{
"reset": {
"title": "Reset",
"support_async": true,
"method": "POST",
"href": "/api/device/cucm/SipTrunkSecurityProfile/5fff570ace894e0015508567/+reset/",
"class": "custom",
"view": "/api/device/cucm/SipTrunkSecurityProfile/+reset/schema/"
}
}
],
"model_type": "device/cucm/SipTrunkSecurityProfile",
"path": [
"6t0ggef2c0deab00hb595101",
"5fff24a2ce894e0015f6de4e",
"5fff560ace894e001550455c",
"5fff570ace894e0015508567"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "20.1.1",
"tagged_versions": []
},
"data": {
"digestAuthentication": false,
"x509SubjectName": null,
"name": "Non Secure SIP Conference Bridge",
"acceptPresenceSubscription": false,
"hierarchy": "5fff560ace894e001550455c",
"acceptUnsolicitedNotification": false,
"description": "Non Secure SIP Conference Bridge",
"sipV150OutboundSdpOfferFiltering": "Use Default Filter",
"acceptOutOfDialogRefer": false,
"outgoingTransport": "TCP",
"securityMode": "Non Secure",
"applLevelAuthentication": false,
"allowChargingHeader": false,
"noncePolicyTime": 600,
"allowReplaceHeader": false,
"incomingPort": 5060,
"incomingTransport": "TCP+UDP",
"summary_device": "Shared CUCM, 192.168.100.17, 8443, hcs.CS-P",
"hierarchy_friendly_name": "CS-P (Provider)",
"transmitSecurityStatus": false,
"hierarchy_path": "sys.hcs.CS-P"
}
},
{
"pkid": "5fff57a9ce894e001550a48e",
"meta": {
"tags": [],
"cached": true,
"title": "Non Secure SIP Conference Bridge",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "5fff56abce894e0015506e8c",
"href": "/api/v0/data/CallManager/5fff56abce894e0015506e8c"
}
],
"self": [
{
"pkid": "5fff57a9ce894e001550a48e",
"href": "/api/device/cucm/SipTrunkSecurityProfile/5fff57a9ce894e001550a48e/"
}
],
"parent": [
{
"pkid": "5fff5657ce894e001550592f",
"href": "/api/data/HierarchyNode/5fff5657ce894e001550592f"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/device/cucm/SipTrunkSecurityProfile/5fff57a9ce894e001550a48e/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"remove": {
"support_async": true,
"href": "/api/device/cucm/SipTrunkSecurityProfile/5fff57a9ce894e001550a48e/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"clone": {
"support_async": false,
"href": "/api/device/cucm/SipTrunkSecurityProfile/5fff57a9ce894e001550a48e/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5fff57a9ce894e001550a48e/?model_type=device/cucm/SipTrunkSecurityProfile",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/SipTrunkSecurityProfile/5fff57a9ce894e001550a48e/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/device/cucm/SipTrunkSecurityProfile/5fff57a9ce894e001550a48e/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/device/cucm/SipTrunkSecurityProfile/5fff57a9ce894e001550a48e/help",
"title": "Help",
"class": "help",
"method": "GET"
}
},
{
"apply": {
"title": "Apply",
"support_async": true,
"class": "custom",
"href": "/api/device/cucm/SipTrunkSecurityProfile/5fff57a9ce894e001550a48e/+apply/",
"method": "POST",
"view": "/api/device/cucm/SipTrunkSecurityProfile/+apply/schema/"
}
},
{
"purge": {
"support_async": false,
"href": "/api/device/cucm/SipTrunkSecurityProfile/5fff57a9ce894e001550a48e/purge/",
"title": "Purge",
"class": "purge",
"method": "POST"
}
},
{
"reset": {
"title": "Reset",
"support_async": true,
"class": "custom",
"href": "/api/device/cucm/SipTrunkSecurityProfile/5fff57a9ce894e001550a48e/+reset/",
"method": "POST",
"view": "/api/device/cucm/SipTrunkSecurityProfile/+reset/schema/"
}
}
],
"model_type": "device/cucm/SipTrunkSecurityProfile",
"path": [
"6t0ggef2c0deab00hb595101",
"5fff24a2ce894e0015f6de4e",
"5fff560ace894e001550455c",
"5fff5649ce894e001550558f",
"5fff5657ce894e001550592f",
"5fff57a9ce894e001550a48e"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "20.1.1",
"tagged_versions": []
},
"data": {
"digestAuthentication": false,
"x509SubjectName": null,
"name": "Non Secure SIP Conference Bridge",
"acceptPresenceSubscription": false,
"hierarchy": "5fff5657ce894e001550592f",
"acceptUnsolicitedNotification": false,
"description": "Non Secure SIP Conference Bridge",
"sipV150OutboundSdpOfferFiltering": "Use Default Filter",
"acceptOutOfDialogRefer": false,
"outgoingTransport": "TCP",
"securityMode": "Non Secure",
"applLevelAuthentication": false,
"allowChargingHeader": false,
"noncePolicyTime": 600,
"allowReplaceHeader": false,
"incomingPort": 5060,
"incomingTransport": "TCP+UDP",
"summary_device": "Dedicated CUCM, 192.168.100.15, 8443, hcs.CS-P.CS-NB.AAAGlobal",
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"transmitSecurityStatus": false,
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
},
{
"pkid": "5fff58abce894e001550f4aa",
"meta": {
"tags": [],
"cached": true,
"title": "Non Secure SIP Conference Bridge",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "5fff56f3ce894e00155080b5",
"href": "/api/v0/data/CallManager/5fff56f3ce894e00155080b5"
}
],
"self": [
{
"pkid": "5fff58abce894e001550f4aa",
"href": "/api/device/cucm/SipTrunkSecurityProfile/5fff58abce894e001550f4aa/"
}
],
"parent": [
{
"pkid": "5fff5657ce894e001550592f",
"href": "/api/data/HierarchyNode/5fff5657ce894e001550592f"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/device/cucm/SipTrunkSecurityProfile/5fff58abce894e001550f4aa/",
"class": "update",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"method": "DELETE",
"href": "/api/device/cucm/SipTrunkSecurityProfile/5fff58abce894e001550f4aa/",
"class": "delete",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/device/cucm/SipTrunkSecurityProfile/5fff58abce894e001550f4aa/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"method": "POST",
"href": "/api/tool/DataMove/5fff58abce894e001550f4aa/?model_type=device/cucm/SipTrunkSecurityProfile",
"class": "move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/device/cucm/SipTrunkSecurityProfile/5fff58abce894e001550f4aa/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/device/cucm/SipTrunkSecurityProfile/5fff58abce894e001550f4aa/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/device/cucm/SipTrunkSecurityProfile/5fff58abce894e001550f4aa/help",
"class": "help",
"title": "Help"
}
},
{
"apply": {
"title": "Apply",
"support_async": true,
"class": "custom",
"href": "/api/device/cucm/SipTrunkSecurityProfile/5fff58abce894e001550f4aa/+apply/",
"method": "POST",
"view": "/api/device/cucm/SipTrunkSecurityProfile/+apply/schema/"
}
},
{
"purge": {
"support_async": false,
"method": "POST",
"href": "/api/device/cucm/SipTrunkSecurityProfile/5fff58abce894e001550f4aa/purge/",
"class": "purge",
"title": "Purge"
}
},
{
"reset": {
"title": "Reset",
"support_async": true,
"class": "custom",
"href": "/api/device/cucm/SipTrunkSecurityProfile/5fff58abce894e001550f4aa/+reset/",
"method": "POST",
"view": "/api/device/cucm/SipTrunkSecurityProfile/+reset/schema/"
}
}
],
"model_type": "device/cucm/SipTrunkSecurityProfile",
"path": [
"6t0ggef2c0deab00hb595101",
"5fff24a2ce894e0015f6de4e",
"5fff560ace894e001550455c",
"5fff5649ce894e001550558f",
"5fff5657ce894e001550592f",
"5fff58abce894e001550f4aa"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "20.1.1",
"tagged_versions": []
},
"data": {
"digestAuthentication": false,
"x509SubjectName": null,
"name": "Non Secure SIP Conference Bridge",
"acceptPresenceSubscription": false,
"hierarchy": "5fff5657ce894e001550592f",
"acceptUnsolicitedNotification": false,
"description": "Non Secure SIP Conference Bridge",
"sipV150OutboundSdpOfferFiltering": "Use Default Filter",
"acceptOutOfDialogRefer": false,
"outgoingTransport": "TCP",
"securityMode": "Non Secure",
"applLevelAuthentication": false,
"allowChargingHeader": false,
"noncePolicyTime": 600,
"allowReplaceHeader": false,
"incomingPort": 5060,
"incomingTransport": "TCP+UDP",
"summary_device": "Dedicated CUCM, 192.168.100.16, 8443, hcs.CS-P.CS-NB.AAAGlobal",
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"transmitSecurityStatus": false,
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
}
]
}
(Show the first instance)
{
"pkid": "5fff570ace894e0015508567",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "Non Secure SIP Conference Bridge",
"business_key": {},
"schema_version": "11.5",
"references": {
"parent": [
{
"pkid": "5fff560ace894e001550455c",
"href": "/api/data/HierarchyNode/5fff560ace894e001550455c"
}
],
"self": [
{
"pkid": "5fff570ace894e0015508567",
"href": "/api/device/cucm/SipTrunkSecurityProfile/5fff570ace894e0015508567/"
}
],
"foreign_key": [],
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "5fff5677ce894e0015506295",
"href": "/api/v0/data/CallManager/5fff5677ce894e0015506295"
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/cucm/SipTrunkSecurityProfile/5fff570ace894e0015508567/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/cucm/SipTrunkSecurityProfile/5fff570ace894e0015508567/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cucm/SipTrunkSecurityProfile/5fff570ace894e0015508567/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5fff570ace894e0015508567/?hierarchy=[hierarchy]&model_type=device/cucm/SipTrunkSecurityProfile",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/SipTrunkSecurityProfile/5fff570ace894e0015508567/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cucm/SipTrunkSecurityProfile/5fff570ace894e0015508567/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cucm/SipTrunkSecurityProfile/5fff570ace894e0015508567/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"apply": {
"title": "Apply",
"support_async": true,
"method": "POST",
"href": "/api/device/cucm/SipTrunkSecurityProfile/5fff570ace894e0015508567/+apply/?hierarchy=[hierarchy]",
"class": "custom",
"view": "/api/device/cucm/SipTrunkSecurityProfile/+apply/schema/?auth_token=[authtoken]
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cucm/SipTrunkSecurityProfile/5fff570ace894e0015508567/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
},
{
"reset": {
"title": "Reset",
"support_async": true,
"method": "POST",
"href": "/api/device/cucm/SipTrunkSecurityProfile/5fff570ace894e0015508567/+reset/?hierarchy=[hierarchy]",
"class": "custom",
"view": "/api/device/cucm/SipTrunkSecurityProfile/+reset/schema/?auth_token=[authtoken]
}
}
],
"model_type": "device/cucm/SipTrunkSecurityProfile",
"path": [
"6t0ggef2c0deab00hb595101",
"5fff24a2ce894e0015f6de4e",
"5fff560ace894e001550455c",
"5fff570ace894e0015508567"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "20.1.1",
"tagged_versions": []
},
"data": {
"digestAuthentication": false,
"x509SubjectName": null,
"description": "Non Secure SIP Conference Bridge",
"acceptPresenceSubscription": false,
"acceptUnsolicitedNotification": false,
"sipV150OutboundSdpOfferFiltering": "Use Default Filter",
"acceptOutOfDialogRefer": false,
"outgoingTransport": "TCP",
"securityMode": "Non Secure",
"applLevelAuthentication": false,
"allowChargingHeader": false,
"noncePolicyTime": 600,
"allowReplaceHeader": false,
"incomingPort": 5060,
"incomingTransport": "TCP+UDP",
"transmitSecurityStatus": false,
"name": "Non Secure SIP Conference Bridge"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cucm/SipTrunkSecurityProfile. | GET | /api/device/cucm/SipTrunkSecurityProfile/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cucm/SipTrunkSecurityProfile as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/cucm/SipTrunkSecurityProfile/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/device/cucm/SipTrunkSecurityProfile/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cucm/SipTrunkSecurityProfile/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cucm/SipTrunkSecurityProfile/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cucm/SipTrunkSecurityProfile | 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/cucm/SipTrunkSecurityProfile; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cucm/SipTrunkSecurityProfile/[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/cucm/SipTrunkSecurityProfile and the JSON format can be used to import instances of device/cucm/SipTrunkSecurityProfile.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cucm/SipTrunkSecurityProfile/[pkid]/ | hierarchy=[hierarchy] | The device/cucm/SipTrunkSecurityProfile instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cucm/SipTrunkSecurityProfile/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cucm/SipTrunkSecurityProfile. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Apply | POST | /api/device/cucm/SipTrunkSecurityProfile/[pkid]/+apply/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cucm/SipTrunkSecurityProfile/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Reset | POST | /api/device/cucm/SipTrunkSecurityProfile/[pkid]/+reset/ | hierarchy=[hierarchy] | If payload required: |