[Index]
Model ref.: device/cuc/MailboxQuotaText
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": {
"Body": {
"minItems": 0,
"type": "string",
"description": " Admin supplied body text in CUCA.",
"name": "Body",
"title": "Body"
},
"LanguageCode": {
"description": " The language identifier for the row.",
"title": "Language Code",
"minItems": 0,
"readonly": true,
"type": "integer",
"name": "LanguageCode"
},
"DefaultSubject": {
"description": " Default data supplied in the subject by data module.",
"title": "Default Subject",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "DefaultSubject"
},
"ObjectId": {
"description": " The primary key for this table. A globally unique, system-generated identifier for a MailboxQuotaText object. - template parameter [1]",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"URI": {
"name": "URI",
"format": "uri",
"minItems": 0,
"title": "URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"RuleDescription": {
"readonly": true,
"type": "string",
"description": "The description for the rule.",
"name": "RuleDescription",
"title": "Rule Description"
},
"DefaultBody": {
"description": " Default text supplied by a data module.",
"title": "Default Body",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "DefaultBody"
},
"UseDefault": {
"minItems": 0,
"type": "boolean",
"description": " Specify that whether DefaultSubject and DefaultBody is used or not.",
"name": "UseDefault",
"title": "Use Default"
},
"QuotaRuleType": {
"minItems": 0,
"type": "integer",
"description": " The rule type the notification is for.",
"name": "QuotaRuleType",
"title": "Quota Rule Type"
},
"Subject": {
"minItems": 0,
"type": "string",
"description": " Admin supplied subject.",
"name": "Subject",
"title": "Subject"
}
},
"schema_version": "12.5"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cuc/MailboxQuotaText/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cuc/MailboxQuotaText/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/MailboxQuotaText/[pkid1]", "/api/v0/device/cuc/MailboxQuotaText/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/MailboxQuotaText/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/cuc/MailboxQuotaText |
|
{"hrefs": ["/api/device/cuc/MailboxQuotaText/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/MailboxQuotaText |
|
{"hrefs": ["/api/device/cuc/MailboxQuotaText/[pkid1]", "/api/device/cuc/MailboxQuotaText/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/MailboxQuotaText; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cuc/MailboxQuotaText/export/ |
|
{ "hrefs":["/api/device/cuc/MailboxQuotaText/[pkid1]", "/api/device/cuc/MailboxQuotaText/[pkid2]",...]}} |
For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
The XLSX format can be used to bulk load instances of device/cuc/MailboxQuotaText and the JSON format can be used to import instances of device/cuc/MailboxQuotaText.
GET http://[host-proxy]/api/device/cuc/MailboxQuotaText/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cuc/MailboxQuotaText | POST | /api/device/cuc/MailboxQuotaText/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/device/cuc/MailboxQuotaText/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/device/cuc/MailboxQuotaText/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cuc/MailboxQuotaText/ |
|
The device/cuc/MailboxQuotaText schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/MailboxQuotaText instances)
{
"operations": [
"move"
],
"pagination": {
"direction": "asc",
"order_by": "ObjectId",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/cuc/MailboxQuotaText/?skip=0&limit=3&order_by=ObjectId&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 7
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "12.5",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/cuc/MailboxQuotaText/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Bulk Modify"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/cuc/MailboxQuotaText",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/MailboxQuotaText/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/device/cuc/MailboxQuotaText/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/cuc/MailboxQuotaText/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/cuc/MailboxQuotaText/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/cuc/MailboxQuotaText/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/MailboxQuotaText/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/MailboxQuotaText/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/MailboxQuotaText",
"model_specific_actions": [
"list",
"update",
"get",
"bulk_update_form",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"help",
"move"
],
"summary_attrs": [
{
"name": "ObjectId",
"title": "Object Id"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"resources": [
{
"pkid": "5dcd18c18192d40018f71a3d",
"meta": {
"tags": [],
"cached": true,
"title": "2346b828-d62c-434d-b242-b235a87e6d20",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "5dcd18824544b70018605580",
"href": "/api/v0/data/UnityConnection/5dcd18824544b70018605580"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5dcd18c18192d40018f71a3d",
"href": "/api/device/cuc/MailboxQuotaText/5dcd18c18192d40018f71a3d/"
}
],
"parent": [
{
"pkid": "5dcd1812e186e30018eb7023",
"href": "/api/data/HierarchyNode/5dcd1812e186e30018eb7023"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/cuc/MailboxQuotaText/5dcd18c18192d40018f71a3d/",
"method": "PUT",
"title": "Modify"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/MailboxQuotaText/5dcd18c18192d40018f71a3d/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5dcd18c18192d40018f71a3d/?model_type=device/cuc/MailboxQuotaText",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/MailboxQuotaText/5dcd18c18192d40018f71a3d/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/MailboxQuotaText/5dcd18c18192d40018f71a3d/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/MailboxQuotaText/5dcd18c18192d40018f71a3d/help",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/MailboxQuotaText/5dcd18c18192d40018f71a3d/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/MailboxQuotaText",
"path": [
"6t0ggef2c0deab00hb595101",
"5dcc7ff74544b7001862482f",
"5dcd17c256b5de00189138f9",
"5dcd180233fc9b00189005b2",
"5dcd1812e186e30018eb7023",
"5dcd18c18192d40018f71a3d"
],
"summary_attrs": [
{
"name": "ObjectId",
"title": "Object Id"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"data": {
"Body": "",
"LanguageCode": 1034,
"DefaultSubject": "Advertencia de cuota de buz\u00f3n de voz",
"ObjectId": "2346b828-d62c-434d-b242-b235a87e6d20",
"Subject": "",
"URI": "/vmrest/mailboxquotatexts/2346b828-d62c-434d-b242-b235a87e6d20",
"RuleDescription": "Text for Mailbox Warning Quota",
"DefaultBody": "Ha superado el umbral para advertencia de cuota establecido por el administrador.\\n\\nUso actual: %CURRENTUSAGE%\\nUmbral para advertencia de cuota: %THRESHOLD%\\nTama\u00f1o l\u00edmite de cuota: %LIMIT%\\n\\nDebe reducir el tama\u00f1o del buz\u00f3n al eliminar algunos elementos.",
"UseDefault": true,
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"summary_device": "Dedicated CUCxn, 192.168.100.21, 8443, hcs.CS-P.CS-NB.AAAGlobal",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
},
{
"pkid": "5dcdc1f44544b70018619238",
"meta": {
"tags": [],
"cached": true,
"title": "2346b828-d62c-434d-b242-b235a87e6d20",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "5dcdc1b933fc9b001891379c",
"href": "/api/v0/data/UnityConnection/5dcdc1b933fc9b001891379c"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5dcdc1f44544b70018619238",
"href": "/api/device/cuc/MailboxQuotaText/5dcdc1f44544b70018619238/"
}
],
"parent": [
{
"pkid": "5dcd181e33fc9b0018900610",
"href": "/api/data/HierarchyNode/5dcd181e33fc9b0018900610"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/device/cuc/MailboxQuotaText/5dcdc1f44544b70018619238/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"clone": {
"support_async": false,
"href": "/api/device/cuc/MailboxQuotaText/5dcdc1f44544b70018619238/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5dcdc1f44544b70018619238/?model_type=device/cuc/MailboxQuotaText",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/MailboxQuotaText/5dcdc1f44544b70018619238/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/device/cuc/MailboxQuotaText/5dcdc1f44544b70018619238/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/device/cuc/MailboxQuotaText/5dcdc1f44544b70018619238/help",
"title": "Help",
"class": "help",
"method": "GET"
}
},
{
"purge": {
"support_async": false,
"href": "/api/device/cuc/MailboxQuotaText/5dcdc1f44544b70018619238/purge/",
"title": "Purge",
"class": "purge",
"method": "POST"
}
}
],
"model_type": "device/cuc/MailboxQuotaText",
"path": [
"6t0ggef2c0deab00hb595101",
"5dcc7ff74544b7001862482f",
"5dcd17c256b5de00189138f9",
"5dcd181e33fc9b0018900610",
"5dcdc1f44544b70018619238"
],
"summary_attrs": [
{
"name": "ObjectId",
"title": "Object Id"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"data": {
"Body": "",
"LanguageCode": 1034,
"DefaultSubject": "Advertencia de cuota de buz\u00f3n de voz",
"ObjectId": "2346b828-d62c-434d-b242-b235a87e6d20",
"Subject": "",
"URI": "/vmrest/mailboxquotatexts/2346b828-d62c-434d-b242-b235a87e6d20",
"RuleDescription": "Text for Mailbox Warning Quota",
"DefaultBody": "Ha superado el umbral para advertencia de cuota establecido por el administrador.\\n\\nUso actual: %CURRENTUSAGE%\\nUmbral para advertencia de cuota: %THRESHOLD%\\nTama\u00f1o l\u00edmite de cuota: %LIMIT%\\n\\nDebe reducir el tama\u00f1o del buz\u00f3n al eliminar algunos elementos.",
"UseDefault": true,
"hierarchy_friendly_name": "GeoLogic (Customer)",
"summary_device": "Dedicated CUCxn, 192.168.100.22, 443, hcs.CS-P.GeoLogic",
"hierarchy_path": "sys.hcs.CS-P.GeoLogic"
}
},
{
"pkid": "5dcd30de8192d40018f77d47",
"meta": {
"tags": [],
"cached": true,
"title": "9adec2b4-7092-495b-a48d-80b05a31600f",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "5dcd3073e186e30018ebc837",
"href": "/api/v0/data/UnityConnection/5dcd3073e186e30018ebc837"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5dcd30de8192d40018f77d47",
"href": "/api/device/cuc/MailboxQuotaText/5dcd30de8192d40018f77d47/"
}
],
"parent": [
{
"pkid": "5dcd2d8b9d77dd0018b0ebe6",
"href": "/api/data/HierarchyNode/5dcd2d8b9d77dd0018b0ebe6"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/device/cuc/MailboxQuotaText/5dcd30de8192d40018f77d47/",
"class": "update",
"title": "Modify"
}
},
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/MailboxQuotaText/5dcd30de8192d40018f77d47/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5dcd30de8192d40018f77d47/?model_type=device/cuc/MailboxQuotaText",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/MailboxQuotaText/5dcd30de8192d40018f77d47/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/MailboxQuotaText/5dcd30de8192d40018f77d47/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/MailboxQuotaText/5dcd30de8192d40018f77d47/help",
"class": "help",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"method": "POST",
"href": "/api/device/cuc/MailboxQuotaText/5dcd30de8192d40018f77d47/purge/",
"class": "purge",
"title": "Purge"
}
}
],
"model_type": "device/cuc/MailboxQuotaText",
"path": [
"6t0ggef2c0deab00hb595101",
"5dcc7ff74544b7001862482f",
"5dcd17c256b5de00189138f9",
"5dcd180233fc9b00189005b2",
"5dcd2d8b9d77dd0018b0ebe6",
"5dcd30de8192d40018f77d47"
],
"summary_attrs": [
{
"name": "ObjectId",
"title": "Object Id"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"data": {
"Body": "",
"LanguageCode": 1033,
"DefaultSubject": "Voicemail Mailbox Quota Warning",
"ObjectId": "9adec2b4-7092-495b-a48d-80b05a31600f",
"Subject": "",
"URI": "/vmrest/mailboxquotatexts/9adec2b4-7092-495b-a48d-80b05a31600f",
"RuleDescription": "Text for Mailbox Warning Quota",
"DefaultBody": "Your voice mailbox has exceeded the quota warning threshold specified by your administrator.\\n\\nCurrent Usage: %CURRENTUSAGE%\\nQuota Warning Threshold: %THRESHOLD%\\nQuota Size Limit: %LIMIT%\\n\\nPlease reduce your voice mailbox size by deleting few items from your mailbox.",
"UseDefault": true,
"hierarchy_friendly_name": "Overton (Customer)",
"summary_device": "Dedicated CUCxn, 10.120.9.246, 8443, hcs.CS-P.CS-NB.Overton",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.Overton"
}
}
]
}
(Show the first instance)
{
"pkid": "5dcd18c18192d40018f71a3d",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "2346b828-d62c-434d-b242-b235a87e6d20",
"business_key": {},
"schema_version": "12.5",
"references": {
"parent": [
{
"pkid": "5dcd1812e186e30018eb7023",
"href": "/api/data/HierarchyNode/5dcd1812e186e30018eb7023"
}
],
"self": [
{
"pkid": "5dcd18c18192d40018f71a3d",
"href": "/api/device/cuc/MailboxQuotaText/5dcd18c18192d40018f71a3d/"
}
],
"foreign_key": [],
"device": [
{
"pkid": "5dcd18824544b70018605580",
"href": "/api/v0/data/UnityConnection/5dcd18824544b70018605580"
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/cuc/MailboxQuotaText/5dcd18c18192d40018f71a3d/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/MailboxQuotaText/5dcd18c18192d40018f71a3d/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5dcd18c18192d40018f71a3d/?hierarchy=[hierarchy]&model_type=device/cuc/MailboxQuotaText",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/MailboxQuotaText/5dcd18c18192d40018f71a3d/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/MailboxQuotaText/5dcd18c18192d40018f71a3d/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/MailboxQuotaText/5dcd18c18192d40018f71a3d/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/MailboxQuotaText/5dcd18c18192d40018f71a3d/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/MailboxQuotaText",
"path": [
"6t0ggef2c0deab00hb595101",
"5dcc7ff74544b7001862482f",
"5dcd17c256b5de00189138f9",
"5dcd180233fc9b00189005b2",
"5dcd1812e186e30018eb7023",
"5dcd18c18192d40018f71a3d"
],
"summary_attrs": [
{
"name": "ObjectId",
"title": "Object Id"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"data": {
"Body": "",
"LanguageCode": 1034,
"DefaultSubject": "Advertencia de cuota de buz\u00f3n de voz",
"ObjectId": "2346b828-d62c-434d-b242-b235a87e6d20",
"URI": "/vmrest/mailboxquotatexts/2346b828-d62c-434d-b242-b235a87e6d20",
"RuleDescription": "Text for Mailbox Warning Quota",
"DefaultBody": "Ha superado el umbral para advertencia de cuota establecido por el administrador.\\n\\nUso actual: %CURRENTUSAGE%\\nUmbral para advertencia de cuota: %THRESHOLD%\\nTama\u00f1o l\u00edmite de cuota: %LIMIT%\\n\\nDebe reducir el tama\u00f1o del buz\u00f3n al eliminar algunos elementos.",
"UseDefault": true,
"Subject": ""
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cuc/MailboxQuotaText. | GET | /api/device/cuc/MailboxQuotaText/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cuc/MailboxQuotaText as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/cuc/MailboxQuotaText/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cuc/MailboxQuotaText/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/MailboxQuotaText/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cuc/MailboxQuotaText | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of device/cuc/MailboxQuotaText; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cuc/MailboxQuotaText/[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 device/cuc/MailboxQuotaText and the JSON format can be used to import instances of device/cuc/MailboxQuotaText.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cuc/MailboxQuotaText/[pkid]/ | hierarchy=[hierarchy] | The device/cuc/MailboxQuotaText instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cuc/MailboxQuotaText/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cuc/MailboxQuotaText. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cuc/MailboxQuotaText/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |