[Index]
Describes a Device Model which maps to API endpoints of some external application (device)
Model ref.: data/DeviceModel
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": { "version": { "required": true, "type": "string", "description": "Version of this model", "title": "Version" }, "name": { "required": true, "type": "string", "description": "Name of this Device Model and resulting model type i.e. device/<Device Type>/<Name>", "title": "Name" }, "documentation": { "type": "string", "description": "Documentation text for this model", "title": "Documentation" }, "Meta": { "properties": { "operations": { "default": [ "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" ], "items": { "type": "string", "choices": [ { "value": "list", "title": "List" }, { "value": "get", "title": "Get" }, { "value": "add", "title": "Add" }, { "value": "update", "title": "Update" }, { "value": "remove", "title": "Remove" }, { "value": "move", "title": "Move" }, { "value": "clone", "title": "Clone" }, { "value": "bulk_update_form", "title": "Bulk Update" }, { "value": "configuration_template", "title": "Configuration Template" }, { "value": "field_display_policy", "title": "Field Display Policy" }, { "value": "execute", "title": "Execute" }, { "value": "export", "title": "Export" }, { "value": "export_bulkload_template", "title": "Export Bulk Load Template" }, { "value": "help", "title": "Help" }, { "value": "import", "title": "Import" }, { "value": "migration", "title": "Migration Template" }, { "value": "transform", "title": "Transform Template" }, { "value": "tag", "title": "Tag" }, { "value": "tag_version", "title": "Tag Version" }, { "value": "test_connect", "title": "Test Connection" } ] }, "type": "array", "description": "List of supported operations", "title": "Operations" }, "list_operations": { "default": [ "list" ], "items": { "type": "string", "choices": [ { "value": "list", "title": "List" }, { "value": "get", "title": "Get" }, { "value": "add", "title": "Add" }, { "value": "update", "title": "Update" }, { "value": "remove", "title": "Remove" }, { "value": "move", "title": "Move" }, { "value": "clone", "title": "Clone" }, { "value": "bulk_update_form", "title": "Bulk Update" }, { "value": "configuration_template", "title": "Configuration Template" }, { "value": "field_display_policy", "title": "Field Display Policy" }, { "value": "execute", "title": "Execute" }, { "value": "export", "title": "Export" }, { "value": "export_bulkload_template", "title": "Export Bulk Load Template" }, { "value": "help", "title": "Help" }, { "value": "import", "title": "Import" }, { "value": "migration", "title": "Migration Template" }, { "value": "transform", "title": "Transform Template" }, { "value": "tag", "title": "Tag" }, { "value": "tag_version", "title": "Tag Version" }, { "value": "test_connect", "title": "Test Connection" } ] }, "type": "array", "description": "List of supported list operations", "title": "List Operations" }, "api_operations": { "items": { "type": "object", "properties": { "pre_request_calls": { "items": { "type": "string" }, "type": "array", "description": "List of API calls to make before making this request", "title": "Pre-request Calls" }, "target": { "description": "Target of this operation", "title": "Target", "default": "HTTP", "required": false, "choices": [ { "value": "HTTP", "title": "HTTP" }, { "value": "Browser", "title": "Browser" }, { "value": "SOAP", "title": "SOAP" } ], "type": "string" }, "variables": { "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Context variable name. This will appear in the context as 'variables.<name>'", "title": "Name" }, "value": { "type": "string", "description": "Value of this variable. This field supports Macros", "title": "Value" } } }, "type": "array", "description": "List of context variables availble to template rendering (supports Macros)", "title": "Variables" }, "uri": { "type": "string", "description": "URI for the API request", "title": "URI" }, "response_format": { "description": "Response format in case of HTTP Target", "title": "Response Format", "default": "JSON", "required": false, "choices": [ { "value": "JSON", "title": "JSON" }, { "value": "XML", "title": "XML" } ], "type": "string" }, "request_headers": { "items": { "type": "object", "properties": { "name": { "required": true, "type": "string", "description": "Name of HTTP request header, e.g. Accept.", "title": "Name" }, "value": { "required": true, "type": "string", "description": "Value of HTTP request header, e.g. text/plain.", "title": "Value" } } }, "type": "array", "description": "HTTP request headers to send with API operation request. Takes precedence over default request headers specified on related Connection Parameters Type instance.", "title": "Request Headers" }, "post_request_calls": { "items": { "type": "string" }, "type": "array", "description": "List of API calls to make after making this request", "title": "Post-request Calls" }, "http_method": { "description": "HTTP method for API request", "title": "HTTP Method", "default": "get", "required": true, "choices": [ { "value": "GET", "title": "GET" }, { "value": "POST", "title": "POST" }, { "value": "PATCH", "title": "PATCH" }, { "value": "PUT", "title": "PUT" }, { "value": "DELETE", "title": "DELETE" } ], "type": "string" }, "request_template": { "type": "string", "description": "Jinja template for API request. Maps system schema to external application schema.", "title": "Request Template" }, "response_code_template": { "type": "string", "description": "Jinja template for mapping API endpoint specific error/status response", "title": "Response Code Template" }, "action": { "required": true, "type": "string", "description": "Name of the device model operation for e.g. add", "title": "Action" }, "response_template": { "type": "string", "description": "Jinja template for API response. Maps external application schema to system schema.", "title": "Response Template" }, "response_handlers": { "items": { "type": "object", "properties": { "type": { "choices": [ { "value": "backoff_retry", "title": "Backoff & Retry" }, { "value": "failure_duplicate", "title": "Failure - Duplicate" } ], "required": true, "type": "string", "description": "Response handler type to execute if specified condition evaluates to True, e.g. Backoff & Retry.", "title": "Type" }, "condition": { "required": true, "type": "string", "description": "Jinja template which if evaluation results in a value of True will cause the specified handler type to be executed, e.g. {{ status_code == 429 }}.", "title": "Condition" } } }, "type": "array", "description": "Handlers to execute on API responses. Only those response handlers' which condition evaluate to True are executed.", "title": "Response Handlers" } } }, "type": "array", "description": "List of API endpoint definitions as they map to model operations", "title": "API Operations" }, "summary_attrs": { "items": { "type": "string" }, "type": "array", "description": "Summary attributes for this model. This defines the data returned in API list requests.", "title": "Summary Attributes" }, "instance_operations": { "default": [ "get" ], "items": { "type": "string", "choices": [ { "value": "list", "title": "List" }, { "value": "get", "title": "Get" }, { "value": "add", "title": "Add" }, { "value": "update", "title": "Update" }, { "value": "remove", "title": "Remove" }, { "value": "move", "title": "Move" }, { "value": "clone", "title": "Clone" }, { "value": "bulk_update_form", "title": "Bulk Update" }, { "value": "configuration_template", "title": "Configuration Template" }, { "value": "field_display_policy", "title": "Field Display Policy" }, { "value": "execute", "title": "Execute" }, { "value": "export", "title": "Export" }, { "value": "export_bulkload_template", "title": "Export Bulk Load Template" }, { "value": "help", "title": "Help" }, { "value": "import", "title": "Import" }, { "value": "migration", "title": "Migration Template" }, { "value": "transform", "title": "Transform Template" }, { "value": "tag", "title": "Tag" }, { "value": "tag_version", "title": "Tag Version" }, { "value": "test_connect", "title": "Test Connection" } ] }, "type": "array", "description": "List of supported instance operations", "title": "Instance Operations" } }, "type": "object", "description": "Meta information for this Device Model", "title": "Meta Information" }, "device_type": { "required": true, "type": "string", "description": "Device type for e.g. device/facebook", "title": "Device Type" }, "schema": { "required": true, "type": "any", "description": "JSON schema of the model", "title": "Schema" }, "primary_key": { "required": true, "type": "string", "description": "This is the field returned by an add operation that uniquely identifies the created entity for e.g. id", "title": "Primary Key Field" } }, "schema_version": "1.3.1" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/data/DeviceModel/add/ |
|
The GUI Add form of data/DeviceModel 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/data/DeviceModel/ | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk delete [pkid1],[pkid2]... | DELETE | /api/data/DeviceModel/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/DeviceModel/[pkid1]", "/api/data/DeviceModel/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/DeviceModel/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/data/DeviceModel/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/data/DeviceModel/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/data/DeviceModel/[pkid1]", "/api/v0/data/DeviceModel/[pkid2]",...]}} |
GET http://[host-proxy]/api/data/DeviceModel/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/DeviceModel; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/DeviceModel/export/ |
|
{ "hrefs":["/api/data/DeviceModel/[pkid1]", "/api/data/DeviceModel/[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 data/DeviceModel and the JSON format can be used to import instances of data/DeviceModel.
GET http://[host-proxy]/api/data/DeviceModel/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for data/DeviceModel | POST | /api/data/DeviceModel/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Configuration Template | GET | /api/data/DeviceModel/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/data/DeviceModel/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Migration Template | GET | /api/data/DeviceModel/migration/ |
|
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/data/DeviceModel/ |
|
The data/DeviceModel schema and all instances as JSON. |
(The list will return 0 to 3 data/DeviceModel instances)
{ "operations": [ "field_display_policy", "configuration_template", "help", "get", "export_bulkload_template", "list", "update", "remove", "move", "transform", "add", "export", "migration", "bulk_update_form" ], "pagination": { "direction": "asc", "order_by": "name", "maximum_limit": 2000, "skip": 0, "current": "/api/data/DeviceModel/?skip=0&limit=3&order_by=name&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 20 }, "meta": { "tags": [], "cached": true, "title": "", "business_key": { "hierarchy": true, "unique": [ "name", "version", "device_type" ] }, "schema_version": "1.3.1", "references": { "device": [ { "pkid": "", "href": "" } ], "children": [], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [] }, "actions": [ { "add": { "support_async": false, "class": "add", "href": "/api/data/DeviceModel/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/data/DeviceModel/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/data/DeviceModel/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true", "method": "GET", "title": "Bulk Modify" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/data/DeviceModel/export/?hierarchy=[hierarchy]", "method": "POST", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "export_bulkload_template": { "support_async": false, "class": "bulkload_template", "href": "/api/data/DeviceModel/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "tag": { "title": "Tag", "support_async": true, "method": "PATCH", "href": "/api/data/DeviceModel/+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/data/DeviceModel/+tag_version/?hierarchy=[hierarchy]", "class": "tag_version", "view": "/api/view/TagVersionForm/add/?auth_token=[authtoken] } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/data/DeviceModel/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/data/DeviceModel/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "migration": { "support_async": false, "class": "migration", "href": "/api/data/DeviceModel/migration/?hierarchy=[hierarchy]", "method": "GET", "title": "Migration Template" } }, { "list": { "support_async": false, "class": "list", "href": "/api/data/DeviceModel/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/data/DeviceModel/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } } ], "model_type": "data/DeviceModel", "model_specific_actions": [ "add", "bulk_update_form", "configuration_template", "export", "export_bulkload_template", "field_display_policy", "get", "help", "list", "clone", "migration", "remove", "tag", "tag_version", "update" ], "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "version", "title": "Version" }, { "name": "device_type", "title": "Device Type" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "19.3.1", "tagged_versions": [] }, "resources": [ { "pkid": "5dcc86ea56b5de001960b714", "meta": { "tags": [ "uccx", "V4UC", "ba_BaseCommonOverlay" ], "cached": true, "title": "Agent - 11.6.1 - device/uccx", "business_key": { "hierarchy": true, "unique": [ "name", "version", "device_type" ] }, "schema_version": "1.3.1", "summary": "false", "references": { "device": [ { "pkid": "", "href": "" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "5dcc86ea56b5de001960b714", "href": "/api/data/DeviceModel/5dcc86ea56b5de001960b714/" } ], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/data/DeviceModel/5dcc86ea56b5de001960b714/", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/data/DeviceModel/5dcc86ea56b5de001960b714/", "method": "DELETE", "title": "Delete" } }, { "clone": { "support_async": false, "class": "clone", "href": "/api/data/DeviceModel/5dcc86ea56b5de001960b714/clone/?schema=&schema_rules=true", "method": "GET", "title": "Clone" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/data/DeviceModel/5dcc86ea56b5de001960b714/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "tag": { "title": "Tag", "support_async": true, "method": "PATCH", "href": "/api/data/DeviceModel/5dcc86ea56b5de001960b714/+tag/", "class": "tag", "view": "/api/view/TagNameForm/add/" } }, { "tag_version": { "title": "Tag Version", "support_async": true, "method": "PATCH", "href": "/api/data/DeviceModel/5dcc86ea56b5de001960b714/+tag_version/", "class": "tag_version", "view": "/api/view/TagVersionForm/add/" } }, { "get": { "support_async": false, "class": "get", "href": "/api/data/DeviceModel/5dcc86ea56b5de001960b714/", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/data/DeviceModel/5dcc86ea56b5de001960b714/help", "method": "GET", "title": "Help" } } ], "model_type": "data/DeviceModel", "path": [ "6t0ggef2c0deab00hb595101", "5dcc86ea56b5de001960b714" ], "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "version", "title": "Version" }, { "name": "device_type", "title": "Device Type" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "19.3.1", "tagged_versions": [] }, "data": { "schema": "{\n \"id\": {\n \"title\": \"ID\",\n \"type\": \"string\",\n \"readonly\": true\n },\n \"userID\": {\n \"description\": \"User ID of this Agent.\",\n \"title\": \"User ID\",\n \"type\": \"string\",\n \"readonly\": true\n },\n \"firstName\": {\n \"description\": \"First name of this Agent.\",\n \"title\": \"First Name\",\n \"type\": \"string\",\n \"readonly\": true\n },\n \"lastName\": {\n \"description\": \"Last name of this Agent.\",\n \"title\": \"Last Name\",\n \"type\": \"string\",\n \"readonly\": true\n },\n \"extension\": {\n \"description\": \"IPCC extension of this Agent.\",\n \"title\": \"Extension\",\n \"type\": \"string\"\n },\n \"type\": {\n \"description\": \"User type i.e. either an Agent or Supervisor.\",\n \"title\": \"Type\",\n \"type\": \"string\",\n \"choices\": [\n {\n \"value\": \"Agent\",\n \"title\": \"Agent\"\n },\n {\n \"value\": \"Supervisor\",\n \"title\": \"Supervisor\"\n }\n ]\n },\n \"alias\": {\n \"description\": \"Alias for this Agent.\",\n \"pattern\": \"|[^`~@#!$%\\\\^&\\\\*\\\\(\\\\)\\\\-_\\\\+=\\\\{\\\\}\\\\[\\\\]\\\\|\\\\\\\\/:;'\\\\?\\\"\\\\.,<>]{1,31}|[^`~@#!$%\\\\^&\\\\*\\\\(\\\\)\\\\-_\\\\+=\\\\{\\\\}\\\\[\\\\]\\\\|\\\\\\\\/:;'\\\\?\\\"\\\\.,<>]{1,1}[^`~@#!$%\\\\^&\\\\*\\\\(\\\\)\\\\+=\\\\{\\\\}\\\\[\\\\]\\\\|\\\\\\\\/:;'\\\\?\\\",<>]{1,29}[^`~@#!$%\\\\^&\\\\*\\\\(\\\\)\\\\-_\\\\+=\\\\{\\\\}\\\\[\\\\]\\\\|\\\\\\\\/:;'\\\\?\\\"\\\\.,<>]{1,1}\",\n \"title\": \"Alias\",\n \"type\": \"string\"\n },\n \"teamName\": {\n \"description\": \"The team this Agent is assigned to.\",\n \"title\": \"Team\",\n \"type\": \"string\",\n \"format\": \"uri\",\n \"target_attr\": \"name\",\n \"target\": \"device/uccx/Team\",\n \"convert_to_primary_key\": true\n },\n \"resourceGroupName\": {\n \"description\": \"Resource group this Agent belongs to.\",\n \"title\": \"Resource Group\",\n \"type\": \"string\",\n \"format\": \"uri\",\n \"target_attr\": \"name\",\n \"target\": \"device/uccx/ResourceGroup\",\n \"convert_to_primary_key\": true\n },\n \"autoAvailable\": {\n \"description\": \"Is this Agent automatically available.\",\n \"title\": \"Automatic Available\",\n \"type\": \"boolean\"\n },\n \"skills\": {\n \"description\": \"Skills that this Agent has.\",\n \"title\": \"Skills\",\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"competencelevel\": {\n \"description\": \"Agent's competency level for this skill.\",\n \"default\": 5,\n \"title\": \"Competence Level\",\n \"type\": \"integer\",\n \"choices\": [\n {\n \"value\": 1,\n \"title\": \"1\"\n },\n {\n \"value\": 2,\n \"title\": \"2\"\n },\n {\n \"value\": 3,\n \"title\": \"3\"\n },\n {\n \"value\": 4,\n \"title\": \"4\"\n },\n {\n \"value\": 5,\n \"title\": \"5\"\n },\n {\n \"value\": 6,\n \"title\": \"6\"\n },\n {\n \"value\": 7,\n \"title\": \"7\"\n },\n {\n \"value\": 8,\n \"title\": \"8\"\n },\n {\n \"value\": 9,\n \"title\": \"9\"\n },\n {\n \"value\": 10,\n \"title\": \"10\"\n }\n ]\n },\n \"skillName\": {\n \"description\": \"Skill name.\",\n \"title\": \"Skill\",\n \"type\": \"string\",\n \"format\": \"uri\",\n \"target_attr\": \"name\",\n \"target\": \"device/uccx/Skill\",\n \"convert_to_primary_key\": true\n }\n }\n }\n }\n}", "primary_key": "id", "pkid": "5dcc86ea56b5de001960b715", "version": "11.6.1", "Meta": { "operations": [ "list", "get", "update", "move", "export", "export_bulkload_template", "bulk_update_form", "configuration_template", "field_display_policy", "help", "migration", "transform", "tag", "tag_version" ], "list_operations": [ "list" ], "api_operations": [ { "action": "get", "http_method": "GET", "uri": "{{ driver_parameters.base_uri }}/resource/{{ driver_parameters.pk }}", "response_code_template": "{\n \"missing_code\": 404\n}", "response_template": "{\n \"id\": \"{{ input.userID }}\",\n \"userID\": \"{{ input.userID }}\",\n \"firstName\": \"{{ input.firstName }}\",\n \"lastName\": \"{{ input.lastName }}\",\n \"alias\": \"{{ input.alias }}\",\n \"extension\": \"{{ input.extension }}\",\n{% if input.type == 1 %}\n \"type\": \"Agent\",\n{% else %}\n \"type\": \"Supervisor\",\n{% endif %}\n \"autoAvailable\": {{ input.autoAvailable | to_json }},\n \"primarySupervisorOf\": {{ input.primarySupervisorOf | to_json }},\n \"secondarySupervisorOf\": {{ input.secondarySupervisorOf | to_json }},\n \"teamName\": \"{{ input.team.refURL.split('/')[-1] }}\",\n{% if input.resourceGroup %}\n \"resourceGroupName\": \"{{ input.resourceGroup.refURL.split('/')[-1] }}\",\n{% endif %}\n \"skills\": [\n{% for skill in input.skillMap.skillCompetency %}\n{\n \"competencelevel\": \"{{ skill.competencelevel }}\",\n \"skillName\": \"{{ skill.skillNameUriPair.refURL.split('/')[-1] }}\"\n}\n{% if not loop.last %},{% endif %}\n{% endfor %} \n ]\n}" }, { "action": "getAllAgents", "http_method": "GET", "uri": "{{ driver_parameters.host }}/uccx-webservices/getAllAgents", "response_code_template": "{\n \"missing_code\": 404\n}", "target": "HTTP" }, { "target": "HTTP", "uri": "{{ driver_parameters.base_uri }}/resource/{{ model_instance_filters[0].userID }}", "response_template": "{\n \"id\": \"{{ input.userID }}\",\n \"userID\": \"{{ input.userID }}\",\n \"firstName\": \"{{ input.firstName }}\",\n \"lastName\": \"{{ input.lastName }}\",\n \"alias\": \"{{ input.alias }}\",\n \"extension\": \"{{ input.extension }}\",\n{% if input.type == 1 %}\n \"type\": \"Agent\",\n{% else %}\n \"type\": \"Supervisor\",\n{% endif %}\n \"autoAvailable\": {{ input.autoAvailable | to_json }},\n \"primarySupervisorOf\": {{ input.primarySupervisorOf | to_json }},\n \"secondarySupervisorOf\": {{ input.secondarySupervisorOf | to_json }},\n \"teamName\": \"{{ input.team.refURL.split('/')[-1] }}\",\n{% if input.resourceGroup %}\n \"resourceGroupName\": \"{{ input.resourceGroup.refURL.split('/')[-1] }}\",\n{% endif %}\n \"skills\": [\n{% for skill in input.skillMap.skillCompetency %}\n{\n \"competencelevel\": \"{{ skill.competencelevel }}\",\n \"skillName\": \"{{ skill.skillNameUriPair.refURL.split('/')[-1] }}\"\n}\n{% if not loop.last %},{% endif %}\n{% endfor %} \n ]\n}", "http_method": "GET", "response_code_template": "{\n \"missing_code\": 404\n}", "action": "get_by_value" }, { "action": "list", "http_method": "GET", "uri": "{{ driver_parameters.base_uri }}/resource/", "response_template": "[\n{% for agent in input['resource']%}\n{\n \"id\": \"{{ agent.userID }}\"\n} {% if not loop.last %},{% endif %}\n{% endfor %} \n]" }, { "action": "update", "variables": [ { "name": "team_name", "value": "{{ input.teamName }}" }, { "name": "resource_group_name", "value": "{{ input.resourceGroupName }}" }, { "name": "input_skills", "value": "(( fn.is_none_or_empty input.skills == False )) <{{ input.skills }}> <{{ fn.list_empty }}>" } ], "http_method": "PUT", "request_template": "{\n \"self\": \"{{ driver_parameters.base_uri }}/resource/{{ driver_parameters.pk }}\",\n \"userID\": \"{{ input.userID }}\",\n \"firstName\": \"{{ input.firstName }}\",\n \"lastName\": \"{{ input.lastName }}\",\n \"alias\": \"{{ input.alias }}\",\n \"extension\": \"{{ input.extension }}\",\n{% if input.type == \"Agent\" %}\n \"type\": 1,\n{% else %}\n \"type\": 2,\n{% endif %}\n \"team\": {\n \"@name\": \"{{ variables.team_name }}\",\n \"refURL\": \"{{ driver_parameters.base_uri }}/team/{{ input.teamName }}\"\n },\n{% if input.resourceGroupName %}\n \"resourceGroup\": {\n \"@name\": \"{{ variables.resource_group_name }}\",\n \"refURL\": \"{{ driver_parameters.base_uri }}/resourceGroup/{{ input.resourceGroupName }}\"\n },\n{% endif %}\n \"skillMap\": {\n \"skillCompetency\": [\n{% for skill in variables.input_skills %}\n {\n \"competencelevel\": {{ skill.competencelevel }},\n \"skillNameUriPair\": {\n \"@name\": \"{{ pwf._context.input.skills[loop.index0].skillName }}\",\n \"refURL\": \"{{ driver_parameters.base_uri }}/skill/{{ input.skills[loop.index0].skillName }}\"\n }\n }{% if not loop.last %},{% endif %}\n{% endfor %} \n ]\n },\n{% if input.primarySupervisorOf %}\n \"primarySupervisorOf\": {{ input.primarySupervisorOf | to_json }},\n{% endif %}\n{% if input.secondarySupervisorOf %}\n \"secondarySupervisorOf\": {{ input.secondarySupervisorOf | to_json }},\n{% endif %}\n \"autoAvailable\": {{ input.autoAvailable | to_json }}\n}", "uri": "{{ driver_parameters.base_uri }}/resource/{{ driver_parameters.pk }}" }, { "action": "UpdateAgentTypeToSupervisor", "http_method": "GET", "request_template": "[\n {\n \"command\": \"open\",\n \"target\": \"{{ driver_parameters.host }}/appadmin\",\n \"value\": \"\",\n \"sleep\": 2\n },\n {\n \"command\": \"type\",\n \"target\": \"name=j_username\",\n \"value\": \"{{ driver_parameters.username }}\"\n },\n {\n \"command\": \"type\",\n \"target\": \"name=j_password\",\n \"value\": \"{{ driver_parameters.password }}\"\n },\n {\n \"command\": \"click\",\n \"target\": \"xpath=(.//*[normalize-space(text()) and normalize-space(.)='Password'])[1]/following::button[1]\",\n \"value\": \"\",\n \"sleep\": 1\n },\n {\n \"command\": \"click\",\n \"target\": \"xpath=//*[@id='udm']/li[5]/nobr/a\",\n \"value\": \"\",\n \"sleep\": 1\n },\n {\n \"command\": \"click\",\n \"target\": \"xpath=//*[@id='udm']/li[5]/ul/li[5]/nobr/a\",\n \"value\": \"\",\n \"sleep\": 1\n },\n {\n \"command\": \"click\",\n \"target\": \"xpath=//*[@id='udm']/li[5]/ul/li[5]/ul/li[1]/nobr/a\",\n \"value\": \"\",\n \"sleep\": 1\n },\n {\n \"command\": \"type\",\n \"target\": \"name=search_criteria\",\n \"value\": \"{{ input.userID }}\"\n },\n {\n \"command\": \"click\",\n \"target\": \"name=btnSearch\",\n \"value\": \"\",\n \"sleep\": 1\n },\n {\n \"command\": \"click\",\n \"target\": \"link={{ input.userID }}\",\n \"value\": \"\",\n \"sleep\": 1\n },\n {\n \"command\": \"select\",\n \"target\": \"name=NotAssignedList\",\n \"value\": \"label=Supervisor\"\n },\n {\n \"command\": \"click\",\n \"target\": \"xpath=(.//*[normalize-space(text()) and normalize-space(.)='Available Capabilities'])[1]/following::img[1]\",\n \"value\": \"\"\n },\n {\n \"command\": \"click\",\n \"target\": \"name=btnUpdate\",\n \"value\": \"\"\n },\n\n {\n \"command\": \"click\",\n \"target\": \"link=Logout\",\n \"value\": \"\"\n }\n]", "target": "Browser" }, { "action": "UpdateAgentTypeToAgent", "http_method": "GET", "request_template": "[\n {\n \"command\": \"open\",\n \"target\": \"{{ driver_parameters.host }}/appadmin\",\n \"value\": \"\",\n \"sleep\": 2\n },\n {\n \"command\": \"type\",\n \"target\": \"name=j_username\",\n \"value\": \"{{ driver_parameters.username }}\"\n },\n {\n \"command\": \"type\",\n \"target\": \"name=j_password\",\n \"value\": \"{{ driver_parameters.password }}\"\n },\n {\n \"command\": \"click\",\n \"target\": \"xpath=(.//*[normalize-space(text()) and normalize-space(.)='Password'])[1]/following::button[1]\",\n \"value\": \"\",\n \"sleep\": 1\n },\n {\n \"command\": \"click\",\n \"target\": \"xpath=//*[@id='udm']/li[5]/nobr/a\",\n \"value\": \"\",\n \"sleep\": 1\n },\n {\n \"command\": \"click\",\n \"target\": \"xpath=//*[@id='udm']/li[5]/ul/li[5]/nobr/a\",\n \"value\": \"\",\n \"sleep\": 1\n },\n {\n \"command\": \"click\",\n \"target\": \"xpath=//*[@id='udm']/li[5]/ul/li[5]/ul/li[1]/nobr/a\",\n \"value\": \"\",\n \"sleep\": 1\n },\n {\n \"command\": \"type\",\n \"target\": \"name=search_criteria\",\n \"value\": \"{{ input.userID }}\"\n },\n {\n \"command\": \"click\",\n \"target\": \"name=btnSearch\",\n \"value\": \"\",\n \"sleep\": 1\n },\n {\n \"command\": \"click\",\n \"target\": \"link={{ input.userID }}\",\n \"value\": \"\",\n \"sleep\": 1\n },\n {\n \"command\": \"select\",\n \"target\": \"name=AssignedList\",\n \"value\": \"label=Supervisor\"\n },\n {\n \"command\": \"click\",\n \"target\": \"xpath=(.//*[normalize-space(text()) and normalize-space(.)='Available Capabilities'])[1]/following::img[2]\",\n \"value\": \"\"\n },\n {\n \"command\": \"click\",\n \"target\": \"name=btnUpdate\",\n \"value\": \"\"\n },\n {\n \"command\": \"click\",\n \"target\": \"link=Logout\",\n \"value\": \"\"\n }\n]", "target": "Browser" } ], "summary_attrs": [ "userID", "firstName", "lastName", "extension", "resourceGroupName", "teamName", "type" ], "instance_operations": [ "get", "move" ] }, "device_type": "device/uccx", "hierarchy_friendly_name": "sys (System)", "hierarchy_path": "sys", "name": "Agent" } }, { "pkid": "5dcc86ece186e30018400581", "meta": { "tags": [ "uccx", "V4UC", "ba_BaseCommonOverlay" ], "cached": true, "title": "AgentStats - 11.6.1 - device/uccx", "business_key": { "hierarchy": true, "unique": [ "name", "version", "device_type" ] }, "schema_version": "1.3.1", "summary": "false", "references": { "device": [ { "pkid": "", "href": "" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "5dcc86ece186e30018400581", "href": "/api/data/DeviceModel/5dcc86ece186e30018400581/" } ], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "href": "/api/data/DeviceModel/5dcc86ece186e30018400581/", "title": "Modify", "class": "update", "method": "PUT" } }, { "remove": { "support_async": true, "href": "/api/data/DeviceModel/5dcc86ece186e30018400581/", "title": "Delete", "class": "delete", "method": "DELETE" } }, { "clone": { "support_async": false, "href": "/api/data/DeviceModel/5dcc86ece186e30018400581/clone/?schema=&schema_rules=true", "title": "Clone", "class": "clone", "method": "GET" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/data/DeviceModel/5dcc86ece186e30018400581/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "tag": { "title": "Tag", "support_async": true, "method": "PATCH", "href": "/api/data/DeviceModel/5dcc86ece186e30018400581/+tag/", "class": "tag", "view": "/api/view/TagNameForm/add/" } }, { "tag_version": { "title": "Tag Version", "support_async": true, "method": "PATCH", "href": "/api/data/DeviceModel/5dcc86ece186e30018400581/+tag_version/", "class": "tag_version", "view": "/api/view/TagVersionForm/add/" } }, { "get": { "support_async": false, "href": "/api/data/DeviceModel/5dcc86ece186e30018400581/", "title": "Get", "class": "get", "method": "GET" } }, { "help": { "support_async": false, "href": "/api/data/DeviceModel/5dcc86ece186e30018400581/help", "title": "Help", "class": "help", "method": "GET" } } ], "model_type": "data/DeviceModel", "path": [ "6t0ggef2c0deab00hb595101", "5dcc86ece186e30018400581" ], "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "version", "title": "Version" }, { "name": "device_type", "title": "Device Type" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "19.3.1", "tagged_versions": [] }, "data": { "schema": "{\n \"id\": {\n \"readonly\": true,\n \"title\": \"Skill ID\",\n \"type\": \"string\"\n },\n \"loggedIn\": {\n \"description\": \"Number of logged in Agents.\",\n \"readonly\": true,\n \"title\": \"Logged In\",\n \"type\": \"string\"\n },\n \"ready\": {\n \"description\": \"Number of Agents that are ready.\",\n \"readonly\": true,\n \"title\": \"Ready\",\n \"type\": \"string\"\n },\n \"notReady\": {\n \"description\": \"Number of Agents that are not ready.\",\n \"readonly\": true,\n \"title\": \"Not Ready\",\n \"type\": \"string\"\n },\n \"talking\": {\n \"description\": \"Number of Agents that are talking.\",\n \"readonly\": true,\n \"title\": \"Talking\",\n \"type\": \"string\"\n }\n}", "primary_key": "id", "pkid": "5dcc86ece186e30018400582", "version": "11.6.1", "Meta": { "operations": [ "list", "get", "export", "help", "field_display_policy" ], "list_operations": [ "list" ], "api_operations": [ { "target": "HTTP", "uri": "{{ driver_parameters.base_uri }}/agentstats", "response_format": "JSON", "response_template": "[\n{\n \"id\": \"1\",\n \"loggedIn\": \"{{ input.loggedIn }}\",\n \"ready\": \"{{ input.ready }}\",\n \"notReady\": \"{{ input.notReady }}\",\n \"talking\": \"{{ input.talking }}\"\n}\n]", "http_method": "GET", "action": "list" }, { "target": "HTTP", "uri": "{{ driver_parameters.base_uri }}/agentstats", "response_format": "JSON", "response_template": "{\n \"id\": \"1\",\n \"loggedIn\": \"{{ input.loggedIn }}\",\n \"ready\": \"{{ input.ready }}\",\n \"notReady\": \"{{ input.notReady }}\",\n \"talking\": \"{{ input.talking }}\"\n}", "http_method": "GET", "action": "get" } ], "summary_attrs": [ "loggedIn", "ready", "notReady", "talking" ], "instance_operations": [ "get" ] }, "device_type": "device/uccx", "hierarchy_friendly_name": "sys (System)", "hierarchy_path": "sys", "name": "AgentStats" } }, { "pkid": "5dcc88489d77dd00186e2b3e", "meta": { "tags": [ "auto_attendant", "V4UC", "ba_CommonOverlay" ], "cached": true, "title": "CallHandler - 11.5.1 - device/guicuc", "business_key": { "hierarchy": true, "unique": [ "name", "version", "device_type" ] }, "schema_version": "1.3.1", "summary": "false", "references": { "device": [ { "pkid": "", "href": "" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "5dcc88489d77dd00186e2b3e", "href": "/api/data/DeviceModel/5dcc88489d77dd00186e2b3e/" } ], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [] }, "version_tag": "1.0", "model_type": "data/DeviceModel", "path": [ "6t0ggef2c0deab00hb595101", "5dcc88489d77dd00186e2b3e" ], "actions": [ { "update": { "support_async": true, "method": "PUT", "href": "/api/data/DeviceModel/5dcc88489d77dd00186e2b3e/", "class": "update", "title": "Modify" } }, { "remove": { "support_async": true, "method": "DELETE", "href": "/api/data/DeviceModel/5dcc88489d77dd00186e2b3e/", "class": "delete", "title": "Delete" } }, { "clone": { "support_async": false, "method": "GET", "href": "/api/data/DeviceModel/5dcc88489d77dd00186e2b3e/clone/?schema=&schema_rules=true", "class": "clone", "title": "Clone" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/data/DeviceModel/5dcc88489d77dd00186e2b3e/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "tag": { "title": "Tag", "support_async": true, "method": "PATCH", "href": "/api/data/DeviceModel/5dcc88489d77dd00186e2b3e/+tag/", "class": "tag", "view": "/api/view/TagNameForm/add/" } }, { "tag_version": { "title": "Tag Version", "support_async": true, "method": "PATCH", "href": "/api/data/DeviceModel/5dcc88489d77dd00186e2b3e/+tag_version/", "class": "tag_version", "view": "/api/view/TagVersionForm/add/" } }, { "get": { "support_async": false, "method": "GET", "href": "/api/data/DeviceModel/5dcc88489d77dd00186e2b3e/", "class": "get", "title": "Get" } }, { "help": { "support_async": false, "method": "GET", "href": "/api/data/DeviceModel/5dcc88489d77dd00186e2b3e/help", "class": "help", "title": "Help" } } ], "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "version", "title": "Version" }, { "name": "device_type", "title": "Device Type" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "19.3.1", "tagged_versions": [ { "pkid": "5df22edb33fc9b001813a373", "version": "1.0", "href": "/api/v0/data/DeviceModel/5dcc88489d77dd00186e2b3e/?cached=5df22edb33fc9b001813a373" } ] }, "data": { "version": "11.5.1", "primary_key": "id", "pkid": "5dcc88489d77dd00186e2b3f", "documentation": "Record/Playback a Call Handler Message", "name": "CallHandler", "Meta": { "operations": [ "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", "execute", "import", "test_connect" ], "list_operations": [ "list" ], "api_operations": [ { "action": "Record", "http_method": "get", "request_template": "[\n {\n \"command\": \"open\",\n \"target\": \"https://{{ driver_parameters.host }}/cuadmin/home.do\"\n },\n {\n \"command\": \"type\",\n \"target\": \"name=j_username\",\n \"value\": \"{{ driver_parameters.username }}\"\n },\n {\n \"command\": \"type\",\n \"target\": \"name=j_password\",\n \"value\": \"{{ driver_parameters.password }}\"\n },\n {\n \"command\": \"click\",\n \"target\": \"xpath=//button[@type='submit']\",\n \"sleep\": 3\n },\n\n\n\n {\n \"command\": \"switch_to_frame_default\"\n }, \n {\n \"command\": \"switch_to_frame\",\n \"target\": \"name=tree\",\n \"value\": \"\"\n },\n {\n \"command\": \"click\",\n \"target\": \"xpath=//td[@id='cutree_21']/a/span\",\n \"sleep\": 3\n },\n\n {\n \"command\": \"switch_to_frame_default\"\n }, \n {\n \"command\": \"switch_to_frame\",\n \"target\": \"name=content\",\n \"value\": \"\"\n },\n\n {\n \"command\": \"select\",\n \"target\": \"id=searchLimit0\",\n \"value\": \"label=is exactly\"\n },\n {\n \"command\": \"type\",\n \"target\": \"id=searchString0\",\n \"value\": \"{{ input.call_handler }}\"\n },\n {\n \"command\": \"click\",\n \"target\": \"name=findButton\",\n \"value\": \"\"\n },\n {\n \"command\": \"click\",\n \"target\": \"link={{ input.call_handler }}\",\n \"value\": \"\"\n },\n {\n \"command\": \"click\",\n \"target\": \"id=toggleAnchor\",\n \"value\": \"\"\n },\n {\n \"command\": \"type\",\n \"target\": \"id=phnExt1\",\n \"value\": \"{{ input.extension }}\"\n },\n {\n \"command\": \"click\",\n \"target\": \"id=RecBtn\",\n \"value\": \"\"\n },\n\n {\n \"command\": \"alert_accept\",\n \"sleep\": {{ input.duration }}\n }, \n\n {\n \"command\": \"click\",\n \"target\": \"id=control-buttons-save\",\n \"value\": \"\"\n },\n\n {\n \"command\": \"alert_accept\"\n }, \n {\n \"command\": \"open\",\n \"target\": \"https://{{ driver_parameters.host }}/ccmadmin/logoff.do\"\n }\n]", "target": "Browser", "response_format": "JSON" }, { "action": "Playback", "http_method": "get", "request_template": "[\n {\n \"command\": \"open\",\n \"target\": \"https://{{ driver_parameters.host }}/cuadmin/home.do\"\n },\n {\n \"command\": \"type\",\n \"target\": \"name=j_username\",\n \"value\": \"{{ driver_parameters.username }}\"\n },\n {\n \"command\": \"type\",\n \"target\": \"name=j_password\",\n \"value\": \"{{ driver_parameters.password }}\"\n },\n {\n \"command\": \"click\",\n \"target\": \"xpath=//button[@type='submit']\",\n \"sleep\": 3\n },\n\n\n\n {\n \"command\": \"switch_to_frame_default\"\n }, \n {\n \"command\": \"switch_to_frame\",\n \"target\": \"name=tree\",\n \"value\": \"\"\n },\n {\n \"command\": \"click\",\n \"target\": \"xpath=//td[@id='cutree_21']/a/span\",\n \"sleep\": 3\n },\n\n {\n \"command\": \"switch_to_frame_default\"\n }, \n {\n \"command\": \"switch_to_frame\",\n \"target\": \"name=content\",\n \"value\": \"\"\n },\n\n {\n \"command\": \"select\",\n \"target\": \"id=searchLimit0\",\n \"value\": \"label=is exactly\"\n },\n {\n \"command\": \"type\",\n \"target\": \"id=searchString0\",\n \"value\": \"{{ input.call_handler }}\"\n },\n {\n \"command\": \"click\",\n \"target\": \"name=findButton\",\n \"value\": \"\"\n },\n {\n \"command\": \"click\",\n \"target\": \"link={{ input.call_handler }}\",\n \"value\": \"\"\n },\n {\n \"command\": \"click\",\n \"target\": \"id=toggleAnchor\",\n \"value\": \"\"\n },\n {\n \"command\": \"type\",\n \"target\": \"id=phnExt1\",\n \"value\": \"{{ input.extension }}\"\n },\n {\n \"command\": \"click\",\n \"target\": \"id=plyBtn\",\n \"value\": \"\"\n },\n {\n \"command\": \"alert_accept\",\n \"sleep\": {{ input.duration }}\n }, \n {\n \"command\": \"alert_accept\"\n }, \n {\n \"command\": \"open\",\n \"target\": \"https://{{ driver_parameters.host }}/ccmadmin/logoff.do\"\n }\n]", "target": "Browser", "response_format": "JSON" }, { "action": "RecordSpecific", "http_method": "get", "request_template": "[\n {\n \"command\": \"open\",\n \"target\": \"https://{{ driver_parameters.host }}/cuadmin/home.do\"\n },\n {\n \"command\": \"type\",\n \"target\": \"name=j_username\",\n \"value\": \"{{ driver_parameters.username }}\"\n },\n {\n \"command\": \"type\",\n \"target\": \"name=j_password\",\n \"value\": \"{{ driver_parameters.password }}\"\n },\n {\n \"command\": \"click\",\n \"target\": \"xpath=//button[@type='submit']\",\n \"sleep\": 3\n },\n\n\n\n {\n \"command\": \"switch_to_frame_default\"\n }, \n {\n \"command\": \"switch_to_frame\",\n \"target\": \"name=tree\",\n \"value\": \"\"\n },\n {\n \"command\": \"click\",\n \"target\": \"xpath=//td[@id='cutree_21']/a/span\",\n \"sleep\": 3\n },\n\n {\n \"command\": \"switch_to_frame_default\"\n }, \n {\n \"command\": \"switch_to_frame\",\n \"target\": \"name=content\",\n \"value\": \"\"\n },\n\n {\n \"command\": \"select\",\n \"target\": \"id=searchLimit0\",\n \"value\": \"label=is exactly\"\n },\n {\n \"command\": \"type\",\n \"target\": \"id=searchString0\",\n \"value\": \"{{ input.call_handler }}\"\n },\n {\n \"command\": \"click\",\n \"target\": \"name=findButton\",\n \"value\": \"\"\n },\n {\n \"command\": \"click\",\n \"target\": \"link={{ input.call_handler }}\",\n \"value\": \"\"\n },\n\n {\n \"command\": \"click\",\n \"target\": \"link=Edit\",\n \"value\": \"\",\n \"sleep\": 3\n },\n {\n \"command\": \"click\",\n \"target\": \"id=menu-item-search-greeting-callhandler\",\n \"value\": \"\"\n },\n {\n \"command\": \"click\",\n \"target\": \"link={{ input.greeting }}\",\n \"value\": \"\"\n },\n\n {\n \"command\": \"click\",\n \"target\": \"id=toggleAnchor\",\n \"value\": \"\"\n },\n {\n \"command\": \"type\",\n \"target\": \"id=phnExt1\",\n \"value\": \"{{ input.extension }}\"\n },\n {\n \"command\": \"click\",\n \"target\": \"id=RecBtn\",\n \"value\": \"\"\n },\n\n {\n \"command\": \"alert_accept\",\n \"sleep\": {{ input.duration }}\n }, \n\n {\n \"command\": \"click\",\n \"target\": \"id=control-buttons-save\",\n \"value\": \"\"\n },\n {\n \"command\": \"alert_accept\"\n }, \n {\n \"command\": \"open\",\n \"target\": \"https://{{ driver_parameters.host }}/ccmadmin/logoff.do\"\n }\n]", "target": "Browser", "response_format": "JSON" }, { "action": "PlaybackSpecific", "http_method": "get", "request_template": "[\n {\n \"command\": \"open\",\n \"target\": \"https://{{ driver_parameters.host }}/cuadmin/home.do\"\n },\n {\n \"command\": \"type\",\n \"target\": \"name=j_username\",\n \"value\": \"{{ driver_parameters.username }}\"\n },\n {\n \"command\": \"type\",\n \"target\": \"name=j_password\",\n \"value\": \"{{ driver_parameters.password }}\"\n },\n {\n \"command\": \"click\",\n \"target\": \"xpath=//button[@type='submit']\",\n \"sleep\": 3\n },\n\n\n\n {\n \"command\": \"switch_to_frame_default\"\n }, \n {\n \"command\": \"switch_to_frame\",\n \"target\": \"name=tree\",\n \"value\": \"\"\n },\n {\n \"command\": \"click\",\n \"target\": \"xpath=//td[@id='cutree_21']/a/span\",\n \"sleep\": 3\n },\n\n {\n \"command\": \"switch_to_frame_default\"\n }, \n {\n \"command\": \"switch_to_frame\",\n \"target\": \"name=content\",\n \"value\": \"\"\n },\n\n {\n \"command\": \"select\",\n \"target\": \"id=searchLimit0\",\n \"value\": \"label=is exactly\"\n },\n {\n \"command\": \"type\",\n \"target\": \"id=searchString0\",\n \"value\": \"{{ input.call_handler }}\"\n },\n {\n \"command\": \"click\",\n \"target\": \"name=findButton\",\n \"value\": \"\"\n },\n {\n \"command\": \"click\",\n \"target\": \"link={{ input.call_handler }}\",\n \"value\": \"\"\n },\n {\n \"command\": \"click\",\n \"target\": \"link=Edit\",\n \"value\": \"\",\n \"sleep\": 3\n },\n {\n \"command\": \"click\",\n \"target\": \"id=menu-item-search-greeting-callhandler\",\n \"value\": \"\"\n },\n {\n \"command\": \"click\",\n \"target\": \"link={{ input.greeting }}\",\n \"value\": \"\"\n },\n\n {\n \"command\": \"click\",\n \"target\": \"id=toggleAnchor\",\n \"value\": \"\"\n },\n {\n \"command\": \"type\",\n \"target\": \"id=phnExt1\",\n \"value\": \"{{ input.extension }}\"\n },\n {\n \"command\": \"click\",\n \"target\": \"id=plyBtn\",\n \"value\": \"\"\n },\n {\n \"command\": \"alert_accept\",\n \"sleep\": {{ input.duration }}\n }, \n {\n \"command\": \"alert_accept\"\n }, \n {\n \"command\": \"open\",\n \"target\": \"https://{{ driver_parameters.host }}/ccmadmin/logoff.do\"\n }\n]", "target": "Browser", "response_format": "JSON" } ], "summary_attrs": [ "id" ], "instance_operations": [ "get" ] }, "device_type": "device/guicuc", "hierarchy_friendly_name": "sys (System)", "schema": "{\n \"id\": {\n \"type\": \"string\"\n },\n \"url\": {\n \"type\": \"string\"\n },\n \"call_handler\": {\n \"type\": \"string\"\n },\n \"extension\": {\n \"type\": \"string\"\n },\n \"greeting\": {\n \"type\": \"string\"\n },\n \"duration\": {\n \"type\": \"string\"\n }\n}", "hierarchy_path": "sys" } } ] }
(Show the first instance)
{ "pkid": "5dcc86ea56b5de001960b714", "meta": { "tags": [ "uccx", "V4UC", "ba_BaseCommonOverlay" ], "cached": false, "title": "Agent - 11.6.1 - device/uccx", "business_key": { "hierarchy": true, "unique": [ "name", "version", "device_type" ] }, "schema_version": "1.3.1", "references": { "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "self": [ { "pkid": "5dcc86ea56b5de001960b714", "href": "/api/data/DeviceModel/5dcc86ea56b5de001960b714/" } ], "foreign_key": [], "device": [ { "pkid": "", "href": "" } ], "owner": [ { "pkid": "" } ], "children": [] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/data/DeviceModel/5dcc86ea56b5de001960b714/?hierarchy=[hierarchy]", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/data/DeviceModel/5dcc86ea56b5de001960b714/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "clone": { "support_async": false, "class": "clone", "href": "/api/data/DeviceModel/5dcc86ea56b5de001960b714/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true", "method": "GET", "title": "Clone" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/data/DeviceModel/5dcc86ea56b5de001960b714/export/?hierarchy=[hierarchy]", "method": "GET", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "tag": { "title": "Tag", "support_async": true, "method": "PATCH", "href": "/api/data/DeviceModel/5dcc86ea56b5de001960b714/+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/data/DeviceModel/5dcc86ea56b5de001960b714/+tag_version/?hierarchy=[hierarchy]", "class": "tag_version", "view": "/api/view/TagVersionForm/add/?auth_token=[authtoken] } }, { "get": { "support_async": false, "class": "get", "href": "/api/data/DeviceModel/5dcc86ea56b5de001960b714/?hierarchy=[hierarchy]", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/data/DeviceModel/5dcc86ea56b5de001960b714/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } } ], "model_type": "data/DeviceModel", "path": [ "6t0ggef2c0deab00hb595101", "5dcc86ea56b5de001960b714" ], "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "version", "title": "Version" }, { "name": "device_type", "title": "Device Type" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "19.3.1", "tagged_versions": [] }, "data": { "primary_key": "id", "pkid": "5dcc86ea56b5de001960b715", "version": "11.6.1", "Meta": { "operations": [ "list", "get", "update", "move", "export", "export_bulkload_template", "bulk_update_form", "configuration_template", "field_display_policy", "help", "migration", "transform", "tag", "tag_version" ], "list_operations": [ "list" ], "api_operations": [ { "action": "get", "http_method": "GET", "uri": "{{ driver_parameters.base_uri }}/resource/{{ driver_parameters.pk }}", "response_code_template": "{\n \"missing_code\": 404\n}", "response_template": "{\n \"id\": \"{{ input.userID }}\",\n \"userID\": \"{{ input.userID }}\",\n \"firstName\": \"{{ input.firstName }}\",\n \"lastName\": \"{{ input.lastName }}\",\n \"alias\": \"{{ input.alias }}\",\n \"extension\": \"{{ input.extension }}\",\n{% if input.type == 1 %}\n \"type\": \"Agent\",\n{% else %}\n \"type\": \"Supervisor\",\n{% endif %}\n \"autoAvailable\": {{ input.autoAvailable | to_json }},\n \"primarySupervisorOf\": {{ input.primarySupervisorOf | to_json }},\n \"secondarySupervisorOf\": {{ input.secondarySupervisorOf | to_json }},\n \"teamName\": \"{{ input.team.refURL.split('/')[-1] }}\",\n{% if input.resourceGroup %}\n \"resourceGroupName\": \"{{ input.resourceGroup.refURL.split('/')[-1] }}\",\n{% endif %}\n \"skills\": [\n{% for skill in input.skillMap.skillCompetency %}\n{\n \"competencelevel\": \"{{ skill.competencelevel }}\",\n \"skillName\": \"{{ skill.skillNameUriPair.refURL.split('/')[-1] }}\"\n}\n{% if not loop.last %},{% endif %}\n{% endfor %} \n ]\n}" }, { "action": "getAllAgents", "http_method": "GET", "uri": "{{ driver_parameters.host }}/uccx-webservices/getAllAgents", "response_code_template": "{\n \"missing_code\": 404\n}", "target": "HTTP" }, { "target": "HTTP", "uri": "{{ driver_parameters.base_uri }}/resource/{{ model_instance_filters[0].userID }}", "response_template": "{\n \"id\": \"{{ input.userID }}\",\n \"userID\": \"{{ input.userID }}\",\n \"firstName\": \"{{ input.firstName }}\",\n \"lastName\": \"{{ input.lastName }}\",\n \"alias\": \"{{ input.alias }}\",\n \"extension\": \"{{ input.extension }}\",\n{% if input.type == 1 %}\n \"type\": \"Agent\",\n{% else %}\n \"type\": \"Supervisor\",\n{% endif %}\n \"autoAvailable\": {{ input.autoAvailable | to_json }},\n \"primarySupervisorOf\": {{ input.primarySupervisorOf | to_json }},\n \"secondarySupervisorOf\": {{ input.secondarySupervisorOf | to_json }},\n \"teamName\": \"{{ input.team.refURL.split('/')[-1] }}\",\n{% if input.resourceGroup %}\n \"resourceGroupName\": \"{{ input.resourceGroup.refURL.split('/')[-1] }}\",\n{% endif %}\n \"skills\": [\n{% for skill in input.skillMap.skillCompetency %}\n{\n \"competencelevel\": \"{{ skill.competencelevel }}\",\n \"skillName\": \"{{ skill.skillNameUriPair.refURL.split('/')[-1] }}\"\n}\n{% if not loop.last %},{% endif %}\n{% endfor %} \n ]\n}", "http_method": "GET", "response_code_template": "{\n \"missing_code\": 404\n}", "action": "get_by_value" }, { "action": "list", "http_method": "GET", "uri": "{{ driver_parameters.base_uri }}/resource/", "response_template": "[\n{% for agent in input['resource']%}\n{\n \"id\": \"{{ agent.userID }}\"\n} {% if not loop.last %},{% endif %}\n{% endfor %} \n]" }, { "action": "update", "variables": [ { "name": "team_name", "value": "{{ input.teamName }}" }, { "name": "resource_group_name", "value": "{{ input.resourceGroupName }}" }, { "name": "input_skills", "value": "(( fn.is_none_or_empty input.skills == False )) <{{ input.skills }}> <{{ fn.list_empty }}>" } ], "http_method": "PUT", "request_template": "{\n \"self\": \"{{ driver_parameters.base_uri }}/resource/{{ driver_parameters.pk }}\",\n \"userID\": \"{{ input.userID }}\",\n \"firstName\": \"{{ input.firstName }}\",\n \"lastName\": \"{{ input.lastName }}\",\n \"alias\": \"{{ input.alias }}\",\n \"extension\": \"{{ input.extension }}\",\n{% if input.type == \"Agent\" %}\n \"type\": 1,\n{% else %}\n \"type\": 2,\n{% endif %}\n \"team\": {\n \"@name\": \"{{ variables.team_name }}\",\n \"refURL\": \"{{ driver_parameters.base_uri }}/team/{{ input.teamName }}\"\n },\n{% if input.resourceGroupName %}\n \"resourceGroup\": {\n \"@name\": \"{{ variables.resource_group_name }}\",\n \"refURL\": \"{{ driver_parameters.base_uri }}/resourceGroup/{{ input.resourceGroupName }}\"\n },\n{% endif %}\n \"skillMap\": {\n \"skillCompetency\": [\n{% for skill in variables.input_skills %}\n {\n \"competencelevel\": {{ skill.competencelevel }},\n \"skillNameUriPair\": {\n \"@name\": \"{{ pwf._context.input.skills[loop.index0].skillName }}\",\n \"refURL\": \"{{ driver_parameters.base_uri }}/skill/{{ input.skills[loop.index0].skillName }}\"\n }\n }{% if not loop.last %},{% endif %}\n{% endfor %} \n ]\n },\n{% if input.primarySupervisorOf %}\n \"primarySupervisorOf\": {{ input.primarySupervisorOf | to_json }},\n{% endif %}\n{% if input.secondarySupervisorOf %}\n \"secondarySupervisorOf\": {{ input.secondarySupervisorOf | to_json }},\n{% endif %}\n \"autoAvailable\": {{ input.autoAvailable | to_json }}\n}", "uri": "{{ driver_parameters.base_uri }}/resource/{{ driver_parameters.pk }}" }, { "action": "UpdateAgentTypeToSupervisor", "http_method": "GET", "request_template": "[\n {\n \"command\": \"open\",\n \"target\": \"{{ driver_parameters.host }}/appadmin\",\n \"value\": \"\",\n \"sleep\": 2\n },\n {\n \"command\": \"type\",\n \"target\": \"name=j_username\",\n \"value\": \"{{ driver_parameters.username }}\"\n },\n {\n \"command\": \"type\",\n \"target\": \"name=j_password\",\n \"value\": \"{{ driver_parameters.password }}\"\n },\n {\n \"command\": \"click\",\n \"target\": \"xpath=(.//*[normalize-space(text()) and normalize-space(.)='Password'])[1]/following::button[1]\",\n \"value\": \"\",\n \"sleep\": 1\n },\n {\n \"command\": \"click\",\n \"target\": \"xpath=//*[@id='udm']/li[5]/nobr/a\",\n \"value\": \"\",\n \"sleep\": 1\n },\n {\n \"command\": \"click\",\n \"target\": \"xpath=//*[@id='udm']/li[5]/ul/li[5]/nobr/a\",\n \"value\": \"\",\n \"sleep\": 1\n },\n {\n \"command\": \"click\",\n \"target\": \"xpath=//*[@id='udm']/li[5]/ul/li[5]/ul/li[1]/nobr/a\",\n \"value\": \"\",\n \"sleep\": 1\n },\n {\n \"command\": \"type\",\n \"target\": \"name=search_criteria\",\n \"value\": \"{{ input.userID }}\"\n },\n {\n \"command\": \"click\",\n \"target\": \"name=btnSearch\",\n \"value\": \"\",\n \"sleep\": 1\n },\n {\n \"command\": \"click\",\n \"target\": \"link={{ input.userID }}\",\n \"value\": \"\",\n \"sleep\": 1\n },\n {\n \"command\": \"select\",\n \"target\": \"name=NotAssignedList\",\n \"value\": \"label=Supervisor\"\n },\n {\n \"command\": \"click\",\n \"target\": \"xpath=(.//*[normalize-space(text()) and normalize-space(.)='Available Capabilities'])[1]/following::img[1]\",\n \"value\": \"\"\n },\n {\n \"command\": \"click\",\n \"target\": \"name=btnUpdate\",\n \"value\": \"\"\n },\n\n {\n \"command\": \"click\",\n \"target\": \"link=Logout\",\n \"value\": \"\"\n }\n]", "target": "Browser" }, { "action": "UpdateAgentTypeToAgent", "http_method": "GET", "request_template": "[\n {\n \"command\": \"open\",\n \"target\": \"{{ driver_parameters.host }}/appadmin\",\n \"value\": \"\",\n \"sleep\": 2\n },\n {\n \"command\": \"type\",\n \"target\": \"name=j_username\",\n \"value\": \"{{ driver_parameters.username }}\"\n },\n {\n \"command\": \"type\",\n \"target\": \"name=j_password\",\n \"value\": \"{{ driver_parameters.password }}\"\n },\n {\n \"command\": \"click\",\n \"target\": \"xpath=(.//*[normalize-space(text()) and normalize-space(.)='Password'])[1]/following::button[1]\",\n \"value\": \"\",\n \"sleep\": 1\n },\n {\n \"command\": \"click\",\n \"target\": \"xpath=//*[@id='udm']/li[5]/nobr/a\",\n \"value\": \"\",\n \"sleep\": 1\n },\n {\n \"command\": \"click\",\n \"target\": \"xpath=//*[@id='udm']/li[5]/ul/li[5]/nobr/a\",\n \"value\": \"\",\n \"sleep\": 1\n },\n {\n \"command\": \"click\",\n \"target\": \"xpath=//*[@id='udm']/li[5]/ul/li[5]/ul/li[1]/nobr/a\",\n \"value\": \"\",\n \"sleep\": 1\n },\n {\n \"command\": \"type\",\n \"target\": \"name=search_criteria\",\n \"value\": \"{{ input.userID }}\"\n },\n {\n \"command\": \"click\",\n \"target\": \"name=btnSearch\",\n \"value\": \"\",\n \"sleep\": 1\n },\n {\n \"command\": \"click\",\n \"target\": \"link={{ input.userID }}\",\n \"value\": \"\",\n \"sleep\": 1\n },\n {\n \"command\": \"select\",\n \"target\": \"name=AssignedList\",\n \"value\": \"label=Supervisor\"\n },\n {\n \"command\": \"click\",\n \"target\": \"xpath=(.//*[normalize-space(text()) and normalize-space(.)='Available Capabilities'])[1]/following::img[2]\",\n \"value\": \"\"\n },\n {\n \"command\": \"click\",\n \"target\": \"name=btnUpdate\",\n \"value\": \"\"\n },\n {\n \"command\": \"click\",\n \"target\": \"link=Logout\",\n \"value\": \"\"\n }\n]", "target": "Browser" } ], "summary_attrs": [ "userID", "firstName", "lastName", "extension", "resourceGroupName", "teamName", "type" ], "instance_operations": [ "get", "move" ] }, "device_type": "device/uccx", "schema": "{\n \"id\": {\n \"title\": \"ID\",\n \"type\": \"string\",\n \"readonly\": true\n },\n \"userID\": {\n \"description\": \"User ID of this Agent.\",\n \"title\": \"User ID\",\n \"type\": \"string\",\n \"readonly\": true\n },\n \"firstName\": {\n \"description\": \"First name of this Agent.\",\n \"title\": \"First Name\",\n \"type\": \"string\",\n \"readonly\": true\n },\n \"lastName\": {\n \"description\": \"Last name of this Agent.\",\n \"title\": \"Last Name\",\n \"type\": \"string\",\n \"readonly\": true\n },\n \"extension\": {\n \"description\": \"IPCC extension of this Agent.\",\n \"title\": \"Extension\",\n \"type\": \"string\"\n },\n \"type\": {\n \"description\": \"User type i.e. either an Agent or Supervisor.\",\n \"title\": \"Type\",\n \"type\": \"string\",\n \"choices\": [\n {\n \"value\": \"Agent\",\n \"title\": \"Agent\"\n },\n {\n \"value\": \"Supervisor\",\n \"title\": \"Supervisor\"\n }\n ]\n },\n \"alias\": {\n \"description\": \"Alias for this Agent.\",\n \"pattern\": \"|[^`~@#!$%\\\\^&\\\\*\\\\(\\\\)\\\\-_\\\\+=\\\\{\\\\}\\\\[\\\\]\\\\|\\\\\\\\/:;'\\\\?\\\"\\\\.,<>]{1,31}|[^`~@#!$%\\\\^&\\\\*\\\\(\\\\)\\\\-_\\\\+=\\\\{\\\\}\\\\[\\\\]\\\\|\\\\\\\\/:;'\\\\?\\\"\\\\.,<>]{1,1}[^`~@#!$%\\\\^&\\\\*\\\\(\\\\)\\\\+=\\\\{\\\\}\\\\[\\\\]\\\\|\\\\\\\\/:;'\\\\?\\\",<>]{1,29}[^`~@#!$%\\\\^&\\\\*\\\\(\\\\)\\\\-_\\\\+=\\\\{\\\\}\\\\[\\\\]\\\\|\\\\\\\\/:;'\\\\?\\\"\\\\.,<>]{1,1}\",\n \"title\": \"Alias\",\n \"type\": \"string\"\n },\n \"teamName\": {\n \"description\": \"The team this Agent is assigned to.\",\n \"title\": \"Team\",\n \"type\": \"string\",\n \"format\": \"uri\",\n \"target_attr\": \"name\",\n \"target\": \"device/uccx/Team\",\n \"convert_to_primary_key\": true\n },\n \"resourceGroupName\": {\n \"description\": \"Resource group this Agent belongs to.\",\n \"title\": \"Resource Group\",\n \"type\": \"string\",\n \"format\": \"uri\",\n \"target_attr\": \"name\",\n \"target\": \"device/uccx/ResourceGroup\",\n \"convert_to_primary_key\": true\n },\n \"autoAvailable\": {\n \"description\": \"Is this Agent automatically available.\",\n \"title\": \"Automatic Available\",\n \"type\": \"boolean\"\n },\n \"skills\": {\n \"description\": \"Skills that this Agent has.\",\n \"title\": \"Skills\",\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"competencelevel\": {\n \"description\": \"Agent's competency level for this skill.\",\n \"default\": 5,\n \"title\": \"Competence Level\",\n \"type\": \"integer\",\n \"choices\": [\n {\n \"value\": 1,\n \"title\": \"1\"\n },\n {\n \"value\": 2,\n \"title\": \"2\"\n },\n {\n \"value\": 3,\n \"title\": \"3\"\n },\n {\n \"value\": 4,\n \"title\": \"4\"\n },\n {\n \"value\": 5,\n \"title\": \"5\"\n },\n {\n \"value\": 6,\n \"title\": \"6\"\n },\n {\n \"value\": 7,\n \"title\": \"7\"\n },\n {\n \"value\": 8,\n \"title\": \"8\"\n },\n {\n \"value\": 9,\n \"title\": \"9\"\n },\n {\n \"value\": 10,\n \"title\": \"10\"\n }\n ]\n },\n \"skillName\": {\n \"description\": \"Skill name.\",\n \"title\": \"Skill\",\n \"type\": \"string\",\n \"format\": \"uri\",\n \"target_attr\": \"name\",\n \"target\": \"device/uccx/Skill\",\n \"convert_to_primary_key\": true\n }\n }\n }\n }\n}", "name": "Agent" } }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for data/DeviceModel. | GET | /api/data/DeviceModel/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/DeviceModel as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/data/DeviceModel/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/data/DeviceModel/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/DeviceModel/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/DeviceModel/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a selected [export_format] of the schema and a single instance with [pkid] of data/DeviceModel; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/DeviceModel/[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 data/DeviceModel and the JSON format can be used to import instances of data/DeviceModel.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Tag | PATCH | /api/data/DeviceModel/[pkid]/+tag/ | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/data/DeviceModel/[pkid]/ | hierarchy=[hierarchy] | The data/DeviceModel instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/data/DeviceModel/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/DeviceModel. |