[Index]
A User Role is a combination of Configuration Templates and Field Display Policies that apply to all the Data-, Device- and Domain Models available in the system. When a User Role is created, a Configuration Template and Field Display Policy can be selected as defaults that apply to each available model. The User Role can also be associated with a Menu Layout, Theme and an Access Profile that specifies create, read, update and delete permissions on each model. When a user is created or updated, a User Role can be selected for the user. This means that the user will by default have the menu, relevant permissions, Configuration Template defaults and settings as well as Field Display Policy views applied when using the relevant model. More than one user can have the same User Role assigned. User Roles provide a means to manage users that are logged in on the system.
Model ref.: data/Role
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": {
"menu_layout": {
"description": "The selected Menu Layout that is associated with the Role.",
"title": "Menu Layout",
"format": "uri",
"choices": [],
"target_attr": "name",
"target_model_type": "data/MenuLayout",
"type": "string",
"target": "/api/data/MenuLayout/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"name": {
"required": true,
"type": "string",
"description": "The name that is given to the Role.",
"title": "Name"
},
"landing_page": {
"description": "Landing page for user",
"format": "uri",
"title": "Landing Page",
"required": false,
"choices": [],
"target_attr": "name",
"target_model_type": "data/LandingPage",
"type": "string",
"target": "/api/data/LandingPage/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"rules": {
"type": "object",
"properties": {
"hierarchy_types": {
"description": "Hierarchy Types that this Role can be added under.",
"title": "Permitted Hierarchy Types",
"minItems": 1,
"items": {
"target_model_type": "data/HierarchyNodeType",
"format": "uri",
"type": "string",
"target": "/api/data/HierarchyNodeType/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"required": false,
"readonly": false,
"type": "array"
}
},
"title": "Rules"
},
"interfaces": {
"items": {
"type": "object",
"properties": {
"interface_type": {
"description": "The selected interface type that is associated with the role.",
"format": "uri",
"title": "Interface Type",
"required": true,
"choices": [],
"target_attr": "name",
"target_model_type": "data/InterfaceType",
"type": "string",
"target": "/api/data/InterfaceType/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"name": {
"description": "The selected interface that is associated with the role.",
"title": "Name",
"format": "uri",
"required": true,
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
}
}
},
"type": "array",
"description": "The list of interfaces that are associated with the role.",
"title": "Custom Interfaces"
},
"selfservice_links": {
"description": "Provide useful links to Self Service end users",
"title": "Self Service Links",
"format": "uri",
"choices": [],
"target_attr": "name",
"target_model_type": "data/SelfServiceLinks",
"type": "string",
"target": "/api/data/SelfServiceLinks/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"theme": {
"description": "The selected Theme that is associated with the Role.",
"title": "Theme",
"format": "uri",
"choices": [],
"target_attr": "name",
"target_model_type": "data/Theme",
"type": "string",
"target": "/api/data/Theme/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"access_profile": {
"description": "The selected Access Profile that is associated with the Role.",
"format": "uri",
"title": "Access Profile",
"required": true,
"choices": [],
"target_attr": "name",
"target_model_type": "data/AccessProfile",
"type": "string",
"target": "/api/data/AccessProfile/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"interface": {
"choices": [
{
"value": "administration",
"title": "Administration"
},
{
"value": "selfservice",
"title": "Self Service"
},
{
"value": "none",
"title": "None"
}
],
"required": true,
"type": "string",
"description": "The selected interface that is associated with the Role. The interface can be an Administration or Self Service.",
"title": "Interface"
},
"ss_display_policy": {
"target": "/api/data/SelfServiceFeatureDisplayPolicy/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"title": "Self Service Feature Display Policy",
"format": "uri",
"choices": [],
"target_attr": "name",
"target_model_type": "data/SelfServiceFeatureDisplayPolicy",
"type": "string"
},
"description": {
"required": false,
"type": "string",
"description": "A description for the Role.",
"title": "Description"
}
},
"schema_version": "0.2.4"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/Role/add/ |
|
The GUI Add form of data/Role 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/Role/ | 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/Role/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/Role/[pkid1]", "/api/data/Role/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/Role/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/data/Role/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/data/Role/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/data/Role/[pkid1]", "/api/v0/data/Role/[pkid2]",...]}} |
GET http://[host-proxy]/api/data/Role/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/Role; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/Role/export/ |
|
{ "hrefs":["/api/data/Role/[pkid1]", "/api/data/Role/[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/Role and the JSON format can be used to import instances of data/Role.
GET http://[host-proxy]/api/data/Role/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for data/Role | POST | /api/data/Role/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/Role/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/data/Role/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Migration Template | GET | /api/data/Role/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/Role/ |
|
The data/Role schema and all instances as JSON. |
(The list will return 0 to 3 data/Role 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/Role/?skip=0&limit=3&order_by=name&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 157
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"schema_version": "0.2.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/Role/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/Role/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/data/Role/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/Role/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/Role/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/data/Role/+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/Role/+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/Role/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/data/Role/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"migration": {
"support_async": false,
"class": "migration",
"href": "/api/data/Role/migration/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Migration Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/data/Role/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/Role/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/Role",
"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"
},
{
"name": "menu_layout",
"title": "Menu Layout"
},
{
"name": "theme",
"title": "Theme"
},
{
"name": "access_profile",
"title": "Access Profile"
},
{
"name": "landing_page",
"title": "Landing Page"
},
{
"name": "selfservice_links",
"title": "Self Service Links"
},
{
"name": "ss_display_policy",
"title": "Self Service Feature Display Policy"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": [
{
"pkid": "63054c52c46e74b4687bca56",
"meta": {
"tags": [],
"cached": true,
"title": "AAAGlobalCustomerAdministrator",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"schema_version": "0.2.4",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "63054c52c46e74b4687bca56",
"href": "/api/data/Role/63054c52c46e74b4687bca56/"
}
],
"parent": [
{
"pkid": "63054c4fc46e74b4687bc91b",
"href": "/api/data/HierarchyNode/63054c4fc46e74b4687bc91b"
}
],
"foreign_key": [
{
"pkid": "63050c3f43fcc416f18ee8a3",
"path": "menu_layout",
"model_type": "data/MenuLayout"
},
{
"pkid": "630507f543fcc416f18e98b0",
"path": "theme",
"model_type": "data/Theme"
},
{
"pkid": "63050c0843fcc416f18ee427",
"path": "access_profile",
"model_type": "data/AccessProfile"
},
{
"pkid": "63050c3b43fcc416f18ee85a",
"path": "landing_page",
"model_type": "data/LandingPage"
},
{
"pkid": "6304f7814efbec3d13c62788",
"path": "interfaces.0.interface_type",
"model_type": "data/InterfaceType"
},
{
"pkid": "6305140f43fcc416f18f7da0",
"path": "interfaces.0.name",
"model_type": "data/InterfaceBusinessAdminPortal"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/Role/63054c52c46e74b4687bca56/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/Role/63054c52c46e74b4687bca56/",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/data/Role/63054c52c46e74b4687bca56/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/Role/63054c52c46e74b4687bca56/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/data/Role/63054c52c46e74b4687bca56/+tag/",
"class": "tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/data/Role/63054c52c46e74b4687bca56/+tag_version/",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/Role/63054c52c46e74b4687bca56/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/Role/63054c52c46e74b4687bca56/help",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/Role",
"path": [
"6t0ggef2c0deab00hb595101",
"6305086243fcc416f18ea4ac",
"63054bfdc46e74b4687bb868",
"63054c3bc46e74b4687bc61b",
"63054c4fc46e74b4687bc91b",
"63054c52c46e74b4687bca56"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "menu_layout",
"title": "Menu Layout"
},
{
"name": "theme",
"title": "Theme"
},
{
"name": "access_profile",
"title": "Access Profile"
},
{
"name": "landing_page",
"title": "Landing Page"
},
{
"name": "selfservice_links",
"title": "Self Service Links"
},
{
"name": "ss_display_policy",
"title": "Self Service Feature Display Policy"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"menu_layout": "HcsCustomerMenu",
"name": "AAAGlobalCustomerAdministrator",
"landing_page": "HcsCustomerLP",
"pkid": "63054c52c46e74b4687bca5e",
"interfaces": [
{
"interface_type": "InterfaceBusinessAdminPortal",
"name": "Disabled"
}
],
"description": "HCS Customer Administrator Role Service Assurance and Fulfillment Access ",
"selfservice_links": "",
"theme": "default",
"access_profile": "HcsCustomerAdminAP",
"interface": "administration",
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
},
{
"pkid": "63054c53c46e74b4687bca91",
"meta": {
"tags": [],
"cached": true,
"title": "AAAGlobalCustomerOperator",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"schema_version": "0.2.4",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "63054c53c46e74b4687bca91",
"href": "/api/data/Role/63054c53c46e74b4687bca91/"
}
],
"parent": [
{
"pkid": "63054c4fc46e74b4687bc91b",
"href": "/api/data/HierarchyNode/63054c4fc46e74b4687bc91b"
}
],
"foreign_key": [
{
"pkid": "63050c4043fcc416f18ee8c6",
"path": "menu_layout",
"model_type": "data/MenuLayout"
},
{
"pkid": "630507f543fcc416f18e98b0",
"path": "theme",
"model_type": "data/Theme"
},
{
"pkid": "63050c0843fcc416f18ee415",
"path": "access_profile",
"model_type": "data/AccessProfile"
},
{
"pkid": "63050c3b43fcc416f18ee85a",
"path": "landing_page",
"model_type": "data/LandingPage"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/data/Role/63054c53c46e74b4687bca91/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"remove": {
"support_async": true,
"href": "/api/data/Role/63054c53c46e74b4687bca91/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"clone": {
"support_async": false,
"href": "/api/data/Role/63054c53c46e74b4687bca91/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/Role/63054c53c46e74b4687bca91/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"class": "tag",
"href": "/api/data/Role/63054c53c46e74b4687bca91/+tag/",
"method": "PATCH",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"class": "tag_version",
"href": "/api/data/Role/63054c53c46e74b4687bca91/+tag_version/",
"method": "PATCH",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/data/Role/63054c53c46e74b4687bca91/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/data/Role/63054c53c46e74b4687bca91/help",
"title": "Help",
"class": "help",
"method": "GET"
}
}
],
"model_type": "data/Role",
"path": [
"6t0ggef2c0deab00hb595101",
"6305086243fcc416f18ea4ac",
"63054bfdc46e74b4687bb868",
"63054c3bc46e74b4687bc61b",
"63054c4fc46e74b4687bc91b",
"63054c53c46e74b4687bca91"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "menu_layout",
"title": "Menu Layout"
},
{
"name": "theme",
"title": "Theme"
},
{
"name": "access_profile",
"title": "Access Profile"
},
{
"name": "landing_page",
"title": "Landing Page"
},
{
"name": "selfservice_links",
"title": "Self Service Links"
},
{
"name": "ss_display_policy",
"title": "Self Service Feature Display Policy"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"menu_layout": "HcsCustomerOperatorMenu",
"name": "AAAGlobalCustomerOperator",
"landing_page": "HcsCustomerLP",
"pkid": "63054c53c46e74b4687bca99",
"description": "HCS Customer Operator Role Service Assurance and Fulfillment Access ",
"theme": "default",
"access_profile": "HcsCustomerOperAP",
"interface": "administration",
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
},
{
"pkid": "63054c54c46e74b4687bcacc",
"meta": {
"tags": [],
"cached": true,
"title": "AAAGlobalENTCustomerAdministrator",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"schema_version": "0.2.4",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "63054c54c46e74b4687bcacc",
"href": "/api/data/Role/63054c54c46e74b4687bcacc/"
}
],
"parent": [
{
"pkid": "63054c4fc46e74b4687bc91b",
"href": "/api/data/HierarchyNode/63054c4fc46e74b4687bc91b"
}
],
"foreign_key": [
{
"pkid": "630516b143fcc416f18fc158",
"path": "menu_layout",
"model_type": "data/MenuLayout"
},
{
"pkid": "630507f543fcc416f18e98b0",
"path": "theme",
"model_type": "data/Theme"
},
{
"pkid": "6305169c43fcc416f18fbe93",
"path": "access_profile",
"model_type": "data/AccessProfile"
},
{
"pkid": "630516a343fcc416f18fbf1a",
"path": "landing_page",
"model_type": "data/LandingPage"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/data/Role/63054c54c46e74b4687bcacc/",
"class": "update",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"method": "DELETE",
"href": "/api/data/Role/63054c54c46e74b4687bcacc/",
"class": "delete",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/data/Role/63054c54c46e74b4687bcacc/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/data/Role/63054c54c46e74b4687bcacc/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"class": "tag",
"href": "/api/data/Role/63054c54c46e74b4687bcacc/+tag/",
"method": "PATCH",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"class": "tag_version",
"href": "/api/data/Role/63054c54c46e74b4687bcacc/+tag_version/",
"method": "PATCH",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/data/Role/63054c54c46e74b4687bcacc/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/data/Role/63054c54c46e74b4687bcacc/help",
"class": "help",
"title": "Help"
}
}
],
"model_type": "data/Role",
"path": [
"6t0ggef2c0deab00hb595101",
"6305086243fcc416f18ea4ac",
"63054bfdc46e74b4687bb868",
"63054c3bc46e74b4687bc61b",
"63054c4fc46e74b4687bc91b",
"63054c54c46e74b4687bcacc"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "menu_layout",
"title": "Menu Layout"
},
{
"name": "theme",
"title": "Theme"
},
{
"name": "access_profile",
"title": "Access Profile"
},
{
"name": "landing_page",
"title": "Landing Page"
},
{
"name": "selfservice_links",
"title": "Self Service Links"
},
{
"name": "ss_display_policy",
"title": "Self Service Feature Display Policy"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"menu_layout": "ENTCustomerMenu",
"name": "AAAGlobalENTCustomerAdministrator",
"landing_page": "ENTCustomerLP",
"pkid": "63054c54c46e74b4687bcad4",
"description": "Enterprise Customer Administrator Role Service Assurance and Fulfillment Access ",
"theme": "default",
"access_profile": "ENTCustomerAdminAP",
"interface": "administration",
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
}
]
}
(Show the first instance)
{
"pkid": "63054c52c46e74b4687bca56",
"meta": {
"tags": [],
"cached": false,
"title": "AAAGlobalCustomerAdministrator",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"schema_version": "0.2.4",
"references": {
"parent": [
{
"pkid": "63054c4fc46e74b4687bc91b",
"href": "/api/data/HierarchyNode/63054c4fc46e74b4687bc91b"
}
],
"self": [
{
"pkid": "63054c52c46e74b4687bca56",
"href": "/api/data/Role/63054c52c46e74b4687bca56/"
}
],
"foreign_key": [
{
"pkid": "63050c3f43fcc416f18ee8a3",
"path": "menu_layout",
"model_type": "data/MenuLayout"
},
{
"pkid": "630507f543fcc416f18e98b0",
"path": "theme",
"model_type": "data/Theme"
},
{
"pkid": "63050c0843fcc416f18ee427",
"path": "access_profile",
"model_type": "data/AccessProfile"
},
{
"pkid": "63050c3b43fcc416f18ee85a",
"path": "landing_page",
"model_type": "data/LandingPage"
},
{
"pkid": "6304f7814efbec3d13c62788",
"path": "interfaces.0.interface_type",
"model_type": "data/InterfaceType"
}
],
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/Role/63054c52c46e74b4687bca56/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/Role/63054c52c46e74b4687bca56/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/data/Role/63054c52c46e74b4687bca56/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/Role/63054c52c46e74b4687bca56/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/data/Role/63054c52c46e74b4687bca56/+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/Role/63054c52c46e74b4687bca56/+tag_version/?hierarchy=[hierarchy]",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/Role/63054c52c46e74b4687bca56/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/Role/63054c52c46e74b4687bca56/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/Role",
"path": [
"6t0ggef2c0deab00hb595101",
"6305086243fcc416f18ea4ac",
"63054bfdc46e74b4687bb868",
"63054c3bc46e74b4687bc61b",
"63054c4fc46e74b4687bc91b",
"63054c52c46e74b4687bca56"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "menu_layout",
"title": "Menu Layout"
},
{
"name": "theme",
"title": "Theme"
},
{
"name": "access_profile",
"title": "Access Profile"
},
{
"name": "landing_page",
"title": "Landing Page"
},
{
"name": "selfservice_links",
"title": "Self Service Links"
},
{
"name": "ss_display_policy",
"title": "Self Service Feature Display Policy"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"menu_layout": "HcsCustomerMenu",
"name": "AAAGlobalCustomerAdministrator",
"landing_page": "HcsCustomerLP",
"pkid": "63054c52c46e74b4687bca5e",
"interfaces": [
{
"interface_type": "InterfaceBusinessAdminPortal",
"name": "Disabled"
}
],
"selfservice_links": "",
"theme": "default",
"access_profile": "HcsCustomerAdminAP",
"interface": "administration",
"description": "HCS Customer Administrator Role Service Assurance and Fulfillment Access "
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/Role. | GET | /api/data/Role/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/Role as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/Role/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/Role/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/Role/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/Role/?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/Role; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/Role/[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/Role and the JSON format can be used to import instances of data/Role.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/data/Role/[pkid]/+tag/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/Role/[pkid]/ | hierarchy=[hierarchy] | The data/Role instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/Role/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/Role. |