[Index]
Data model that will allow additions to the general help section for the online help.
Model ref.: data/GeneralHelp
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": {
"menu_title": {
"readonly": false,
"required": false,
"type": "string",
"description": "Menu title of this specific general help instance as it should be displayed in general help.",
"title": "Menu Title"
},
"name": {
"readonly": false,
"required": true,
"type": "string",
"description": "The name that is given to the General Help Model instance. This will be displayed as the title of the general help entry.",
"title": "Name"
},
"overwrite_specifics": {
"description": "Object that will contain various fields that will indicate how the dynamic model content will be affected by the general help content.",
"title": "Model Overwrite Options",
"required": false,
"readonly": false,
"type": "object",
"properties": {
"overwrite_details": {
"description": "This complex field will contain details around the overwrite options per model type.",
"title": "Overwrite Details",
"items": {
"type": "object",
"properties": {
"model_general_title": {
"readonly": false,
"required": false,
"type": "string",
"description": "This field will tell the model help page which title to display for the particular general help overwrite sections. An empty field means unaffected",
"title": "New General Help Section Title"
},
"hide_model_visualize_button": {
"description": "Only applicable to certain models. Indicates if the Visualize button should be shown.",
"title": "Hide Visualize Button",
"default": false,
"required": false,
"readonly": false,
"type": "boolean"
},
"hide_general_title": {
"description": "Indicates if this overwrite will hide the general help text section title. Each inserted general help text will have the general help menu title as default title for that section.",
"title": "Hide General Help Section Title",
"default": false,
"required": false,
"readonly": false,
"type": "boolean"
},
"insert_model_content": {
"description": "Indicates if this overwrite will insert the help text into the model help.",
"title": "Insert General Help Text Into Model Content",
"default": false,
"required": false,
"readonly": false,
"type": "boolean"
},
"model_title": {
"readonly": false,
"required": false,
"type": "string",
"description": "This field will tell the model help page which title to display. An empty field means unaffected",
"title": "New Model Help Title"
},
"affected_model": {
"description": "This field will show which model types to overwrite with this data.",
"format": "uri",
"title": "Affected Model Type",
"required": false,
"choices": [],
"readonly": false,
"target_model_type": "",
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"affect_dynamic_help": {
"description": "This field will indicate if we want this general help's model overwrites to affect the dynamically generated model help sections as well",
"title": "Manipulate Model Dynamic Generated Help",
"default": false,
"required": false,
"readonly": false,
"type": "boolean"
},
"model_content_position": {
"description": "This indicates the position of the model help overwrite content on the page (paragraph positions). -1 means it will be hidden.",
"title": "New Model General Help Paragraph Position.",
"default": 1,
"required": false,
"readonly": false,
"type": "integer"
},
"hide_model_title": {
"description": "Indicates if this overwrite will hide the model help title.",
"title": "Hide Model Help Title",
"default": false,
"required": false,
"readonly": false,
"type": "boolean"
},
"hide_model_api_url": {
"description": "Indicates if the API HREF (Link) in the dynamic help should be shown.",
"title": "Hide API Help Link",
"default": false,
"required": false,
"readonly": false,
"type": "boolean"
},
"dynamic_help_position": {
"description": "This indicates the position of the dynamic model help on the page (paragraph positions). -1 means hide the help.",
"title": "Model Dynamically Generated Help Paragraph Position.",
"default": 2,
"required": false,
"readonly": false,
"type": "integer"
}
}
},
"required": false,
"readonly": false,
"type": "array"
}
}
},
"menu_position": {
"readonly": false,
"required": false,
"type": "integer",
"description": "Position where this specific general help instance must be placed within general help. If duplicates of the position number occur it will simply be ordered randomly on that position. Order is from lowest integer to highest integer.",
"title": "Menu Position"
},
"language_code": {
"description": "The language shortcode this help instance is written in.",
"format": "uri",
"title": "Language",
"required": true,
"choices": [],
"target_attr": "lcid",
"target_model_type": "data/Language",
"type": "string",
"target": "/api/data/Language/choices/?field=lcid&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"help_text": {
"description": "Object that will contain various fields that will allow formatted HTML additions to the general help section",
"title": "Help Text",
"required": true,
"readonly": false,
"type": "object",
"properties": {
"paragraph_section": {
"description": "This field will allow additions of paragraphs to the general help model",
"title": "Help Paragraph Section",
"items": {
"type": "string"
},
"required": true,
"readonly": false,
"type": "array"
}
}
}
},
"schema_version": "0.2.2"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/GeneralHelp/add/ |
|
The GUI Add form of data/GeneralHelp 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/GeneralHelp/ | 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/GeneralHelp/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/GeneralHelp/[pkid1]", "/api/data/GeneralHelp/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/GeneralHelp/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/data/GeneralHelp/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/data/GeneralHelp/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/data/GeneralHelp/[pkid1]", "/api/v0/data/GeneralHelp/[pkid2]",...]}} |
GET http://[host-proxy]/api/data/GeneralHelp/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/GeneralHelp; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/GeneralHelp/export/ |
|
{ "hrefs":["/api/data/GeneralHelp/[pkid1]", "/api/data/GeneralHelp/[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/GeneralHelp and the JSON format can be used to import instances of data/GeneralHelp.
GET http://[host-proxy]/api/data/GeneralHelp/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for data/GeneralHelp | POST | /api/data/GeneralHelp/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/GeneralHelp/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/data/GeneralHelp/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Migration Template | GET | /api/data/GeneralHelp/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/GeneralHelp/ |
|
The data/GeneralHelp schema and all instances as JSON. |
(The list will return 0 to 3 data/GeneralHelp 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/GeneralHelp/?skip=0&limit=3&order_by=name&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 340
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"schema_version": "0.2.2",
"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/GeneralHelp/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/GeneralHelp/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/data/GeneralHelp/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/GeneralHelp/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/GeneralHelp/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/data/GeneralHelp/+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/GeneralHelp/+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/GeneralHelp/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/data/GeneralHelp/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"migration": {
"support_async": false,
"class": "migration",
"href": "/api/data/GeneralHelp/migration/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Migration Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/data/GeneralHelp/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/GeneralHelp/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/GeneralHelp",
"model_specific_actions": [
"add",
"bulk_update_form",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"get",
"help",
"list",
"migration",
"remove",
"tag",
"tag_version",
"update"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "menu_title",
"title": "Menu Title"
},
{
"name": "menu_position",
"title": "Menu Position"
},
{
"name": "language_code",
"title": "Language"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": [
{
"pkid": "610977c6e04a4a001502f1cf",
"meta": {
"tags": [
"V4UC"
],
"cached": true,
"title": "./src/user/add-agent-lines.rst",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"schema_version": "0.2.2",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "610977c6e04a4a001502f1cf",
"href": "/api/data/GeneralHelp/610977c6e04a4a001502f1cf/"
}
],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": [
{
"pkid": "610961ffe04a4a00149a291b",
"path": "language_code",
"model_type": "data/Language"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/GeneralHelp/610977c6e04a4a001502f1cf/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/GeneralHelp/610977c6e04a4a001502f1cf/",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/data/GeneralHelp/610977c6e04a4a001502f1cf/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/GeneralHelp/610977c6e04a4a001502f1cf/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/data/GeneralHelp/610977c6e04a4a001502f1cf/+tag/",
"class": "tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/data/GeneralHelp/610977c6e04a4a001502f1cf/+tag_version/",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/GeneralHelp/610977c6e04a4a001502f1cf/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/GeneralHelp/610977c6e04a4a001502f1cf/help",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/GeneralHelp",
"path": [
"6t0ggef2c0deab00hb595101",
"610977c6e04a4a001502f1cf"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "menu_title",
"title": "Menu Title"
},
{
"name": "menu_position",
"title": "Menu Position"
},
{
"name": "language_code",
"title": "Language"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"menu_title": "Agent Lines",
"name": "./src/user/add-agent-lines.rst",
"overwrite_specifics": {
"overwrite_details": [
{
"model_content_position": 1,
"affected_model": "relation/HcsCucmCcTagREL",
"hide_model_title": false,
"dynamic_help_position": 20,
"insert_model_content": true
}
]
},
"pkid": "610977c6e04a4a001502f1d1",
"menu_position": -1,
"language_code": "en-us",
"help_text": {
"paragraph_section": [
"Add Agent Line (Phone or Device Profile)\n----------------------------------------\n\n*To access the latest documentation, go to Documentation and Resources at:* https://voss.portalshape.com\n\n**Prerequisites**:\n\nIn order to have an application user available, add a Contact Center server and\nservice:\n\n1. Under **Services > Contact Center > Servers** (default): add a server. \n\n Two SIP Trunks are needed, a CVP and CUBEE on the server.\n2. Under **Services > Contact Center > Service** (default): add a service using \n the above server. This step will create the application users\n needed when adding an Agent Line.\n\n\n**Perform these steps**:\n\n1. From the **Agent Lines** form (default menu **Subscriber Management > Agent Lines**).\n2. Click **Add** to add a new agent line.\n3. Complete the mandatory fields, consider the following:\n\n * Device Type*\n \n * Phone, or\n * Device Profile (Extension Mobility)\n \n * Profile User* (Device Profile device types only)\n \n Drop-down displays only users who have an extension mobility profile.\n\n\n4. Click **Save** to add the agent line.\n\n\n\n"
]
},
"hierarchy_friendly_name": "sys (System)",
"hierarchy_path": "sys"
}
},
{
"pkid": "610977cee04a4a001502f4bf",
"meta": {
"tags": [
"V4UC"
],
"cached": true,
"title": "./src/user/add-device-to-user.rst",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"schema_version": "0.2.2",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "610977cee04a4a001502f4bf",
"href": "/api/data/GeneralHelp/610977cee04a4a001502f4bf/"
}
],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": [
{
"pkid": "610961ffe04a4a00149a291b",
"path": "language_code",
"model_type": "data/Language"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/data/GeneralHelp/610977cee04a4a001502f4bf/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"remove": {
"support_async": true,
"href": "/api/data/GeneralHelp/610977cee04a4a001502f4bf/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"clone": {
"support_async": false,
"href": "/api/data/GeneralHelp/610977cee04a4a001502f4bf/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/GeneralHelp/610977cee04a4a001502f4bf/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"class": "tag",
"href": "/api/data/GeneralHelp/610977cee04a4a001502f4bf/+tag/",
"method": "PATCH",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"class": "tag_version",
"href": "/api/data/GeneralHelp/610977cee04a4a001502f4bf/+tag_version/",
"method": "PATCH",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/data/GeneralHelp/610977cee04a4a001502f4bf/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/data/GeneralHelp/610977cee04a4a001502f4bf/help",
"title": "Help",
"class": "help",
"method": "GET"
}
}
],
"model_type": "data/GeneralHelp",
"path": [
"6t0ggef2c0deab00hb595101",
"610977cee04a4a001502f4bf"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "menu_title",
"title": "Menu Title"
},
{
"name": "menu_position",
"title": "Menu Position"
},
{
"name": "language_code",
"title": "Language"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"menu_title": "Add Device to User",
"name": "./src/user/add-device-to-user.rst",
"overwrite_specifics": {
"overwrite_details": [
{
"model_content_position": 1,
"affected_model": "view/GS_AddDeviceToUser_VIEW",
"hide_model_title": false,
"dynamic_help_position": 20,
"insert_model_content": true
}
]
},
"pkid": "610977cee04a4a001502f4c1",
"menu_position": -1,
"language_code": "en-us",
"help_text": {
"paragraph_section": [
"Add Device to User\n------------------\n\n*To access the latest documentation, go to Documentation and Resources at:* https://voss.portalshape.com\n\n\nUse this utility to easily associate an existing phone or device profile\nwith an existing user.\n\n1. Choose a **User Name**.\n2. Choose the association type:\n\n * *For a device*, choose **Phone** as the **New Device Type** and \n choose the phone as the **New Device Name**.\n\n or \n\n * *For a device profile*, choose **Device Profile** as the **New Device Type** \n and choose the device profile as the **New Device Name**.\n\n2. Click **Save**.\n\nThe device is added to the user as a controlled device and the device itself\nis updated with the owner ID and line owner as applicable.\n\n.. note::\n\n You cannot associate a device to a user if it is already associated.\n\n\n\n"
]
},
"hierarchy_friendly_name": "sys (System)",
"hierarchy_path": "sys"
}
},
{
"pkid": "610977bce04a4a001502ee87",
"meta": {
"tags": [
"V4UC"
],
"cached": true,
"title": "./src/user/add-device-type.rst",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"schema_version": "0.2.2",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "610977bce04a4a001502ee87",
"href": "/api/data/GeneralHelp/610977bce04a4a001502ee87/"
}
],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": [
{
"pkid": "610961ffe04a4a00149a291b",
"path": "language_code",
"model_type": "data/Language"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/data/GeneralHelp/610977bce04a4a001502ee87/",
"class": "update",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"method": "DELETE",
"href": "/api/data/GeneralHelp/610977bce04a4a001502ee87/",
"class": "delete",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/data/GeneralHelp/610977bce04a4a001502ee87/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/data/GeneralHelp/610977bce04a4a001502ee87/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"class": "tag",
"href": "/api/data/GeneralHelp/610977bce04a4a001502ee87/+tag/",
"method": "PATCH",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"class": "tag_version",
"href": "/api/data/GeneralHelp/610977bce04a4a001502ee87/+tag_version/",
"method": "PATCH",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/data/GeneralHelp/610977bce04a4a001502ee87/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/data/GeneralHelp/610977bce04a4a001502ee87/help",
"class": "help",
"title": "Help"
}
}
],
"model_type": "data/GeneralHelp",
"path": [
"6t0ggef2c0deab00hb595101",
"610977bce04a4a001502ee87"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "menu_title",
"title": "Menu Title"
},
{
"name": "menu_position",
"title": "Menu Position"
},
{
"name": "language_code",
"title": "Language"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"menu_title": "Device Types",
"name": "./src/user/add-device-type.rst",
"overwrite_specifics": {
"overwrite_details": [
{
"model_content_position": 1,
"affected_model": "data/HcsDeviceTypeDAT",
"hide_model_title": false,
"dynamic_help_position": 20,
"insert_model_content": true
}
]
},
"pkid": "610977bce04a4a001502ee89",
"menu_position": -1,
"language_code": "en-us",
"help_text": {
"paragraph_section": [
"Add Device Type\n---------------\n\n*To access the latest documentation, go to Documentation and Resources at:* https://voss.portalshape.com\n\nVOSS-4-UC is prepopulated with a list of current product types. However, the\nprovider administrator may add additional device types as needed.\n\n**To add a new device type**: \n\n1. Log in as provider administrator.\n2. Choose **Entitlement > Device Types** (default).\n3. Click **Add**.\n4. Enter the new device type.\n5. Click **Save**.\n\nThe new device type is added to the list of available device types that can be\nassigned to a device group.\n\n\n\n"
]
},
"hierarchy_friendly_name": "sys (System)",
"hierarchy_path": "sys"
}
}
]
}
(Show the first instance)
{
"pkid": "610977c6e04a4a001502f1cf",
"meta": {
"tags": [
"V4UC"
],
"cached": false,
"title": "./src/user/add-agent-lines.rst",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"schema_version": "0.2.2",
"references": {
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"self": [
{
"pkid": "610977c6e04a4a001502f1cf",
"href": "/api/data/GeneralHelp/610977c6e04a4a001502f1cf/"
}
],
"foreign_key": [
{
"pkid": "610961ffe04a4a00149a291b",
"path": "language_code",
"model_type": "data/Language"
}
],
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/GeneralHelp/610977c6e04a4a001502f1cf/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/GeneralHelp/610977c6e04a4a001502f1cf/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/data/GeneralHelp/610977c6e04a4a001502f1cf/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/GeneralHelp/610977c6e04a4a001502f1cf/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/data/GeneralHelp/610977c6e04a4a001502f1cf/+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/GeneralHelp/610977c6e04a4a001502f1cf/+tag_version/?hierarchy=[hierarchy]",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/GeneralHelp/610977c6e04a4a001502f1cf/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/GeneralHelp/610977c6e04a4a001502f1cf/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/GeneralHelp",
"path": [
"6t0ggef2c0deab00hb595101",
"610977c6e04a4a001502f1cf"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "menu_title",
"title": "Menu Title"
},
{
"name": "menu_position",
"title": "Menu Position"
},
{
"name": "language_code",
"title": "Language"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"menu_title": "Agent Lines",
"name": "./src/user/add-agent-lines.rst",
"overwrite_specifics": {
"overwrite_details": [
{
"insert_model_content": true,
"affected_model": "relation/HcsCucmCcTagREL",
"hide_model_title": false,
"dynamic_help_position": 20,
"model_content_position": 1
}
]
},
"pkid": "610977c6e04a4a001502f1d1",
"menu_position": -1,
"language_code": "en-us",
"help_text": {
"paragraph_section": [
"Add Agent Line (Phone or Device Profile)\n----------------------------------------\n\n*To access the latest documentation, go to Documentation and Resources at:* https://voss.portalshape.com\n\n**Prerequisites**:\n\nIn order to have an application user available, add a Contact Center server and\nservice:\n\n1. Under **Services > Contact Center > Servers** (default): add a server. \n\n Two SIP Trunks are needed, a CVP and CUBEE on the server.\n2. Under **Services > Contact Center > Service** (default): add a service using \n the above server. This step will create the application users\n needed when adding an Agent Line.\n\n\n**Perform these steps**:\n\n1. From the **Agent Lines** form (default menu **Subscriber Management > Agent Lines**).\n2. Click **Add** to add a new agent line.\n3. Complete the mandatory fields, consider the following:\n\n * Device Type*\n \n * Phone, or\n * Device Profile (Extension Mobility)\n \n * Profile User* (Device Profile device types only)\n \n Drop-down displays only users who have an extension mobility profile.\n\n\n4. Click **Save** to add the agent line.\n\n\n\n"
]
}
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/GeneralHelp. | GET | /api/data/GeneralHelp/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/GeneralHelp as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/GeneralHelp/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/GeneralHelp/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/GeneralHelp/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/GeneralHelp/?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/GeneralHelp; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/GeneralHelp/[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/GeneralHelp and the JSON format can be used to import instances of data/GeneralHelp.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/data/GeneralHelp/[pkid]/+tag/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/GeneralHelp/[pkid]/ | hierarchy=[hierarchy] | The data/GeneralHelp instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/GeneralHelp/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/GeneralHelp. |