[Index]
Model ref.: relation/HcsHcmfREL
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": {
"username": {
"required": false,
"type": "string",
"description": "The administrator Username to connect to the HCMF installation.",
"title": "Admin Username"
},
"description": {
"required": false,
"type": "string",
"description": "The description of the HCMF installation.",
"title": "Description"
},
"base_url": {
"default": "/sdr/rest",
"required": true,
"type": "string",
"description": "The base URL for the HCMF API.",
"title": "Base URL"
},
"host": {
"required": true,
"type": "string",
"description": "The host name of the HCMF installation.",
"title": "Host Name"
},
"version": {
"choices": [
{
"value": "v10_0",
"title": "v10_0"
},
{
"value": "v10_6",
"title": "v10_6"
},
{
"value": "v11_5",
"title": "v11_5"
},
{
"value": "v12_5",
"title": "v12_5"
},
{
"value": "v12_6",
"title": "v12_6"
}
],
"required": true,
"type": "string",
"description": "The selected version of the HCMF installation to connect to.",
"title": "Version"
},
"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"
},
"password": {
"is_password": true,
"description": "The administrator Password associated with the Username to connect to the HCMF installation. The text will be hidden.",
"title": "Admin Password",
"required": false,
"store_encrypted": true,
"type": "string"
},
"port": {
"default": "8443",
"type": "string",
"description": "The port on the HCMF installation server to connect to.",
"title": "Port"
}
},
"schema_version": "2.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/HcsHcmfREL/add/ |
|
The GUI Add form of relation/HcsHcmfREL 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/HcsHcmfREL | 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/HcsHcmfREL/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/HcsHcmfREL/[pkid1]", "/api/relation/HcsHcmfREL/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/HcsHcmfREL/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/HcsHcmfREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/HcsHcmfREL/export/ |
|
{ "hrefs":["/api/relation/HcsHcmfREL/[pkid1]", "/api/relation/HcsHcmfREL/[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/HcsHcmfREL and the JSON format can be used to import instances of relation/HcsHcmfREL.
GET http://[host-proxy]/api/relation/HcsHcmfREL/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/HcsHcmfREL | POST | /api/relation/HcsHcmfREL/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/HcsHcmfREL/ |
|
The relation/HcsHcmfREL schema and all instances as JSON. |
(The list will return 0 to 3 relation/HcsHcmfREL instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"add",
"bulk_update",
"export"
],
"pagination": {
"direction": "asc",
"order_by": "description",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/relation/HcsHcmfREL/?skip=0&limit=3&order_by=description&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 1
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "2.1",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"self": [
{
"pkid": null,
"href": "/api/relation/HcsHcmfREL/None/"
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/relation/HcsHcmfREL/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/HcsHcmfREL/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsHcmfREL/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/HcsHcmfREL/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/relation/HcsHcmfREL/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/HcsHcmfREL/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/HcsHcmfREL",
"model_specific_actions": [
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"add",
"export"
],
"summary_attrs": [
{
"name": "description",
"title": "Description"
},
{
"name": "host",
"title": "Host Name"
},
{
"name": "port",
"title": "Port"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": [
{
"pkid": "5f3ae140ce894e001204deac",
"meta": {
"tags": [],
"cached": true,
"title": "192.168.100.11:8443",
"business_key": {
"hierarchy": true,
"unique": [
"host",
"port"
]
},
"schema_version": "0.2.0",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5f3ae140ce894e001204deac",
"href": "/api/relation/HcsHcmfREL/5f3ae140ce894e001204deac/"
}
],
"parent": [
{
"pkid": "5df35e48ce894e0012b345a1",
"href": "/api/data/HierarchyNode/5df35e48ce894e0012b345a1"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/relation/HcsHcmfREL/5f3ae140ce894e001204deac/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/HcsHcmfREL/5f3ae140ce894e001204deac/",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsHcmfREL/5f3ae140ce894e001204deac/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/relation/HcsHcmfREL/5f3ae140ce894e001204deac/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/HcsHcmfREL/5f3ae140ce894e001204deac/help",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/HcsHcmfREL",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae140ce894e001204deac"
],
"summary_attrs": [
{
"name": "description",
"title": "Description"
},
{
"name": "host",
"title": "Host Name"
},
{
"name": "port",
"title": "Port"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"username": "ccmadmin",
"description": "TB2-V4UC HCM-F",
"pkid": "5f3ae140ce894e001204dead",
"base_url": "/sdr/rest",
"host": "192.168.100.11",
"version": "v11_5",
"hierarchy_friendly_name": "hcs (Hcs)",
"password": "==$y1dMSnneLKJyRZZl$K8IRtnocjfs=$==",
"port": "8443",
"hierarchy_path": "sys.hcs"
}
}
]
}
(Show the first instance)
{
"pkid": "5f3ae140ce894e001204deac",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "TB2-V4UC HCM-F",
"business_key": {},
"schema_version": "2.1",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"self": [
{
"pkid": "5f3ae140ce894e001204deac",
"href": "/api/relation/HcsHcmfREL/5f3ae140ce894e001204deac/"
}
],
"children": [],
"parent": [
{
"pkid": "5df35e48ce894e0012b345a1",
"href": "/api/data/HierarchyNode/5df35e48ce894e0012b345a1"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/relation/HcsHcmfREL/5f3ae140ce894e001204deac/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/HcsHcmfREL/5f3ae140ce894e001204deac/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsHcmfREL/5f3ae140ce894e001204deac/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/relation/HcsHcmfREL/5f3ae140ce894e001204deac/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/HcsHcmfREL/5f3ae140ce894e001204deac/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/HcsHcmfREL",
"summary_attrs": [
{
"name": "description",
"title": "Description"
},
{
"name": "host",
"title": "Host Name"
},
{
"name": "port",
"title": "Port"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"username": "ccmadmin",
"description": "TB2-V4UC HCM-F",
"base_url": "/sdr/rest",
"host": "192.168.100.11",
"version": "v11_5",
"shadow": [],
"password": "==$y1dMSnneLKJyRZZl$K8IRtnocjfs=$==",
"port": "8443"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/HcsHcmfREL. | GET | /api/relation/HcsHcmfREL/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/HcsHcmfREL as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/HcsHcmfREL/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/HcsHcmfREL/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of relation/HcsHcmfREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/HcsHcmfREL/[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/HcsHcmfREL and the JSON format can be used to import instances of relation/HcsHcmfREL.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/HcsHcmfREL/[pkid] | hierarchy=[hierarchy] | The relation/HcsHcmfREL instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/HcsHcmfREL/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/HcsHcmfREL. |