[Index]

API Reference for device/spark/CXDesktopProfile

Model ref.: device/spark/CXDesktopProfile

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 [auth_token]:
1. The VOSS portal will extract the [auth_token] from the URLs and send these as an Authorization header.
2. Model schemas show that the auth_token parameter is still supported.

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/spark/CXDesktopProfile/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema",
     "type": "object",
     "properties": {
          "id": {
               "type": "string",
               "title": "ID",
               "description": "ID of this Desktop Profile"
          },
          "accessBuddyTeam": {
               "type": "string",
               "required": true,
               "title": "Buddy Teams",
               "description": "Access level for buddy teams",
               "choices": [
                    {
                         "title": "All",
                         "value": "ALL"
                    },
                    {
                         "title": "None",
                         "value": "NONE"
                    },
                    {
                         "title": "Specific",
                         "value": "SPECIFIC"
                    }
               ]
          },
          "accessEntryPoint": {
               "type": "string",
               "required": true,
               "title": "Entry Point transfer targets",
               "description": "Access level for entry points and queues",
               "choices": [
                    {
                         "title": "All",
                         "value": "ALL"
                    },
                    {
                         "title": "None",
                         "value": "NONE"
                    },
                    {
                         "title": "Specific",
                         "value": "SPECIFIC"
                    }
               ]
          },
          "accessIdleCode": {
               "type": "string",
               "required": true,
               "title": "Access Idle Code",
               "description": "Access level for idle codes, if Specific is selected the list must contain a default idle code",
               "choices": [
                    {
                         "title": "All",
                         "value": "ALL"
                    },
                    {
                         "title": "Specific",
                         "value": "SPECIFIC"
                    }
               ]
          },
          "accessQueue": {
               "type": "string",
               "required": true,
               "title": "Queue transfer targets",
               "description": "Access level for queues",
               "choices": [
                    {
                         "title": "All",
                         "value": "ALL"
                    },
                    {
                         "title": "None",
                         "value": "NONE"
                    },
                    {
                         "title": "Specific",
                         "value": "SPECIFIC"
                    }
               ]
          },
          "accessWrapUpCode": {
               "type": "string",
               "required": true,
               "title": "Access Wrap-Up Code",
               "description": "Access level for wrap-up codes, if Specific is selected the list must contain a default wrap-up code",
               "choices": [
                    {
                         "title": "All",
                         "value": "ALL"
                    },
                    {
                         "title": "Specific",
                         "value": "SPECIFIC"
                    }
               ]
          },
          "active": {
               "type": "boolean",
               "default": false,
               "title": "Active",
               "description": "Indicates whether the Desktop Profile is active"
          },
          "addressBookId": {
               "type": "string",
               "title": "Address Book ID",
               "description": "ID of the address book",
               "format": "uri",
               "target_attr": "name",
               "target": "/api/device/spark/CXAddressBook/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
               "convert_to_primary_key": true,
               "target_model_type": "device/spark/CXAddressBook",
               "choices": []
          },
          "agentAvailableAfterOutdial": {
               "type": "boolean",
               "default": false,
               "title": "Agent Available After Outdial",
               "description": "Indicates if the agent is available after an outdial"
          },
          "loginVoiceOptions": {
               "type": "array",
               "required": true,
               "title": "Login Voice Options",
               "description": "List of login voice options",
               "items": {
                    "type": "string"
               }
          },
          "agentDNValidation": {
               "type": "string",
               "required": true,
               "title": "Agent DN Validation",
               "description": "Validation level for agent DN",
               "choices": [
                    {
                         "title": "Unrestricted",
                         "value": "NONE"
                    },
                    {
                         "title": "Provisioned Directory Number",
                         "value": "PROVISIONED_VALUE"
                    },
                    {
                         "title": "Validate using Dial Plans",
                         "value": "SPECIFIC"
                    }
               ]
          },
          "agentDNValidationCriteria": {
               "type": "string",
               "title": "Select Dial Plans",
               "description": "Criteria for agent DN validation",
               "choices": [
                    {
                         "title": "All",
                         "value": "ALL"
                    },
                    {
                         "title": "Specific",
                         "value": "SPECIFIC"
                    }
               ]
          },
          "agentDNValidationCriterions": {
               "type": "array",
               "title": "Dial Plans",
               "description": "List of validation criterions for agent DN",
               "items": {
                    "type": "string",
                    "format": "uri",
                    "target_attr": "name",
                    "target": "/api/device/spark/CXDialPlan/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
                    "convert_to_primary_key": true,
                    "target_model_type": "device/spark/CXDialPlan",
                    "choices": []
               }
          },
          "allowAutoWrapUpExtension": {
               "type": "boolean",
               "default": false,
               "title": "Allow Auto Wrap-Up Extension",
               "description": "Indicates if auto wrap-up extension is allowed"
          },
          "autoAnswer": {
               "type": "boolean",
               "default": false,
               "title": "Auto Answer",
               "description": "Indicates if auto answer is enabled"
          },
          "autoWrapAfterSeconds": {
               "type": "integer",
               "title": "Auto Wrap After Seconds",
               "description": "Time in seconds after which auto wrap-up is triggered"
          },
          "autoWrapUp": {
               "type": "boolean",
               "default": false,
               "title": "Auto Wrap-Up",
               "description": "Indicates if auto wrap-up is enabled"
          },
          "buddyTeams": {
               "type": "array",
               "title": "Select Teams",
               "description": "List of buddy teams",
               "items": {
                    "type": "string",
                    "format": "uri",
                    "target_attr": "name",
                    "target": "/api/device/spark/CXTeam/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
                    "convert_to_primary_key": true,
                    "target_model_type": "device/spark/CXTeam",
                    "choices": []
               }
          },
          "consultToQueue": {
               "type": "boolean",
               "default": false,
               "title": "Consult to Queue",
               "description": "Indicates if consult to queue is enabled"
          },
          "createdTime": {
               "type": "string",
               "title": "Created Time",
               "description": "Creation time (in epoch millis) of this resource"
          },
          "lastUpdatedTime": {
               "type": "string",
               "title": "Last Updated Time",
               "description": "Time (in epoch millis) when this resource was last updated"
          },
          "description": {
               "type": "string",
               "title": "Description",
               "description": "A brief explanation of the Desktop Profile"
          },
          "dialPlanEnabled": {
               "type": "boolean",
               "default": false,
               "title": "Dial Plan Enabled",
               "description": "Indicates if the dial plan is enabled"
          },
          "dialPlans": {
               "type": "array",
               "title": "Dial Plans",
               "description": "List of dial plans",
               "items": {
                    "type": "string",
                    "format": "uri",
                    "target_attr": "name",
                    "target": "/api/device/spark/CXDialPlan/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
                    "convert_to_primary_key": true,
                    "target_model_type": "device/spark/CXDialPlan",
                    "choices": []
               }
          },
          "entryPoints": {
               "type": "array",
               "title": "Select Entry Points",
               "description": "List of entry points",
               "items": {
                    "type": "string",
                    "format": "uri",
                    "target_attr": "name",
                    "target": "/api/device/spark/CXEntryPoint/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
                    "convert_to_primary_key": true,
                    "target_model_type": "device/spark/CXEntryPoint",
                    "choices": []
               }
          },
          "idleCodes": {
               "type": "array",
               "title": "Idle Codes",
               "description": "List of idle codes associated with the Desktop Profile, the list must contain a default idle code",
               "items": {
                    "type": "string"
               }
          },
          "lastAgentRouting": {
               "type": "boolean",
               "default": false,
               "title": "Last Agent Routing",
               "description": "Indicates if last agent routing is enabled"
          },
          "name": {
               "type": "string",
               "title": "Name",
               "description": "Name of the Desktop Profile"
          },
          "organizationId": {
               "type": "string",
               "title": "Organization ID",
               "description": "ID of the contact center organization"
          },
          "outdialANIId": {
               "type": "string",
               "title": "Outdial ANI ID",
               "description": "ID for outdial ANI",
               "format": "uri",
               "target_attr": "name",
               "target": "/api/device/spark/CXOutdialANI/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
               "convert_to_primary_key": true,
               "target_model_type": "device/spark/CXOutdialANI",
               "choices": []
          },
          "outdialEnabled": {
               "type": "boolean",
               "default": false,
               "title": "Outdial Enabled",
               "description": "Indicates if outdial is enabled"
          },
          "outdialEntryPointId": {
               "type": "string",
               "title": "Outdial Entry Point ID",
               "description": "ID for outdial entry point"
          },
          "parentType": {
               "type": "string",
               "required": true,
               "title": "Parent Type",
               "description": "Type of the parent entity",
               "choices": [
                    {
                         "title": "Tenant",
                         "value": "ORGANIZATION"
                    },
                    {
                         "title": "Site",
                         "value": "SITE"
                    }
               ]
          },
          "queues": {
               "type": "array",
               "title": "Select Queues",
               "description": "List of queues",
               "items": {
                    "type": "string",
                    "format": "uri",
                    "target_attr": "name",
                    "target": "/api/device/spark/CXContactServiceQueue/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
                    "convert_to_primary_key": true,
                    "target_model_type": "device/spark/CXContactServiceQueue",
                    "choices": []
               }
          },
          "screenPopup": {
               "type": "boolean",
               "default": false,
               "title": "Screen Popup",
               "description": "Indicates if screen popup is enabled"
          },
          "thresholdRules": {
               "type": "array",
               "title": "Threshold Rules",
               "description": "The Agent Thresholds page appears only if your enterprise uses the Threshold Alerts feature. If your enterprise uses the Agent Threshold Alerts feature, the page also provides settings to specify the thresholds associated with the agent.",
               "items": {
                    "type": "string"
               }
          },
          "timeoutDesktopInactivityCustomEnabled": {
               "type": "boolean",
               "default": false,
               "title": "Desktop Inactivity Custom Enabled",
               "description": "Indicates if custom timeout for desktop inactivity is enabled"
          },
          "timeoutDesktopInactivityMins": {
               "type": "integer",
               "title": "Desktop Inactivity Minutes",
               "description": "Custom timeout duration for desktop inactivity in minutes"
          },
          "version": {
               "type": "integer",
               "title": "Version",
               "description": "The version number (revision count) for this resource"
          },
          "viewableStatistics": {
               "type": "object",
               "title": "Viewable Statistics",
               "properties": {
                    "accessQueueStats": {
                         "type": "string",
                         "required": true,
                         "title": "Access Queue Stats",
                         "description": "Access level for queue statistics",
                         "choices": [
                              {
                                   "title": "All",
                                   "value": "ALL"
                              },
                              {
                                   "title": "None",
                                   "value": "NONE"
                              },
                              {
                                   "title": "Specific",
                                   "value": "SPECIFIC"
                              }
                         ]
                    },
                    "accessTeamStats": {
                         "type": "string",
                         "required": true,
                         "title": "Access Team Stats",
                         "description": "Access level for team statistics",
                         "choices": [
                              {
                                   "title": "All",
                                   "value": "ALL"
                              },
                              {
                                   "title": "None",
                                   "value": "NONE"
                              },
                              {
                                   "title": "Specific",
                                   "value": "SPECIFIC"
                              }
                         ]
                    },
                    "agentStats": {
                         "type": "boolean",
                         "default": false,
                         "title": "Agent Stats",
                         "description": "Indicates if agent statistics are viewable"
                    },
                    "contactServiceQueues": {
                         "type": "array",
                         "title": "Contact Service Queues",
                         "description": "List of contact service queues",
                         "items": {
                              "type": "string",
                              "format": "uri",
                              "target_attr": "name",
                              "target": "/api/device/spark/CXContactServiceQueue/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
                              "convert_to_primary_key": true,
                              "target_model_type": "device/spark/CXContactServiceQueue",
                              "choices": []
                         }
                    },
                    "id": {
                         "type": "string",
                         "title": "Statistics ID",
                         "description": "ID of the statistics object"
                    },
                    "loggedInTeamStats": {
                         "type": "boolean",
                         "default": false,
                         "title": "Logged-In Team Stats",
                         "description": "Indicates if logged-in team statistics are viewable"
                    },
                    "organizationId": {
                         "type": "string",
                         "title": "Organization ID",
                         "description": "ID of the organization for statistics"
                    },
                    "teams": {
                         "type": "array",
                         "title": "Teams",
                         "description": "List of teams for statistics",
                         "items": {
                              "type": "string",
                              "format": "uri",
                              "target_attr": "name",
                              "target": "/api/device/spark/CXTeam/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
                              "convert_to_primary_key": true,
                              "target_model_type": "device/spark/CXTeam",
                              "choices": []
                         }
                    },
                    "version": {
                         "type": "integer",
                         "title": "Statistics Version",
                         "description": "Version of the statistics object"
                    }
               }
          },
          "wrapUpCodes": {
               "type": "array",
               "title": "Wrap-Up Codes",
               "description": "List of wrap-up codes associated with the Desktop Profile, the list must contain a default wrap-up code",
               "items": {
                    "type": "string"
               }
          },
          "showUserDetailsMS": {
               "type": "boolean",
               "default": false,
               "title": "Show User Details MS",
               "description": "Indicates if user details for MS are shown"
          },
          "stateSynchronizationMS": {
               "type": "boolean",
               "default": false,
               "title": "State Synchronization MS",
               "description": "Indicates if state synchronization for MS is enabled"
          },
          "showUserDetailsWebex": {
               "type": "boolean",
               "default": false,
               "title": "Show User Details Webex",
               "description": "Indicates if user details for Webex are shown"
          },
          "stateSynchronizationWebex": {
               "type": "boolean",
               "default": false,
               "title": "State Synchronization Webex",
               "description": "Indicates if state synchronization for Webex is enabled"
          },
          "systemDefault": {
               "type": "boolean",
               "default": false,
               "title": "System Default",
               "description": "Indicates if the profile is a system default"
          },
          "siteId": {
               "type": "string",
               "title": "Site ID",
               "description": "ID of the site",
               "format": "uri",
               "target_attr": "name",
               "target": "/api/device/spark/CXSite/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
               "convert_to_primary_key": true,
               "target_model_type": "device/spark/CXSite",
               "choices": []
          }
     },
     "schema_version": "1.0.0"
}

Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/device/spark/CXDesktopProfile/add/	hierarchy=[hierarchy] format=json	The GUI Add form of device/spark/CXDesktopProfile 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/spark/CXDesktopProfile	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/spark/CXDesktopProfile/	hierarchy=[hierarchy]	{"hrefs":["/api/device/spark/CXDesktopProfile/[pkid1]", "/api/device/spark/CXDesktopProfile/[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/spark/CXDesktopProfile
```
GET http://[host-proxy]/api/device/spark/CXDesktopProfile/?hierarchy=[hierarchy]&format=json
```

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

Task	Call	URL	Parameters	Payload
Bulk Modify	POST	/api/device/spark/CXDesktopProfile/bulk_update/	hierarchy=[hierarchy] format=json	For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/spark/CXDesktopProfile/[pkid1]", "/api/v0/device/spark/CXDesktopProfile/[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/spark/CXDesktopProfile/?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/spark/CXDesktopProfile	hierarchy=[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/spark/CXDesktopProfile/[pkid]"]}
Bulk Move	POST	/api/tool/DataMove/?model_type=device/spark/CXDesktopProfile	hierarchy==[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/spark/CXDesktopProfile/[pkid1]", "/api/device/spark/CXDesktopProfile/[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/spark/CXDesktopProfile/?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/spark/CXDesktopProfile; optionally with tag_version at [version] and Configuration Template as [configtemplate].	POST	/api/device/spark/CXDesktopProfile/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	{ "hrefs":["/api/device/spark/CXDesktopProfile/[pkid1]", "/api/device/spark/CXDesktopProfile/[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/spark/CXDesktopProfile and the JSON format can be used to import instances of device/spark/CXDesktopProfile.

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

 GET http://[host-proxy]/api/device/spark/CXDesktopProfile/?hierarchy=[hierarchy]

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

Task	Call	URL	Parameters	Response
Tag	PATCH	/api/device/spark/CXDesktopProfile/+tag/	hierarchy=[hierarchy] format=json

Task	Call	URL	Parameters	Response
Tag Version	PATCH	/api/device/spark/CXDesktopProfile/+tag_version/	hierarchy=[hierarchy] format=json

Task	Call	URL	Parameters	Response
Configuration Template	GET	/api/device/spark/CXDesktopProfile/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/spark/CXDesktopProfile/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/spark/CXDesktopProfile/migration/	hierarchy=[hierarchy] format=json

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

(The list will return 0 to 3 device/spark/CXDesktopProfile instances)

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

{
     "pagination": {
          "skip": 0,
          "limit": 3,
          "maximum_limit": 2000,
          "total": 0,
          "total_limit": null,
          "order_by": "name",
          "direction": "asc",
          "current": "/api/device/spark/CXDesktopProfile/?skip=0&limit=3&order_by=name&direction=asc&traversal=down"
     },
     "operations": [
          "list"
     ],
     "meta": {
          "model_type": "device/spark/CXDesktopProfile",
          "summary_attrs": [
               {
                    "name": "name",
                    "title": "Name"
               },
               {
                    "name": "description",
                    "title": "Description"
               },
               {
                    "name": "parentType",
                    "title": "Parent Type"
               },
               {
                    "name": "active",
                    "title": "Active"
               },
               {
                    "name": "createdTime",
                    "title": "Created Time"
               },
               {
                    "name": "lastUpdatedTime",
                    "title": "Last Updated Time"
               },
               {
                    "name": "hierarchy_friendly_name",
                    "title": "Located At",
                    "allow_filtering": true
               }
          ],
          "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": []
          },
          "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"
          ],
          "schema_version": "1.0.0",
          "actions": [
               {
                    "add": {
                         "method": "GET",
                         "class": "add",
                         "href": "/api/device/spark/CXDesktopProfile/add/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Add"
                    }
               },
               {
                    "remove": {
                         "method": "DELETE",
                         "class": "delete",
                         "href": "/api/device/spark/CXDesktopProfile/?hierarchy=[hierarchy]",
                         "support_async": true,
                         "title": "Delete"
                    }
               },
               {
                    "bulk_update_form": {
                         "method": "GET",
                         "class": "update",
                         "href": "/api/device/spark/CXDesktopProfile/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
                         "support_async": false,
                         "title": "Bulk Modify"
                    }
               },
               {
                    "move": {
                         "method": "POST",
                         "class": "move",
                         "href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/spark/CXDesktopProfile",
                         "support_async": true,
                         "title": "Move",
                         "view": "/api/tool/DataMove/?auth_token=[authtoken]
                    }
               },
               {
                    "export": {
                         "method": "POST",
                         "class": "export",
                         "href": "/api/device/spark/CXDesktopProfile/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/device/spark/CXDesktopProfile/export_bulkload_template/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Export Bulk Load Template"
                    }
               },
               {
                    "tag": {
                         "method": "PATCH",
                         "class": "tag",
                         "href": "/api/device/spark/CXDesktopProfile/+tag/?hierarchy=[hierarchy]",
                         "support_async": true,
                         "title": "Tag",
                         "view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
                    }
               },
               {
                    "tag_version": {
                         "method": "PATCH",
                         "class": "tag_version",
                         "href": "/api/device/spark/CXDesktopProfile/+tag_version/?hierarchy=[hierarchy]",
                         "support_async": true,
                         "title": "Tag Version",
                         "view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
                    }
               },
               {
                    "configuration_template": {
                         "method": "GET",
                         "class": "config",
                         "href": "/api/device/spark/CXDesktopProfile/configuration_template/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Configuration Template"
                    }
               },
               {
                    "field_display_policy": {
                         "method": "GET",
                         "class": "display_policy",
                         "href": "/api/device/spark/CXDesktopProfile/field_display_policy/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Field Display Policy"
                    }
               },
               {
                    "migration": {
                         "method": "GET",
                         "class": "migration",
                         "href": "/api/device/spark/CXDesktopProfile/migration/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Migration Template"
                    }
               },
               {
                    "list": {
                         "method": "GET",
                         "class": "list",
                         "href": "/api/device/spark/CXDesktopProfile/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "List"
                    }
               },
               {
                    "help": {
                         "method": "GET",
                         "class": "help",
                         "href": "/api/device/spark/CXDesktopProfile/help?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Help"
                    }
               },
               {
                    "purge": {
                         "method": "POST",
                         "class": "purge",
                         "href": "/api/device/spark/CXDesktopProfile/purge/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Purge"
                    }
               },
               {
                    "transform": {
                         "method": "GET",
                         "class": "transform",
                         "href": "/api/device/spark/CXDesktopProfile/transform/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Transform Template"
                    }
               }
          ]
     },
     "resources": []
}

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

Task	Call	URL	Parameters	Response
Purge	POST	/api/device/spark/CXDesktopProfile/purge/	hierarchy=[hierarchy] format=json

Task	Call	URL	Parameters	Response
Transform Template	GET	/api/device/spark/CXDesktopProfile/transform/	hierarchy=[hierarchy] format=json

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/spark/CXDesktopProfile/[pkid]	hierarchy=[hierarchy]	(For payload specification)

For Bulk modification, refer to the Bulk Modify section.

Task	Call	URL	Parameters	Response
Delete	DELETE	/api/device/spark/CXDesktopProfile/[pkid]	hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Clone instance with [pkid]. The schema rules are applied.	GET	/api/device/spark/CXDesktopProfile/[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/spark/CXDesktopProfile

GET http://[host-proxy]/api/device/spark/CXDesktopProfile/?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/spark/CXDesktopProfile	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/spark/CXDesktopProfile; optionally with tag_version at [version] and Configuration Template as [configtemplate].	GET	/api/device/spark/CXDesktopProfile/[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/spark/CXDesktopProfile and the JSON format can be used to import instances of device/spark/CXDesktopProfile.

For Bulk Export, refer to the Bulk Export section.

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

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

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

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

API Reference for device/spark/CXDesktopProfile

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

Get the Add form

Create

Bulk Delete

Bulk Modify

Move

Bulk Export

Export Bulk Load Template

Tag

Tag Version

Configuration Template

Field Display Policy

Migration Template

List

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

Help

Purge

Transform Template

Instance API Reference

Modify

Delete

Clone

Move

Export

Tag

Get

Help

Purge