[Index]
This relation wraps the device/cucm/SipTrunkSecurityProfile element.
Model ref.: relation/HcsSipTrunkSecurityProfileREL
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"
},
"allowReplaceHeader": {
"title": "Allow Replace Header",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"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"
},
"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"
]
},
"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"
]
},
"shadow": {
"title": "Shadow",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"title": "Name",
"type": "string",
"maxLength": 1024,
"required": true,
"readonly": false,
"is_password": false,
"displayable": false
}
}
},
"maxItems": 1
}
},
"schema_version": "2.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/HcsSipTrunkSecurityProfileREL/add/ |
|
The GUI Add form of relation/HcsSipTrunkSecurityProfileREL 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/HcsSipTrunkSecurityProfileREL | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/relation/HcsSipTrunkSecurityProfileREL/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/HcsSipTrunkSecurityProfileREL/[pkid1]", "/api/relation/HcsSipTrunkSecurityProfileREL/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/HcsSipTrunkSecurityProfileREL/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/HcsSipTrunkSecurityProfileREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/HcsSipTrunkSecurityProfileREL/export/ |
|
{ "hrefs":["/api/relation/HcsSipTrunkSecurityProfileREL/[pkid1]", "/api/relation/HcsSipTrunkSecurityProfileREL/[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/HcsSipTrunkSecurityProfileREL and the JSON format can be used to import instances of relation/HcsSipTrunkSecurityProfileREL.
GET http://[host-proxy]/api/relation/HcsSipTrunkSecurityProfileREL/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/HcsSipTrunkSecurityProfileREL | POST | /api/relation/HcsSipTrunkSecurityProfileREL/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/HcsSipTrunkSecurityProfileREL/ |
|
The relation/HcsSipTrunkSecurityProfileREL schema and all instances as JSON. |
(The list will return 0 to 3 relation/HcsSipTrunkSecurityProfileREL instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 4,
"total_limit": null,
"order_by": "name",
"direction": "asc",
"current": "/api/relation/HcsSipTrunkSecurityProfileREL/?skip=0&limit=3&order_by=name&direction=asc&traversal=down"
},
"operations": [
"list",
"help",
"field_display_policy",
"get",
"configuration_template",
"update",
"bulk_update",
"remove",
"add",
"export",
"clone",
"export_bulkload_template"
],
"meta": {
"model_type": "relation/HcsSipTrunkSecurityProfileREL",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"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/HcsSipTrunkSecurityProfileREL/None/",
"pkid": null
}
]
},
"model_specific_actions": [
"list",
"help",
"get",
"update",
"remove",
"add",
"export",
"clone",
"export_bulkload_template"
],
"schema_version": "2.1",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/relation/HcsSipTrunkSecurityProfileREL/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/HcsSipTrunkSecurityProfileREL/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/relation/HcsSipTrunkSecurityProfileREL/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/HcsSipTrunkSecurityProfileREL/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/relation/HcsSipTrunkSecurityProfileREL/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/HcsSipTrunkSecurityProfileREL/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": [
{
"data": {
"digestAuthentication": false,
"x509SubjectName": null,
"name": "Non Secure SIP Conference Bridge",
"acceptPresenceSubscription": false,
"hierarchy": "5df0b66bce894e001275a913",
"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,
"description": "Non Secure SIP Conference Bridge",
"summary_device": "Dedicated CUCM, 192.168.100.15, 8443, hcs.CS-P.CS-AB.AB_Group",
"hierarchy_friendly_name": "AB_Group (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
},
"meta": {
"model_type": "relation/HcsSipTrunkSecurityProfileREL",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "Non Secure SIP Conference Bridge",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"href": "/api/v0/data/CallManager/5df0b693ce894e001275c115",
"pkid": "5df0b693ce894e001275c115"
}
],
"parent": [
{
"pkid": "5df0b66bce894e001275a913",
"href": "/api/data/HierarchyNode/5df0b66bce894e001275a913"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/relation/HcsSipTrunkSecurityProfileREL/5df0b745ce894e001275e897/",
"pkid": "5df0b745ce894e001275e897"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5da4c643ce894e0012225c90",
"5df0b338ce894e001275535c",
"5df0b3a3ce894e0012756904",
"5df0b66bce894e001275a913",
"5df0b745ce894e001275e897"
],
"schema_version": "",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/HcsSipTrunkSecurityProfileREL/5df0b745ce894e001275e897/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/HcsSipTrunkSecurityProfileREL/5df0b745ce894e001275e897/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/relation/HcsSipTrunkSecurityProfileREL/5df0b745ce894e001275e897/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/HcsSipTrunkSecurityProfileREL/5df0b745ce894e001275e897/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/HcsSipTrunkSecurityProfileREL/5df0b745ce894e001275e897/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/HcsSipTrunkSecurityProfileREL/5df0b745ce894e001275e897/help",
"support_async": false,
"title": "Help"
}
},
{
"apply": {
"method": "POST",
"class": "custom",
"href": "/api/relation/HcsSipTrunkSecurityProfileREL/5df0b745ce894e001275e897/+apply/",
"support_async": true,
"title": "Apply"
}
},
{
"reset": {
"method": "POST",
"class": "custom",
"href": "/api/relation/HcsSipTrunkSecurityProfileREL/5df0b745ce894e001275e897/+reset/",
"support_async": true,
"title": "Reset"
}
}
],
"summary": "false"
},
"pkid": "5df0b745ce894e001275e897"
},
{
"data": {
"digestAuthentication": false,
"x509SubjectName": null,
"name": "Non Secure SIP Trunk Profile",
"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,
"description": "Non Secure SIP Trunk Profile authenticated by null String",
"summary_device": "Dedicated CUCM, 192.168.100.15, 8443, hcs.CS-P.CS-AB.AB_Group",
"hierarchy_friendly_name": "AB_Group (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
},
"meta": {
"model_type": "relation/HcsSipTrunkSecurityProfileREL",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "Non Secure SIP Trunk Profile",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "/api/v0/data/CallManager/5df0b693ce894e001275c115",
"pkid": "5df0b693ce894e001275c115"
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5df0b66bce894e001275a913",
"href": "/api/data/HierarchyNode/5df0b66bce894e001275a913"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/relation/HcsSipTrunkSecurityProfileREL/5df0b745ce894e001275e886/",
"pkid": "5df0b745ce894e001275e886"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5da4c643ce894e0012225c90",
"5df0b338ce894e001275535c",
"5df0b3a3ce894e0012756904",
"5df0b66bce894e001275a913",
"5df0b745ce894e001275e886"
],
"schema_version": "",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/HcsSipTrunkSecurityProfileREL/5df0b745ce894e001275e886/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/HcsSipTrunkSecurityProfileREL/5df0b745ce894e001275e886/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/relation/HcsSipTrunkSecurityProfileREL/5df0b745ce894e001275e886/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/HcsSipTrunkSecurityProfileREL/5df0b745ce894e001275e886/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/HcsSipTrunkSecurityProfileREL/5df0b745ce894e001275e886/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/HcsSipTrunkSecurityProfileREL/5df0b745ce894e001275e886/help",
"support_async": false,
"title": "Help"
}
},
{
"apply": {
"method": "POST",
"class": "custom",
"href": "/api/relation/HcsSipTrunkSecurityProfileREL/5df0b745ce894e001275e886/+apply/",
"support_async": true,
"title": "Apply"
}
},
{
"reset": {
"method": "POST",
"class": "custom",
"href": "/api/relation/HcsSipTrunkSecurityProfileREL/5df0b745ce894e001275e886/+reset/",
"support_async": true,
"title": "Reset"
}
}
],
"summary": "false"
},
"pkid": "5df0b745ce894e001275e886"
},
{
"data": {
"digestAuthentication": false,
"x509SubjectName": null,
"name": "SIP Trunk Profile for HCS Voice Mail Service ABG-VMS-1",
"acceptPresenceSubscription": true,
"acceptUnsolicitedNotification": true,
"sipV150OutboundSdpOfferFiltering": "Use Default Filter",
"acceptOutOfDialogRefer": true,
"outgoingTransport": "TCP",
"securityMode": "Non Secure",
"applLevelAuthentication": false,
"allowChargingHeader": false,
"noncePolicyTime": 600,
"allowReplaceHeader": true,
"incomingPort": 5072,
"incomingTransport": "TCP+UDP",
"transmitSecurityStatus": false,
"description": "Default Non Secure SIP Trunk Profile for deployed HCS Voice Mail services",
"summary_device": "Dedicated CUCM, 192.168.100.15, 8443, hcs.CS-P.CS-AB.AB_Group",
"hierarchy_friendly_name": "AB_Group (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
},
"meta": {
"model_type": "relation/HcsSipTrunkSecurityProfileREL",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "SIP Trunk Profile for HCS Voice Mail Service ABG-VMS-1",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "/api/v0/data/CallManager/5df0b693ce894e001275c115",
"pkid": "5df0b693ce894e001275c115"
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5df0b66bce894e001275a913",
"href": "/api/data/HierarchyNode/5df0b66bce894e001275a913"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/relation/HcsSipTrunkSecurityProfileREL/5df0bb02ce894e0012772163/",
"pkid": "5df0bb02ce894e0012772163"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5da4c643ce894e0012225c90",
"5df0b338ce894e001275535c",
"5df0b3a3ce894e0012756904",
"5df0b66bce894e001275a913",
"5df0bb02ce894e0012772163"
],
"schema_version": "",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/HcsSipTrunkSecurityProfileREL/5df0bb02ce894e0012772163/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/HcsSipTrunkSecurityProfileREL/5df0bb02ce894e0012772163/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/relation/HcsSipTrunkSecurityProfileREL/5df0bb02ce894e0012772163/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/HcsSipTrunkSecurityProfileREL/5df0bb02ce894e0012772163/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/HcsSipTrunkSecurityProfileREL/5df0bb02ce894e0012772163/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/HcsSipTrunkSecurityProfileREL/5df0bb02ce894e0012772163/help",
"support_async": false,
"title": "Help"
}
},
{
"apply": {
"method": "POST",
"class": "custom",
"href": "/api/relation/HcsSipTrunkSecurityProfileREL/5df0bb02ce894e0012772163/+apply/",
"support_async": true,
"title": "Apply"
}
},
{
"reset": {
"method": "POST",
"class": "custom",
"href": "/api/relation/HcsSipTrunkSecurityProfileREL/5df0bb02ce894e0012772163/+reset/",
"support_async": true,
"title": "Reset"
}
}
],
"summary": "false"
},
"pkid": "5df0bb02ce894e0012772163"
}
]
}
(Show the first instance)
{
"data": {
"digestAuthentication": false,
"x509SubjectName": null,
"name": "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,
"description": "Non Secure SIP Conference Bridge",
"shadow": []
},
"meta": {
"model_type": "relation/HcsSipTrunkSecurityProfileREL",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "Non Secure SIP Conference Bridge",
"business_key": {},
"api_version": "21.2",
"cached": true,
"cache_control_policy": "cache_then_device",
"references": {
"device": [
{
"href": "/api/v0/data/CallManager/5df0b693ce894e001275c115",
"pkid": "5df0b693ce894e001275c115"
}
],
"children": [],
"parent": [
{
"pkid": "5df0b66bce894e001275a913",
"href": "/api/data/HierarchyNode/5df0b66bce894e001275a913"
}
],
"self": [
{
"href": "/api/relation/HcsSipTrunkSecurityProfileREL/5df0b745ce894e001275e897/",
"pkid": "5df0b745ce894e001275e897"
}
]
},
"schema_version": "2.1",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/HcsSipTrunkSecurityProfileREL/5df0b745ce894e001275e897/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/HcsSipTrunkSecurityProfileREL/5df0b745ce894e001275e897/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/relation/HcsSipTrunkSecurityProfileREL/5df0b745ce894e001275e897/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/HcsSipTrunkSecurityProfileREL/5df0b745ce894e001275e897/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/HcsSipTrunkSecurityProfileREL/5df0b745ce894e001275e897/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/HcsSipTrunkSecurityProfileREL/5df0b745ce894e001275e897/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"apply": {
"method": "POST",
"class": "custom",
"href": "/api/relation/HcsSipTrunkSecurityProfileREL/5df0b745ce894e001275e897/+apply/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Apply"
}
},
{
"reset": {
"method": "POST",
"class": "custom",
"href": "/api/relation/HcsSipTrunkSecurityProfileREL/5df0b745ce894e001275e897/+reset/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Reset"
}
}
]
},
"pkid": "5df0b745ce894e001275e897"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/HcsSipTrunkSecurityProfileREL. | GET | /api/relation/HcsSipTrunkSecurityProfileREL/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/HcsSipTrunkSecurityProfileREL as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/HcsSipTrunkSecurityProfileREL/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/HcsSipTrunkSecurityProfileREL/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/relation/HcsSipTrunkSecurityProfileREL/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/relation/HcsSipTrunkSecurityProfileREL/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of relation/HcsSipTrunkSecurityProfileREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/HcsSipTrunkSecurityProfileREL/[pkid]/export |
|
The response is an attachment. Refer to the list below. |
For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=json, the response is a time stamped zip file of data in JSON and a response format:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
The XLSX format can be used to bulk load instances of relation/HcsSipTrunkSecurityProfileREL and the JSON format can be used to import instances of relation/HcsSipTrunkSecurityProfileREL.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/HcsSipTrunkSecurityProfileREL/[pkid] | hierarchy=[hierarchy] | The relation/HcsSipTrunkSecurityProfileREL instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/HcsSipTrunkSecurityProfileREL/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/HcsSipTrunkSecurityProfileREL. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Apply | POST | /api/relation/HcsSipTrunkSecurityProfileREL/[pkid]/+apply | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Reset | POST | /api/relation/HcsSipTrunkSecurityProfileREL/[pkid]/+reset | hierarchy=[hierarchy] | If payload required: |