[Index]
Model ref.: device/cucm/LineOptions
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": {
"return": {
"title": "Return",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "object",
"properties": {
"line": {
"name": "line",
"title": "Line",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"partyEntranceTone": {
"name": "partyEntranceTone",
"title": "Party Entrance Tone",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"cfaCssPolicy": {
"name": "cfaCssPolicy",
"title": "Cfa Css Policy",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"autoAnswer": {
"description": "For an intercom line this tag should be treated as a mandatory tag and the valid values are Auto Answer with Headset and Auto Answer with Speakerphone.",
"title": "Auto Answer",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"name": "autoAnswer"
},
"callForwardNotRegisteredInt": {
"name": "callForwardNotRegisteredInt",
"title": "Call Forward Not Registered Int",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"callingSearchSpaceName": {
"name": "callingSearchSpaceName",
"format": "uri",
"minItems": 0,
"title": "Calling Search Space Name",
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/Css",
"type": "string",
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
}
}
},
"userHoldMohAudioSourceId": {
"description": "A value of 0 means 'none selected'.",
"title": "User Hold Moh Audio Source Id",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"name": "userHoldMohAudioSourceId"
},
"callForwardOnFailure": {
"name": "callForwardOnFailure",
"title": "Call Forward On Failure",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"callingSearchSpaceName": {
"name": "callingSearchSpaceName",
"format": "uri",
"minItems": 0,
"title": "Calling Search Space Name",
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/Css",
"type": "string",
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
}
}
},
"routePartitionName": {
"name": "routePartitionName",
"format": "uri",
"minItems": 0,
"title": "Route Partition Name",
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/RoutePartition",
"type": "string",
"target": "/api/device/cucm/RoutePartition/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"releaseClause": {
"name": "releaseClause",
"title": "Release Clause",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"shareLineAppearanceCssName": {
"name": "shareLineAppearanceCssName",
"title": "Share Line Appearance Css Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"enterpriseAltNum": {
"description": "Applicable only for Update and Get Request",
"title": "Enterprise Alt Num",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"numMask": {
"name": "numMask",
"title": "Num Mask",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"addLocalRoutePartition": {
"name": "addLocalRoutePartition",
"title": "Add Local Route Partition",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"advertiseGloballyIls": {
"name": "advertiseGloballyIls",
"title": "Advertise Globally Ils",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"routePartition": {
"name": "routePartition",
"title": "Route Partition",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"isUrgent": {
"name": "isUrgent",
"title": "Is Urgent",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
}
},
"name": "enterpriseAltNum"
},
"callForwardBusy": {
"name": "callForwardBusy",
"title": "Call Forward Busy",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"callingSearchSpaceName": {
"name": "callingSearchSpaceName",
"format": "uri",
"minItems": 0,
"title": "Calling Search Space Name",
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/Css",
"type": "string",
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
}
}
},
"callForwardNoAnswerInt": {
"name": "callForwardNoAnswerInt",
"title": "Call Forward No Answer Int",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"callingSearchSpaceName": {
"name": "callingSearchSpaceName",
"format": "uri",
"minItems": 0,
"title": "Calling Search Space Name",
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/Css",
"type": "string",
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
}
}
},
"patternPrecedence": {
"name": "patternPrecedence",
"title": "Pattern Precedence",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"callForwardNoAnswer": {
"name": "callForwardNoAnswer",
"title": "Call Forward No Answer",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"callingSearchSpaceName": {
"name": "callingSearchSpaceName",
"format": "uri",
"minItems": 0,
"title": "Calling Search Space Name",
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/Css",
"type": "string",
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
}
}
},
"callForwardNoCoverage": {
"name": "callForwardNoCoverage",
"title": "Call Forward No Coverage",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"callingSearchSpaceName": {
"name": "callingSearchSpaceName",
"format": "uri",
"minItems": 0,
"title": "Calling Search Space Name",
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/Css",
"type": "string",
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
}
}
},
"callForwardNotRegistered": {
"name": "callForwardNotRegistered",
"title": "Call Forward Not Registered",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"callingSearchSpaceName": {
"name": "callingSearchSpaceName",
"format": "uri",
"minItems": 0,
"title": "Calling Search Space Name",
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/Css",
"type": "string",
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
}
}
},
"usage": {
"description": "For Intercom DN and Intercom Translation patterns the usage tag value needs to be specified explicitly as Device Intercom and Translation Intercom respectively. For all other patterns it is a Read-only tag.",
"title": "Usage",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"name": "usage"
},
"externalCallControlProfile": {
"name": "externalCallControlProfile",
"title": "External Call Control Profile",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"defaultActivatedDeviceName": {
"description": "This tag is applicable for only intercom lines and if not set, intercom lines will not be active.",
"title": "Default Activated Device Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"name": "defaultActivatedDeviceName"
},
"parkMonForwardNoRetrieveIntCssName": {
"name": "parkMonForwardNoRetrieveIntCssName",
"title": "Park Mon Forward No Retrieve Int Css Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"callForwardNoCoverageInt": {
"name": "callForwardNoCoverageInt",
"title": "Call Forward No Coverage Int",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"callingSearchSpaceName": {
"name": "callingSearchSpaceName",
"format": "uri",
"minItems": 0,
"title": "Calling Search Space Name",
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/Css",
"type": "string",
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
}
}
},
"e164AltNum": {
"description": "Applicable only for Update and Get Request",
"title": "E164Alt Num",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"numMask": {
"name": "numMask",
"title": "Num Mask",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"addLocalRoutePartition": {
"name": "addLocalRoutePartition",
"title": "Add Local Route Partition",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"advertiseGloballyIls": {
"name": "advertiseGloballyIls",
"title": "Advertise Globally Ils",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"routePartition": {
"name": "routePartition",
"title": "Route Partition",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"isUrgent": {
"name": "isUrgent",
"title": "Is Urgent",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
}
},
"name": "e164AltNum"
},
"callForwardAll": {
"name": "callForwardAll",
"title": "Call Forward All",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"secondaryCallingSearchSpaceName": {
"name": "secondaryCallingSearchSpaceName",
"format": "uri",
"minItems": 0,
"title": "Secondary Calling Search Space Name",
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/Css",
"type": "string",
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"callingSearchSpaceName": {
"name": "callingSearchSpaceName",
"format": "uri",
"minItems": 0,
"title": "Calling Search Space Name",
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/Css",
"type": "string",
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
}
}
},
"parkMonForwardNoRetrieveCssName": {
"name": "parkMonForwardNoRetrieveCssName",
"title": "Park Mon Forward No Retrieve Css Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"voiceMailProfileName": {
"name": "voiceMailProfileName",
"title": "Voice Mail Profile Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"presenceGroupName": {
"name": "presenceGroupName",
"format": "uri",
"minItems": 0,
"title": "Presence Group Name",
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/PresenceGroup",
"type": "string",
"target": "/api/device/cucm/PresenceGroup/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"directoryURIs": {
"description": "While updating, send all the URIs",
"title": "Directory UR Is",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"directoryUri": {
"name": "directoryUri",
"title": "Directory Uri",
"minItems": 0,
"items": {
"type": [
"object",
"null"
],
"properties": {
"partition": {
"name": "partition",
"title": "Partition",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
}
}
},
"required": false,
"type": "array"
}
},
"name": "directoryURIs"
},
"callForwardBusyInt": {
"name": "callForwardBusyInt",
"title": "Call Forward Busy Int",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"callingSearchSpaceName": {
"name": "callingSearchSpaceName",
"format": "uri",
"minItems": 0,
"title": "Calling Search Space Name",
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/Css",
"type": "string",
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
}
}
},
"callPickupGroupName": {
"name": "callPickupGroupName",
"title": "Call Pickup Group Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"networkHoldMohAudioSourceId": {
"description": "A value of 0 means 'none selected'.",
"title": "Network Hold Moh Audio Source Id",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"name": "networkHoldMohAudioSourceId"
},
"aarNeighborhoodName": {
"name": "aarNeighborhoodName",
"title": "Aar Neighborhood Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"callForwardAlternateParty": {
"name": "callForwardAlternateParty",
"title": "Call Forward Alternate Party",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"callingSearchSpaceName": {
"name": "callingSearchSpaceName",
"format": "uri",
"minItems": 0,
"title": "Calling Search Space Name",
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/Css",
"type": "string",
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
}
}
},
"callingIdPresentationWhenDiverted": {
"name": "callingIdPresentationWhenDiverted",
"title": "Calling Id Presentation When Diverted",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
}
}
}
}
}
},
"schema_version": "12.5"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cucm/LineOptions/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cucm/LineOptions/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cucm/LineOptions/[pkid1]", "/api/v0/device/cucm/LineOptions/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cucm/LineOptions/?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/LineOptions |
|
{"hrefs": ["/api/device/cucm/LineOptions/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cucm/LineOptions |
|
{"hrefs": ["/api/device/cucm/LineOptions/[pkid1]", "/api/device/cucm/LineOptions/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cucm/LineOptions; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cucm/LineOptions/export/ |
|
{ "hrefs":["/api/device/cucm/LineOptions/[pkid1]", "/api/device/cucm/LineOptions/[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/LineOptions and the JSON format can be used to import instances of device/cucm/LineOptions.
GET http://[host-proxy]/api/device/cucm/LineOptions/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cucm/LineOptions | POST | /api/device/cucm/LineOptions/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/LineOptions/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/LineOptions/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cucm/LineOptions. | GET | /api/device/cucm/LineOptions/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cucm/LineOptions as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cucm/LineOptions/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cucm/LineOptions/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cucm/LineOptions | 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/LineOptions; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cucm/LineOptions/[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/LineOptions and the JSON format can be used to import instances of device/cucm/LineOptions.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cucm/LineOptions/[pkid]/ | hierarchy=[hierarchy] | The device/cucm/LineOptions instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cucm/LineOptions/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cucm/LineOptions. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cucm/LineOptions/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |