[Index]
Defines rules regarding when data is retrieved from cache or directly from a device
Model ref.: data/CacheControlPolicy
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": { "default": { "properties": { "read_after_write": { "items": { "type": "string", "choices": [ { "value": "add", "title": "On Add" }, { "value": "update", "title": "On Update" } ] }, "type": "array", "title": "Read After Write" }, "read_cache_policy": { "title": "Cache Policy for Reads", "required": true, "type": "string", "choices": [ { "value": "cache", "title": "Cache" }, { "value": "no_cache", "title": "No Cache" }, { "value": "manual", "title": "Manual" }, { "value": "cache_then_device", "title": "Cache then Device" } ] }, "read_before_write": { "items": { "type": "string", "choices": [ { "value": "update", "title": "On Update" } ] }, "type": "array", "title": "Read Before Write" } }, "type": "object", "description": "The default policy for this instance.", "title": "Default" }, "model_specific": { "properties": { "overrides": { "items": { "type": "object", "properties": { "model_type": { "title": "Model Type", "type": "string", "choices": [ { "value": "", "title": "" } ] }, "read_after_write": { "items": { "type": "string", "choices": [ { "value": "add", "title": "On Add" }, { "value": "update", "title": "On Update" } ] }, "type": "array", "title": "Read After Write" }, "read_cache_policy": { "title": "Cache Policy for Reads", "required": true, "type": "string", "choices": [ { "value": "cache", "title": "Cache" }, { "value": "no_cache", "title": "No Cache" }, { "value": "manual", "title": "Manual" }, { "value": "cache_then_device", "title": "Cache then Device" } ] }, "read_before_write": { "items": { "type": "string", "choices": [ { "value": "update", "title": "On Update" } ] }, "type": "array", "title": "Read Before Write" } } }, "type": "array", "title": "Overrides" } }, "type": "object", "description": "Policy overrides per model.", "title": "Model Specific" }, "name": { "required": true, "type": "string", "description": "A textual identifier for this instance.", "title": "Name" }, "assigned_models": { "items": { "type": "object", "properties": { "model_type": { "description": "The model type of the assigned model", "format": "uri", "title": "Model Type", "required": true, "choices": [], "target_attr": "name", "target_model_type": "data", "type": "string", "target": "/api/data/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "model_attr": { "choices": [ { "value": "", "title": "" } ], "required": true, "type": "string", "description": "The name of the attribute that is used to identify the assigned data model", "title": "Model Attribute" }, "value": { "choices": [ { "value": "", "title": "" } ], "required": true, "type": "string", "description": "The value of the assigned model instance", "title": "Value" } } }, "required": false, "type": "array", "description": "A list of models that must specifically use this cache control policy.", "title": "Assigned Models" }, "description": { "required": false, "type": "string", "description": "A summary of the purpose of this policy.", "title": "Description" } }, "schema_version": "0.1.4" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/data/CacheControlPolicy/add/ |
|
The GUI Add form of data/CacheControlPolicy 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/CacheControlPolicy/ | 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/CacheControlPolicy/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/CacheControlPolicy/[pkid1]", "/api/data/CacheControlPolicy/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/CacheControlPolicy/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/data/CacheControlPolicy/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/data/CacheControlPolicy/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/data/CacheControlPolicy/[pkid1]", "/api/v0/data/CacheControlPolicy/[pkid2]",...]}} |
GET http://[host-proxy]/api/data/CacheControlPolicy/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/CacheControlPolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/CacheControlPolicy/export/ |
|
{ "hrefs":["/api/data/CacheControlPolicy/[pkid1]", "/api/data/CacheControlPolicy/[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/CacheControlPolicy and the JSON format can be used to import instances of data/CacheControlPolicy.
GET http://[host-proxy]/api/data/CacheControlPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for data/CacheControlPolicy | POST | /api/data/CacheControlPolicy/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/CacheControlPolicy/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/data/CacheControlPolicy/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Migration Template | GET | /api/data/CacheControlPolicy/migration/ |
|
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/data/CacheControlPolicy/ |
|
The data/CacheControlPolicy schema and all instances as JSON. |
(The list will return 0 to 3 data/CacheControlPolicy 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/CacheControlPolicy/?skip=0&limit=3&order_by=name&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 1 }, "meta": { "tags": [], "cached": true, "title": "", "business_key": { "hierarchy": true, "unique": [ "name" ] }, "schema_version": "0.1.4", "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/CacheControlPolicy/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/data/CacheControlPolicy/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/data/CacheControlPolicy/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/CacheControlPolicy/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/CacheControlPolicy/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "tag": { "title": "Tag", "support_async": true, "method": "PATCH", "href": "/api/data/CacheControlPolicy/+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/CacheControlPolicy/+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/CacheControlPolicy/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/data/CacheControlPolicy/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "migration": { "support_async": false, "class": "migration", "href": "/api/data/CacheControlPolicy/migration/?hierarchy=[hierarchy]", "method": "GET", "title": "Migration Template" } }, { "list": { "support_async": false, "class": "list", "href": "/api/data/CacheControlPolicy/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/data/CacheControlPolicy/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } } ], "model_type": "data/CacheControlPolicy", "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": "description", "title": "Description" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "resources": [ { "pkid": "610961f9e04a4a00149a26f9", "meta": { "tags": [ "base", "core", "V4UC", "ba_CommonOverlay" ], "cached": true, "title": "System Default", "business_key": { "hierarchy": true, "unique": [ "name" ] }, "schema_version": "0.1.4", "summary": "false", "references": { "device": [ { "pkid": "", "href": "" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "610961f9e04a4a00149a26f9", "href": "/api/data/CacheControlPolicy/610961f9e04a4a00149a26f9/" } ], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [] }, "version_tag": "0.1", "model_type": "data/CacheControlPolicy", "path": [ "6t0ggef2c0deab00hb595101", "610961f9e04a4a00149a26f9" ], "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/data/CacheControlPolicy/610961f9e04a4a00149a26f9/", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/data/CacheControlPolicy/610961f9e04a4a00149a26f9/", "method": "DELETE", "title": "Delete" } }, { "clone": { "support_async": false, "class": "clone", "href": "/api/data/CacheControlPolicy/610961f9e04a4a00149a26f9/clone/?schema=&schema_rules=true", "method": "GET", "title": "Clone" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/data/CacheControlPolicy/610961f9e04a4a00149a26f9/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "tag": { "title": "Tag", "support_async": true, "method": "PATCH", "href": "/api/data/CacheControlPolicy/610961f9e04a4a00149a26f9/+tag/", "class": "tag", "view": "/api/view/TagNameForm/add/" } }, { "tag_version": { "title": "Tag Version", "support_async": true, "method": "PATCH", "href": "/api/data/CacheControlPolicy/610961f9e04a4a00149a26f9/+tag_version/", "class": "tag_version", "view": "/api/view/TagVersionForm/add/" } }, { "get": { "support_async": false, "class": "get", "href": "/api/data/CacheControlPolicy/610961f9e04a4a00149a26f9/", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/data/CacheControlPolicy/610961f9e04a4a00149a26f9/help", "method": "GET", "title": "Help" } } ], "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "description", "title": "Description" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [ { "pkid": "610975efe04a4a0015027a5d", "version": "0.1", "href": "/api/v0/data/CacheControlPolicy/610961f9e04a4a00149a26f9/?cached=610975efe04a4a0015027a5d" } ] }, "data": { "model_specific": { "overrides": [ { "model_type": "device/notification_service/*", "read_cache_policy": "cache" }, { "model_type": "relation/WebexTeamsPlace", "read_cache_policy": "cache" }, { "model_type": "device/spark/Device", "read_cache_policy": "cache" } ] }, "name": "System Default", "pkid": "610961f9e04a4a00149a26fa", "description": "For all models: read from cache then device, read before/after write enabled", "default": { "read_after_write": [ "add", "update" ], "read_cache_policy": "cache_then_device", "read_before_write": [ "update" ] }, "hierarchy_friendly_name": "sys (System)", "hierarchy_path": "sys" } } ] }
(Show the first instance)
{ "pkid": "610961f9e04a4a00149a26f9", "meta": { "tags": [ "base", "core", "V4UC", "ba_CommonOverlay" ], "cached": false, "title": "System Default", "business_key": { "hierarchy": true, "unique": [ "name" ] }, "schema_version": "0.1.4", "references": { "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "self": [ { "pkid": "610961f9e04a4a00149a26f9", "href": "/api/data/CacheControlPolicy/610961f9e04a4a00149a26f9/" } ], "foreign_key": [], "device": [ { "pkid": "", "href": "" } ], "owner": [ { "pkid": "" } ], "children": [] }, "version_tag": "0.1", "model_type": "data/CacheControlPolicy", "path": [ "6t0ggef2c0deab00hb595101", "610961f9e04a4a00149a26f9" ], "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/data/CacheControlPolicy/610961f9e04a4a00149a26f9/?hierarchy=[hierarchy]", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/data/CacheControlPolicy/610961f9e04a4a00149a26f9/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "clone": { "support_async": false, "class": "clone", "href": "/api/data/CacheControlPolicy/610961f9e04a4a00149a26f9/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true", "method": "GET", "title": "Clone" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/data/CacheControlPolicy/610961f9e04a4a00149a26f9/export/?hierarchy=[hierarchy]", "method": "GET", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "tag": { "title": "Tag", "support_async": true, "method": "PATCH", "href": "/api/data/CacheControlPolicy/610961f9e04a4a00149a26f9/+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/CacheControlPolicy/610961f9e04a4a00149a26f9/+tag_version/?hierarchy=[hierarchy]", "class": "tag_version", "view": "/api/view/TagVersionForm/add/?auth_token=[authtoken] } }, { "get": { "support_async": false, "class": "get", "href": "/api/data/CacheControlPolicy/610961f9e04a4a00149a26f9/?hierarchy=[hierarchy]", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/data/CacheControlPolicy/610961f9e04a4a00149a26f9/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } } ], "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "description", "title": "Description" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [ { "pkid": "610975efe04a4a0015027a5d", "version": "0.1", "href": "/api/v0/data/CacheControlPolicy/610961f9e04a4a00149a26f9/?cached=610975efe04a4a0015027a5d" } ] }, "data": { "default": { "read_after_write": [ "add", "update" ], "read_cache_policy": "cache_then_device", "read_before_write": [ "update" ] }, "pkid": "610961f9e04a4a00149a26fa", "model_specific": { "overrides": [ { "model_type": "device/notification_service/*", "read_cache_policy": "cache" }, { "model_type": "relation/WebexTeamsPlace", "read_cache_policy": "cache" }, { "model_type": "device/spark/Device", "read_cache_policy": "cache" } ] }, "name": "System Default", "description": "For all models: read from cache then device, read before/after write enabled" } }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for data/CacheControlPolicy. | GET | /api/data/CacheControlPolicy/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/CacheControlPolicy as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/data/CacheControlPolicy/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/data/CacheControlPolicy/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/CacheControlPolicy/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/CacheControlPolicy/?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/CacheControlPolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/CacheControlPolicy/[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/CacheControlPolicy and the JSON format can be used to import instances of data/CacheControlPolicy.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Tag | PATCH | /api/data/CacheControlPolicy/[pkid]/+tag/ | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/data/CacheControlPolicy/[pkid]/ | hierarchy=[hierarchy] | The data/CacheControlPolicy instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/data/CacheControlPolicy/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/CacheControlPolicy. |