[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": {
"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"
},
"hierarchyType": {
"is_password": false,
"target": "/api/data/HierarchyNodeType/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Hierarchy Type",
"required": true,
"displayable": false,
"choices": [],
"target_attr": "name",
"readonly": false,
"maxLength": 1024,
"target_model_type": "data/HierarchyNodeType",
"type": "string"
},
"name": {
"is_password": false,
"title": "Name",
"required": true,
"displayable": true,
"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)
{
"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": "name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/data/HcsRoleDAT/?skip=0&limit=3&order_by=name&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 127
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"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/HcsRoleDAT/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/HcsRoleDAT/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/data/HcsRoleDAT/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
}
],
"model_type": "data/HcsRoleDAT",
"model_specific_actions": [
"list",
"get",
"add",
"update",
"remove",
"import",
"execute"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "20.1.1",
"tagged_versions": []
},
"resources": [
{
"pkid": "5fff565bce894e0015505b05",
"meta": {
"tags": [],
"cached": true,
"title": "title format",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"schema_version": "2.0",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5fff565bce894e0015505b05",
"href": "/api/data/HcsRoleDAT/5fff565bce894e0015505b05/"
}
],
"parent": [
{
"pkid": "5fff5657ce894e001550592f",
"href": "/api/data/HierarchyNode/5fff5657ce894e001550592f"
}
],
"foreign_key": [
{
"pkid": "5fff2414ce894e0015f6c769",
"path": "hierarchyType",
"model_type": "data/HierarchyNodeType"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/HcsRoleDAT/5fff565bce894e0015505b05/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/HcsRoleDAT/5fff565bce894e0015505b05/",
"method": "DELETE",
"title": "Delete"
}
},
{
"import": {
"support_async": true,
"method": "POST",
"href": "/api/data/HcsRoleDAT/5fff565bce894e0015505b05/import/",
"class": "import",
"title": "Import"
}
},
{
"execute": {
"support_async": true,
"class": "execute",
"href": "/api/data/HcsRoleDAT/5fff565bce894e0015505b05/execute/",
"method": "POST",
"title": "Execute"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/HcsRoleDAT/5fff565bce894e0015505b05/",
"method": "GET",
"title": "Get"
}
}
],
"model_type": "data/HcsRoleDAT",
"path": [
"6t0ggef2c0deab00hb595101",
"5fff24a2ce894e0015f6de4e",
"5fff560ace894e001550455c",
"5fff5649ce894e001550558f",
"5fff5657ce894e001550592f",
"5fff565bce894e0015505b05"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "20.1.1",
"tagged_versions": []
},
"data": {
"hierarchyType": "Customer",
"name": "AAAGlobalCustomerAdministrator",
"pkid": "5fff565bce894e0015505b09",
"privileges": "READ_WRITE",
"hcsComponentAccess": "FF_SA",
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
},
{
"pkid": "5fff565ace894e0015505abd",
"meta": {
"tags": [],
"cached": true,
"title": "title format",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"schema_version": "2.0",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5fff565ace894e0015505abd",
"href": "/api/data/HcsRoleDAT/5fff565ace894e0015505abd/"
}
],
"parent": [
{
"pkid": "5fff5657ce894e001550592f",
"href": "/api/data/HierarchyNode/5fff5657ce894e001550592f"
}
],
"foreign_key": [
{
"pkid": "5fff2414ce894e0015f6c769",
"path": "hierarchyType",
"model_type": "data/HierarchyNodeType"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/data/HcsRoleDAT/5fff565ace894e0015505abd/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"remove": {
"support_async": true,
"href": "/api/data/HcsRoleDAT/5fff565ace894e0015505abd/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"import": {
"support_async": true,
"href": "/api/data/HcsRoleDAT/5fff565ace894e0015505abd/import/",
"title": "Import",
"method": "POST",
"class": "import"
}
},
{
"execute": {
"support_async": true,
"href": "/api/data/HcsRoleDAT/5fff565ace894e0015505abd/execute/",
"title": "Execute",
"class": "execute",
"method": "POST"
}
},
{
"get": {
"support_async": false,
"href": "/api/data/HcsRoleDAT/5fff565ace894e0015505abd/",
"title": "Get",
"class": "get",
"method": "GET"
}
}
],
"model_type": "data/HcsRoleDAT",
"path": [
"6t0ggef2c0deab00hb595101",
"5fff24a2ce894e0015f6de4e",
"5fff560ace894e001550455c",
"5fff5649ce894e001550558f",
"5fff5657ce894e001550592f",
"5fff565ace894e0015505abd"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "20.1.1",
"tagged_versions": []
},
"data": {
"hierarchyType": "Customer",
"name": "AAAGlobalCustomerOperator",
"pkid": "5fff565ace894e0015505ac1",
"privileges": "READ_ONLY",
"hcsComponentAccess": "FF_SA",
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
},
{
"pkid": "5fff565cce894e0015505b4d",
"meta": {
"tags": [],
"cached": true,
"title": "title format",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"schema_version": "2.0",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5fff565cce894e0015505b4d",
"href": "/api/data/HcsRoleDAT/5fff565cce894e0015505b4d/"
}
],
"parent": [
{
"pkid": "5fff5657ce894e001550592f",
"href": "/api/data/HierarchyNode/5fff5657ce894e001550592f"
}
],
"foreign_key": [
{
"pkid": "5fff2414ce894e0015f6c769",
"path": "hierarchyType",
"model_type": "data/HierarchyNodeType"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/data/HcsRoleDAT/5fff565cce894e0015505b4d/",
"class": "update",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"method": "DELETE",
"href": "/api/data/HcsRoleDAT/5fff565cce894e0015505b4d/",
"class": "delete",
"title": "Delete"
}
},
{
"import": {
"support_async": true,
"class": "import",
"href": "/api/data/HcsRoleDAT/5fff565cce894e0015505b4d/import/",
"method": "POST",
"title": "Import"
}
},
{
"execute": {
"support_async": true,
"method": "POST",
"href": "/api/data/HcsRoleDAT/5fff565cce894e0015505b4d/execute/",
"class": "execute",
"title": "Execute"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/data/HcsRoleDAT/5fff565cce894e0015505b4d/",
"class": "get",
"title": "Get"
}
}
],
"model_type": "data/HcsRoleDAT",
"path": [
"6t0ggef2c0deab00hb595101",
"5fff24a2ce894e0015f6de4e",
"5fff560ace894e001550455c",
"5fff5649ce894e001550558f",
"5fff5657ce894e001550592f",
"5fff565cce894e0015505b4d"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "20.1.1",
"tagged_versions": []
},
"data": {
"hierarchyType": "Customer",
"name": "AAAGlobalENTCustomerAdministrator",
"pkid": "5fff565cce894e0015505b51",
"privileges": "READ_WRITE",
"hcsComponentAccess": "FF_SA",
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
}
]
}
(Show the first instance)
{
"pkid": "5fff565bce894e0015505b05",
"meta": {
"tags": [],
"cached": false,
"title": "title format",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"schema_version": "2.0",
"references": {
"parent": [
{
"pkid": "5fff5657ce894e001550592f",
"href": "/api/data/HierarchyNode/5fff5657ce894e001550592f"
}
],
"self": [
{
"pkid": "5fff565bce894e0015505b05",
"href": "/api/data/HcsRoleDAT/5fff565bce894e0015505b05/"
}
],
"foreign_key": [
{
"pkid": "5fff2414ce894e0015f6c769",
"path": "hierarchyType",
"model_type": "data/HierarchyNodeType"
}
],
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/HcsRoleDAT/5fff565bce894e0015505b05/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/HcsRoleDAT/5fff565bce894e0015505b05/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"import": {
"support_async": true,
"method": "POST",
"href": "/api/data/HcsRoleDAT/5fff565bce894e0015505b05/import/?hierarchy=[hierarchy]",
"class": "import",
"title": "Import"
}
},
{
"execute": {
"support_async": true,
"class": "execute",
"href": "/api/data/HcsRoleDAT/5fff565bce894e0015505b05/execute/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Execute"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/HcsRoleDAT/5fff565bce894e0015505b05/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
}
],
"model_type": "data/HcsRoleDAT",
"path": [
"6t0ggef2c0deab00hb595101",
"5fff24a2ce894e0015f6de4e",
"5fff560ace894e001550455c",
"5fff5649ce894e001550558f",
"5fff5657ce894e001550592f",
"5fff565bce894e0015505b05"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "20.1.1",
"tagged_versions": []
},
"data": {
"pkid": "5fff565bce894e0015505b09",
"privileges": "READ_WRITE",
"hcsComponentAccess": "FF_SA",
"hierarchyType": "Customer",
"name": "AAAGlobalCustomerAdministrator"
}
}
| 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]. |