Get a Configuration Element Instance
post
/rest/{versionId}/configuration/device-configs/{deviceId}/config-elements/retrieve
Use this (POST) method to target and retrieve a specific configuration element instance to modify and submit them. Refer to the Update an Element method for more information about updating this element that you modified and submitted.
Request
Path Parameters
Back to Top
Response
200 Response
Configuration of the element instance is retrieved successfully.
400 Response
The user input is invalid.
401 Response
The user is unauthorized.
403 Response
The user does not have permission for the attempted action.
404 Response
The object (resource URI, device, and so on) of your input request cannot be found.
409 Response
The device is of type MCE/ME . The Configuration instance of it cannot be listed/seen.
500 Response
An internal server error has occurred while processing the request.
Examples
Examples of Accessing the API
See Authenticate page to acquire a token.
The following example shows how to use curl to get a Configuration Element Instance.
curl -X POST \
-d @request.json \
-H @auth_header.txt \
"https://<tenant-url>/<tenant-name>/osdmc/ums/rest/<versionId>/configuration/device-configs/<deviceId>/config-elements/retrieve"The following example shows how to use Python to get a Configuration Element Instance.
import requests
import json
headers = {
"Accept": "application/json",
"Authorization": "Bearer <auth-token>"
}
with open("request.json") as f: data = json.load(f)
url = "https://<tenant-url>/<tenant-name>/osdmc/ums/rest/<versionId>/configuration/device-configs/<deviceId>/config-elements/retrieve"
resp = requests.post(url, headers=headers, data=data)Note:
Use the Get a List of Devices Associated with Config Manager API to find the deviceId parameter.Example of the Request Body
The following shows an example of the contents of the request file sent as the request body.
{
"attributes": [
{
"name": "hostname",
"value": "dummyagent"
}
],
"elementTypePath": "sessionAgent"
}
Example of the Response Body
The following example shows the contents of the response body.
{
"attributes": [
{
"name": "burstWindowPerSession",
"value": "1"
},{
"name": "staticTcpSourcePort",
"value": "0"
},{
"name": "sipRecursionPolicy",
"value": ""
},{
"name": "hostname",
"value": "dummyagent"
},{
"name": "smIcsiMatchForInvite",
"value": ""
},{
"name": "pingSendMode",
"value": "keep-alive"
},{
"name": "hmrString",
"value": ""
},{
"name": "options",
"value": ""
},{
"name": "maxRegisterSustainedRate",
"value": "0"
},{
"name": "state",
"value": "enabled"
},{
"name": "pingInterval",
"value": "5"
},{
"name": "invalidateRegistrations",
"value": "disabled"
},{
"name": "stopRecurse",
"value": ""
},{
"name": "rbtTrigger",
"value": "none"
},{
"name": "pingMethod",
"value": ""
},{
"name": "transMethod",
"value": "UDP"
},{
"name": "stiAttest",
"value": ""
},{
"name": "sipProfile",
"value": ""
},{
"name": "egressRealmID",
"value": ""
},{
"name": "smIcsiMatchForMessage",
"value": ""
},{
"name": "inManipulationId",
"value": ""
},{
"name": "localresponseMap",
"value": ""
},{
"name": "stiAsTarget",
"value": ""
},{
"name": "emergencyDscpProfile",
"value": ""
},{
"name": "sustainedWindow",
"value": "0"
},{
"name": "splOptions",
"value": ""
},{
"name": "responseMap",
"value": ""
},{
"name": "appProtocol",
"value": "SIP"
},{
"name": "outManipulationId",
"value": ""
},{
"name": "outServiceCodes",
"value": ""
},{
"name": "earlyMediaAllow",
"value": ""
},{
"name": "allocMedia",
"value": "enabled"
},{
"name": "tcp-reconn-interval",
"value": "0"
},{
"name": "appType",
"value": ""
},{
"name": "ringbackFile",
"value": ""
},{
"name": "maxOutbSessions",
"value": "0"
},{
"name": "inclCarrierAs",
"value": "None"
},{
"name": "codecPolicy",
"value": ""
},{
"name": "inServicePeriod",
"value": "0"
},{
"name": "holdReferReinvite",
"value": "disabled"
},{
"name": "hsuPolicy",
"value": ""
},{
"name": "dataVersion",
"value": ""
},{
"name": "redirectAct",
"value": ""
},{
"name": "maxNumSessions",
"value": "0"
},{
"name": "pingAllAddresses",
"value": "disabled"
},{
"name": "minAnswerSeizureRatio",
"value": "0"
},{
"name": "cacTrapThreshold",
"value": "0"
},{
"name": "rfc2833-payload",
"value": "0"
},{
"name": "maxInbSessions",
"value": "0"
},{
"name": "referNotifyProvisional",
"value": "none"
},{
"name": "maxInbBurstRate",
"value": "0"
},{
"name": "realmID",
"value": ""
},{
"name": "trustMeForLI",
"value": "disabled"
},{
"name": "triggerOOSAlarm",
"value": "disabled"
},{
"name": "maxInbSustainedRate",
"value": "0"
},{
"name": "faxServers",
"value": ""
},{
"name": "pingFromUserPart",
"value": ""
},{
"name": "maxRegisterBurstRate",
"value": "0"
},{
"name": "tcp-keepalive",
"value": "none"
},{
"name": "sessionRecordingServerTarget",
"value": ""
},{
"name": "precedence",
"value": "0"
},{
"name": "maxBurstRate",
"value": "0"
},{
"name": "timeToResume",
"value": "0"
},{
"name": "trustMe",
"value": "disabled"
},{
"name": "kpml2833IwfOnHairpin",
"value": "inherit"
},{
"name": "maxOutbSustainedRate",
"value": "0"
},{
"name": "allowNextHop",
"value": "enabled"
},{
"name": "referCallTransfer",
"value": "disabled"
},{
"name": "loadBalanceDnsQuery",
"value": "hunt"
},{
"name": "ipAddress",
"value": "192.0.2.10"
},{
"name": "enforcementProfile",
"value": ""
},{
"name": "proxyMode",
"value": ""
},{
"name": "reuse-connections",
"value": "NONE"
},{
"name": "noResponseTo",
"value": "0"
},{
"name": "burstWindow",
"value": "0"
},{
"name": "kpmlInterworking",
"value": "inherit"
},{
"name": "port",
"value": "5060"
},{
"name": "sipIsupProfile",
"value": ""
},{
"name": "looseRouter",
"value": "enabled"
},{
"name": "sessionRecordingRequired",
"value": "disabled"
},{
"name": "sendTcpFin",
"value": "disabled"
},{
"name": "minSeizure",
"value": "5"
},{
"name": "maxOutbBurstRate",
"value": "0"
},{
"name": "rfc2833-mode",
"value": "none"
},{
"name": "description",
"value": ""
},{
"name": "stiSignalingAttest",
"value": "disabled"
},{
"name": "inServiceCodes",
"value": ""
},{
"name": "manipPattern",
"value": ""
},{
"name": "pingToUserPart",
"value": ""
},{
"name": "sessionMaxLifeLimit",
"value": "0"
},{
"name": "useConstraints",
"value": "disabled"
},{
"name": "maxSustainedRate",
"value": "0"
},{
"name": "lastModifiedDate",
"value": "2020-09-03 13:25:52"
},{
"name": "lastModifiedBy",
"value": "webHTTPS-admin@192.0.2.10:443"
},{
"name": "assertedID",
"value": ""
},{
"name": "rerouteServerSagName",
"value": ""
},{
"name": "registerBurstWindow",
"value": "0"
},{
"name": "maxInbBurstRatePerSession",
"value": "30"
},{
"name": "dos-action-at-session",
"value": "inherit"
},{
"name": "stiVsTarget",
"value": ""
},{
"name": "pingResponse",
"value": "disabled"
},{
"name": "stiOrigId",
"value": ""
}
],
"elementTypePath": "sessionAgent"
}