[Index]
A group of alerting rules providing ease of management and control of alerting scenarios.
Model ref.: data/AlertingRuleGroup
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": {
"title": "Group Name",
"description": "Name of the alerting rule group. This must be unique per hierarchy.",
"type": "string",
"maxLength": 255,
"required": true
},
"description": {
"title": "Description",
"description": "Provide a brief description of this group.",
"type": "string",
"maxLength": 2048
},
"enabled": {
"title": "Enabled",
"description": "Is this group enabled?",
"type": "boolean"
},
"alerting_rules": {
"title": "Alerting Rules",
"description": "The alerting rules to be included in the group.",
"type": "array",
"items": {
"type": "object",
"properties": {
"alerting_rule": {
"title": "Alerting Rule",
"type": "string",
"format": "uri",
"target": "/api/data/AlertingRule/template_choices/?choice_title=name&field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "name",
"target_title": "name",
"maxLength": 1024,
"target_model_type": "data/AlertingRule",
"choices": []
}
}
}
},
"query_hierarchies": {
"title": "Target Hierarchies",
"description": "The hierarchies to be included in the query.",
"type": "array",
"items": {
"type": "string",
"format": "uri",
"target": "/api/data/HierarchyNode/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_title": "name",
"maxLength": 1024,
"target_model_type": "data/HierarchyNode",
"choices": []
}
}
},
"schema_version": "1.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/AlertingRuleGroup/add/ |
|
The GUI Add form of data/AlertingRuleGroup 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/AlertingRuleGroup | 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/AlertingRuleGroup/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/AlertingRuleGroup/[pkid1]", "/api/data/AlertingRuleGroup/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/AlertingRuleGroup/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/AlertingRuleGroup; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/AlertingRuleGroup/export/ |
|
{ "hrefs":["/api/data/AlertingRuleGroup/[pkid1]", "/api/data/AlertingRuleGroup/[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/AlertingRuleGroup and the JSON format can be used to import instances of data/AlertingRuleGroup.
GET http://[host-proxy]/api/data/AlertingRuleGroup/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for data/AlertingRuleGroup | POST | /api/data/AlertingRuleGroup/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/AlertingRuleGroup/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/data/AlertingRuleGroup/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/AlertingRuleGroup/ |
|
The data/AlertingRuleGroup schema and all instances as JSON. |
(The list will return 0 to 3 data/AlertingRuleGroup instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 3,
"total_limit": null,
"order_by": "name",
"direction": "asc",
"current": "/api/data/AlertingRuleGroup/?skip=0&limit=3&order_by=name&direction=asc&traversal=fulltree"
},
"operations": [
"add",
"bulk_update_form",
"list",
"update",
"transform",
"migration",
"remove",
"move",
"export",
"help",
"configuration_template",
"field_display_policy",
"get",
"export_bulkload_template"
],
"meta": {
"model_type": "data/AlertingRuleGroup",
"summary_attrs": [
{
"name": "name",
"title": "Group Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "enabled",
"title": "Enabled"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {
"unique": [
"name"
],
"hierarchy": true
},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": []
},
"model_specific_actions": [
"get",
"list",
"add",
"update",
"remove",
"export",
"export_bulkload_template",
"configuration_template",
"field_display_policy",
"help"
],
"schema_version": "1.0",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/data/AlertingRuleGroup/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/AlertingRuleGroup/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/data/AlertingRuleGroup/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/AlertingRuleGroup/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"method": "GET",
"class": "config",
"href": "/api/data/AlertingRuleGroup/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/data/AlertingRuleGroup/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/data/AlertingRuleGroup/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/AlertingRuleGroup/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": [
{
"data": {
"name": "Default Examples - Meeting Rooms",
"description": "Sample alerting rules for meeting room health, offline devices, and poor meeting quality rollups. All member rules ship disabled; review thresholds and email actions before enabling.",
"enabled": false,
"alerting_rules": [
{
"alerting_rule": "Default Example - Meeting Room - Health Band Critical"
},
{
"alerting_rule": "Default Example - Meeting Room - Device Offline"
},
{
"alerting_rule": "Default Example - Meeting Room - Poor Meeting Quality (30d)"
}
],
"pkid": "69ee3a3662dfd021865c5a27",
"hierarchy_friendly_name": "sys (System)",
"hierarchy_path": "sys"
},
"meta": {
"model_type": "data/AlertingRuleGroup",
"summary_attrs": [
{
"name": "name",
"title": "Group Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "enabled",
"title": "Enabled"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [
"alerting",
"V4UC",
"ba_CommonOverlay",
"V4UC",
"ba_CommonOverlay"
],
"title": "Default Examples - Meeting Rooms",
"business_key": {
"unique": [
"name"
],
"hierarchy": true
},
"api_version": "21.2",
"cached": true,
"references": {
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": [
{
"path": "alerting_rules.0.alerting_rule",
"model_type": "data/AlertingRule"
},
{
"path": "alerting_rules.1.alerting_rule",
"model_type": "data/AlertingRule"
},
{
"path": "alerting_rules.2.alerting_rule",
"model_type": "data/AlertingRule"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"href": "/api/data/AlertingRuleGroup/69ee3a3662dfd021865c5a26/",
"pkid": "69ee3a3662dfd021865c5a26"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"69ee3a3662dfd021865c5a26"
],
"schema_version": "1.0",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/AlertingRuleGroup/69ee3a3662dfd021865c5a26/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/AlertingRuleGroup/69ee3a3662dfd021865c5a26/",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/AlertingRuleGroup/69ee3a3662dfd021865c5a26/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/AlertingRuleGroup/69ee3a3662dfd021865c5a26/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/AlertingRuleGroup/69ee3a3662dfd021865c5a26/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "69ee3a3662dfd021865c5a26"
},
{
"data": {
"name": "Default Examples - Microsoft 365 Licensing",
"description": "Sample cost-optimization rules built on Data O365 Activity Summary: inactive licensed users, Teams license without usage, and Teams Phone without PSTN usage. Validate Reporter field names in UI before production enablement.",
"enabled": false,
"alerting_rules": [
{
"alerting_rule": "Default Example - M365 - Licensed User Inactive 60+ Days"
},
{
"alerting_rule": "Default Example - M365 - Teams Licensed No Usage"
},
{
"alerting_rule": "Default Example - M365 - Teams Phone Licensed No PSTN Usage"
}
],
"pkid": "69ee3a3662dfd021865c5a1f",
"hierarchy_friendly_name": "sys (System)",
"hierarchy_path": "sys"
},
"meta": {
"model_type": "data/AlertingRuleGroup",
"summary_attrs": [
{
"name": "name",
"title": "Group Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "enabled",
"title": "Enabled"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [
"alerting",
"V4UC",
"ba_CommonOverlay",
"V4UC",
"ba_CommonOverlay"
],
"title": "Default Examples - Microsoft 365 Licensing",
"business_key": {
"unique": [
"name"
],
"hierarchy": true
},
"api_version": "21.2",
"cached": true,
"references": {
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": [
{
"path": "alerting_rules.0.alerting_rule",
"model_type": "data/AlertingRule"
},
{
"path": "alerting_rules.1.alerting_rule",
"model_type": "data/AlertingRule"
},
{
"path": "alerting_rules.2.alerting_rule",
"model_type": "data/AlertingRule"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"href": "/api/data/AlertingRuleGroup/69ee3a3662dfd021865c5a1e/",
"pkid": "69ee3a3662dfd021865c5a1e"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"69ee3a3662dfd021865c5a1e"
],
"schema_version": "1.0",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/AlertingRuleGroup/69ee3a3662dfd021865c5a1e/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/AlertingRuleGroup/69ee3a3662dfd021865c5a1e/",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/AlertingRuleGroup/69ee3a3662dfd021865c5a1e/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/AlertingRuleGroup/69ee3a3662dfd021865c5a1e/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/AlertingRuleGroup/69ee3a3662dfd021865c5a1e/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "69ee3a3662dfd021865c5a1e"
},
{
"data": {
"name": "Default Examples - Microsoft Exchange",
"description": "Sample Exchange-oriented templates (inactive licensed mailbox, premium quota underutilization, mailbox nearing capacity). Each rule includes a sentinel filter so it does not match real mailboxes until LXT/Reporter columns are confirmed and filters are replaced.",
"enabled": false,
"alerting_rules": [
{
"alerting_rule": "Default Example - Exchange - Inactive Licensed Mailbox"
},
{
"alerting_rule": "Default Example - Exchange - Oversized Quota Underutilized"
},
{
"alerting_rule": "Default Example - Exchange - Mailbox Near Capacity"
}
],
"pkid": "69ee3a3662dfd021865c5a23",
"hierarchy_friendly_name": "sys (System)",
"hierarchy_path": "sys"
},
"meta": {
"model_type": "data/AlertingRuleGroup",
"summary_attrs": [
{
"name": "name",
"title": "Group Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "enabled",
"title": "Enabled"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [
"alerting",
"V4UC",
"ba_CommonOverlay",
"V4UC",
"ba_CommonOverlay"
],
"title": "Default Examples - Microsoft Exchange",
"business_key": {
"unique": [
"name"
],
"hierarchy": true
},
"api_version": "21.2",
"cached": true,
"references": {
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": [
{
"path": "alerting_rules.0.alerting_rule",
"model_type": "data/AlertingRule"
},
{
"path": "alerting_rules.1.alerting_rule",
"model_type": "data/AlertingRule"
},
{
"path": "alerting_rules.2.alerting_rule",
"model_type": "data/AlertingRule"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"href": "/api/data/AlertingRuleGroup/69ee3a3662dfd021865c5a22/",
"pkid": "69ee3a3662dfd021865c5a22"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"69ee3a3662dfd021865c5a22"
],
"schema_version": "1.0",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/AlertingRuleGroup/69ee3a3662dfd021865c5a22/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/AlertingRuleGroup/69ee3a3662dfd021865c5a22/",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/AlertingRuleGroup/69ee3a3662dfd021865c5a22/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/AlertingRuleGroup/69ee3a3662dfd021865c5a22/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/AlertingRuleGroup/69ee3a3662dfd021865c5a22/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "69ee3a3662dfd021865c5a22"
}
]
}
(Show the first instance)
{
"data": {
"name": "Default Examples - Meeting Rooms",
"description": "Sample alerting rules for meeting room health, offline devices, and poor meeting quality rollups. All member rules ship disabled; review thresholds and email actions before enabling.",
"enabled": false,
"alerting_rules": [
{
"alerting_rule": "Default Example - Meeting Room - Health Band Critical"
},
{
"alerting_rule": "Default Example - Meeting Room - Device Offline"
},
{
"alerting_rule": "Default Example - Meeting Room - Poor Meeting Quality (30d)"
}
],
"pkid": "69ee3a3662dfd021865c5a27"
},
"meta": {
"model_type": "data/AlertingRuleGroup",
"summary_attrs": [
{
"name": "name",
"title": "Group Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "enabled",
"title": "Enabled"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [
"alerting",
"V4UC",
"ba_CommonOverlay",
"V4UC",
"ba_CommonOverlay"
],
"title": "Default Examples - Meeting Rooms",
"business_key": {
"unique": [
"name"
],
"hierarchy": true
},
"api_version": "21.2",
"cached": false,
"references": {
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": [
{
"path": "alerting_rules.0.alerting_rule",
"model_type": "data/AlertingRule"
},
{
"path": "alerting_rules.1.alerting_rule",
"model_type": "data/AlertingRule"
},
{
"path": "alerting_rules.2.alerting_rule",
"model_type": "data/AlertingRule"
}
],
"owner": [
{
"pkid": ""
}
],
"children": [],
"self": [
{
"href": "/api/data/AlertingRuleGroup/69ee3a3662dfd021865c5a26/",
"pkid": "69ee3a3662dfd021865c5a26"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"69ee3a3662dfd021865c5a26"
],
"schema_version": "1.0",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/AlertingRuleGroup/69ee3a3662dfd021865c5a26/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/AlertingRuleGroup/69ee3a3662dfd021865c5a26/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/AlertingRuleGroup/69ee3a3662dfd021865c5a26/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/AlertingRuleGroup/69ee3a3662dfd021865c5a26/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/AlertingRuleGroup/69ee3a3662dfd021865c5a26/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"pkid": "69ee3a3662dfd021865c5a26"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/AlertingRuleGroup. | GET | /api/data/AlertingRuleGroup/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/AlertingRuleGroup as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/AlertingRuleGroup/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/AlertingRuleGroup/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of data/AlertingRuleGroup; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/AlertingRuleGroup/[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/AlertingRuleGroup and the JSON format can be used to import instances of data/AlertingRuleGroup.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/AlertingRuleGroup/[pkid] | hierarchy=[hierarchy] | The data/AlertingRuleGroup instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/AlertingRuleGroup/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/AlertingRuleGroup. |