[Index]
HcsNbnSupportedModelsDAT
Model ref.: data/HcsNbnSupportedModelsDAT
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": { "operations": { "is_password": false, "title": "Operations", "minItems": 0, "items": { "is_password": false, "type": "string" }, "required": true, "displayable": true, "readonly": false, "type": "array" }, "modelType": { "is_password": false, "title": "Model Type", "required": true, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" } }, "schema_version": "2.0" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/data/HcsNbnSupportedModelsDAT/add/ |
|
The GUI Add form of data/HcsNbnSupportedModelsDAT 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/HcsNbnSupportedModelsDAT/ | 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/HcsNbnSupportedModelsDAT/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/HcsNbnSupportedModelsDAT/[pkid1]", "/api/data/HcsNbnSupportedModelsDAT/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/HcsNbnSupportedModelsDAT/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/data/HcsNbnSupportedModelsDAT/ |
|
The data/HcsNbnSupportedModelsDAT schema and all instances as JSON. |
(The list will return 0 to 3 data/HcsNbnSupportedModelsDAT 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": "modelType", "maximum_limit": 2000, "skip": 0, "current": "/api/data/HcsNbnSupportedModelsDAT/?skip=0&limit=3&order_by=modelType&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 2 }, "meta": { "tags": [], "cached": true, "title": "", "business_key": { "hierarchy": true, "unique": [ "modelType" ] }, "schema_version": "2.0", "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/HcsNbnSupportedModelsDAT/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/data/HcsNbnSupportedModelsDAT/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "list": { "support_async": false, "class": "list", "href": "/api/data/HcsNbnSupportedModelsDAT/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } } ], "model_type": "data/HcsNbnSupportedModelsDAT", "model_specific_actions": [ "list", "get", "add", "update", "remove", "import", "execute" ], "summary_attrs": [ { "name": "modelType", "title": "Model Type" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "resources": [ { "pkid": "63050cab43fcc416f18efb10", "meta": { "tags": [ "HcsNorthboundNotifications", "V4UC", "ba_dcpld__SYSdotHCS" ], "cached": true, "title": "title format", "business_key": { "hierarchy": true, "unique": [ "modelType" ] }, "schema_version": "2.0", "summary": "false", "references": { "device": [ { "pkid": "", "href": "" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "63050cab43fcc416f18efb10", "href": "/api/data/HcsNbnSupportedModelsDAT/63050cab43fcc416f18efb10/" } ], "parent": [ { "pkid": "6305086243fcc416f18ea4ac", "href": "/api/data/HierarchyNode/6305086243fcc416f18ea4ac" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/data/HcsNbnSupportedModelsDAT/63050cab43fcc416f18efb10/", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/data/HcsNbnSupportedModelsDAT/63050cab43fcc416f18efb10/", "method": "DELETE", "title": "Delete" } }, { "import": { "support_async": true, "method": "POST", "href": "/api/data/HcsNbnSupportedModelsDAT/63050cab43fcc416f18efb10/import/", "class": "import", "title": "Import" } }, { "execute": { "support_async": true, "class": "execute", "href": "/api/data/HcsNbnSupportedModelsDAT/63050cab43fcc416f18efb10/execute/", "method": "POST", "title": "Execute" } }, { "get": { "support_async": false, "class": "get", "href": "/api/data/HcsNbnSupportedModelsDAT/63050cab43fcc416f18efb10/", "method": "GET", "title": "Get" } } ], "model_type": "data/HcsNbnSupportedModelsDAT", "path": [ "6t0ggef2c0deab00hb595101", "6305086243fcc416f18ea4ac", "63050cab43fcc416f18efb10" ], "summary_attrs": [ { "name": "modelType", "title": "Model Type" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "data": { "operations": [ "create", "delete", "update" ], "pkid": "63050cab43fcc416f18efb11", "hierarchy_friendly_name": "hcs (Hcs)", "modelType": "data/NormalizedUser", "hierarchy_path": "sys.hcs" } }, { "pkid": "63050cab43fcc416f18efb0a", "meta": { "tags": [ "HcsNorthboundNotifications", "V4UC", "ba_dcpld__SYSdotHCS" ], "cached": true, "title": "title format", "business_key": { "hierarchy": true, "unique": [ "modelType" ] }, "schema_version": "2.0", "summary": "false", "references": { "device": [ { "pkid": "", "href": "" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "63050cab43fcc416f18efb0a", "href": "/api/data/HcsNbnSupportedModelsDAT/63050cab43fcc416f18efb0a/" } ], "parent": [ { "pkid": "6305086243fcc416f18ea4ac", "href": "/api/data/HierarchyNode/6305086243fcc416f18ea4ac" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "href": "/api/data/HcsNbnSupportedModelsDAT/63050cab43fcc416f18efb0a/", "title": "Modify", "class": "update", "method": "PUT" } }, { "remove": { "support_async": true, "href": "/api/data/HcsNbnSupportedModelsDAT/63050cab43fcc416f18efb0a/", "title": "Delete", "class": "delete", "method": "DELETE" } }, { "import": { "support_async": true, "href": "/api/data/HcsNbnSupportedModelsDAT/63050cab43fcc416f18efb0a/import/", "title": "Import", "method": "POST", "class": "import" } }, { "execute": { "support_async": true, "href": "/api/data/HcsNbnSupportedModelsDAT/63050cab43fcc416f18efb0a/execute/", "title": "Execute", "class": "execute", "method": "POST" } }, { "get": { "support_async": false, "href": "/api/data/HcsNbnSupportedModelsDAT/63050cab43fcc416f18efb0a/", "title": "Get", "class": "get", "method": "GET" } } ], "model_type": "data/HcsNbnSupportedModelsDAT", "path": [ "6t0ggef2c0deab00hb595101", "6305086243fcc416f18ea4ac", "63050cab43fcc416f18efb0a" ], "summary_attrs": [ { "name": "modelType", "title": "Model Type" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "data": { "operations": [ "create", "delete", "update" ], "pkid": "63050cab43fcc416f18efb0b", "hierarchy_friendly_name": "hcs (Hcs)", "modelType": "relation/Subscriber", "hierarchy_path": "sys.hcs" } } ] }
(Show the first instance)
{ "pkid": "63050cab43fcc416f18efb10", "meta": { "tags": [ "HcsNorthboundNotifications", "V4UC", "ba_dcpld__SYSdotHCS" ], "cached": false, "title": "title format", "business_key": { "hierarchy": true, "unique": [ "modelType" ] }, "schema_version": "2.0", "references": { "parent": [ { "pkid": "6305086243fcc416f18ea4ac", "href": "/api/data/HierarchyNode/6305086243fcc416f18ea4ac" } ], "self": [ { "pkid": "63050cab43fcc416f18efb10", "href": "/api/data/HcsNbnSupportedModelsDAT/63050cab43fcc416f18efb10/" } ], "foreign_key": [], "device": [ { "pkid": "", "href": "" } ], "owner": [ { "pkid": "" } ], "children": [] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/data/HcsNbnSupportedModelsDAT/63050cab43fcc416f18efb10/?hierarchy=[hierarchy]", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/data/HcsNbnSupportedModelsDAT/63050cab43fcc416f18efb10/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "import": { "support_async": true, "method": "POST", "href": "/api/data/HcsNbnSupportedModelsDAT/63050cab43fcc416f18efb10/import/?hierarchy=[hierarchy]", "class": "import", "title": "Import" } }, { "execute": { "support_async": true, "class": "execute", "href": "/api/data/HcsNbnSupportedModelsDAT/63050cab43fcc416f18efb10/execute/?hierarchy=[hierarchy]", "method": "POST", "title": "Execute" } }, { "get": { "support_async": false, "class": "get", "href": "/api/data/HcsNbnSupportedModelsDAT/63050cab43fcc416f18efb10/?hierarchy=[hierarchy]", "method": "GET", "title": "Get" } } ], "model_type": "data/HcsNbnSupportedModelsDAT", "path": [ "6t0ggef2c0deab00hb595101", "6305086243fcc416f18ea4ac", "63050cab43fcc416f18efb10" ], "summary_attrs": [ { "name": "modelType", "title": "Model Type" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "data": { "operations": [ "create", "delete", "update" ], "pkid": "63050cab43fcc416f18efb11", "modelType": "data/NormalizedUser" } }
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/data/HcsNbnSupportedModelsDAT/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/data/HcsNbnSupportedModelsDAT/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Import | POST | /api/data/HcsNbnSupportedModelsDAT/[pkid]/import/ | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Execute | POST | /api/data/HcsNbnSupportedModelsDAT/[pkid]/execute/ | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/data/HcsNbnSupportedModelsDAT/[pkid]/ | hierarchy=[hierarchy] | The data/HcsNbnSupportedModelsDAT instance with [pkid]. |