[Index]
Model ref.: relation/HcsHierarchyNodeREL
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": {
"node_type": {
"is_password": false,
"description": "A type label for this node which refers to a Hierarchy Node Type.",
"title": "Hierarchy node type",
"items": {
"is_password": false
},
"format": "uri",
"required": false,
"target_attr": "name",
"readonly": false,
"target_model_type": "data/HierarchyNodeType",
"choices": [],
"type": "string",
"target": "/api/data/HierarchyNodeType/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"shadow": {
"items": {
"type": "object",
"properties": {
"name": {
"is_password": false,
"title": "Name",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"type": "array",
"maxItems": 1,
"title": "Shadow"
},
"name": {
"pattern": "^([A-Za-z0-9_\\-][A-Za-z0-9_\\ -]*[A-Za-z0-9_\\-]|[A-Za-z0-9_\\-])$",
"required": true,
"type": "string",
"description": "The name by which this hierarchy node will be known.",
"title": "Name"
},
"description": {
"type": "string",
"description": "A general description for the hierarchy node.",
"title": "Description"
}
},
"schema_version": "2.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/HcsHierarchyNodeREL/add/ |
|
The GUI Add form of relation/HcsHierarchyNodeREL 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/HcsHierarchyNodeREL/ | 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/HcsHierarchyNodeREL/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/HcsHierarchyNodeREL/[pkid1]", "/api/relation/HcsHierarchyNodeREL/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/HcsHierarchyNodeREL/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/HcsHierarchyNodeREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/HcsHierarchyNodeREL/export/ |
|
{ "hrefs":["/api/relation/HcsHierarchyNodeREL/[pkid1]", "/api/relation/HcsHierarchyNodeREL/[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/HcsHierarchyNodeREL and the JSON format can be used to import instances of relation/HcsHierarchyNodeREL.
GET http://[host-proxy]/api/relation/HcsHierarchyNodeREL/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/HcsHierarchyNodeREL | POST | /api/relation/HcsHierarchyNodeREL/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/HcsHierarchyNodeREL/ |
|
The relation/HcsHierarchyNodeREL schema and all instances as JSON. |
(The list will return 0 to 3 relation/HcsHierarchyNodeREL instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"add",
"bulk_update",
"export"
],
"pagination": {
"direction": "asc",
"order_by": "name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/relation/HcsHierarchyNodeREL/?skip=0&limit=3&order_by=name&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 24
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "2.1",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"self": [
{
"pkid": null,
"href": "/api/relation/HcsHierarchyNodeREL/None/"
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/relation/HcsHierarchyNodeREL/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/HcsHierarchyNodeREL/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsHierarchyNodeREL/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/HcsHierarchyNodeREL/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/relation/HcsHierarchyNodeREL/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/HcsHierarchyNodeREL/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/HcsHierarchyNodeREL",
"model_specific_actions": [
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"add",
"export"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "node_type",
"title": "Hierarchy node type"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": [
{
"pkid": "6109c040e04a4a00149d61cf",
"meta": {
"tags": [],
"cached": true,
"title": "AAAGlobal",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"schema_version": "0.1",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "6109c040e04a4a00149d61cf",
"href": "/api/relation/HcsHierarchyNodeREL/6109c040e04a4a00149d61cf/"
}
],
"parent": [
{
"pkid": "6109c032e04a4a00149d5e4d",
"href": "/api/data/HierarchyNode/6109c032e04a4a00149d5e4d"
}
],
"foreign_key": [
{
"pkid": "61096fd4e04a4a0015019b10",
"path": "node_type",
"model_type": "data/HierarchyNodeType"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/relation/HcsHierarchyNodeREL/6109c040e04a4a00149d61cf/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/HcsHierarchyNodeREL/6109c040e04a4a00149d61cf/",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsHierarchyNodeREL/6109c040e04a4a00149d61cf/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/relation/HcsHierarchyNodeREL/6109c040e04a4a00149d61cf/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/HcsHierarchyNodeREL/6109c040e04a4a00149d61cf/help",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/HcsHierarchyNodeREL",
"path": [
"6t0ggef2c0deab00hb595101",
"61097058e04a4a001501b18c",
"6109bff5e04a4a00149d4e1d",
"6109c032e04a4a00149d5e4d",
"6109c040e04a4a00149d61cf"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "node_type",
"title": "Hierarchy node type"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"description": "AAAGlobal Description",
"pkid": "6109c040e04a4a00149d61d3",
"node_type": "Customer",
"hierarchy_friendly_name": "CS-NB (Reseller)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB",
"name": "AAAGlobal"
}
},
{
"pkid": "610a2204e04a4a0014a899b9",
"meta": {
"tags": [],
"cached": true,
"title": "AutoPushSite",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"schema_version": "0.1",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "610a2204e04a4a0014a899b9",
"href": "/api/relation/HcsHierarchyNodeREL/610a2204e04a4a0014a899b9/"
}
],
"parent": [
{
"pkid": "6109c040e04a4a00149d61cf",
"href": "/api/data/HierarchyNode/6109c040e04a4a00149d61cf"
}
],
"foreign_key": [
{
"pkid": "61096fd4e04a4a0015019b02",
"path": "node_type",
"model_type": "data/HierarchyNodeType"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/relation/HcsHierarchyNodeREL/610a2204e04a4a0014a899b9/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"remove": {
"support_async": true,
"href": "/api/relation/HcsHierarchyNodeREL/610a2204e04a4a0014a899b9/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsHierarchyNodeREL/610a2204e04a4a0014a899b9/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/relation/HcsHierarchyNodeREL/610a2204e04a4a0014a899b9/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/relation/HcsHierarchyNodeREL/610a2204e04a4a0014a899b9/help",
"title": "Help",
"class": "help",
"method": "GET"
}
}
],
"model_type": "relation/HcsHierarchyNodeREL",
"path": [
"6t0ggef2c0deab00hb595101",
"61097058e04a4a001501b18c",
"6109bff5e04a4a00149d4e1d",
"6109c032e04a4a00149d5e4d",
"6109c040e04a4a00149d61cf",
"610a2204e04a4a0014a899b9"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "node_type",
"title": "Hierarchy node type"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"description": "Site part of automation for EKB-4343",
"pkid": "610a2204e04a4a0014a899bd",
"node_type": "Site",
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal",
"name": "AutoPushSite"
}
},
{
"pkid": "6109c032e04a4a00149d5e4d",
"meta": {
"tags": [],
"cached": true,
"title": "CS-NB",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"schema_version": "0.1",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "6109c032e04a4a00149d5e4d",
"href": "/api/relation/HcsHierarchyNodeREL/6109c032e04a4a00149d5e4d/"
}
],
"parent": [
{
"pkid": "6109bff5e04a4a00149d4e1d",
"href": "/api/data/HierarchyNode/6109bff5e04a4a00149d4e1d"
}
],
"foreign_key": [
{
"pkid": "6109706fe04a4a001501b468",
"path": "node_type",
"model_type": "data/HierarchyNodeType"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/relation/HcsHierarchyNodeREL/6109c032e04a4a00149d5e4d/",
"class": "update",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"method": "DELETE",
"href": "/api/relation/HcsHierarchyNodeREL/6109c032e04a4a00149d5e4d/",
"class": "delete",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/relation/HcsHierarchyNodeREL/6109c032e04a4a00149d5e4d/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/relation/HcsHierarchyNodeREL/6109c032e04a4a00149d5e4d/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/relation/HcsHierarchyNodeREL/6109c032e04a4a00149d5e4d/help",
"class": "help",
"title": "Help"
}
}
],
"model_type": "relation/HcsHierarchyNodeREL",
"path": [
"6t0ggef2c0deab00hb595101",
"61097058e04a4a001501b18c",
"6109bff5e04a4a00149d4e1d",
"6109c032e04a4a00149d5e4d"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "node_type",
"title": "Hierarchy node type"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"pkid": "6109c032e04a4a00149d5e51",
"node_type": "Reseller",
"name": "CS-NB",
"hierarchy_friendly_name": "CS-P (Provider)",
"hierarchy_path": "sys.hcs.CS-P"
}
}
]
}
(Show the first instance)
{
"pkid": "6109c040e04a4a00149d61cf",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "AAAGlobal",
"business_key": {},
"schema_version": "2.1",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"self": [
{
"pkid": "6109c040e04a4a00149d61cf",
"href": "/api/relation/HcsHierarchyNodeREL/6109c040e04a4a00149d61cf/"
}
],
"children": [],
"parent": [
{
"pkid": "6109c032e04a4a00149d5e4d",
"href": "/api/data/HierarchyNode/6109c032e04a4a00149d5e4d"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/relation/HcsHierarchyNodeREL/6109c040e04a4a00149d61cf/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/HcsHierarchyNodeREL/6109c040e04a4a00149d61cf/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsHierarchyNodeREL/6109c040e04a4a00149d61cf/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/relation/HcsHierarchyNodeREL/6109c040e04a4a00149d61cf/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/HcsHierarchyNodeREL/6109c040e04a4a00149d61cf/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/HcsHierarchyNodeREL",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "node_type",
"title": "Hierarchy node type"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"node_type": "Customer",
"shadow": [],
"name": "AAAGlobal",
"description": "AAAGlobal Description"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/HcsHierarchyNodeREL. | GET | /api/relation/HcsHierarchyNodeREL/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/HcsHierarchyNodeREL as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/HcsHierarchyNodeREL/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/HcsHierarchyNodeREL/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of relation/HcsHierarchyNodeREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/HcsHierarchyNodeREL/[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/HcsHierarchyNodeREL and the JSON format can be used to import instances of relation/HcsHierarchyNodeREL.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/HcsHierarchyNodeREL/[pkid]/ | hierarchy=[hierarchy] | The relation/HcsHierarchyNodeREL instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/HcsHierarchyNodeREL/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/HcsHierarchyNodeREL. |