[Index]
This relation wraps the device/cucm/SipProfile element.
Model ref.: relation/HcsSipProfileREL
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": {
"rsvpOverSip": {
"title": "Rsvp Over Sip",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Local RSVP",
"title": "Local RSVP"
},
{
"value": "E2E",
"title": "E2E"
}
],
"default": "Local RSVP",
"maxItems": 1,
"type": "string"
},
"useCallerIdCallerNameinUriOutgoingRequest": {
"description": "Equivalent field on the SIP Profile Configuration page in Cisco Unified CM Administration is renamed from Allow Passthrough of Configured Line Device Caller Information to Enable External Presentation Name and Number",
"title": "Use Caller Id Caller Namein Uri Outgoing Request",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"mlppUserAuthorization": {
"title": "Mlpp User Authorization",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"timerInvite": {
"title": "Timer Invite",
"minItems": 0,
"required": false,
"default": 180,
"maxItems": 1,
"type": "integer"
},
"stopMediaPort": {
"title": "Stop Media Port",
"minItems": 0,
"required": false,
"default": 32766,
"maxItems": 1,
"type": "integer"
},
"rerouteIncomingRequest": {
"title": "Reroute Incoming Request",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Never",
"title": "Never"
},
{
"value": "Contact Header",
"title": "Contact Header"
},
{
"value": "Call-Info Header with purpose=x-cisco-origIP",
"title": "Call-Info Header with purpose=x-cisco-origIP"
}
],
"default": "Never",
"maxItems": 1,
"type": "string"
},
"retryNotInvite": {
"title": "Retry Not Invite",
"minItems": 0,
"required": false,
"default": 10,
"maxItems": 1,
"type": "integer"
},
"optionsPingIntervalWhenStatusNotOK": {
"title": "Options Ping Interval When Status Not OK",
"minItems": 0,
"required": false,
"default": 120,
"maxItems": 1,
"type": "integer"
},
"meetmeServiceUrl": {
"title": "Meetme Service Url",
"minItems": 0,
"required": false,
"default": "x-cisco-serviceuri-meetme",
"maxItems": 1,
"maxLength": 128,
"type": "string"
},
"maxRedirects": {
"title": "Max Redirects",
"minItems": 0,
"required": false,
"default": 70,
"maxItems": 1,
"type": "integer"
},
"dscpForVideoCalls": {
"title": "Dscp For Video Calls",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"stopVideoPort": {
"title": "Stop Video Port",
"minItems": 0,
"required": false,
"default": 0,
"maxItems": 1,
"type": "integer"
},
"redirectByApplication": {
"title": "Redirect By Application",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"callpickupListUri": {
"title": "Callpickup List Uri",
"minItems": 0,
"required": false,
"default": "x-cisco-serviceuri-opickup",
"maxItems": 1,
"maxLength": 128,
"type": "string"
},
"timerRegisterDelta": {
"title": "Timer Register Delta",
"minItems": 0,
"required": false,
"default": 5,
"maxItems": 1,
"type": "integer"
},
"dndControl": {
"title": "Dnd Control",
"minItems": 0,
"required": false,
"choices": [
{
"value": "User",
"title": "User"
},
{
"value": "Admin",
"title": "Admin"
}
],
"default": "User",
"maxItems": 1,
"type": "string"
},
"callpickupUri": {
"title": "Callpickup Uri",
"minItems": 0,
"required": false,
"default": "x-cisco-serviceuri-pickup",
"maxItems": 1,
"maxLength": 128,
"type": "string"
},
"allowPresentationSharingUsingBfcp": {
"title": "Allow Presentation Sharing Using Bfcp",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"callpickupGroupUri": {
"title": "Callpickup Group Uri",
"minItems": 0,
"required": false,
"default": "x-cisco-serviceuri-gpickup",
"maxItems": 1,
"maxLength": 128,
"type": "string"
},
"name": {
"title": "Name",
"minItems": 1,
"required": true,
"maxItems": 1,
"maxLength": 50,
"type": "string"
},
"dialStringInterpretation": {
"title": "Dial String Interpretation",
"minItems": 1,
"required": true,
"choices": [
{
"value": "Always treat all dial strings as URI addresses",
"title": "Always treat all dial strings as URI addresses"
},
{
"value": "Phone number consists of characters 0-9, A-D, *, #, and + (others treated as URI addresses)",
"title": "Phone number consists of characters 0-9, A-D, *, #, and + (others treated as URI addresses)"
},
{
"value": "Phone number consists of characters 0-9, *, #, and + (others treated as URI addresses)",
"title": "Phone number consists of characters 0-9, *, #, and + (others treated as URI addresses)"
}
],
"default": "Phone number consists of characters 0-9, *, #, and + (others treated as URI addresses)",
"maxItems": 1,
"type": "string"
},
"confJointEnable": {
"title": "Conf Joint Enable",
"minItems": 0,
"required": false,
"default": true,
"maxItems": 1,
"type": "boolean"
},
"acceptAudioCodecPreferences": {
"title": "Accept Audio Codec Preferences",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Off",
"title": "Off"
},
{
"value": "On",
"title": "On"
},
{
"value": "Default",
"title": "Default"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"connectCallBeforePlayingAnnouncement": {
"title": "Connect Call Before Playing Announcement",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"dscpForAudioPortionOfVideoCalls": {
"title": "Dscp For Audio Portion Of Video Calls",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"cucmVersionInSipHeader": {
"title": "Cucm Version In Sip Header",
"minItems": 1,
"required": true,
"choices": [
{
"value": "Major And Minor",
"title": "Major And Minor"
},
{
"value": "Major",
"title": "Major"
},
{
"value": "Major, Minor And Revision",
"title": "Major, Minor And Revision"
},
{
"value": "Full Build",
"title": "Full Build"
},
{
"value": "None",
"title": "None"
}
],
"default": "Major And Minor",
"maxItems": 1,
"type": "string"
},
"optionsPingIntervalWhenStatusOK": {
"title": "Options Ping Interval When Status OK",
"minItems": 0,
"required": false,
"default": 60,
"maxItems": 1,
"type": "integer"
},
"timerT1": {
"title": "Timer T1",
"minItems": 0,
"required": false,
"default": 500,
"maxItems": 1,
"type": "integer"
},
"timerT2": {
"title": "Timer T2",
"minItems": 0,
"required": false,
"default": 4000,
"maxItems": 1,
"type": "integer"
},
"sipSessionRefreshMethod": {
"title": "Sip Session Refresh Method",
"minItems": 1,
"required": true,
"choices": [
{
"value": "Invite",
"title": "Invite"
},
{
"value": "Update",
"title": "Update"
}
],
"default": "Invite",
"maxItems": 1,
"type": "string"
},
"timerSubscribe": {
"title": "Timer Subscribe",
"minItems": 0,
"required": false,
"default": 120,
"maxItems": 1,
"type": "integer"
},
"callStats": {
"title": "Call Stats",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"timerOffHookToFirstDigit": {
"title": "Timer Off Hook To First Digit",
"minItems": 0,
"required": false,
"default": 15000,
"maxItems": 1,
"type": "integer"
},
"sipRe11XxEnabled": {
"title": "Sip Re11Xx Enabled",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Disabled",
"title": "Disabled"
},
{
"value": "Send PRACK if 1xx Contains SDP",
"title": "Send PRACK if 1xx Contains SDP"
},
{
"value": "Send PRACK for all 1xx Messages",
"title": "Send PRACK for all 1xx Messages"
}
],
"default": "Disabled",
"maxItems": 1,
"type": "string"
},
"sipOptionsRetryCount": {
"title": "Sip Options Retry Count",
"minItems": 0,
"required": false,
"default": 6,
"maxItems": 1,
"type": "integer"
},
"sipNormalizationScript": {
"title": "Sip Normalization Script",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"type": [
"string",
"null"
],
"target": "/api/device/cucm/SIPNormalizationScript/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/SIPNormalizationScript",
"choices": []
},
"allowiXApplicationMedia": {
"title": "Allowi X Application Media",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"telnetLevel": {
"title": "Telnet Level",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Disabled",
"title": "Disabled"
},
{
"value": "Limited",
"title": "Limited"
},
{
"value": "Enabled",
"title": "Enabled"
}
],
"default": "Disabled",
"maxItems": 1,
"type": "string"
},
"allowRRAndRSBandwidthModifier": {
"title": "Allow RR And RS Bandwidth Modifier",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"userInfo": {
"title": "User Info",
"minItems": 0,
"required": false,
"choices": [
{
"value": "None",
"title": "None"
},
{
"value": "Phone",
"title": "Phone"
},
{
"value": "IP",
"title": "IP"
}
],
"default": "None",
"maxItems": 1,
"type": "string"
},
"enableOutboundOptionsPing": {
"title": "Enable Outbound Options Ping",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"rfc2543Hold": {
"title": "Rfc2543Hold",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"callHoldRingback": {
"title": "Call Hold Ringback",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Off",
"title": "Off"
},
{
"value": "On",
"title": "On"
}
],
"default": "Off",
"maxItems": 1,
"type": "string"
},
"callingLineIdentification": {
"title": "Calling Line Identification",
"minItems": 1,
"required": true,
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Strict From URI presentation Only",
"title": "Strict From URI presentation Only"
},
{
"value": "Strict Identity Headers presentation Only",
"title": "Strict Identity Headers presentation Only"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"dscpForTelePresenceCalls": {
"title": "Dscp For Tele Presence Calls",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"userAgentServerHeaderInfo": {
"title": "User Agent Server Header Info",
"minItems": 1,
"required": true,
"choices": [
{
"value": "Send Unified CM Version Information as User-Agent Header",
"title": "Send Unified CM Version Information as User-Agent Header"
},
{
"value": "Pass Through Received Information as Contact Header Parameters",
"title": "Pass Through Received Information as Contact Header Parameters"
},
{
"value": "Pass Through Received Information as User-Agent and Server Header",
"title": "Pass Through Received Information as User-Agent and Server Header"
}
],
"default": "Send Unified CM Version Information as User-Agent Header",
"maxItems": 1,
"type": "string"
},
"sendRecvSDPInMidCallInvite": {
"description": "This field is editable only if earlyOfferSupportForVoiceCall is set to true.",
"title": "Send Recv SDP In Mid Call Invite",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"startMediaPort": {
"title": "Start Media Port",
"minItems": 0,
"required": false,
"default": 16384,
"maxItems": 1,
"type": "integer"
},
"scriptParameters": {
"description": "This field will be enabled only when SIP Normalization Script is present.",
"title": "Script Parameters",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"isScriptTraceEnabled": {
"description": "This field will be enabled only when SIP Normalization Script is present.",
"title": "Is Script Trace Enabled",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"enableExternalQoS": {
"title": "Enable External Qo S",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"anonymousCallBlock": {
"title": "Anonymous Call Block",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Off",
"title": "Off"
},
{
"value": "On",
"title": "On"
}
],
"default": "Off",
"maxItems": 1,
"type": "string"
},
"earlyOfferSuppVoiceCall": {
"title": "Early Offer Supp Voice Call",
"minItems": 1,
"required": true,
"choices": [
{
"value": "Disabled (Default value)",
"title": "Disabled (Default value)"
},
{
"value": "Best Effort (no MTP inserted)",
"title": "Best Effort (no MTP inserted)"
},
{
"value": "Mandatory (insert MTP if needed)",
"title": "Mandatory (insert MTP if needed)"
}
],
"default": "Disabled (Default value)",
"maxItems": 1,
"type": "string"
},
"enableAnatForEarlyOfferCalls": {
"title": "Enable Anat For Early Offer Calls",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"dscpForAudioPortionOfTelePresenceCalls": {
"title": "Dscp For Audio Portion Of Tele Presence Calls",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"dtmfDbLevel": {
"title": "Dtmf Db Level",
"minItems": 0,
"required": false,
"choices": [
{
"value": "6 dB below nominal",
"title": "6 dB below nominal"
},
{
"value": "3 dB below nominal",
"title": "3 dB below nominal"
},
{
"value": "Nominal",
"title": "Nominal"
},
{
"value": "3 dB above nominal",
"title": "3 dB above nominal"
},
{
"value": "6 dB above nominal",
"title": "6 dB above nominal"
}
],
"default": "Nominal",
"maxItems": 1,
"type": "string"
},
"dscpForAudioCalls": {
"title": "Dscp For Audio Calls",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"sdpTransparency": {
"description": "SDP Transparency Profile for SIP Profile",
"title": "Sdp Transparency",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"fallbackToLocalRsvp": {
"title": "Fallback To Local Rsvp",
"minItems": 0,
"required": false,
"default": true,
"maxItems": 1,
"type": "boolean"
},
"t38Invite": {
"title": "T38Invite",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"defaultTelephonyEventPayloadType": {
"title": "Default Telephony Event Payload Type",
"minItems": 0,
"required": false,
"default": 101,
"maxItems": 1,
"type": "integer"
},
"retryInvite": {
"title": "Retry Invite",
"minItems": 0,
"required": false,
"default": 6,
"maxItems": 1,
"type": "integer"
},
"destRouteString": {
"title": "Dest Route String",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"semiAttendedTransfer": {
"title": "Semi Attended Transfer",
"minItems": 0,
"required": false,
"default": true,
"maxItems": 1,
"type": "boolean"
},
"isAssuredSipServiceEnabled": {
"title": "Is Assured Sip Service Enabled",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"rejectAnonymousOutgoingCall": {
"title": "Reject Anonymous Outgoing Call",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"allowMultipleCodecs": {
"title": "Allow Multiple Codecs",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"callForwardUri": {
"title": "Call Forward Uri",
"minItems": 0,
"required": false,
"default": "x-cisco-serviceuri-cfwdall",
"maxItems": 1,
"maxLength": 128,
"type": "string"
},
"ringing180": {
"title": "Ringing180",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"enableVad": {
"title": "Enable Vad",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"externalPresentationInfo": {
"title": "External Presentation Info",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "object",
"properties": {
"presentationInfo": {
"name": "presentationInfo",
"title": "Presentation Info",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"externalPresentationNumber": {
"name": "externalPresentationNumber",
"title": "External Presentation Number",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"externalPresentationName": {
"name": "externalPresentationName",
"title": "External Presentation Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 50,
"type": [
"string",
"null"
]
}
}
},
"isAnonymous": {
"name": "isAnonymous",
"title": "Is Anonymous",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
}
}
},
"sipOptionsRetryTimer": {
"title": "Sip Options Retry Timer",
"minItems": 0,
"required": false,
"default": 500,
"maxItems": 1,
"type": "integer"
},
"faxInvite": {
"title": "Fax Invite",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"sipBandwidthModifier": {
"title": "Sip Bandwidth Modifier",
"minItems": 1,
"required": true,
"choices": [
{
"value": "TIAS and AS",
"title": "TIAS and AS"
},
{
"value": "TIAS only",
"title": "TIAS only"
},
{
"value": "AS only",
"title": "AS only"
},
{
"value": "CT only",
"title": "CT only"
}
],
"default": "TIAS and AS",
"maxItems": 1,
"type": "string"
},
"timerSubscribeDelta": {
"title": "Timer Subscribe Delta",
"minItems": 0,
"required": false,
"default": 5,
"maxItems": 1,
"type": "integer"
},
"callerIdBlock": {
"title": "Caller Id Block",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Off",
"title": "Off"
},
{
"value": "On",
"title": "On"
}
],
"default": "Off",
"maxItems": 1,
"type": "string"
},
"startVideoPort": {
"title": "Start Video Port",
"minItems": 0,
"required": false,
"default": 0,
"maxItems": 1,
"type": "integer"
},
"deliverConferenceBridgeIdentifier": {
"title": "Deliver Conference Bridge Identifier",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"inactiveSDPRequired": {
"title": "Inactive SDP Required",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"abbreviatedDialUri": {
"title": "Abbreviated Dial Uri",
"minItems": 0,
"required": false,
"default": "x-cisco-serviceuri-abbrdial",
"maxItems": 1,
"maxLength": 128,
"type": "string"
},
"description": {
"title": "Description",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 100,
"type": [
"string",
"null"
]
},
"gClear": {
"title": "G Clear",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Disabled",
"title": "Disabled"
},
{
"value": "CLEARMODE",
"title": "CLEARMODE"
},
{
"value": "CCD",
"title": "CCD"
},
{
"value": "G.nX64",
"title": "G.nX64"
},
{
"value": "X-CCD",
"title": "X-CCD"
}
],
"default": "Disabled",
"maxItems": 1,
"type": "string"
},
"resourcePriorityNamespaceListName": {
"title": "Resource Priority Namespace List Name",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"type": [
"string",
"null"
],
"target": "/api/device/cucm/ResourcePriorityNamespaceList/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/ResourcePriorityNamespaceList",
"choices": []
},
"rejectAnonymousIncomingCall": {
"title": "Reject Anonymous Incoming Call",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"videoCallTrafficClass": {
"title": "Video Call Traffic Class",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Immersive",
"title": "Immersive"
},
{
"value": "Desktop",
"title": "Desktop"
},
{
"value": "Mixed",
"title": "Mixed"
}
],
"default": "Mixed",
"maxItems": 1,
"type": "string"
},
"timerRegister": {
"title": "Timer Register",
"minItems": 0,
"required": false,
"default": 3600,
"maxItems": 1,
"type": "integer"
},
"resourcePriorityNamespace": {
"title": "Resource Priority Namespace",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "namespace",
"maxItems": 1,
"type": [
"string",
"null"
],
"target": "/api/device/cucm/ResourcePriorityNamespace/choices/?field=namespace&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/ResourcePriorityNamespace",
"choices": []
},
"timerKeepAlive": {
"title": "Timer Keep Alive",
"minItems": 0,
"required": false,
"default": 120,
"maxItems": 1,
"type": "integer"
},
"enableUriOutdialSupport": {
"title": "Enable Uri Outdial Support",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"stutterMsgWaiting": {
"title": "Stutter Msg Waiting",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"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/HcsSipProfileREL/add/ |
|
The GUI Add form of relation/HcsSipProfileREL 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/HcsSipProfileREL | 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/HcsSipProfileREL/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/HcsSipProfileREL/[pkid1]", "/api/relation/HcsSipProfileREL/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/HcsSipProfileREL/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/HcsSipProfileREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/HcsSipProfileREL/export/ |
|
{ "hrefs":["/api/relation/HcsSipProfileREL/[pkid1]", "/api/relation/HcsSipProfileREL/[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/HcsSipProfileREL and the JSON format can be used to import instances of relation/HcsSipProfileREL.
GET http://[host-proxy]/api/relation/HcsSipProfileREL/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/HcsSipProfileREL | POST | /api/relation/HcsSipProfileREL/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/HcsSipProfileREL/ |
|
The relation/HcsSipProfileREL schema and all instances as JSON. |
(The list will return 0 to 3 relation/HcsSipProfileREL instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 6,
"total_limit": null,
"order_by": "name",
"direction": "asc",
"current": "/api/relation/HcsSipProfileREL/?skip=0&limit=3&order_by=name&direction=asc&traversal=down"
},
"operations": [
"bulk_update",
"clone",
"help",
"update",
"add",
"export",
"get",
"list",
"export_bulkload_template",
"remove",
"configuration_template",
"field_display_policy"
],
"meta": {
"model_type": "relation/HcsSipProfileREL",
"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/HcsSipProfileREL/None/",
"pkid": null
}
]
},
"model_specific_actions": [
"clone",
"help",
"update",
"add",
"export",
"get",
"list",
"export_bulkload_template",
"remove"
],
"schema_version": "2.1",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/relation/HcsSipProfileREL/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/HcsSipProfileREL/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/relation/HcsSipProfileREL/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/HcsSipProfileREL/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/relation/HcsSipProfileREL/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/HcsSipProfileREL/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": [
{
"data": {
"rsvpOverSip": "Local RSVP",
"useCallerIdCallerNameinUriOutgoingRequest": false,
"mlppUserAuthorization": false,
"allowPresentationSharingUsingBfcp": false,
"stopMediaPort": 32766,
"rerouteIncomingRequest": "Never",
"callerIdDn": null,
"retryNotInvite": 10,
"optionsPingIntervalWhenStatusNotOK": 120,
"meetmeServiceUrl": "x-cisco-serviceuri-meetme",
"maxRedirects": 70,
"dscpForVideoCalls": null,
"acceptAudioCodecPreferences": "Default",
"stopVideoPort": 0,
"redirectByApplication": false,
"callpickupListUri": "x-cisco-serviceuri-opickup",
"timerRegisterDelta": 5,
"faxInvite": false,
"callpickupUri": "x-cisco-serviceuri-pickup",
"timerInvite": 180,
"callpickupGroupUri": "x-cisco-serviceuri-gpickup",
"name": "Standard SIP Profile",
"dialStringInterpretation": "Phone number consists of characters 0-9, *, #, and + (others treated as URI addresses)",
"confJointEnable": true,
"callForwardUri": "x-cisco-serviceuri-cfwdall",
"connectCallBeforePlayingAnnouncement": false,
"dscpForAudioPortionOfVideoCalls": null,
"cucmVersionInSipHeader": "Major And Minor",
"optionsPingIntervalWhenStatusOK": 60,
"timerT1": 500,
"timerT2": 4000,
"sipSessionRefreshMethod": "Invite",
"enableVad": false,
"callStats": false,
"timerOffHookToFirstDigit": 15000,
"sipRe11XxEnabled": "Disabled",
"sipOptionsRetryCount": 6,
"sipNormalizationScript": null,
"allowiXApplicationMedia": false,
"telnetLevel": "Disabled",
"userInfo": "None",
"enableOutboundOptionsPing": false,
"rfc2543Hold": false,
"callHoldRingback": "Off",
"callingLineIdentification": "Default",
"hierarchy": "5df0b66bce894e001275a913",
"dscpForTelePresenceCalls": null,
"userAgentServerHeaderInfo": "Send Unified CM Version Information as User-Agent Header",
"sendRecvSDPInMidCallInvite": false,
"startMediaPort": 16384,
"isScriptTraceEnabled": false,
"enableExternalQoS": false,
"anonymousCallBlock": "Off",
"earlyOfferSuppVoiceCall": "Disabled (Default value)",
"enableAnatForEarlyOfferCalls": false,
"dscpForAudioPortionOfTelePresenceCalls": null,
"dtmfDbLevel": "Nominal",
"dscpForAudioCalls": null,
"sdpTransparency": null,
"fallbackToLocalRsvp": true,
"t38Invite": false,
"defaultTelephonyEventPayloadType": 101,
"retryInvite": 6,
"destRouteString": false,
"semiAttendedTransfer": true,
"isAssuredSipServiceEnabled": false,
"rejectAnonymousOutgoingCall": false,
"allowMultipleCodecs": false,
"timerRegister": 3600,
"ringing180": false,
"timerSubscribe": 120,
"sipOptionsRetryTimer": 500,
"dndControl": "User",
"sipBandwidthModifier": "TIAS and AS",
"timerSubscribeDelta": 5,
"callerIdBlock": "Off",
"startVideoPort": 0,
"deliverConferenceBridgeIdentifier": false,
"inactiveSDPRequired": false,
"abbreviatedDialUri": "x-cisco-serviceuri-abbrdial",
"description": "Default SIP Profile",
"gClear": "Disabled",
"resourcePriorityNamespaceListName": null,
"rejectAnonymousIncomingCall": false,
"videoCallTrafficClass": "Mixed",
"resourcePriorityNamespace": null,
"timerKeepAlive": 120,
"enableUriOutdialSupport": false,
"stutterMsgWaiting": false,
"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/HcsSipProfileREL",
"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": "Standard SIP Profile",
"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/HcsSipProfileREL/5df0b744ce894e001275e83e/",
"pkid": "5df0b744ce894e001275e83e"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5da4c643ce894e0012225c90",
"5df0b338ce894e001275535c",
"5df0b3a3ce894e0012756904",
"5df0b66bce894e001275a913",
"5df0b744ce894e001275e83e"
],
"schema_version": "",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/HcsSipProfileREL/5df0b744ce894e001275e83e/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/HcsSipProfileREL/5df0b744ce894e001275e83e/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/relation/HcsSipProfileREL/5df0b744ce894e001275e83e/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/HcsSipProfileREL/5df0b744ce894e001275e83e/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/HcsSipProfileREL/5df0b744ce894e001275e83e/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/HcsSipProfileREL/5df0b744ce894e001275e83e/help",
"support_async": false,
"title": "Help"
}
},
{
"apply": {
"method": "POST",
"class": "custom",
"href": "/api/relation/HcsSipProfileREL/5df0b744ce894e001275e83e/+apply/",
"support_async": true,
"title": "Apply"
}
},
{
"reset": {
"method": "POST",
"class": "custom",
"href": "/api/relation/HcsSipProfileREL/5df0b744ce894e001275e83e/+reset/",
"support_async": true,
"title": "Reset"
}
}
],
"summary": "false"
},
"pkid": "5df0b744ce894e001275e83e"
},
{
"data": {
"rsvpOverSip": "Local RSVP",
"useCallerIdCallerNameinUriOutgoingRequest": false,
"mlppUserAuthorization": false,
"allowPresentationSharingUsingBfcp": true,
"stopMediaPort": 32766,
"rerouteIncomingRequest": "Never",
"callerIdDn": null,
"retryNotInvite": 10,
"optionsPingIntervalWhenStatusNotOK": 120,
"meetmeServiceUrl": "x-cisco-serviceuri-meetme",
"maxRedirects": 70,
"dscpForVideoCalls": null,
"acceptAudioCodecPreferences": "Default",
"stopVideoPort": 0,
"redirectByApplication": true,
"callpickupListUri": "x-cisco-serviceuri-opickup",
"timerRegisterDelta": 5,
"faxInvite": false,
"callpickupUri": "x-cisco-serviceuri-pickup",
"timerInvite": 180,
"callpickupGroupUri": "x-cisco-serviceuri-gpickup",
"name": "Standard SIP Profile For Cisco VCS",
"dialStringInterpretation": "Phone number consists of characters 0-9, *, #, and + (others treated as URI addresses)",
"confJointEnable": true,
"callForwardUri": "x-cisco-serviceuri-cfwdall",
"connectCallBeforePlayingAnnouncement": false,
"dscpForAudioPortionOfVideoCalls": null,
"cucmVersionInSipHeader": "Major And Minor",
"optionsPingIntervalWhenStatusOK": 60,
"timerT1": 500,
"timerT2": 4000,
"sipSessionRefreshMethod": "Invite",
"enableVad": false,
"callStats": false,
"timerOffHookToFirstDigit": 15000,
"sipRe11XxEnabled": "Disabled",
"sipOptionsRetryCount": 6,
"sipNormalizationScript": null,
"allowiXApplicationMedia": true,
"telnetLevel": "Disabled",
"userInfo": "None",
"enableOutboundOptionsPing": true,
"rfc2543Hold": false,
"callHoldRingback": "Off",
"callingLineIdentification": "Default",
"hierarchy": "5df0b66bce894e001275a913",
"dscpForTelePresenceCalls": null,
"userAgentServerHeaderInfo": "Send Unified CM Version Information as User-Agent Header",
"sendRecvSDPInMidCallInvite": false,
"startMediaPort": 16384,
"isScriptTraceEnabled": false,
"enableExternalQoS": false,
"anonymousCallBlock": "Off",
"earlyOfferSuppVoiceCall": "Disabled (Default value)",
"enableAnatForEarlyOfferCalls": false,
"dscpForAudioPortionOfTelePresenceCalls": null,
"dtmfDbLevel": "Nominal",
"dscpForAudioCalls": null,
"sdpTransparency": "Pass all unknown SDP attributes",
"fallbackToLocalRsvp": true,
"t38Invite": false,
"defaultTelephonyEventPayloadType": 101,
"retryInvite": 6,
"destRouteString": false,
"semiAttendedTransfer": true,
"isAssuredSipServiceEnabled": false,
"rejectAnonymousOutgoingCall": false,
"allowMultipleCodecs": true,
"timerRegister": 3600,
"ringing180": false,
"timerSubscribe": 120,
"sipOptionsRetryTimer": 500,
"dndControl": "User",
"sipBandwidthModifier": "TIAS and AS",
"timerSubscribeDelta": 5,
"callerIdBlock": "Off",
"startVideoPort": 0,
"deliverConferenceBridgeIdentifier": false,
"inactiveSDPRequired": false,
"abbreviatedDialUri": "x-cisco-serviceuri-abbrdial",
"description": "Default SIP Profile For Cisco Video Communication Server",
"gClear": "Disabled",
"resourcePriorityNamespaceListName": null,
"rejectAnonymousIncomingCall": false,
"videoCallTrafficClass": "Immersive",
"resourcePriorityNamespace": null,
"timerKeepAlive": 120,
"enableUriOutdialSupport": true,
"stutterMsgWaiting": false,
"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/HcsSipProfileREL",
"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": "Standard SIP Profile For Cisco VCS",
"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/HcsSipProfileREL/5df0b743ce894e001275e824/",
"pkid": "5df0b743ce894e001275e824"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5da4c643ce894e0012225c90",
"5df0b338ce894e001275535c",
"5df0b3a3ce894e0012756904",
"5df0b66bce894e001275a913",
"5df0b743ce894e001275e824"
],
"schema_version": "",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/HcsSipProfileREL/5df0b743ce894e001275e824/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/HcsSipProfileREL/5df0b743ce894e001275e824/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/relation/HcsSipProfileREL/5df0b743ce894e001275e824/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/HcsSipProfileREL/5df0b743ce894e001275e824/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/HcsSipProfileREL/5df0b743ce894e001275e824/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/HcsSipProfileREL/5df0b743ce894e001275e824/help",
"support_async": false,
"title": "Help"
}
},
{
"apply": {
"method": "POST",
"class": "custom",
"href": "/api/relation/HcsSipProfileREL/5df0b743ce894e001275e824/+apply/",
"support_async": true,
"title": "Apply"
}
},
{
"reset": {
"method": "POST",
"class": "custom",
"href": "/api/relation/HcsSipProfileREL/5df0b743ce894e001275e824/+reset/",
"support_async": true,
"title": "Reset"
}
}
],
"summary": "false"
},
"pkid": "5df0b743ce894e001275e824"
},
{
"data": {
"rsvpOverSip": "Local RSVP",
"useCallerIdCallerNameinUriOutgoingRequest": false,
"mlppUserAuthorization": false,
"allowPresentationSharingUsingBfcp": false,
"stopMediaPort": 32766,
"rerouteIncomingRequest": "Never",
"callerIdDn": null,
"retryNotInvite": 10,
"optionsPingIntervalWhenStatusNotOK": 120,
"meetmeServiceUrl": "x-cisco-serviceuri-meetme",
"maxRedirects": 70,
"dscpForVideoCalls": null,
"acceptAudioCodecPreferences": "Default",
"stopVideoPort": 0,
"redirectByApplication": false,
"callpickupListUri": "x-cisco-serviceuri-opickup",
"timerRegisterDelta": 5,
"faxInvite": false,
"callpickupUri": "x-cisco-serviceuri-pickup",
"timerInvite": 180,
"callpickupGroupUri": "x-cisco-serviceuri-gpickup",
"name": "Standard SIP Profile for HCS Voice Mail",
"dialStringInterpretation": "Phone number consists of characters 0-9, *, #, and + (others treated as URI addresses)",
"confJointEnable": true,
"callForwardUri": "x-cisco-serviceuri-cfwdall",
"connectCallBeforePlayingAnnouncement": false,
"dscpForAudioPortionOfVideoCalls": null,
"cucmVersionInSipHeader": "Major And Minor",
"optionsPingIntervalWhenStatusOK": 60,
"timerT1": 500,
"timerT2": 4000,
"sipSessionRefreshMethod": "Invite",
"enableVad": false,
"callStats": false,
"timerOffHookToFirstDigit": 15000,
"sipRe11XxEnabled": "Send PRACK if 1xx Contains SDP",
"sipOptionsRetryCount": 6,
"sipNormalizationScript": null,
"allowiXApplicationMedia": false,
"telnetLevel": "Disabled",
"userInfo": "None",
"enableOutboundOptionsPing": false,
"rfc2543Hold": false,
"callHoldRingback": "Off",
"callingLineIdentification": "Default",
"dscpForTelePresenceCalls": null,
"userAgentServerHeaderInfo": "Send Unified CM Version Information as User-Agent Header",
"sendRecvSDPInMidCallInvite": false,
"startMediaPort": 16384,
"isScriptTraceEnabled": false,
"enableExternalQoS": false,
"anonymousCallBlock": "Off",
"earlyOfferSuppVoiceCall": "Disabled (Default value)",
"enableAnatForEarlyOfferCalls": false,
"dscpForAudioPortionOfTelePresenceCalls": null,
"dtmfDbLevel": "Nominal",
"dscpForAudioCalls": null,
"sdpTransparency": "Pass all unknown SDP attributes",
"fallbackToLocalRsvp": true,
"t38Invite": false,
"defaultTelephonyEventPayloadType": 101,
"retryInvite": 6,
"destRouteString": false,
"semiAttendedTransfer": true,
"isAssuredSipServiceEnabled": false,
"rejectAnonymousOutgoingCall": false,
"allowMultipleCodecs": false,
"timerRegister": 3600,
"ringing180": false,
"timerSubscribe": 120,
"sipOptionsRetryTimer": 500,
"dndControl": "User",
"sipBandwidthModifier": "TIAS and AS",
"timerSubscribeDelta": 5,
"callerIdBlock": "Off",
"startVideoPort": 0,
"deliverConferenceBridgeIdentifier": false,
"inactiveSDPRequired": false,
"abbreviatedDialUri": "x-cisco-serviceuri-abbrdial",
"description": "Default SIP Profile for deployed HCS Voice Mail services",
"gClear": "Disabled",
"resourcePriorityNamespaceListName": null,
"rejectAnonymousIncomingCall": false,
"videoCallTrafficClass": "Mixed",
"resourcePriorityNamespace": null,
"timerKeepAlive": 120,
"enableUriOutdialSupport": false,
"stutterMsgWaiting": false,
"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/HcsSipProfileREL",
"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": "Standard SIP Profile for HCS Voice Mail",
"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/HcsSipProfileREL/5df0bb02ce894e001277214f/",
"pkid": "5df0bb02ce894e001277214f"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5da4c643ce894e0012225c90",
"5df0b338ce894e001275535c",
"5df0b3a3ce894e0012756904",
"5df0b66bce894e001275a913",
"5df0bb02ce894e001277214f"
],
"schema_version": "",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/HcsSipProfileREL/5df0bb02ce894e001277214f/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/HcsSipProfileREL/5df0bb02ce894e001277214f/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/relation/HcsSipProfileREL/5df0bb02ce894e001277214f/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/HcsSipProfileREL/5df0bb02ce894e001277214f/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/HcsSipProfileREL/5df0bb02ce894e001277214f/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/HcsSipProfileREL/5df0bb02ce894e001277214f/help",
"support_async": false,
"title": "Help"
}
},
{
"apply": {
"method": "POST",
"class": "custom",
"href": "/api/relation/HcsSipProfileREL/5df0bb02ce894e001277214f/+apply/",
"support_async": true,
"title": "Apply"
}
},
{
"reset": {
"method": "POST",
"class": "custom",
"href": "/api/relation/HcsSipProfileREL/5df0bb02ce894e001277214f/+reset/",
"support_async": true,
"title": "Reset"
}
}
],
"summary": "false"
},
"pkid": "5df0bb02ce894e001277214f"
}
]
}
(Show the first instance)
{
"data": {
"rsvpOverSip": "Local RSVP",
"useCallerIdCallerNameinUriOutgoingRequest": false,
"mlppUserAuthorization": false,
"allowPresentationSharingUsingBfcp": false,
"stopMediaPort": 32766,
"rerouteIncomingRequest": "Never",
"callerIdDn": null,
"retryNotInvite": 10,
"optionsPingIntervalWhenStatusNotOK": 120,
"meetmeServiceUrl": "x-cisco-serviceuri-meetme",
"maxRedirects": 70,
"dscpForVideoCalls": null,
"acceptAudioCodecPreferences": "Default",
"stopVideoPort": 0,
"redirectByApplication": false,
"callpickupListUri": "x-cisco-serviceuri-opickup",
"timerRegisterDelta": 5,
"faxInvite": false,
"callpickupUri": "x-cisco-serviceuri-pickup",
"timerInvite": 180,
"callpickupGroupUri": "x-cisco-serviceuri-gpickup",
"name": "Standard SIP Profile",
"dialStringInterpretation": "Phone number consists of characters 0-9, *, #, and + (others treated as URI addresses)",
"confJointEnable": true,
"callForwardUri": "x-cisco-serviceuri-cfwdall",
"connectCallBeforePlayingAnnouncement": false,
"dscpForAudioPortionOfVideoCalls": null,
"cucmVersionInSipHeader": "Major And Minor",
"optionsPingIntervalWhenStatusOK": 60,
"timerT1": 500,
"timerT2": 4000,
"sipSessionRefreshMethod": "Invite",
"enableVad": false,
"callStats": false,
"timerOffHookToFirstDigit": 15000,
"sipRe11XxEnabled": "Disabled",
"sipOptionsRetryCount": 6,
"sipNormalizationScript": null,
"allowiXApplicationMedia": false,
"telnetLevel": "Disabled",
"userInfo": "None",
"enableOutboundOptionsPing": false,
"rfc2543Hold": false,
"callHoldRingback": "Off",
"callingLineIdentification": "Default",
"dscpForTelePresenceCalls": null,
"userAgentServerHeaderInfo": "Send Unified CM Version Information as User-Agent Header",
"sendRecvSDPInMidCallInvite": false,
"startMediaPort": 16384,
"isScriptTraceEnabled": false,
"enableExternalQoS": false,
"anonymousCallBlock": "Off",
"earlyOfferSuppVoiceCall": "Disabled (Default value)",
"enableAnatForEarlyOfferCalls": false,
"dscpForAudioPortionOfTelePresenceCalls": null,
"dtmfDbLevel": "Nominal",
"dscpForAudioCalls": null,
"sdpTransparency": null,
"fallbackToLocalRsvp": true,
"t38Invite": false,
"defaultTelephonyEventPayloadType": 101,
"retryInvite": 6,
"destRouteString": false,
"semiAttendedTransfer": true,
"isAssuredSipServiceEnabled": false,
"rejectAnonymousOutgoingCall": false,
"allowMultipleCodecs": false,
"timerRegister": 3600,
"ringing180": false,
"timerSubscribe": 120,
"sipOptionsRetryTimer": 500,
"dndControl": "User",
"sipBandwidthModifier": "TIAS and AS",
"timerSubscribeDelta": 5,
"callerIdBlock": "Off",
"startVideoPort": 0,
"deliverConferenceBridgeIdentifier": false,
"inactiveSDPRequired": false,
"abbreviatedDialUri": "x-cisco-serviceuri-abbrdial",
"description": "Default SIP Profile",
"gClear": "Disabled",
"resourcePriorityNamespaceListName": null,
"rejectAnonymousIncomingCall": false,
"videoCallTrafficClass": "Mixed",
"resourcePriorityNamespace": null,
"timerKeepAlive": 120,
"enableUriOutdialSupport": false,
"stutterMsgWaiting": false,
"shadow": []
},
"meta": {
"model_type": "relation/HcsSipProfileREL",
"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": "Standard SIP Profile",
"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/HcsSipProfileREL/5df0b744ce894e001275e83e/",
"pkid": "5df0b744ce894e001275e83e"
}
]
},
"schema_version": "2.1",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/HcsSipProfileREL/5df0b744ce894e001275e83e/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/HcsSipProfileREL/5df0b744ce894e001275e83e/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/relation/HcsSipProfileREL/5df0b744ce894e001275e83e/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/HcsSipProfileREL/5df0b744ce894e001275e83e/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/HcsSipProfileREL/5df0b744ce894e001275e83e/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/HcsSipProfileREL/5df0b744ce894e001275e83e/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"apply": {
"method": "POST",
"class": "custom",
"href": "/api/relation/HcsSipProfileREL/5df0b744ce894e001275e83e/+apply/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Apply"
}
},
{
"reset": {
"method": "POST",
"class": "custom",
"href": "/api/relation/HcsSipProfileREL/5df0b744ce894e001275e83e/+reset/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Reset"
}
}
]
},
"pkid": "5df0b744ce894e001275e83e"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/HcsSipProfileREL. | GET | /api/relation/HcsSipProfileREL/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/HcsSipProfileREL as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/HcsSipProfileREL/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/HcsSipProfileREL/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/relation/HcsSipProfileREL/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/relation/HcsSipProfileREL/?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/HcsSipProfileREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/HcsSipProfileREL/[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/HcsSipProfileREL and the JSON format can be used to import instances of relation/HcsSipProfileREL.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/HcsSipProfileREL/[pkid] | hierarchy=[hierarchy] | The relation/HcsSipProfileREL instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/HcsSipProfileREL/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/HcsSipProfileREL. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Apply | POST | /api/relation/HcsSipProfileREL/[pkid]/+apply | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Reset | POST | /api/relation/HcsSipProfileREL/[pkid]/+reset | hierarchy=[hierarchy] | If payload required: |