[Index]
Manage Webex Teams Message API markdown templates.
Model ref.: data/WebexTeamsMessageMarkdownTemplate
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": {
"name": {
"required": true,
"type": "string",
"description": "Name of the template.",
"title": "Name"
},
"description": {
"type": "string",
"description": "Description of the template.",
"title": "Description"
},
"template": {
"required": true,
"type": "string",
"description": "Webex App Message Markdown Template. See here for details https://dev-preview.webex.com/formatting-messages.html.",
"title": "Markdown Template"
}
},
"schema_version": "1.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/WebexTeamsMessageMarkdownTemplate/add/ |
|
The GUI Add form of data/WebexTeamsMessageMarkdownTemplate 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/WebexTeamsMessageMarkdownTemplate | 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/WebexTeamsMessageMarkdownTemplate/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/WebexTeamsMessageMarkdownTemplate/[pkid1]", "/api/data/WebexTeamsMessageMarkdownTemplate/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/WebexTeamsMessageMarkdownTemplate/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/WebexTeamsMessageMarkdownTemplate; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/WebexTeamsMessageMarkdownTemplate/export/ |
|
{ "hrefs":["/api/data/WebexTeamsMessageMarkdownTemplate/[pkid1]", "/api/data/WebexTeamsMessageMarkdownTemplate/[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/WebexTeamsMessageMarkdownTemplate and the JSON format can be used to import instances of data/WebexTeamsMessageMarkdownTemplate.
GET http://[host-proxy]/api/data/WebexTeamsMessageMarkdownTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for data/WebexTeamsMessageMarkdownTemplate | POST | /api/data/WebexTeamsMessageMarkdownTemplate/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag | PATCH | /api/data/WebexTeamsMessageMarkdownTemplate/+tag/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/data/WebexTeamsMessageMarkdownTemplate/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/data/WebexTeamsMessageMarkdownTemplate/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/WebexTeamsMessageMarkdownTemplate/ |
|
The data/WebexTeamsMessageMarkdownTemplate schema and all instances as JSON. |
(The list will return 0 to 3 data/WebexTeamsMessageMarkdownTemplate instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 7,
"total_limit": null,
"order_by": "name",
"direction": "asc",
"current": "/api/data/WebexTeamsMessageMarkdownTemplate/?skip=0&limit=3&order_by=name&direction=asc&traversal=fulltree"
},
"operations": [
"help",
"bulk_update_form",
"update",
"add",
"export",
"get",
"list",
"export_bulkload_template",
"migration",
"remove",
"move",
"transform",
"configuration_template",
"field_display_policy"
],
"meta": {
"model_type": "data/WebexTeamsMessageMarkdownTemplate",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {
"hierarchy": true,
"consider_null": false,
"unique": [
"name"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": []
},
"model_specific_actions": [
"add",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"get",
"help",
"list",
"remove",
"tag",
"update"
],
"schema_version": "1.1",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/data/WebexTeamsMessageMarkdownTemplate/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/WebexTeamsMessageMarkdownTemplate/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/data/WebexTeamsMessageMarkdownTemplate/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/data/WebexTeamsMessageMarkdownTemplate/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/WebexTeamsMessageMarkdownTemplate/+tag/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"configuration_template": {
"method": "GET",
"class": "config",
"href": "/api/data/WebexTeamsMessageMarkdownTemplate/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/data/WebexTeamsMessageMarkdownTemplate/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/data/WebexTeamsMessageMarkdownTemplate/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/WebexTeamsMessageMarkdownTemplate/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": [
{
"data": {
"name": "Webex App Activation Code Steps",
"template": "**Webex Room Device Activation for Workspace {{ pwf.name }}: [{{ pwf.device_activation_code.friendlyCode }}]** \n- If the Webex Room Device is not installed, please install them following the [Installation Guides](https://help.webex.com/en-us/ng9h54cb/Room-Setup-and-Installation-of-Cisco-Webex-Room-and-Desk-Devices)\n- At first boot, make sure you configure the network connectivity settings and connects to the Internet. \n- If the Webex Device is already on service and needs to be reconfigured;\n - Tap on the screen, the Name will show on the top left corner, tap on it\n - Tap on \u201cSettings\u201d\n - Scroll down and tap on \u201cFactory Reset\u201d. At the prompt, confirm \u201cReset\u201d\n - It will take several minutes to reset and reboot\n- The Webex Device will start to a \u201cWelcome\u201d screen, tap on \u201cStart\u201d\n- The Network Connection page will show the Ethernet or Wifi Connected, and network configurations. Any network configuration can be changed at this stage\n- Make sure Network connection shows Connected and green. Then tap on the top right arrow to continue\n- Select Cisco Webex as the call service\n- Introduce the Activation code **[{{ pwf.device_activation_code.friendlyCode }}]**. Make sure the Workplace name corresponds with the device place in the customer premises. Tap on the top right arrow\n- The device will activate and register in the cloud and will associate to the Workspace. Confirm the time and the Time Zone and tap the arrow to complete the setup\n- Once the device is registered, it will appear as online in the Devices or Workspaces section in Webex Control Hub.\n- For additional information on how to use the Webex Room Devices refer to the [Webex Room Devices Help Center](https://help.webex.com/ld-65dz9cb-CiscoWebexDevices/Webex-Room-Devices) \n",
"description": "This template is used when notifying a recipient of the steps to complete to activate a Webex App device at a place.",
"pkid": "628364ab188f78218906a36f",
"hierarchy_friendly_name": "sys (System)",
"hierarchy_path": "sys"
},
"meta": {
"model_type": "data/WebexTeamsMessageMarkdownTemplate",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [
"V4UC",
"ba_CommonOverlay"
],
"title": "Webex App Activation Code Steps",
"business_key": {
"hierarchy": true,
"consider_null": false,
"unique": [
"name"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/data/WebexTeamsMessageMarkdownTemplate/628364ab188f78218906a36e/",
"pkid": "628364ab188f78218906a36e"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"628364ab188f78218906a36e"
],
"schema_version": "1.1",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/WebexTeamsMessageMarkdownTemplate/628364ab188f78218906a36e/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/WebexTeamsMessageMarkdownTemplate/628364ab188f78218906a36e/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/WebexTeamsMessageMarkdownTemplate/628364ab188f78218906a36e/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/WebexTeamsMessageMarkdownTemplate/628364ab188f78218906a36e/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/WebexTeamsMessageMarkdownTemplate/628364ab188f78218906a36e/+tag/",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/WebexTeamsMessageMarkdownTemplate/628364ab188f78218906a36e/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/WebexTeamsMessageMarkdownTemplate/628364ab188f78218906a36e/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "628364ab188f78218906a36e"
},
{
"data": {
"name": "Webex App Refresh Token Expired",
"template": "**Webex App Access Token Expired**\n\n- Customer: **{{ pwf.customer_name }}**\n\nPlease contact your administrator to refresh your Webex App access token.",
"description": "This template is used when notifying a recipient that a specific Webex App organization's access token is about to expire.",
"pkid": "628364aa188f78218906a357",
"hierarchy_friendly_name": "sys (System)",
"hierarchy_path": "sys"
},
"meta": {
"model_type": "data/WebexTeamsMessageMarkdownTemplate",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [
"V4UC",
"ba_CommonOverlay"
],
"title": "Webex App Refresh Token Expired",
"business_key": {
"hierarchy": true,
"consider_null": false,
"unique": [
"name"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/data/WebexTeamsMessageMarkdownTemplate/628364aa188f78218906a356/",
"pkid": "628364aa188f78218906a356"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"628364aa188f78218906a356"
],
"schema_version": "1.1",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/WebexTeamsMessageMarkdownTemplate/628364aa188f78218906a356/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/WebexTeamsMessageMarkdownTemplate/628364aa188f78218906a356/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/WebexTeamsMessageMarkdownTemplate/628364aa188f78218906a356/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/WebexTeamsMessageMarkdownTemplate/628364aa188f78218906a356/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/WebexTeamsMessageMarkdownTemplate/628364aa188f78218906a356/+tag/",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/WebexTeamsMessageMarkdownTemplate/628364aa188f78218906a356/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/WebexTeamsMessageMarkdownTemplate/628364aa188f78218906a356/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "628364aa188f78218906a356"
},
{
"data": {
"pkid": "61f0f286e04a4a0015109e97",
"name": "Webex Teams Activation Code Steps",
"template": "**Webex Room Device Activation for Workspace {{ pwf.name }}: [{{ pwf.device_activation_code.friendlyCode }}]** \n- If the Webex Room Device is not installed, please install them following the [Installation Guides](https://help.webex.com/en-us/ng9h54cb/Room-Setup-and-Installation-of-Cisco-Webex-Room-and-Desk-Devices)\n- At first boot, make sure you configure the network connectivity settings and connects to the Internet. \n- If the Webex Device is already on service and needs to be reconfigured;\n - Tap on the screen, the Name will show on the top left corner, tap on it\n - Tap on \u201cSettings\u201d\n - Scroll down and tap on \u201cFactory Reset\u201d. At the prompt, confirm \u201cReset\u201d\n - It will take several minutes to reset and reboot\n- The Webex Device will start to a \u201cWelcome\u201d screen, tap on \u201cStart\u201d\n- The Network Connection page will show the Ethernet or Wifi Connected, and network configurations. Any network configuration can be changed at this stage\n- Make sure Network connection shows Connected and green. Then tap on the top right arrow to continue\n- Select Cisco Webex as the call service\n- Introduce the Activation code **[{{ pwf.device_activation_code.friendlyCode }}]**. Make sure the Workplace name corresponds with the device place in the customer premises. Tap on the top right arrow\n- The device will activate and register in the cloud and will associate to the Workspace. Confirm the time and the Time Zone and tap the arrow to complete the setup\n- Once the device is registered, it will appear as online in the Devices or Workspaces section in Webex Control Hub.\n- For additional information on how to use the Webex Room Devices refer to the [Webex Room Devices Help Center](https://help.webex.com/ld-65dz9cb-CiscoWebexDevices/Webex-Room-Devices) \n",
"description": "This template is used when notifying a recipient of the steps to complete to activate a Webex Teams device at a place.",
"hierarchy_friendly_name": "sys (System)",
"hierarchy_path": "sys"
},
"meta": {
"model_type": "data/WebexTeamsMessageMarkdownTemplate",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [
"spark",
"V4UC",
"ba_CommonOverlay"
],
"title": "Webex Teams Activation Code Steps",
"business_key": {
"hierarchy": true,
"consider_null": false,
"unique": [
"name"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/data/WebexTeamsMessageMarkdownTemplate/61f0f286e04a4a0015109e96/",
"pkid": "61f0f286e04a4a0015109e96"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"61f0f286e04a4a0015109e96"
],
"schema_version": "1.1",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/WebexTeamsMessageMarkdownTemplate/61f0f286e04a4a0015109e96/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/WebexTeamsMessageMarkdownTemplate/61f0f286e04a4a0015109e96/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/WebexTeamsMessageMarkdownTemplate/61f0f286e04a4a0015109e96/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/WebexTeamsMessageMarkdownTemplate/61f0f286e04a4a0015109e96/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/WebexTeamsMessageMarkdownTemplate/61f0f286e04a4a0015109e96/+tag/",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/WebexTeamsMessageMarkdownTemplate/61f0f286e04a4a0015109e96/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/WebexTeamsMessageMarkdownTemplate/61f0f286e04a4a0015109e96/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "61f0f286e04a4a0015109e96"
}
]
}
(Show the first instance)
{
"data": {
"name": "Webex App Activation Code Steps",
"template": "**Webex Room Device Activation for Workspace {{ pwf.name }}: [{{ pwf.device_activation_code.friendlyCode }}]** \n- If the Webex Room Device is not installed, please install them following the [Installation Guides](https://help.webex.com/en-us/ng9h54cb/Room-Setup-and-Installation-of-Cisco-Webex-Room-and-Desk-Devices)\n- At first boot, make sure you configure the network connectivity settings and connects to the Internet. \n- If the Webex Device is already on service and needs to be reconfigured;\n - Tap on the screen, the Name will show on the top left corner, tap on it\n - Tap on \u201cSettings\u201d\n - Scroll down and tap on \u201cFactory Reset\u201d. At the prompt, confirm \u201cReset\u201d\n - It will take several minutes to reset and reboot\n- The Webex Device will start to a \u201cWelcome\u201d screen, tap on \u201cStart\u201d\n- The Network Connection page will show the Ethernet or Wifi Connected, and network configurations. Any network configuration can be changed at this stage\n- Make sure Network connection shows Connected and green. Then tap on the top right arrow to continue\n- Select Cisco Webex as the call service\n- Introduce the Activation code **[{{ pwf.device_activation_code.friendlyCode }}]**. Make sure the Workplace name corresponds with the device place in the customer premises. Tap on the top right arrow\n- The device will activate and register in the cloud and will associate to the Workspace. Confirm the time and the Time Zone and tap the arrow to complete the setup\n- Once the device is registered, it will appear as online in the Devices or Workspaces section in Webex Control Hub.\n- For additional information on how to use the Webex Room Devices refer to the [Webex Room Devices Help Center](https://help.webex.com/ld-65dz9cb-CiscoWebexDevices/Webex-Room-Devices) \n",
"description": "This template is used when notifying a recipient of the steps to complete to activate a Webex App device at a place.",
"pkid": "628364ab188f78218906a36f"
},
"meta": {
"model_type": "data/WebexTeamsMessageMarkdownTemplate",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [
"V4UC",
"ba_CommonOverlay"
],
"title": "Webex App Activation Code Steps",
"business_key": {
"hierarchy": true,
"consider_null": false,
"unique": [
"name"
]
},
"api_version": "21.2",
"cached": false,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"foreign_key": [],
"children": [],
"self": [
{
"href": "/api/data/WebexTeamsMessageMarkdownTemplate/628364ab188f78218906a36e/",
"pkid": "628364ab188f78218906a36e"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"628364ab188f78218906a36e"
],
"schema_version": "1.1",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/WebexTeamsMessageMarkdownTemplate/628364ab188f78218906a36e/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/WebexTeamsMessageMarkdownTemplate/628364ab188f78218906a36e/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/WebexTeamsMessageMarkdownTemplate/628364ab188f78218906a36e/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/WebexTeamsMessageMarkdownTemplate/628364ab188f78218906a36e/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/WebexTeamsMessageMarkdownTemplate/628364ab188f78218906a36e/+tag/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/WebexTeamsMessageMarkdownTemplate/628364ab188f78218906a36e/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/WebexTeamsMessageMarkdownTemplate/628364ab188f78218906a36e/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"pkid": "628364ab188f78218906a36e"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/WebexTeamsMessageMarkdownTemplate. | GET | /api/data/WebexTeamsMessageMarkdownTemplate/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/WebexTeamsMessageMarkdownTemplate as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/WebexTeamsMessageMarkdownTemplate/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/WebexTeamsMessageMarkdownTemplate/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/WebexTeamsMessageMarkdownTemplate/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/WebexTeamsMessageMarkdownTemplate/?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/WebexTeamsMessageMarkdownTemplate; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/WebexTeamsMessageMarkdownTemplate/[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/WebexTeamsMessageMarkdownTemplate and the JSON format can be used to import instances of data/WebexTeamsMessageMarkdownTemplate.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/data/WebexTeamsMessageMarkdownTemplate/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/WebexTeamsMessageMarkdownTemplate/[pkid] | hierarchy=[hierarchy] | The data/WebexTeamsMessageMarkdownTemplate instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/WebexTeamsMessageMarkdownTemplate/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/WebexTeamsMessageMarkdownTemplate. |