[Index]
Linked Site HN relation
Model ref.: relation/GS_LinkedSiteData_REL
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": {
"type": "string",
"title": "Name",
"pattern": "^([A-Za-z0-9_\\-][A-Za-z0-9_\\ -]*[A-Za-z0-9_\\-]|[A-Za-z0-9_\\-])$",
"required": true,
"description": "The name by which this hierarchy node will be known."
},
"description": {
"type": "string",
"title": "Description",
"description": "A general description for the hierarchy node."
},
"node_type": {
"is_password": false,
"description": "A type label for this node which refers to a Hierarchy Node Type.",
"format": "uri",
"items": {
"is_password": false
},
"required": false,
"readonly": false,
"title": "Hierarchy node type",
"type": "string",
"target": "/api/data/HierarchyNodeType/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "name",
"target_model_type": "data/HierarchyNodeType",
"choices": []
},
"data_linkedSite": {
"title": "Data Linked Site",
"type": "object",
"properties": {
"name": {
"required": true,
"type": "string",
"description": "Site Name",
"title": "Site Name"
},
"extendedName": {
"type": "string",
"description": "Extended Name",
"title": "Extended Name"
},
"externalID": {
"type": "string",
"description": "External ID",
"title": "External ID"
},
"streetAddress1": {
"type": "string",
"description": "Address 1",
"title": "Address 1"
},
"streetAddress2": {
"type": "string",
"description": "Address 2",
"title": "Address 2"
},
"streetAddress3": {
"type": "string",
"description": "Address 3",
"title": "Address 3"
},
"city": {
"type": "string",
"description": "City",
"title": "City"
},
"state": {
"type": "string",
"description": "State",
"title": "State"
},
"postalCode": {
"type": "string",
"description": "Postal Code",
"title": "Postal Code"
},
"siteID": {
"type": "string",
"description": "Site ID",
"title": "Site ID"
},
"emerNumber": {
"required": true,
"type": "string",
"description": "Emergency Call CLI",
"title": "Emergency Callback Number"
},
"pubNumber": {
"required": true,
"type": "string",
"description": "Updating the published number applies to all child sites under this parent site",
"title": "Site Published Number"
},
"areaCode": {
"type": "string",
"description": "Local Area Code",
"title": "Area Code"
},
"areaCodeArray": {
"description": "Specify one or more area codes for this site.",
"title": "Area Codes",
"minItems": 0,
"items": {
"type": "object",
"properties": {
"areaCode": {
"description": "An area code associated with this site.",
"title": "Area Code",
"pattern": "^[0-9#*]+$",
"required": true,
"maxLength": 8,
"type": "string"
},
"locNumLen": {
"required": true,
"type": "string",
"description": "Length of the local numbers associated with this area code.",
"title": "Local Number Length"
}
}
},
"type": "array"
},
"localPattern": {
"type": "string",
"description": "Local pattern for E164 without area code - e.g. [2-9]XXXXX",
"title": "Local Number Pattern"
},
"useAreaCodeLocalDialing": {
"type": "boolean",
"description": "Indicated whether users include area code when dialing a local number",
"title": "Use area code for local dialing"
},
"createLSEmerPattern": {
"default": "true",
"type": "boolean",
"description": "Use DDI for emergency calls when user is at home location",
"title": "Use DDI for emergency calls"
},
"audioBandwidth": {
"required": false,
"type": "string",
"description": "Optional Audio Bandwidth",
"title": "Audio Bandwidth (kbps)"
},
"videoBandwidth": {
"required": false,
"type": "string",
"description": "Optional Video Bandwidth",
"title": "Video Bandwidth (kbps)"
},
"ImmersiveVideoBandwidth": {
"required": false,
"type": "string",
"description": "Optional Immersive Video Bandwidth",
"title": "Immersive Video Bandwidth (kbps)"
},
"active": {
"default": "false",
"type": "boolean",
"description": "Site Dialplan Connected",
"title": "Site Dialplan Active"
}
}
}
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/GS_LinkedSiteData_REL/add/ |
|
The GUI Add form of relation/GS_LinkedSiteData_REL 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/GS_LinkedSiteData_REL | 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/GS_LinkedSiteData_REL/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/GS_LinkedSiteData_REL/[pkid1]", "/api/relation/GS_LinkedSiteData_REL/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/GS_LinkedSiteData_REL/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/GS_LinkedSiteData_REL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/GS_LinkedSiteData_REL/export/ |
|
{ "hrefs":["/api/relation/GS_LinkedSiteData_REL/[pkid1]", "/api/relation/GS_LinkedSiteData_REL/[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/GS_LinkedSiteData_REL and the JSON format can be used to import instances of relation/GS_LinkedSiteData_REL.
GET http://[host-proxy]/api/relation/GS_LinkedSiteData_REL/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/GS_LinkedSiteData_REL | POST | /api/relation/GS_LinkedSiteData_REL/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/GS_LinkedSiteData_REL/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/GS_LinkedSiteData_REL/ |
|
The relation/GS_LinkedSiteData_REL schema and all instances as JSON. |
(The list will return 0 to 3 relation/GS_LinkedSiteData_REL instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 93,
"total_limit": null,
"order_by": "name",
"direction": "asc",
"current": "/api/relation/GS_LinkedSiteData_REL/?skip=0&limit=3&order_by=name&direction=asc&traversal=down"
},
"operations": [
"configuration_template",
"export_bulkload_template",
"bulk_update",
"add",
"update",
"help",
"remove",
"list",
"export",
"get",
"field_display_policy"
],
"meta": {
"model_type": "relation/GS_LinkedSiteData_REL",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "node_type",
"title": "Hierarchy node type"
},
{
"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/GS_LinkedSiteData_REL/None/",
"pkid": null
}
]
},
"model_specific_actions": [
"configuration_template",
"export_bulkload_template",
"add",
"update",
"remove",
"list",
"export",
"get"
],
"schema_version": null,
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/relation/GS_LinkedSiteData_REL/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/GS_LinkedSiteData_REL/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/relation/GS_LinkedSiteData_REL/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/GS_LinkedSiteData_REL/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"method": "GET",
"class": "config",
"href": "/api/relation/GS_LinkedSiteData_REL/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/relation/GS_LinkedSiteData_REL/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
}
]
},
"resources": [
{
"data": {
"name": "AAA-Boston",
"node_type": "Site",
"description": "AAA Boston",
"pkid": "5a86743967ea6f2039933bc4",
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
},
"meta": {
"model_type": "relation/GS_LinkedSiteData_REL",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "node_type",
"title": "Hierarchy node type"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "AAA-Boston",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5a8673030085ec1f7f30e906",
"href": "/api/data/HierarchyNode/5a8673030085ec1f7f30e906"
}
],
"foreign_key": [
{
"pkid": "5a7c4181b12a1c4e4285b7a3",
"path": "node_type",
"model_type": "data/HierarchyNodeType"
}
],
"self": [
{
"href": "/api/relation/GS_LinkedSiteData_REL/5a86743967ea6f2039933bc1/",
"pkid": "5a86743967ea6f2039933bc1"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5a7c462e1360b64cc8bf16e5",
"5a866fd11360b6206c488deb",
"5a86702067ea6f203993285d",
"5a8673030085ec1f7f30e906",
"5a86743967ea6f2039933bc1"
],
"schema_version": "0.1",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/GS_LinkedSiteData_REL/5a86743967ea6f2039933bc1/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/GS_LinkedSiteData_REL/5a86743967ea6f2039933bc1/",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/GS_LinkedSiteData_REL/5a86743967ea6f2039933bc1/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/GS_LinkedSiteData_REL/5a86743967ea6f2039933bc1/",
"support_async": false,
"title": "Get"
}
}
],
"summary": "false"
},
"pkid": "5a86743967ea6f2039933bc1"
},
{
"data": {
"name": "AAA-Brisbane",
"node_type": "Site",
"description": "AAA-Brisbane",
"pkid": "5a867496b12a1c20228c12ee",
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
},
"meta": {
"model_type": "relation/GS_LinkedSiteData_REL",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "node_type",
"title": "Hierarchy node type"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "AAA-Brisbane",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5a8673030085ec1f7f30e906",
"href": "/api/data/HierarchyNode/5a8673030085ec1f7f30e906"
}
],
"foreign_key": [
{
"pkid": "5a7c4181b12a1c4e4285b7a3",
"path": "node_type",
"model_type": "data/HierarchyNodeType"
}
],
"self": [
{
"href": "/api/relation/GS_LinkedSiteData_REL/5a867496b12a1c20228c12eb/",
"pkid": "5a867496b12a1c20228c12eb"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5a7c462e1360b64cc8bf16e5",
"5a866fd11360b6206c488deb",
"5a86702067ea6f203993285d",
"5a8673030085ec1f7f30e906",
"5a867496b12a1c20228c12eb"
],
"schema_version": "0.1",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/GS_LinkedSiteData_REL/5a867496b12a1c20228c12eb/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/GS_LinkedSiteData_REL/5a867496b12a1c20228c12eb/",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/GS_LinkedSiteData_REL/5a867496b12a1c20228c12eb/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/GS_LinkedSiteData_REL/5a867496b12a1c20228c12eb/",
"support_async": false,
"title": "Get"
}
}
],
"summary": "false"
},
"pkid": "5a867496b12a1c20228c12eb"
},
{
"data": {
"name": "AAA-Brooklyn",
"node_type": "Site",
"description": "AAA Brooklyn",
"pkid": "5a86742d0085ec1f7f30f147",
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
},
"meta": {
"model_type": "relation/GS_LinkedSiteData_REL",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "node_type",
"title": "Hierarchy node type"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "AAA-Brooklyn",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5a8673030085ec1f7f30e906",
"href": "/api/data/HierarchyNode/5a8673030085ec1f7f30e906"
}
],
"foreign_key": [
{
"pkid": "5a7c4181b12a1c4e4285b7a3",
"path": "node_type",
"model_type": "data/HierarchyNodeType"
}
],
"self": [
{
"href": "/api/relation/GS_LinkedSiteData_REL/5a86742d0085ec1f7f30f144/",
"pkid": "5a86742d0085ec1f7f30f144"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5a7c462e1360b64cc8bf16e5",
"5a866fd11360b6206c488deb",
"5a86702067ea6f203993285d",
"5a8673030085ec1f7f30e906",
"5a86742d0085ec1f7f30f144"
],
"schema_version": "0.1",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/GS_LinkedSiteData_REL/5a86742d0085ec1f7f30f144/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/GS_LinkedSiteData_REL/5a86742d0085ec1f7f30f144/",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/GS_LinkedSiteData_REL/5a86742d0085ec1f7f30f144/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/GS_LinkedSiteData_REL/5a86742d0085ec1f7f30f144/",
"support_async": false,
"title": "Get"
}
}
],
"summary": "false"
},
"pkid": "5a86742d0085ec1f7f30f144"
}
]
}
(Show the first instance)
{
"data": {
"name": "AAA-Boston",
"node_type": "Site",
"description": "AAA Boston"
},
"meta": {
"model_type": "relation/GS_LinkedSiteData_REL",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "node_type",
"title": "Hierarchy node type"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "AAA-Boston",
"business_key": {},
"api_version": "21.2",
"cached": true,
"cache_control_policy": "cache_then_device",
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"children": [],
"parent": [
{
"pkid": "5a8673030085ec1f7f30e906",
"href": "/api/data/HierarchyNode/5a8673030085ec1f7f30e906"
}
],
"self": [
{
"href": "/api/relation/GS_LinkedSiteData_REL/5a86743967ea6f2039933bc1/",
"pkid": "5a86743967ea6f2039933bc1"
}
]
},
"schema_version": null,
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/GS_LinkedSiteData_REL/5a86743967ea6f2039933bc1/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/GS_LinkedSiteData_REL/5a86743967ea6f2039933bc1/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/GS_LinkedSiteData_REL/5a86743967ea6f2039933bc1/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/GS_LinkedSiteData_REL/5a86743967ea6f2039933bc1/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
}
]
},
"pkid": "5a86743967ea6f2039933bc1"
}
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/GS_LinkedSiteData_REL/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/GS_LinkedSiteData_REL/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of relation/GS_LinkedSiteData_REL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/GS_LinkedSiteData_REL/[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/GS_LinkedSiteData_REL and the JSON format can be used to import instances of relation/GS_LinkedSiteData_REL.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/GS_LinkedSiteData_REL/[pkid] | hierarchy=[hierarchy] | The relation/GS_LinkedSiteData_REL instance with [pkid]. |