[Index]
HcsLocalizedStringDat
Model ref.: data/HcsLocalizedStringDat
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": { "value": { "is_password": false, "title": "Localized String", "required": true, "displayable": true, "readonly": false, "maxLength": 1024, "type": "string" }, "key": { "is_password": false, "title": "Key", "required": true, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" } }, "schema_version": "2.1" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/data/HcsLocalizedStringDat/add/ |
|
The GUI Add form of data/HcsLocalizedStringDat 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/HcsLocalizedStringDat | 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/HcsLocalizedStringDat/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/HcsLocalizedStringDat/[pkid1]", "/api/data/HcsLocalizedStringDat/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/HcsLocalizedStringDat/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/data/HcsLocalizedStringDat/ |
|
The data/HcsLocalizedStringDat schema and all instances as JSON. |
(The list will return 0 to 3 data/HcsLocalizedStringDat instances)
{ "operations": [ "field_display_policy", "configuration_template", "help", "get", "export_bulkload_template", "list", "update", "remove", "transform", "add", "export", "migration", "bulk_update_form" ], "pagination": { "direction": "asc", "order_by": "key", "maximum_limit": 2000, "skip": 0, "current": "/api/data/HcsLocalizedStringDat/?skip=0&limit=3&order_by=key&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 149 }, "meta": { "tags": [], "cached": true, "title": "", "business_key": { "hierarchy": true, "unique": [ "key" ] }, "schema_version": "2.1", "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/HcsLocalizedStringDat/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/data/HcsLocalizedStringDat/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "list": { "support_async": false, "class": "list", "href": "/api/data/HcsLocalizedStringDat/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } } ], "model_type": "data/HcsLocalizedStringDat", "model_specific_actions": [ "list", "get", "add", "update", "remove", "import", "execute" ], "summary_attrs": [ { "name": "key", "title": "Key" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "resources": [ { "pkid": "5df361b0ce894e0012b36c3b", "meta": { "tags": [ "HcsLocalization", "V4UC", "ba_SYSdotHCS_with_hcmf" ], "cached": true, "title": "title format", "business_key": { "hierarchy": false, "unique": [ "key" ] }, "schema_version": "2.1", "summary": "false", "references": { "device": [ { "pkid": "", "href": "" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "5df361b0ce894e0012b36c3b", "href": "/api/data/HcsLocalizedStringDat/5df361b0ce894e0012b36c3b/" } ], "parent": [ { "pkid": "5df35e48ce894e0012b345a1", "href": "/api/data/HierarchyNode/5df35e48ce894e0012b345a1" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/data/HcsLocalizedStringDat/5df361b0ce894e0012b36c3b/", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/data/HcsLocalizedStringDat/5df361b0ce894e0012b36c3b/", "method": "DELETE", "title": "Delete" } }, { "import": { "support_async": true, "method": "POST", "href": "/api/data/HcsLocalizedStringDat/5df361b0ce894e0012b36c3b/import/", "class": "import", "title": "Import" } }, { "execute": { "support_async": true, "class": "execute", "href": "/api/data/HcsLocalizedStringDat/5df361b0ce894e0012b36c3b/execute/", "method": "POST", "title": "Execute" } }, { "get": { "support_async": false, "class": "get", "href": "/api/data/HcsLocalizedStringDat/5df361b0ce894e0012b36c3b/", "method": "GET", "title": "Get" } } ], "model_type": "data/HcsLocalizedStringDat", "path": [ "6t0ggef2c0deab00hb595101", "5df35e48ce894e0012b345a1", "5df361b0ce894e0012b36c3b" ], "summary_attrs": [ { "name": "key", "title": "Key" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "data": { "pkid": "5df361b0ce894e0012b36c3c", "hierarchy_friendly_name": "hcs (Hcs)", "key": "auditReport_component", "value": "Custom Templates Audit", "hierarchy_path": "sys.hcs" } }, { "pkid": "5df361bdce894e0012b36ce3", "meta": { "tags": [ "HcsLocalization", "V4UC", "ba_SYSdotHCS_with_hcmf" ], "cached": true, "title": "title format", "business_key": { "hierarchy": false, "unique": [ "key" ] }, "schema_version": "2.1", "summary": "false", "references": { "device": [ { "pkid": "", "href": "" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "5df361bdce894e0012b36ce3", "href": "/api/data/HcsLocalizedStringDat/5df361bdce894e0012b36ce3/" } ], "parent": [ { "pkid": "5df35e48ce894e0012b345a1", "href": "/api/data/HierarchyNode/5df35e48ce894e0012b345a1" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "href": "/api/data/HcsLocalizedStringDat/5df361bdce894e0012b36ce3/", "title": "Modify", "class": "update", "method": "PUT" } }, { "remove": { "support_async": true, "href": "/api/data/HcsLocalizedStringDat/5df361bdce894e0012b36ce3/", "title": "Delete", "class": "delete", "method": "DELETE" } }, { "import": { "support_async": true, "href": "/api/data/HcsLocalizedStringDat/5df361bdce894e0012b36ce3/import/", "title": "Import", "method": "POST", "class": "import" } }, { "execute": { "support_async": true, "href": "/api/data/HcsLocalizedStringDat/5df361bdce894e0012b36ce3/execute/", "title": "Execute", "class": "execute", "method": "POST" } }, { "get": { "support_async": false, "href": "/api/data/HcsLocalizedStringDat/5df361bdce894e0012b36ce3/", "title": "Get", "class": "get", "method": "GET" } } ], "model_type": "data/HcsLocalizedStringDat", "path": [ "6t0ggef2c0deab00hb595101", "5df35e48ce894e0012b345a1", "5df361bdce894e0012b36ce3" ], "summary_attrs": [ { "name": "key", "title": "Key" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "data": { "pkid": "5df361bdce894e0012b36ce4", "hierarchy_friendly_name": "hcs (Hcs)", "key": "auditReport_no_templates", "value": "There were no customized templates found at ", "hierarchy_path": "sys.hcs" } }, { "pkid": "5df361b0ce894e0012b36c32", "meta": { "tags": [ "HcsLocalization", "V4UC", "ba_SYSdotHCS_with_hcmf" ], "cached": true, "title": "title format", "business_key": { "hierarchy": false, "unique": [ "key" ] }, "schema_version": "2.1", "summary": "false", "references": { "device": [ { "pkid": "", "href": "" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "5df361b0ce894e0012b36c32", "href": "/api/data/HcsLocalizedStringDat/5df361b0ce894e0012b36c32/" } ], "parent": [ { "pkid": "5df35e48ce894e0012b345a1", "href": "/api/data/HierarchyNode/5df35e48ce894e0012b345a1" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "method": "PUT", "href": "/api/data/HcsLocalizedStringDat/5df361b0ce894e0012b36c32/", "class": "update", "title": "Modify" } }, { "remove": { "support_async": true, "method": "DELETE", "href": "/api/data/HcsLocalizedStringDat/5df361b0ce894e0012b36c32/", "class": "delete", "title": "Delete" } }, { "import": { "support_async": true, "class": "import", "href": "/api/data/HcsLocalizedStringDat/5df361b0ce894e0012b36c32/import/", "method": "POST", "title": "Import" } }, { "execute": { "support_async": true, "method": "POST", "href": "/api/data/HcsLocalizedStringDat/5df361b0ce894e0012b36c32/execute/", "class": "execute", "title": "Execute" } }, { "get": { "support_async": false, "method": "GET", "href": "/api/data/HcsLocalizedStringDat/5df361b0ce894e0012b36c32/", "class": "get", "title": "Get" } } ], "model_type": "data/HcsLocalizedStringDat", "path": [ "6t0ggef2c0deab00hb595101", "5df35e48ce894e0012b345a1", "5df361b0ce894e0012b36c32" ], "summary_attrs": [ { "name": "key", "title": "Key" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "data": { "pkid": "5df361b0ce894e0012b36c33", "hierarchy_friendly_name": "hcs (Hcs)", "key": "auditReport_rec_action", "value": "Please make sure these templates are expected at hierarchy ", "hierarchy_path": "sys.hcs" } } ] }
(Show the first instance)
{ "pkid": "5df361b0ce894e0012b36c3b", "meta": { "tags": [ "HcsLocalization", "V4UC", "ba_SYSdotHCS_with_hcmf" ], "cached": false, "title": "title format", "business_key": { "hierarchy": true, "unique": [ "key" ] }, "schema_version": "2.1", "references": { "parent": [ { "pkid": "5df35e48ce894e0012b345a1", "href": "/api/data/HierarchyNode/5df35e48ce894e0012b345a1" } ], "self": [ { "pkid": "5df361b0ce894e0012b36c3b", "href": "/api/data/HcsLocalizedStringDat/5df361b0ce894e0012b36c3b/" } ], "foreign_key": [], "device": [ { "pkid": "", "href": "" } ], "owner": [ { "pkid": "" } ], "children": [] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/data/HcsLocalizedStringDat/5df361b0ce894e0012b36c3b/?hierarchy=[hierarchy]", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/data/HcsLocalizedStringDat/5df361b0ce894e0012b36c3b/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "import": { "support_async": true, "method": "POST", "href": "/api/data/HcsLocalizedStringDat/5df361b0ce894e0012b36c3b/import/?hierarchy=[hierarchy]", "class": "import", "title": "Import" } }, { "execute": { "support_async": true, "class": "execute", "href": "/api/data/HcsLocalizedStringDat/5df361b0ce894e0012b36c3b/execute/?hierarchy=[hierarchy]", "method": "POST", "title": "Execute" } }, { "get": { "support_async": false, "class": "get", "href": "/api/data/HcsLocalizedStringDat/5df361b0ce894e0012b36c3b/?hierarchy=[hierarchy]", "method": "GET", "title": "Get" } } ], "model_type": "data/HcsLocalizedStringDat", "path": [ "6t0ggef2c0deab00hb595101", "5df35e48ce894e0012b345a1", "5df361b0ce894e0012b36c3b" ], "summary_attrs": [ { "name": "key", "title": "Key" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "data": { "pkid": "5df361b0ce894e0012b36c3c", "key": "auditReport_component", "value": "Custom Templates Audit" } }
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/data/HcsLocalizedStringDat/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/data/HcsLocalizedStringDat/[pkid] | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Import | POST | /api/data/HcsLocalizedStringDat/[pkid]/import | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Execute | POST | /api/data/HcsLocalizedStringDat/[pkid]/execute | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/data/HcsLocalizedStringDat/[pkid] | hierarchy=[hierarchy] | The data/HcsLocalizedStringDat instance with [pkid]. |