API Reference for device/genericcucm/ServiceParameter

Model ref.: device/genericcucm/ServiceParameter

The full URL would include the host-proxy name: https://[host-proxy].

Variables are enclosed in square brackets.

[hierarchy] is the hierarchy.
1. as UUID. For example: 6t0ggef2c0deab00hb595101
2. in dot notation. E.g. ProviderName.CustomerName.LocationName

For a list of available UUIDs and their dot notations:
GET /api/v0/data/HierarchyNode/?format=json

[pkid] is the ID of the resource instance. Refer to the List reference below.
[filename] refers to a file

GET http://[host-proxy]/api/device/genericcucm/ServiceParameter/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema", 
     "type": "object", 
     "properties": {
          "valueType": {
               "name": "valueType", 
               "title": "Value Type", 
               "minItems": 1, 
               "required": false, 
               "choices": [
                    {
                         "value": "boolean", 
                         "title": "boolean"
                    }, 
                    {
                         "value": "double", 
                         "title": "double"
                    }, 
                    {
                         "value": "long", 
                         "title": "long"
                    }, 
                    {
                         "value": "string", 
                         "title": "string"
                    }, 
                    {
                         "value": "date/time", 
                         "title": "date/time"
                    }, 
                    {
                         "value": "any digit", 
                         "title": "any digit"
                    }, 
                    {
                         "value": "digits", 
                         "title": "digits"
                    }, 
                    {
                         "value": "timeout", 
                         "title": "timeout"
                    }, 
                    {
                         "value": "terminating", 
                         "title": "terminating"
                    }, 
                    {
                         "value": "more digits", 
                         "title": "more digits"
                    }
               ], 
               "maxItems": 1, 
               "type": "string"
          }, 
          "service": {
               "description": "The service that this service parameter belongs to.", 
               "title": "Service", 
               "minItems": 1, 
               "required": true, 
               "choices": [
                    {
                         "value": "Cisco CallManager", 
                         "title": "Cisco CallManager"
                    }, 
                    {
                         "value": "Cisco Tftp", 
                         "title": "Cisco Tftp"
                    }, 
                    {
                         "value": "Cisco Messaging Interface", 
                         "title": "Cisco Messaging Interface"
                    }, 
                    {
                         "value": "Cisco IP Voice Media Streaming App", 
                         "title": "Cisco IP Voice Media Streaming App"
                    }, 
                    {
                         "value": "Cisco CTIManager", 
                         "title": "Cisco CTIManager"
                    }, 
                    {
                         "value": "Cisco RIS Data Collector", 
                         "title": "Cisco RIS Data Collector"
                    }, 
                    {
                         "value": "Cisco Extension Mobility", 
                         "title": "Cisco Extension Mobility"
                    }, 
                    {
                         "value": "Cisco Database Layer Monitor", 
                         "title": "Cisco Database Layer Monitor"
                    }, 
                    {
                         "value": "Enterprise Wide", 
                         "title": "Enterprise Wide"
                    }, 
                    {
                         "value": "Cisco IP Manager Assistant", 
                         "title": "Cisco IP Manager Assistant"
                    }, 
                    {
                         "value": "Cisco Extended Functions", 
                         "title": "Cisco Extended Functions"
                    }, 
                    {
                         "value": "Cisco Serviceability Reporter", 
                         "title": "Cisco Serviceability Reporter"
                    }, 
                    {
                         "value": "Cisco CTL Provider", 
                         "title": "Cisco CTL Provider"
                    }, 
                    {
                         "value": "Cisco WebDialer Web Service", 
                         "title": "Cisco WebDialer Web Service"
                    }, 
                    {
                         "value": "Cisco Dialed Number Analyzer", 
                         "title": "Cisco Dialed Number Analyzer"
                    }, 
                    {
                         "value": "Cisco CDR Repository Manager", 
                         "title": "Cisco CDR Repository Manager"
                    }, 
                    {
                         "value": "Cisco Certificate Authority Proxy Function", 
                         "title": "Cisco Certificate Authority Proxy Function"
                    }, 
                    {
                         "value": "Cisco CDR Agent", 
                         "title": "Cisco CDR Agent"
                    }, 
                    {
                         "value": "Cisco SOAP - CDRonDemand Service", 
                         "title": "Cisco SOAP - CDRonDemand Service"
                    }, 
                    {
                         "value": "Cisco CAR Scheduler", 
                         "title": "Cisco CAR Scheduler"
                    }, 
                    {
                         "value": "Cisco CAR Web Service", 
                         "title": "Cisco CAR Web Service"
                    }, 
                    {
                         "value": "Cisco AMC Service", 
                         "title": "Cisco AMC Service"
                    }, 
                    {
                         "value": "Cisco Log Partition Monitoring Tool", 
                         "title": "Cisco Log Partition Monitoring Tool"
                    }, 
                    {
                         "value": "Cisco CallManager SNMP Service", 
                         "title": "Cisco CallManager SNMP Service"
                    }, 
                    {
                         "value": "Cisco DirSync", 
                         "title": "Cisco DirSync"
                    }, 
                    {
                         "value": "Cisco AXL Web Service", 
                         "title": "Cisco AXL Web Service"
                    }, 
                    {
                         "value": "Cisco DRF Master", 
                         "title": "Cisco DRF Master"
                    }, 
                    {
                         "value": "Cisco DRF Local", 
                         "title": "Cisco DRF Local"
                    }, 
                    {
                         "value": "Cisco CallManager Cisco IP Phone Services", 
                         "title": "Cisco CallManager Cisco IP Phone Services"
                    }, 
                    {
                         "value": "Cisco CCMAdmin Web Service", 
                         "title": "Cisco CCMAdmin Web Service"
                    }, 
                    {
                         "value": "Cisco CCMRealm Web Service", 
                         "title": "Cisco CCMRealm Web Service"
                    }, 
                    {
                         "value": "Cisco CCMService Web Service", 
                         "title": "Cisco CCMService Web Service"
                    }, 
                    {
                         "value": "Cisco SOAP Web Service", 
                         "title": "Cisco SOAP Web Service"
                    }, 
                    {
                         "value": "Cisco RTMT Web Service", 
                         "title": "Cisco RTMT Web Service"
                    }, 
                    {
                         "value": "Cisco CCM PD Web Service", 
                         "title": "Cisco CCM PD Web Service"
                    }, 
                    {
                         "value": "Cisco CCM DBL Web Library", 
                         "title": "Cisco CCM DBL Web Library"
                    }, 
                    {
                         "value": "Cisco CCM NCS Web Library", 
                         "title": "Cisco CCM NCS Web Library"
                    }, 
                    {
                         "value": "Cisco Bulk Provisioning Service", 
                         "title": "Cisco Bulk Provisioning Service"
                    }, 
                    {
                         "value": "Cisco Extension Mobility Application", 
                         "title": "Cisco Extension Mobility Application"
                    }, 
                    {
                         "value": "Cisco License Manager", 
                         "title": "Cisco License Manager"
                    }, 
                    {
                         "value": "Cisco Role-based Security", 
                         "title": "Cisco Role-based Security"
                    }, 
                    {
                         "value": "Cisco Trace Collection Service", 
                         "title": "Cisco Trace Collection Service"
                    }, 
                    {
                         "value": "Cisco Security Agent", 
                         "title": "Cisco Security Agent"
                    }, 
                    {
                         "value": "Cisco Trust Verification Service", 
                         "title": "Cisco Trust Verification Service"
                    }, 
                    {
                         "value": "Cisco DHCP Monitor Service", 
                         "title": "Cisco DHCP Monitor Service"
                    }, 
                    {
                         "value": "Cisco TAPS Service", 
                         "title": "Cisco TAPS Service"
                    }, 
                    {
                         "value": "Cisco Tomcat", 
                         "title": "Cisco Tomcat"
                    }, 
                    {
                         "value": "Cisco Unified OS Admin Web Service", 
                         "title": "Cisco Unified OS Admin Web Service"
                    }, 
                    {
                         "value": "Cisco GRT Communication Web Service", 
                         "title": "Cisco GRT Communication Web Service"
                    }, 
                    {
                         "value": "Cisco Unified Reporting Web Service", 
                         "title": "Cisco Unified Reporting Web Service"
                    }, 
                    {
                         "value": "Cisco RisBean Library", 
                         "title": "Cisco RisBean Library"
                    }, 
                    {
                         "value": "Cisco SOAPMessage Service", 
                         "title": "Cisco SOAPMessage Service"
                    }, 
                    {
                         "value": "Platform Administrative Web Service", 
                         "title": "Platform Administrative Web Service"
                    }, 
                    {
                         "value": "Cisco Change Credential Application", 
                         "title": "Cisco Change Credential Application"
                    }, 
                    {
                         "value": "Cisco CCMUser Web Service", 
                         "title": "Cisco CCMUser Web Service"
                    }, 
                    {
                         "value": "Cisco Audit Event Service", 
                         "title": "Cisco Audit Event Service"
                    }, 
                    {
                         "value": "SOAP - Diagnostic Portal Database Service", 
                         "title": "SOAP - Diagnostic Portal Database Service"
                    }, 
                    {
                         "value": "Cisco SIP Proxy", 
                         "title": "Cisco SIP Proxy"
                    }, 
                    {
                         "value": "Cisco UXL Web Service", 
                         "title": "Cisco UXL Web Service"
                    }, 
                    {
                         "value": "Cisco Config Agent", 
                         "title": "Cisco Config Agent"
                    }, 
                    {
                         "value": "Cisco OAM Agent", 
                         "title": "Cisco OAM Agent"
                    }, 
                    {
                         "value": "Cisco Client Profile Agent", 
                         "title": "Cisco Client Profile Agent"
                    }, 
                    {
                         "value": "Cisco Sync Agent", 
                         "title": "Cisco Sync Agent"
                    }, 
                    {
                         "value": "Cisco SIP Proxy Logger", 
                         "title": "Cisco SIP Proxy Logger"
                    }, 
                    {
                         "value": "Cisco Intercluster Sync Agent", 
                         "title": "Cisco Intercluster Sync Agent"
                    }, 
                    {
                         "value": "Cisco XCP Router", 
                         "title": "Cisco XCP Router"
                    }, 
                    {
                         "value": "Cisco XCP Text Conference Manager", 
                         "title": "Cisco XCP Text Conference Manager"
                    }, 
                    {
                         "value": "Cisco XCP Web Connection Manager", 
                         "title": "Cisco XCP Web Connection Manager"
                    }, 
                    {
                         "value": "Cisco XCP Connection Manager", 
                         "title": "Cisco XCP Connection Manager"
                    }, 
                    {
                         "value": "Cisco XCP SIP Federation Connection Manager", 
                         "title": "Cisco XCP SIP Federation Connection Manager"
                    }, 
                    {
                         "value": "Cisco XCP XMPP Federation Connection Manager", 
                         "title": "Cisco XCP XMPP Federation Connection Manager"
                    }, 
                    {
                         "value": "Cisco XCP Message Archiver", 
                         "title": "Cisco XCP Message Archiver"
                    }, 
                    {
                         "value": "Cisco XCP Directory Service", 
                         "title": "Cisco XCP Directory Service"
                    }, 
                    {
                         "value": "Cisco XCP Authentication Service", 
                         "title": "Cisco XCP Authentication Service"
                    }, 
                    {
                         "value": "Cisco IM and Presence Admin", 
                         "title": "Cisco IM and Presence Admin"
                    }, 
                    {
                         "value": "Cisco Server Recovery Manager", 
                         "title": "Cisco Server Recovery Manager"
                    }, 
                    {
                         "value": "Cisco XCP Config Manager", 
                         "title": "Cisco XCP Config Manager"
                    }, 
                    {
                         "value": "Cisco IM and Presence Data Monitor", 
                         "title": "Cisco IM and Presence Data Monitor"
                    }, 
                    {
                         "value": "Cisco Presence Datastore", 
                         "title": "Cisco Presence Datastore"
                    }, 
                    {
                         "value": "Cisco Login Datastore", 
                         "title": "Cisco Login Datastore"
                    }, 
                    {
                         "value": "Cisco Route Datastore", 
                         "title": "Cisco Route Datastore"
                    }, 
                    {
                         "value": "Cisco SIP Registration Datastore", 
                         "title": "Cisco SIP Registration Datastore"
                    }, 
                    {
                         "value": "Cisco Presence Engine", 
                         "title": "Cisco Presence Engine"
                    }, 
                    {
                         "value": "Cisco Common User Interface", 
                         "title": "Cisco Common User Interface"
                    }, 
                    {
                         "value": "Cisco User Data Services", 
                         "title": "Cisco User Data Services"
                    }, 
                    {
                         "value": "Cisco External Call Control Service", 
                         "title": "Cisco External Call Control Service"
                    }, 
                    {
                         "value": "Cisco E911 Service", 
                         "title": "Cisco E911 Service"
                    }, 
                    {
                         "value": "Cisco Location Bandwidth Manager", 
                         "title": "Cisco Location Bandwidth Manager"
                    }, 
                    {
                         "value": "Cisco Dialed Number Analyzer Server", 
                         "title": "Cisco Dialed Number Analyzer Server"
                    }, 
                    {
                         "value": "Cisco Unified Mobile Voice Access Service", 
                         "title": "Cisco Unified Mobile Voice Access Service"
                    }, 
                    {
                         "value": "Cisco Intercluster Lookup Service", 
                         "title": "Cisco Intercluster Lookup Service"
                    }, 
                    {
                         "value": "Cisco Directory Number Alias Sync", 
                         "title": "Cisco Directory Number Alias Sync"
                    }, 
                    {
                         "value": "Cisco Directory Number Alias Lookup", 
                         "title": "Cisco Directory Number Alias Lookup"
                    }, 
                    {
                         "value": "Self Provisioning IVR", 
                         "title": "Self Provisioning IVR"
                    }, 
                    {
                         "value": "Cisco RCC Device Selection Service", 
                         "title": "Cisco RCC Device Selection Service"
                    }, 
                    {
                         "value": "Cisco CtlCli", 
                         "title": "Cisco CtlCli"
                    }, 
                    {
                         "value": "Cisco XCP File Transfer Manager", 
                         "title": "Cisco XCP File Transfer Manager"
                    }, 
                    {
                         "value": "Cisco Certificate Change Notification Service", 
                         "title": "Cisco Certificate Change Notification Service"
                    }, 
                    {
                         "value": "Cisco Wireless Controller Synchronization Service", 
                         "title": "Cisco Wireless Controller Synchronization Service"
                    }
               ], 
               "maxItems": 1, 
               "type": "string", 
               "name": "service"
          }, 
          "processNodeName": {
               "description": "The process Node that this the service parameter belongs to. Not nullable.", 
               "title": "Process Node Name", 
               "minItems": 1, 
               "required": true, 
               "maxItems": 1, 
               "type": "string", 
               "name": "processNodeName"
          }, 
          "value": {
               "name": "value", 
               "title": "Value", 
               "minItems": 0, 
               "required": true, 
               "maxItems": 1, 
               "type": [
                    "string", 
                    "null"
               ]
          }, 
          "name": {
               "description": "Name of the service parameter. Not nullable.", 
               "title": "Name", 
               "minItems": 1, 
               "required": true, 
               "maxItems": 1, 
               "type": "string", 
               "name": "name"
          }
     }, 
     "schema_version": "11.5"
}

Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/device/genericcucm/ServiceParameter/add/	hierarchy=[hierarchy] format=json	The GUI Add form of device/genericcucm/ServiceParameter as JSON

The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.

Task	Call	URL	Parameters	Payload
Create	POST	/api/device/genericcucm/ServiceParameter/	hierarchy=[hierarchy]	(For payload specification)

Response is a transaction pkid for the create action.

Use the GET call to

tool/Transaction/[trans pkid]

to inspect the created resource and its instance pkid.

Task	Call	URL	Parameters	Payload
Bulk delete [pkid1],[pkid2]...	DELETE	/api/device/genericcucm/ServiceParameter/	hierarchy=[hierarchy]	{"hrefs":["/api/device/genericcucm/ServiceParameter/[pkid1]", "/api/device/genericcucm/ServiceParameter/[pkid2]", ...]}

For the instance pkids [pkid1],[pkid2], ... that can be added to the DELETE call (the instance pkids to delete), refer to the List GET call for: device/genericcucm/ServiceParameter
```
GET http://[host-proxy]/api/device/genericcucm/ServiceParameter/?hierarchy=[hierarchy]&format=json
```

Task	Call	URL	Parameters	Response
Bulk Modify	GET	/api/device/genericcucm/ServiceParameter/bulk_update/?schema=&schema_rules=true	hierarchy=[hierarchy] format=json pkids=pkid1,pkid2,...	In JSON format: POST call to update the instances of device/genericcucm/ServiceParameter device/genericcucm/ServiceParameter schema to create POST payload.

Task	Call	URL	Parameters	Payload
Bulk Modify	POST	/api/device/genericcucm/ServiceParameter/bulk_update/	hierarchy=[hierarchy] format=json	For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/genericcucm/ServiceParameter/[pkid1]", "/api/v0/device/genericcucm/ServiceParameter/[pkid2]",...]}}

To get a list of model instance pkids that are available to Bulk Modify, use the GET call:

GET http://[host-proxy]/api/device/genericcucm/ServiceParameter/?hierarchy=[hierarchy]&format=json

The POST payload is in JSON format (refer to the Payload example) and contains:
- data in name-value update pairs according to the returned schema
- meta (empty - for a valid payload)
- request_meta with the hrefs list of instances to update

Task	Call	URL	Parameters	Payload
Move the instance with [pkid] to [target_hierarchy]	POST	/api/tool/DataMove/?model_type=device/genericcucm/ServiceParameter	hierarchy=[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/genericcucm/ServiceParameter/[pkid]"]}
Bulk Move	POST	/api/tool/DataMove/?model_type=device/genericcucm/ServiceParameter	hierarchy==[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/genericcucm/ServiceParameter/[pkid1]", "/api/device/genericcucm/ServiceParameter/[pkid2]",...]}

Move one or more model instances ([pkid1],[pkid2],...) from source hierarchy (pkid or dot notation) to target_hierarchy (pkid or dot notation). A move can only take place from a source hierarchy equal to or lower than target_hierarchy.
For a list of hierarchy pkids and their dot notation available from [hierarchy], use the GET call:
GET http://[host-proxy]/api/device/genericcucm/ServiceParameter/?hierarchy=[hierarchy]&format=json&schema_rules=true

Task	Call	URL	Parameters	Payload
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/genericcucm/ServiceParameter; optionally with tag_version at [version] and Configuration Template as [configtemplate].	POST	/api/device/genericcucm/ServiceParameter/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	{ "hrefs":["/api/device/genericcucm/ServiceParameter/[pkid1]", "/api/device/genericcucm/ServiceParameter/[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/genericcucm/ServiceParameter and the JSON format can be used to import instances of device/genericcucm/ServiceParameter.

To get the list of all instance pkids [pkid1],[pkid2], ..., use the List GET call for device/genericcucm/ServiceParameter:

 GET http://[host-proxy]/api/device/genericcucm/ServiceParameter/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Get a compressed format of the Bulk Load spreadsheet template for device/genericcucm/ServiceParameter	POST	/api/device/genericcucm/ServiceParameter/export_bulkload_template/	hierarchy=[hierarchy] modeltype=device/genericcucm/ServiceParameter	The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz

Task	Call	URL	Parameters	Response
Configuration Template	GET	/api/device/genericcucm/ServiceParameter/configuration_template/	hierarchy=[hierarchy]	POST call to create the Configuration Template Configuration Template schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Field Display Policy	GET	/api/device/genericcucm/ServiceParameter/field_display_policy/	hierarchy=[hierarchy]	POST call to create the Field Display Policy Field Display Policy schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Migration Template	GET	/api/device/genericcucm/ServiceParameter/migration/	hierarchy=[hierarchy] format=json

Task	Call	URL	Parameters	Response
List	GET	/api/device/genericcucm/ServiceParameter/	hierarchy=[hierarchy] format=json schema=true	The device/genericcucm/ServiceParameter schema and all instances as JSON.

(The list will return 0 to 3 device/genericcucm/ServiceParameter instances)

GET http://[host]/api/device/genericcucm/ServiceParameter/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

{
     "operations": [
          "list"
     ], 
     "pagination": {
          "direction": "asc", 
          "order_by": "name", 
          "maximum_limit": 2000, 
          "skip": 0, 
          "current": "/api/device/genericcucm/ServiceParameter/?skip=0&limit=3&order_by=name&direction=asc&traversal=default", 
          "limit": 3, 
          "total_limit": null, 
          "total": 0
     }, 
     "meta": {
          "tags": [], 
          "cached": true, 
          "title": "", 
          "business_key": {}, 
          "schema_version": "11.5", 
          "references": {
               "device": [
                    {
                         "pkid": "", 
                         "href": ""
                    }
               ], 
               "children": [], 
               "parent": [
                    {
                         "pkid": "6t0ggef2c0deab00hb595101", 
                         "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
                    }
               ], 
               "foreign_key": []
          }, 
          "actions": [
               {
                    "add": {
                         "support_async": false, 
                         "class": "add", 
                         "href": "/api/device/genericcucm/ServiceParameter/add/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Add"
                    }
               }, 
               {
                    "remove": {
                         "support_async": true, 
                         "class": "delete", 
                         "href": "/api/device/genericcucm/ServiceParameter/?hierarchy=[hierarchy]", 
                         "method": "DELETE", 
                         "title": "Delete"
                    }
               }, 
               {
                    "bulk_update_form": {
                         "support_async": false, 
                         "class": "update", 
                         "href": "/api/device/genericcucm/ServiceParameter/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true", 
                         "method": "GET", 
                         "title": "Bulk Modify"
                    }
               }, 
               {
                    "move": {
                         "title": "Move", 
                         "support_async": true, 
                         "class": "move", 
                         "href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/genericcucm/ServiceParameter", 
                         "method": "POST", 
                         "view": "/api/tool/DataMove/?auth_token=[authtoken]
                    }
               }, 
               {
                    "export": {
                         "title": "Export", 
                         "support_async": false, 
                         "submit": "payload", 
                         "class": "export", 
                         "href": "/api/device/genericcucm/ServiceParameter/export/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "view": "/api/view/ExportData/add/?auth_token=[authtoken]
                    }
               }, 
               {
                    "export_bulkload_template": {
                         "support_async": false, 
                         "class": "bulkload_template", 
                         "href": "/api/device/genericcucm/ServiceParameter/export_bulkload_template/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Export Bulk Load Template"
                    }
               }, 
               {
                    "tag": {
                         "title": "Tag", 
                         "support_async": true, 
                         "method": "PATCH", 
                         "href": "/api/device/genericcucm/ServiceParameter/+tag/?hierarchy=[hierarchy]", 
                         "class": "tag", 
                         "view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
                    }
               }, 
               {
                    "tag_version": {
                         "title": "Tag Version", 
                         "support_async": true, 
                         "method": "PATCH", 
                         "href": "/api/device/genericcucm/ServiceParameter/+tag_version/?hierarchy=[hierarchy]", 
                         "class": "tag_version", 
                         "view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
                    }
               }, 
               {
                    "configuration_template": {
                         "support_async": false, 
                         "class": "config", 
                         "href": "/api/device/genericcucm/ServiceParameter/configuration_template/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Configuration Template"
                    }
               }, 
               {
                    "field_display_policy": {
                         "support_async": false, 
                         "class": "display_policy", 
                         "href": "/api/device/genericcucm/ServiceParameter/field_display_policy/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Field Display Policy"
                    }
               }, 
               {
                    "migration": {
                         "support_async": false, 
                         "class": "migration", 
                         "href": "/api/device/genericcucm/ServiceParameter/migration/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Migration Template"
                    }
               }, 
               {
                    "list": {
                         "support_async": false, 
                         "class": "list", 
                         "href": "/api/device/genericcucm/ServiceParameter/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "List"
                    }
               }, 
               {
                    "help": {
                         "support_async": false, 
                         "class": "help", 
                         "href": "/api/device/genericcucm/ServiceParameter/help?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Help"
                    }
               }, 
               {
                    "purge": {
                         "support_async": false, 
                         "class": "purge", 
                         "href": "/api/device/genericcucm/ServiceParameter/purge/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Purge"
                    }
               }, 
               {
                    "transform": {
                         "support_async": false, 
                         "class": "transform", 
                         "href": "/api/device/genericcucm/ServiceParameter/transform/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Transform Template"
                    }
               }
          ], 
          "model_type": "device/genericcucm/ServiceParameter", 
          "model_specific_actions": [
               "list", 
               "get", 
               "add", 
               "update", 
               "remove", 
               "move", 
               "clone", 
               "export", 
               "export_bulkload_template", 
               "bulk_update_form", 
               "configuration_template", 
               "field_display_policy", 
               "help", 
               "migration", 
               "transform", 
               "tag", 
               "tag_version"
          ], 
          "summary_attrs": [
               {
                    "name": "name", 
                    "title": "Name"
               }, 
               {
                    "allow_filtering": true, 
                    "name": "hierarchy_friendly_name", 
                    "title": "Located At"
               }
          ], 
          "api_version": "21.2", 
          "tagged_versions": []
     }, 
     "resources": []
}

Task	Call	URL	Parameters	Response
Get the on-line Help for device/genericcucm/ServiceParameter.	GET	/api/device/genericcucm/ServiceParameter/help	hierarchy=[hierarchy]	On-line help of Model ref.: device/genericcucm/ServiceParameter as HTML

Instance API Reference

[pkid] is the ID of the resource instance.
If a payload is required, inspect the schema for payload details.

Task	Call	URL	Parameters	Payload
Modify	PUT	/api/device/genericcucm/ServiceParameter/[pkid]/	hierarchy=[hierarchy]	(For payload specification)

For Bulk modification, refer to the Bulk Modify section.

Task	Call	URL	Parameters	Response
Delete	DELETE	/api/device/genericcucm/ServiceParameter/[pkid]/	hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Clone instance with [pkid]. The schema rules are applied.	GET	/api/device/genericcucm/ServiceParameter/[pkid]/clone/?schema=&schema_rules=true	hierarchy=[hierarchy]	A JSON payload with: A POST action URL. The unchanged model [pkid] payload to be modified to create a new instance.

For the instance pkids that can cloned, refer to the List GET call for device/genericcucm/ServiceParameter

GET http://[host-proxy]/api/device/genericcucm/ServiceParameter/?hierarchy=[hierarchy]&format=json

Use the POST action in the response with a modification of the response payload to create the clone.

Task	Call	URL	Parameters	Payload
Move	POST	/api/tool/DataMove/[pkid]/?model_type=device/genericcucm/ServiceParameter	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/genericcucm/ServiceParameter; optionally with tag_version at [version] and Configuration Template as [configtemplate].	GET	/api/device/genericcucm/ServiceParameter/[pkid]/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	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/genericcucm/ServiceParameter and the JSON format can be used to import instances of device/genericcucm/ServiceParameter.

For Bulk Export, refer to the Bulk Export section.

Task	Call	URL	Parameters	Payload
Tag	PATCH	/api/device/genericcucm/ServiceParameter/[pkid]/+tag/	hierarchy=[hierarchy]	If payload required:

Task	Call	URL	Parameters	Response
Get	GET	/api/device/genericcucm/ServiceParameter/[pkid]/	hierarchy=[hierarchy]	The device/genericcucm/ServiceParameter instance with [pkid].

Task	Call	URL	Parameters	Response
Help	GET	/api/device/genericcucm/ServiceParameter/[pkid]/help	hierarchy=[hierarchy]	The on-line Help for device/genericcucm/ServiceParameter.

Task	Call	URL	Parameters	Payload
Purge	POST	/api/device/genericcucm/ServiceParameter/[pkid]/purge/	hierarchy=[hierarchy]	If payload required:

API Reference for device/genericcucm/ServiceParameter

GET http://[host-proxy]/api/device/genericcucm/ServiceParameter/schema/?hierarchy=[hierarchy]&format=json&schema=1

Get the Add form

Create

Bulk Delete

Bulk Modify

Move

Bulk Export

Export Bulk Load Template

Configuration Template

Field Display Policy

Migration Template

List

GET http://[host]/api/device/genericcucm/ServiceParameter/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

Help

Instance API Reference

Modify

Delete

Clone

Move

Export

Tag

Get

Help

Purge