[Index]
HcsRoleDAT
Model ref.: data/HcsRoleDAT
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": { "is_password": false, "title": "Name", "required": true, "displayable": true, "readonly": false, "maxLength": 1024, "type": "string" }, "hierarchyType": { "is_password": false, "format": "uri", "required": true, "displayable": false, "target_attr": "name", "readonly": false, "maxLength": 1024, "title": "Hierarchy Type", "type": "string", "target": "/api/data/HierarchyNodeType/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_model_type": "data/HierarchyNodeType", "choices": [] }, "privileges": { "is_password": false, "title": "Privileges", "required": true, "displayable": false, "choices": [ { "value": "READ_WRITE", "title": "Administrator" }, { "value": "READ_ONLY", "title": "Operator" } ], "readonly": false, "maxLength": 1024, "type": "string" }, "hcsComponentAccess": { "is_password": false, "title": "Hcs Component Access", "required": true, "displayable": false, "choices": [ { "value": "FF_SA", "title": "Fulfillment and ServiceAssurance" }, { "value": "FF_ONLY", "title": "Fulfillment Only" }, { "value": "SA_ONLY", "title": "Service Assurance Only" }, { "value": "SS_ONLY", "title": "Self Service" } ], "readonly": false, "maxLength": 1024, "type": "string" } }, "schema_version": "2.0" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/data/HcsRoleDAT/add/ |
|
The GUI Add form of data/HcsRoleDAT 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/HcsRoleDAT | 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/HcsRoleDAT/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/HcsRoleDAT/[pkid1]", "/api/data/HcsRoleDAT/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/HcsRoleDAT/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/data/HcsRoleDAT/ |
|
The data/HcsRoleDAT schema and all instances as JSON. |
(The list will return 0 to 3 data/HcsRoleDAT instances)
{ "pagination": { "skip": 0, "limit": 3, "maximum_limit": 2000, "total": 167, "total_limit": null, "order_by": "name", "direction": "asc", "current": "/api/data/HcsRoleDAT/?skip=0&limit=3&order_by=name&direction=asc&traversal=down" }, "operations": [ "field_display_policy", "update", "help", "remove", "move", "add", "export", "list", "configuration_template", "get", "bulk_update_form", "migration", "transform", "export_bulkload_template" ], "meta": { "model_type": "data/HcsRoleDAT", "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "hierarchy_friendly_name", "title": "Located At", "allow_filtering": true } ], "tagged_versions": [], "tags": [], "title": "", "business_key": { "hierarchy": true, "unique": [ "name" ] }, "api_version": "21.2", "cached": true, "references": { "children": [], "parent": [ { "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101", "pkid": "6t0ggef2c0deab00hb595101" } ], "device": [ { "href": "", "pkid": "" } ], "foreign_key": [] }, "model_specific_actions": [ "list", "get", "add", "update", "remove", "import", "execute" ], "schema_version": "2.0", "actions": [ { "add": { "method": "GET", "class": "add", "href": "/api/data/HcsRoleDAT/add/?hierarchy=[hierarchy]", "support_async": false, "title": "Add" } }, { "remove": { "method": "DELETE", "class": "delete", "href": "/api/data/HcsRoleDAT/?hierarchy=[hierarchy]", "support_async": true, "title": "Delete" } }, { "list": { "method": "GET", "class": "list", "href": "/api/data/HcsRoleDAT/?hierarchy=[hierarchy]", "support_async": false, "title": "List" } } ] }, "resources": [ { "data": { "pkid": "5ae89ea6affa931cce38a6a8", "privileges": "READ_WRITE", "hcsComponentAccess": "FF_SA", "hierarchyType": "Customer", "name": "AB_GroupCustomerAdministrator", "hierarchy_friendly_name": "AB_Group (Customer)", "hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group" }, "meta": { "model_type": "data/HcsRoleDAT", "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "hierarchy_friendly_name", "title": "Located At", "allow_filtering": true } ], "tagged_versions": [], "tags": [], "title": "title format", "business_key": { "hierarchy": true, "unique": [ "name" ] }, "api_version": "21.2", "cached": true, "references": { "device": [ { "href": "", "pkid": "" } ], "owner": [ { "pkid": "" } ], "parent": [ { "pkid": "5ae89ea2affa931cce38a523", "href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523" } ], "foreign_key": [ { "pkid": "5ad5b255affa9343e4d9292f", "path": "hierarchyType", "model_type": "data/HierarchyNodeType" } ], "self": [ { "href": "/api/data/HcsRoleDAT/5ae89ea6affa931cce38a6a5/", "pkid": "5ae89ea6affa931cce38a6a5" } ] }, "path": [ "6t0ggef2c0deab00hb595101", "5ad5bacbaffa9343e4d93e01", "5ae89b62affa931cce3855c4", "5ae89c0faffa931cce386c0f", "5ae89ea2affa931cce38a523", "5ae89ea6affa931cce38a6a5" ], "schema_version": "2.0", "actions": [ { "update": { "method": "PUT", "class": "update", "href": "/api/data/HcsRoleDAT/5ae89ea6affa931cce38a6a5/", "support_async": true, "title": "Modify" } }, { "remove": { "method": "DELETE", "class": "delete", "href": "/api/data/HcsRoleDAT/5ae89ea6affa931cce38a6a5/", "support_async": true, "title": "Delete" } }, { "import": { "method": "POST", "class": "import", "href": "/api/data/HcsRoleDAT/5ae89ea6affa931cce38a6a5/import/", "support_async": true, "title": "Import" } }, { "execute": { "method": "POST", "class": "execute", "href": "/api/data/HcsRoleDAT/5ae89ea6affa931cce38a6a5/execute/", "support_async": true, "title": "Execute" } }, { "get": { "method": "GET", "class": "get", "href": "/api/data/HcsRoleDAT/5ae89ea6affa931cce38a6a5/", "support_async": false, "title": "Get" } } ], "summary": "false" }, "pkid": "5ae89ea6affa931cce38a6a5" }, { "data": { "pkid": "5ae89ea7affa931cce38a6eb", "privileges": "READ_ONLY", "hcsComponentAccess": "FF_SA", "hierarchyType": "Customer", "name": "AB_GroupCustomerOperator", "hierarchy_friendly_name": "AB_Group (Customer)", "hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group" }, "meta": { "model_type": "data/HcsRoleDAT", "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "hierarchy_friendly_name", "title": "Located At", "allow_filtering": true } ], "tagged_versions": [], "tags": [], "title": "title format", "business_key": { "hierarchy": true, "unique": [ "name" ] }, "api_version": "21.2", "cached": true, "references": { "device": [ { "href": "", "pkid": "" } ], "owner": [ { "pkid": "" } ], "parent": [ { "pkid": "5ae89ea2affa931cce38a523", "href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523" } ], "foreign_key": [ { "pkid": "5ad5b255affa9343e4d9292f", "path": "hierarchyType", "model_type": "data/HierarchyNodeType" } ], "self": [ { "href": "/api/data/HcsRoleDAT/5ae89ea7affa931cce38a6e8/", "pkid": "5ae89ea7affa931cce38a6e8" } ] }, "path": [ "6t0ggef2c0deab00hb595101", "5ad5bacbaffa9343e4d93e01", "5ae89b62affa931cce3855c4", "5ae89c0faffa931cce386c0f", "5ae89ea2affa931cce38a523", "5ae89ea7affa931cce38a6e8" ], "schema_version": "2.0", "actions": [ { "update": { "method": "PUT", "class": "update", "href": "/api/data/HcsRoleDAT/5ae89ea7affa931cce38a6e8/", "support_async": true, "title": "Modify" } }, { "remove": { "method": "DELETE", "class": "delete", "href": "/api/data/HcsRoleDAT/5ae89ea7affa931cce38a6e8/", "support_async": true, "title": "Delete" } }, { "import": { "method": "POST", "class": "import", "href": "/api/data/HcsRoleDAT/5ae89ea7affa931cce38a6e8/import/", "support_async": true, "title": "Import" } }, { "execute": { "method": "POST", "class": "execute", "href": "/api/data/HcsRoleDAT/5ae89ea7affa931cce38a6e8/execute/", "support_async": true, "title": "Execute" } }, { "get": { "method": "GET", "class": "get", "href": "/api/data/HcsRoleDAT/5ae89ea7affa931cce38a6e8/", "support_async": false, "title": "Get" } } ], "summary": "false" }, "pkid": "5ae89ea7affa931cce38a6e8" }, { "data": { "pkid": "5ae89ea9affa931cce38a7a9", "privileges": "HcsRW", "hcsComponentAccess": "SS_ONLY", "hierarchyType": "Customer", "name": "AB_GroupSelfService", "hierarchy_friendly_name": "AB_Group (Customer)", "hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group" }, "meta": { "model_type": "data/HcsRoleDAT", "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "hierarchy_friendly_name", "title": "Located At", "allow_filtering": true } ], "tagged_versions": [], "tags": [], "title": "title format", "business_key": { "hierarchy": true, "unique": [ "name" ] }, "api_version": "21.2", "cached": true, "references": { "device": [ { "href": "", "pkid": "" } ], "owner": [ { "pkid": "" } ], "parent": [ { "pkid": "5ae89ea2affa931cce38a523", "href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523" } ], "foreign_key": [ { "pkid": "5ad5b255affa9343e4d9292f", "path": "hierarchyType", "model_type": "data/HierarchyNodeType" } ], "self": [ { "href": "/api/data/HcsRoleDAT/5ae89ea9affa931cce38a7a6/", "pkid": "5ae89ea9affa931cce38a7a6" } ] }, "path": [ "6t0ggef2c0deab00hb595101", "5ad5bacbaffa9343e4d93e01", "5ae89b62affa931cce3855c4", "5ae89c0faffa931cce386c0f", "5ae89ea2affa931cce38a523", "5ae89ea9affa931cce38a7a6" ], "schema_version": "2.0", "actions": [ { "update": { "method": "PUT", "class": "update", "href": "/api/data/HcsRoleDAT/5ae89ea9affa931cce38a7a6/", "support_async": true, "title": "Modify" } }, { "remove": { "method": "DELETE", "class": "delete", "href": "/api/data/HcsRoleDAT/5ae89ea9affa931cce38a7a6/", "support_async": true, "title": "Delete" } }, { "import": { "method": "POST", "class": "import", "href": "/api/data/HcsRoleDAT/5ae89ea9affa931cce38a7a6/import/", "support_async": true, "title": "Import" } }, { "execute": { "method": "POST", "class": "execute", "href": "/api/data/HcsRoleDAT/5ae89ea9affa931cce38a7a6/execute/", "support_async": true, "title": "Execute" } }, { "get": { "method": "GET", "class": "get", "href": "/api/data/HcsRoleDAT/5ae89ea9affa931cce38a7a6/", "support_async": false, "title": "Get" } } ], "summary": "false" }, "pkid": "5ae89ea9affa931cce38a7a6" } ] }
(Show the first instance)
{ "data": { "hierarchyType": "Customer", "name": "AB_GroupCustomerAdministrator", "privileges": "READ_WRITE", "hcsComponentAccess": "FF_SA", "pkid": "5ae89ea6affa931cce38a6a8" }, "meta": { "model_type": "data/HcsRoleDAT", "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "hierarchy_friendly_name", "title": "Located At", "allow_filtering": true } ], "tagged_versions": [], "tags": [], "title": "title format", "business_key": { "hierarchy": true, "unique": [ "name" ] }, "api_version": "21.2", "cached": false, "references": { "device": [ { "href": "", "pkid": "" } ], "owner": [ { "pkid": "" } ], "parent": [ { "href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523", "pkid": "5ae89ea2affa931cce38a523" } ], "foreign_key": [ { "pkid": "5ad5b255affa9343e4d9292f", "path": "hierarchyType", "model_type": "data/HierarchyNodeType" } ], "children": [], "self": [ { "href": "/api/data/HcsRoleDAT/5ae89ea6affa931cce38a6a5/", "pkid": "5ae89ea6affa931cce38a6a5" } ] }, "path": [ "6t0ggef2c0deab00hb595101", "5ad5bacbaffa9343e4d93e01", "5ae89b62affa931cce3855c4", "5ae89c0faffa931cce386c0f", "5ae89ea2affa931cce38a523", "5ae89ea6affa931cce38a6a5" ], "schema_version": "2.0", "actions": [ { "update": { "method": "PUT", "class": "update", "href": "/api/data/HcsRoleDAT/5ae89ea6affa931cce38a6a5/?hierarchy=[hierarchy]", "support_async": true, "title": "Modify" } }, { "remove": { "method": "DELETE", "class": "delete", "href": "/api/data/HcsRoleDAT/5ae89ea6affa931cce38a6a5/?hierarchy=[hierarchy]", "support_async": true, "title": "Delete" } }, { "import": { "method": "POST", "class": "import", "href": "/api/data/HcsRoleDAT/5ae89ea6affa931cce38a6a5/import/?hierarchy=[hierarchy]", "support_async": true, "title": "Import" } }, { "execute": { "method": "POST", "class": "execute", "href": "/api/data/HcsRoleDAT/5ae89ea6affa931cce38a6a5/execute/?hierarchy=[hierarchy]", "support_async": true, "title": "Execute" } }, { "get": { "method": "GET", "class": "get", "href": "/api/data/HcsRoleDAT/5ae89ea6affa931cce38a6a5/?hierarchy=[hierarchy]", "support_async": false, "title": "Get" } } ] }, "pkid": "5ae89ea6affa931cce38a6a5" }
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/data/HcsRoleDAT/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/data/HcsRoleDAT/[pkid] | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Import | POST | /api/data/HcsRoleDAT/[pkid]/import | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Execute | POST | /api/data/HcsRoleDAT/[pkid]/execute | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/data/HcsRoleDAT/[pkid] | hierarchy=[hierarchy] | The data/HcsRoleDAT instance with [pkid]. |