[Index]
Model ref.: relation/HcsRoleREL
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": {
"role": {
"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",
"title": "Landing Page",
"format": "uri",
"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",
"choices": [],
"type": "string",
"target": "/api/data/HierarchyNodeType/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri"
},
"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.",
"title": "Interface Type",
"format": "uri",
"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": {
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"title": "Name",
"format": "uri",
"required": true,
"choices": [],
"type": "string",
"description": "The selected interface that is associated with the role."
}
}
},
"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.",
"title": "Access Profile",
"format": "uri",
"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"
}
},
"title": "Role"
},
"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_model_type": "data/HierarchyNodeType",
"target": "/api/data/HierarchyNodeType/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": true,
"displayable": false,
"choices": [],
"target_attr": "name",
"readonly": false,
"maxLength": 1024,
"title": "Hierarchy Type",
"type": "string"
},
"name": {
"is_password": false,
"title": "Name",
"required": true,
"displayable": true,
"readonly": false,
"maxLength": 1024,
"type": "string"
}
},
"schema_version": "2.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/HcsRoleREL/add/ |
|
The GUI Add form of relation/HcsRoleREL 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/relation/HcsRoleREL/ | 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/relation/HcsRoleREL/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/HcsRoleREL/[pkid1]", "/api/relation/HcsRoleREL/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/HcsRoleREL/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/HcsRoleREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/HcsRoleREL/export/ |
|
{ "hrefs":["/api/relation/HcsRoleREL/[pkid1]", "/api/relation/HcsRoleREL/[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 relation/HcsRoleREL and the JSON format can be used to import instances of relation/HcsRoleREL.
GET http://[host-proxy]/api/relation/HcsRoleREL/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/HcsRoleREL | POST | /api/relation/HcsRoleREL/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/HcsRoleREL/ |
|
The relation/HcsRoleREL schema and all instances as JSON. |
(The list will return 0 to 3 relation/HcsRoleREL instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"clone",
"list",
"update",
"remove",
"add",
"bulk_update",
"export",
"export_bulkload_template"
],
"pagination": {
"direction": "asc",
"order_by": "name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/relation/HcsRoleREL/?skip=0&limit=3&order_by=name&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 152
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "2.1",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"self": [
{
"pkid": null,
"href": "/api/relation/HcsRoleREL/None/"
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/relation/HcsRoleREL/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/HcsRoleREL/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsRoleREL/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/relation/HcsRoleREL/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/relation/HcsRoleREL/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/HcsRoleREL/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/HcsRoleREL",
"model_specific_actions": [
"help",
"get",
"clone",
"list",
"update",
"remove",
"add",
"export",
"export_bulkload_template"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": [
{
"pkid": "63054c53c46e74b4687bca6b",
"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": "63054c53c46e74b4687bca6b",
"href": "/api/relation/HcsRoleREL/63054c53c46e74b4687bca6b/"
}
],
"parent": [
{
"pkid": "63054c4fc46e74b4687bc91b",
"href": "/api/data/HierarchyNode/63054c4fc46e74b4687bc91b"
}
],
"foreign_key": [
{
"pkid": "6305076443fcc416f18e9159",
"path": "hierarchyType",
"model_type": "data/HierarchyNodeType"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/relation/HcsRoleREL/63054c53c46e74b4687bca6b/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/HcsRoleREL/63054c53c46e74b4687bca6b/",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/relation/HcsRoleREL/63054c53c46e74b4687bca6b/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsRoleREL/63054c53c46e74b4687bca6b/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/relation/HcsRoleREL/63054c53c46e74b4687bca6b/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/HcsRoleREL/63054c53c46e74b4687bca6b/help",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/HcsRoleREL",
"path": [
"6t0ggef2c0deab00hb595101",
"6305086243fcc416f18ea4ac",
"63054bfdc46e74b4687bb868",
"63054c3bc46e74b4687bc61b",
"63054c4fc46e74b4687bc91b",
"63054c53c46e74b4687bca6b"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"hierarchyType": "Customer",
"name": "AAAGlobalCustomerAdministrator",
"pkid": "63054c53c46e74b4687bca6d",
"privileges": "READ_WRITE",
"hcsComponentAccess": "FF_SA",
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
},
{
"pkid": "63054c53c46e74b4687bcaa6",
"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": "63054c53c46e74b4687bcaa6",
"href": "/api/relation/HcsRoleREL/63054c53c46e74b4687bcaa6/"
}
],
"parent": [
{
"pkid": "63054c4fc46e74b4687bc91b",
"href": "/api/data/HierarchyNode/63054c4fc46e74b4687bc91b"
}
],
"foreign_key": [
{
"pkid": "6305076443fcc416f18e9159",
"path": "hierarchyType",
"model_type": "data/HierarchyNodeType"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/relation/HcsRoleREL/63054c53c46e74b4687bcaa6/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"remove": {
"support_async": true,
"href": "/api/relation/HcsRoleREL/63054c53c46e74b4687bcaa6/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"clone": {
"support_async": false,
"href": "/api/relation/HcsRoleREL/63054c53c46e74b4687bcaa6/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsRoleREL/63054c53c46e74b4687bcaa6/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/relation/HcsRoleREL/63054c53c46e74b4687bcaa6/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/relation/HcsRoleREL/63054c53c46e74b4687bcaa6/help",
"title": "Help",
"class": "help",
"method": "GET"
}
}
],
"model_type": "relation/HcsRoleREL",
"path": [
"6t0ggef2c0deab00hb595101",
"6305086243fcc416f18ea4ac",
"63054bfdc46e74b4687bb868",
"63054c3bc46e74b4687bc61b",
"63054c4fc46e74b4687bc91b",
"63054c53c46e74b4687bcaa6"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"hierarchyType": "Customer",
"name": "AAAGlobalCustomerOperator",
"pkid": "63054c53c46e74b4687bcaa8",
"privileges": "READ_ONLY",
"hcsComponentAccess": "FF_SA",
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
},
{
"pkid": "63054c54c46e74b4687bcae1",
"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": "63054c54c46e74b4687bcae1",
"href": "/api/relation/HcsRoleREL/63054c54c46e74b4687bcae1/"
}
],
"parent": [
{
"pkid": "63054c4fc46e74b4687bc91b",
"href": "/api/data/HierarchyNode/63054c4fc46e74b4687bc91b"
}
],
"foreign_key": [
{
"pkid": "6305076443fcc416f18e9159",
"path": "hierarchyType",
"model_type": "data/HierarchyNodeType"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/relation/HcsRoleREL/63054c54c46e74b4687bcae1/",
"class": "update",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"method": "DELETE",
"href": "/api/relation/HcsRoleREL/63054c54c46e74b4687bcae1/",
"class": "delete",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/relation/HcsRoleREL/63054c54c46e74b4687bcae1/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/relation/HcsRoleREL/63054c54c46e74b4687bcae1/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/relation/HcsRoleREL/63054c54c46e74b4687bcae1/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/relation/HcsRoleREL/63054c54c46e74b4687bcae1/help",
"class": "help",
"title": "Help"
}
}
],
"model_type": "relation/HcsRoleREL",
"path": [
"6t0ggef2c0deab00hb595101",
"6305086243fcc416f18ea4ac",
"63054bfdc46e74b4687bb868",
"63054c3bc46e74b4687bc61b",
"63054c4fc46e74b4687bc91b",
"63054c54c46e74b4687bcae1"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"hierarchyType": "Customer",
"name": "AAAGlobalENTCustomerAdministrator",
"pkid": "63054c54c46e74b4687bcae3",
"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": "63054c53c46e74b4687bca6b",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "AAAGlobalCustomerAdministrator",
"business_key": {},
"schema_version": "2.1",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"self": [
{
"pkid": "63054c53c46e74b4687bca6b",
"href": "/api/relation/HcsRoleREL/63054c53c46e74b4687bca6b/"
}
],
"children": [],
"parent": [
{
"pkid": "63054c4fc46e74b4687bc91b",
"href": "/api/data/HierarchyNode/63054c4fc46e74b4687bc91b"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/relation/HcsRoleREL/63054c53c46e74b4687bca6b/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/HcsRoleREL/63054c53c46e74b4687bca6b/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/relation/HcsRoleREL/63054c53c46e74b4687bca6b/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsRoleREL/63054c53c46e74b4687bca6b/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/relation/HcsRoleREL/63054c53c46e74b4687bca6b/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/HcsRoleREL/63054c53c46e74b4687bca6b/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/HcsRoleREL",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"role": {
"menu_layout": "HcsCustomerMenu",
"name": "AAAGlobalCustomerAdministrator",
"landing_page": "HcsCustomerLP",
"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 "
},
"privileges": "READ_WRITE",
"hcsComponentAccess": "FF_SA",
"hierarchyType": "Customer",
"name": "AAAGlobalCustomerAdministrator"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/HcsRoleREL. | GET | /api/relation/HcsRoleREL/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/HcsRoleREL as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/HcsRoleREL/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/HcsRoleREL/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/relation/HcsRoleREL/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/relation/HcsRoleREL/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of relation/HcsRoleREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/HcsRoleREL/[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 relation/HcsRoleREL and the JSON format can be used to import instances of relation/HcsRoleREL.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/HcsRoleREL/[pkid]/ | hierarchy=[hierarchy] | The relation/HcsRoleREL instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/HcsRoleREL/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/HcsRoleREL. |