[Index]
Site relationship
Model ref.: relation/VOSS-Site-Relation
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": {
"name": {
"is_password": false,
"title": "Site Name",
"minLength": 1,
"required": true,
"readonly": false,
"maxLength": 64,
"pattern": "^[\\w\\ -]+$",
"items": {
"is_password": false
},
"type": "string"
},
"SiteID": {
"is_password": false,
"title": "Site ID",
"items": {
"is_password": false
},
"required": false,
"readonly": false,
"type": "string"
},
"Description": {
"is_password": false,
"title": "Description",
"items": {
"is_password": false
},
"required": false,
"readonly": false,
"type": "string"
},
"ndlr": {
"is_password": false,
"format": "uri",
"items": {
"is_password": false
},
"required": false,
"readonly": false,
"title": "Network Device List Reference",
"type": "string",
"target": "/api/data/NetworkDeviceList/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/NetworkDeviceList",
"choices": []
},
"Address1": {
"is_password": false,
"title": "Address 1",
"items": {
"is_password": false
},
"required": false,
"readonly": false,
"type": "string"
},
"Address2": {
"is_password": false,
"title": "Address 2",
"items": {
"is_password": false
},
"required": false,
"readonly": false,
"type": "string"
},
"Address3": {
"is_password": false,
"title": "Address 3",
"items": {
"is_password": false
},
"required": false,
"readonly": false,
"type": "string"
},
"City": {
"is_password": false,
"title": "City",
"items": {
"is_password": false
},
"required": false,
"readonly": false,
"type": "string"
},
"State": {
"is_password": false,
"title": "State",
"items": {
"is_password": false
},
"required": false,
"readonly": false,
"type": "string"
},
"PostalCode": {
"is_password": false,
"title": "Postal Code",
"items": {
"is_password": false
},
"required": false,
"readonly": false,
"type": "string"
},
"ExtendedName": {
"is_password": false,
"title": "Extended Name",
"items": {
"is_password": false
},
"required": false,
"readonly": false,
"type": "string"
},
"ExternalID": {
"is_password": false,
"title": "External ID",
"items": {
"is_password": false
},
"required": false,
"readonly": false,
"type": "string"
},
"InternalSiteID": {
"is_password": false,
"title": "Internal ID",
"default": "\"Auto-generated value\"",
"items": {
"is_password": false
},
"required": false,
"readonly": false,
"type": "string"
},
"Country": {
"is_password": false,
"format": "uri",
"items": {
"is_password": false
},
"required": false,
"target_attr": "country_name",
"readonly": false,
"title": "Country",
"type": "string",
"target": "/api/data/Countries/choices/?field=country_name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/Countries",
"choices": []
},
"CUCDM8xLocID": {
"required": false,
"type": "string",
"description": "Location ID as used in CUCDM 8.x DialPlan",
"title": "CUCDM 8.x Location ID"
},
"CUCDM8xRID": {
"required": false,
"type": "string",
"description": "Routing Identifier(RID) value as used in CUCDM 8.x DialPlan",
"title": "CUCDM 8.x Routing Identifier(RID)"
},
"custom_string_1": {
"type": "string",
"title": "custom_string_1"
},
"custom_string_2": {
"type": "string",
"title": "custom_string_2"
},
"custom_string_3": {
"type": "string",
"title": "custom_string_3"
},
"custom_string_4": {
"type": "string",
"title": "custom_string_4"
},
"custom_string_5": {
"type": "string",
"title": "custom_string_5"
},
"custom_string_6": {
"type": "string",
"title": "custom_string_6"
},
"custom_string_7": {
"type": "string",
"title": "custom_string_7"
},
"custom_string_8": {
"type": "string",
"title": "custom_string_8"
},
"custom_string_9": {
"type": "string",
"title": "custom_string_9"
},
"custom_string_10": {
"type": "string",
"title": "custom_string_10"
},
"custom_boolean_1": {
"type": "boolean",
"title": "custom_boolean_1"
},
"custom_boolean_2": {
"type": "boolean",
"title": "custom_boolean_2"
},
"custom_boolean_3": {
"type": "boolean",
"title": "custom_boolean_3"
},
"custom_boolean_4": {
"type": "boolean",
"title": "custom_boolean_4"
},
"custom_boolean_5": {
"type": "boolean",
"title": "custom_boolean_5"
},
"custom_boolean_6": {
"type": "boolean",
"title": "custom_boolean_6"
},
"custom_boolean_7": {
"type": "boolean",
"title": "custom_boolean_7"
},
"custom_boolean_8": {
"type": "boolean",
"title": "custom_boolean_8"
},
"custom_boolean_9": {
"type": "boolean",
"title": "custom_boolean_9"
},
"custom_boolean_10": {
"type": "boolean",
"title": "custom_boolean_10"
},
"dpSite": {
"title": "Dp Site",
"type": "object",
"properties": {
"name": {
"title": "Name",
"type": "string",
"required": true,
"readonly": false,
"is_password": false,
"items": {
"is_password": false
},
"default": "default"
},
"SavedSite": {
"title": "SavedSite",
"description": "Field to check if adding Site or modding Site - NDL read-only GUI Rule.",
"type": "string"
},
"Country": {
"title": "Country",
"type": "string",
"required": false,
"readonly": false,
"is_password": false,
"items": {
"is_password": false
}
},
"DialPlanName": {
"title": "Dial Plan Name",
"type": "string",
"required": false,
"readonly": false,
"is_password": false,
"items": {
"is_password": false
},
"default": "{{ data.VOSS-Customer-DialPlan.DialPlanName }}"
},
"SiteCode": {
"type": "string",
"required": false,
"readonly": false,
"choices": [
{
"value": "y"
}
],
"title": "Select Site Code"
},
"ndlr": {
"title": "Network Device List Reference",
"type": "string",
"format": "uri",
"target": "/api/data/NetworkDeviceList/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "name",
"target_model_type": "data/NetworkDeviceList",
"choices": []
},
"SiteCodeChosen": {
"type": "string",
"required": false,
"readonly": false,
"title": "Chosen Site Code"
},
"EXTLength": {
"type": "string",
"required": false,
"readonly": false,
"is_password": false,
"items": {
"is_password": false
},
"choices": [
{
"value": "1",
"title": "1"
},
{
"value": "2",
"title": "2"
},
{
"value": "3",
"title": "3"
},
{
"value": "4",
"title": "4"
},
{
"value": "5",
"title": "5"
},
{
"value": "6",
"title": "6"
},
{
"value": "7",
"title": "7"
},
{
"value": "8",
"title": "8"
},
{
"value": "9",
"title": "9"
},
{
"value": "0",
"title": "0"
}
],
"title": "Extension Length"
},
"DialForOutside": {
"type": "string",
"required": false,
"readonly": false,
"is_password": false,
"items": {
"is_password": false
},
"choices": [
{
"value": "1",
"title": "1"
},
{
"value": "2",
"title": "2"
},
{
"value": "3",
"title": "3"
},
{
"value": "4",
"title": "4"
},
{
"value": "5",
"title": "5"
},
{
"value": "6",
"title": "6"
},
{
"value": "7",
"title": "7"
},
{
"value": "8",
"title": "8"
},
{
"value": "9",
"title": "9"
},
{
"value": "0",
"title": "0"
}
],
"title": "Dial For Outside Line?"
},
"CUCMProvisioning": {
"title": "Provision CUCM?",
"type": "string",
"required": false,
"readonly": false,
"is_password": false,
"items": {
"is_password": false
},
"default": "Yes",
"choices": [
{
"value": "Yes",
"title": "Yes"
},
{
"value": "No",
"title": "No"
}
]
}
}
}
},
"schema_version": "1.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/VOSS-Site-Relation/add/ |
|
The GUI Add form of relation/VOSS-Site-Relation 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/VOSS-Site-Relation | 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/VOSS-Site-Relation/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/VOSS-Site-Relation/[pkid1]", "/api/relation/VOSS-Site-Relation/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/VOSS-Site-Relation/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/VOSS-Site-Relation; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/VOSS-Site-Relation/export/ |
|
{ "hrefs":["/api/relation/VOSS-Site-Relation/[pkid1]", "/api/relation/VOSS-Site-Relation/[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/VOSS-Site-Relation and the JSON format can be used to import instances of relation/VOSS-Site-Relation.
GET http://[host-proxy]/api/relation/VOSS-Site-Relation/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/VOSS-Site-Relation | POST | /api/relation/VOSS-Site-Relation/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/relation/VOSS-Site-Relation/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/relation/VOSS-Site-Relation/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/VOSS-Site-Relation/ |
|
The relation/VOSS-Site-Relation schema and all instances as JSON. |
(The list will return 0 to 3 relation/VOSS-Site-Relation instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 12,
"total_limit": null,
"order_by": "name",
"direction": "asc",
"current": "/api/relation/VOSS-Site-Relation/?skip=0&limit=3&order_by=name&direction=asc&traversal=down"
},
"operations": [
"list",
"help",
"field_display_policy",
"get",
"configuration_template",
"update",
"bulk_update",
"remove",
"add",
"export",
"export_bulkload_template"
],
"meta": {
"model_type": "relation/VOSS-Site-Relation",
"summary_attrs": [
{
"name": "name",
"title": "Site Name"
},
{
"name": "Description",
"title": "Description"
},
{
"name": "SiteID",
"title": "Site ID"
},
{
"name": "InternalSiteID",
"title": "Internal ID"
},
{
"name": "ExternalID",
"title": "External ID"
},
{
"name": "City",
"title": "City"
},
{
"name": "State",
"title": "State"
},
{
"name": "Country",
"title": "Country"
},
{
"name": "ndlr",
"title": "Network Device List Reference"
},
{
"name": "Address1",
"title": "Address 1"
},
{
"name": "Address2",
"title": "Address 2"
},
{
"name": "Address3",
"title": "Address 3"
},
{
"name": "PostalCode",
"title": "Postal Code"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": [],
"self": [
{
"href": "/api/relation/VOSS-Site-Relation/None/",
"pkid": null
}
]
},
"model_specific_actions": [
"list",
"help",
"field_display_policy",
"get",
"configuration_template",
"update",
"remove",
"add",
"export",
"export_bulkload_template"
],
"schema_version": "1.1",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/relation/VOSS-Site-Relation/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/VOSS-Site-Relation/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/relation/VOSS-Site-Relation/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/relation/VOSS-Site-Relation/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"method": "GET",
"class": "config",
"href": "/api/relation/VOSS-Site-Relation/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/relation/VOSS-Site-Relation/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/relation/VOSS-Site-Relation/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/VOSS-Site-Relation/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": [
{
"data": {
"City": "Berlin",
"InternalSiteID": "6",
"ndlr": "[\"AB_Group-Germany-CL1-NDL\", \"hcs.CS-P.CS-AB.AB_Group\"]",
"name": "CL1-AB-C-Berlin",
"Address1": "Hunefeldstr.5",
"Address2": "Neuenland",
"ExtendedName": "AB_Group-Civil-Berlin",
"ExternalID": "AB-C-BE",
"Country": "Germany",
"PostalCode": "28199",
"Description": "AB_Group-Civil-Berlin",
"hierarchy_friendly_name": "CL1-AB-C-Berlin (Site)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group.AB-C.CL1-AB-C-Berlin"
},
"meta": {
"model_type": "relation/VOSS-Site-Relation",
"summary_attrs": [
{
"name": "name",
"title": "Site Name"
},
{
"name": "Description",
"title": "Description"
},
{
"name": "SiteID",
"title": "Site ID"
},
{
"name": "InternalSiteID",
"title": "Internal ID"
},
{
"name": "ExternalID",
"title": "External ID"
},
{
"name": "City",
"title": "City"
},
{
"name": "State",
"title": "State"
},
{
"name": "Country",
"title": "Country"
},
{
"name": "ndlr",
"title": "Network Device List Reference"
},
{
"name": "Address1",
"title": "Address 1"
},
{
"name": "Address2",
"title": "Address 2"
},
{
"name": "Address3",
"title": "Address 3"
},
{
"name": "PostalCode",
"title": "Postal Code"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "CL1-AB-C-Berlin",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5df0b767ce894e001275f0cf",
"href": "/api/data/HierarchyNode/5df0b767ce894e001275f0cf"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/relation/VOSS-Site-Relation/5df0b76dce894e001275f27e/",
"pkid": "5df0b76dce894e001275f27e"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5da4c643ce894e0012225c90",
"5df0b338ce894e001275535c",
"5df0b3a3ce894e0012756904",
"5df0b66bce894e001275a913",
"5df0b6b6ce894e001275ca48",
"5df0b767ce894e001275f0cf",
"5df0b76dce894e001275f27e"
],
"schema_version": null,
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/VOSS-Site-Relation/5df0b76dce894e001275f27e/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/VOSS-Site-Relation/5df0b76dce894e001275f27e/",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/VOSS-Site-Relation/5df0b76dce894e001275f27e/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/VOSS-Site-Relation/5df0b76dce894e001275f27e/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/VOSS-Site-Relation/5df0b76dce894e001275f27e/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "5df0b76dce894e001275f27e"
},
{
"data": {
"City": "Grenoble",
"InternalSiteID": "2",
"ndlr": "[\"AB_Group-France-CL1-NDL\", \"hcs.CS-P.CS-AB.AB_Group\"]",
"name": "CL1-AB-C-Grenoble",
"Address1": "Site de Saint Martin du Talon",
"Address2": "316 Route de Beuvoir",
"ExtendedName": "AB_Group-Civil-Grenoble",
"ExternalID": "AB-C-GR",
"Country": "France",
"PostalCode": "31160",
"Description": "AB_Group-Civil-Grenoble",
"hierarchy_friendly_name": "CL1-AB-C-Grenoble (Site)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group.AB-C.CL1-AB-C-Grenoble"
},
"meta": {
"model_type": "relation/VOSS-Site-Relation",
"summary_attrs": [
{
"name": "name",
"title": "Site Name"
},
{
"name": "Description",
"title": "Description"
},
{
"name": "SiteID",
"title": "Site ID"
},
{
"name": "InternalSiteID",
"title": "Internal ID"
},
{
"name": "ExternalID",
"title": "External ID"
},
{
"name": "City",
"title": "City"
},
{
"name": "State",
"title": "State"
},
{
"name": "Country",
"title": "Country"
},
{
"name": "ndlr",
"title": "Network Device List Reference"
},
{
"name": "Address1",
"title": "Address 1"
},
{
"name": "Address2",
"title": "Address 2"
},
{
"name": "Address3",
"title": "Address 3"
},
{
"name": "PostalCode",
"title": "Postal Code"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "CL1-AB-C-Grenoble",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5df0b73fce894e001275e736",
"href": "/api/data/HierarchyNode/5df0b73fce894e001275e736"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/relation/VOSS-Site-Relation/5df0b746ce894e001275e8c0/",
"pkid": "5df0b746ce894e001275e8c0"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5da4c643ce894e0012225c90",
"5df0b338ce894e001275535c",
"5df0b3a3ce894e0012756904",
"5df0b66bce894e001275a913",
"5df0b6b6ce894e001275ca48",
"5df0b73fce894e001275e736",
"5df0b746ce894e001275e8c0"
],
"schema_version": null,
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/VOSS-Site-Relation/5df0b746ce894e001275e8c0/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/VOSS-Site-Relation/5df0b746ce894e001275e8c0/",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/VOSS-Site-Relation/5df0b746ce894e001275e8c0/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/VOSS-Site-Relation/5df0b746ce894e001275e8c0/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/VOSS-Site-Relation/5df0b746ce894e001275e8c0/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "5df0b746ce894e001275e8c0"
},
{
"data": {
"City": "Hannover",
"InternalSiteID": "5",
"ndlr": "[\"AB_Group-Germany-CL1-NDL\", \"hcs.CS-P.CS-AB.AB_Group\"]",
"name": "CL1-AB-C-Hannover",
"Address1": "Kreetslag 10",
"ExtendedName": "AB_Group-Civil-Hannover",
"ExternalID": "AB-C-HA",
"Country": "Germany",
"PostalCode": "21129",
"Description": "AB_Group-Civil-Hannover",
"hierarchy_friendly_name": "CL1-AB-C-Hannover (Site)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group.AB-C.CL1-AB-C-Hannover"
},
"meta": {
"model_type": "relation/VOSS-Site-Relation",
"summary_attrs": [
{
"name": "name",
"title": "Site Name"
},
{
"name": "Description",
"title": "Description"
},
{
"name": "SiteID",
"title": "Site ID"
},
{
"name": "InternalSiteID",
"title": "Internal ID"
},
{
"name": "ExternalID",
"title": "External ID"
},
{
"name": "City",
"title": "City"
},
{
"name": "State",
"title": "State"
},
{
"name": "Country",
"title": "Country"
},
{
"name": "ndlr",
"title": "Network Device List Reference"
},
{
"name": "Address1",
"title": "Address 1"
},
{
"name": "Address2",
"title": "Address 2"
},
{
"name": "Address3",
"title": "Address 3"
},
{
"name": "PostalCode",
"title": "Postal Code"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "CL1-AB-C-Hannover",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5df0b75ece894e001275ee96",
"href": "/api/data/HierarchyNode/5df0b75ece894e001275ee96"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/relation/VOSS-Site-Relation/5df0b765ce894e001275f036/",
"pkid": "5df0b765ce894e001275f036"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5da4c643ce894e0012225c90",
"5df0b338ce894e001275535c",
"5df0b3a3ce894e0012756904",
"5df0b66bce894e001275a913",
"5df0b6b6ce894e001275ca48",
"5df0b75ece894e001275ee96",
"5df0b765ce894e001275f036"
],
"schema_version": null,
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/VOSS-Site-Relation/5df0b765ce894e001275f036/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/VOSS-Site-Relation/5df0b765ce894e001275f036/",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/VOSS-Site-Relation/5df0b765ce894e001275f036/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/VOSS-Site-Relation/5df0b765ce894e001275f036/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/VOSS-Site-Relation/5df0b765ce894e001275f036/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "5df0b765ce894e001275f036"
}
]
}
(Show the first instance)
{
"data": {
"City": "Berlin",
"InternalSiteID": "6",
"ndlr": "[\"AB_Group-Germany-CL1-NDL\", \"hcs.CS-P.CS-AB.AB_Group\"]",
"name": "CL1-AB-C-Berlin",
"Address1": "Hunefeldstr.5",
"Address2": "Neuenland",
"ExtendedName": "AB_Group-Civil-Berlin",
"ExternalID": "AB-C-BE",
"Country": "Germany",
"PostalCode": "28199",
"Description": "AB_Group-Civil-Berlin"
},
"meta": {
"model_type": "relation/VOSS-Site-Relation",
"summary_attrs": [
{
"name": "name",
"title": "Site Name"
},
{
"name": "Description",
"title": "Description"
},
{
"name": "SiteID",
"title": "Site ID"
},
{
"name": "InternalSiteID",
"title": "Internal ID"
},
{
"name": "ExternalID",
"title": "External ID"
},
{
"name": "City",
"title": "City"
},
{
"name": "State",
"title": "State"
},
{
"name": "Country",
"title": "Country"
},
{
"name": "ndlr",
"title": "Network Device List Reference"
},
{
"name": "Address1",
"title": "Address 1"
},
{
"name": "Address2",
"title": "Address 2"
},
{
"name": "Address3",
"title": "Address 3"
},
{
"name": "PostalCode",
"title": "Postal Code"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "CL1-AB-C-Berlin",
"business_key": {},
"api_version": "21.2",
"cached": true,
"cache_control_policy": "cache_then_device",
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"children": [],
"parent": [
{
"pkid": "5df0b767ce894e001275f0cf",
"href": "/api/data/HierarchyNode/5df0b767ce894e001275f0cf"
}
],
"self": [
{
"href": "/api/relation/VOSS-Site-Relation/5df0b76dce894e001275f27e/",
"pkid": "5df0b76dce894e001275f27e"
}
]
},
"schema_version": "1.1",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/VOSS-Site-Relation/5df0b76dce894e001275f27e/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/VOSS-Site-Relation/5df0b76dce894e001275f27e/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/VOSS-Site-Relation/5df0b76dce894e001275f27e/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/VOSS-Site-Relation/5df0b76dce894e001275f27e/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/VOSS-Site-Relation/5df0b76dce894e001275f27e/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"pkid": "5df0b76dce894e001275f27e"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/VOSS-Site-Relation. | GET | /api/relation/VOSS-Site-Relation/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/VOSS-Site-Relation as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/VOSS-Site-Relation/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/VOSS-Site-Relation/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of relation/VOSS-Site-Relation; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/VOSS-Site-Relation/[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/VOSS-Site-Relation and the JSON format can be used to import instances of relation/VOSS-Site-Relation.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/VOSS-Site-Relation/[pkid] | hierarchy=[hierarchy] | The relation/VOSS-Site-Relation instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/VOSS-Site-Relation/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/VOSS-Site-Relation. |