[Index]
Sample customer
Model ref.: relation/VOSS-Customer-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": "Customer Name",
"minLength": 1,
"required": true,
"readonly": false,
"maxLength": 64,
"pattern": "^[\\w\\ -]+$",
"items": {
"is_password": false
},
"type": "string"
},
"InternalCustomerID": {
"is_password": false,
"title": "Internal ID",
"default": "\"Auto Generated\"",
"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"
},
"Address1": {
"is_password": false,
"title": "Address Line 1",
"items": {
"is_password": false
},
"required": false,
"readonly": false,
"type": "string"
},
"Address2": {
"is_password": false,
"title": "Address Line 2",
"items": {
"is_password": false
},
"required": false,
"readonly": false,
"type": "string"
},
"Address3": {
"is_password": false,
"title": "Address Line 3",
"items": {
"is_password": false
},
"required": false,
"readonly": false,
"type": "string"
},
"CustomerID": {
"is_password": false,
"title": "Customer ID",
"items": {
"is_password": false
},
"required": false,
"readonly": false,
"type": "string"
},
"dpCustomer": {
"title": "Dp Customer",
"type": "object",
"properties": {
"custName": {
"is_password": false,
"description": "The name of the customer.",
"title": "Customer Name",
"default": "default",
"items": {
"is_password": false
},
"required": false,
"readonly": false,
"type": "string"
},
"DialPlanName": {
"is_password": false,
"format": "uri",
"default": "VOSS-DEMO-DialPlan",
"items": {
"is_password": false
},
"required": false,
"target_attr": "DialPlanName",
"readonly": false,
"title": "Dial Plan Name",
"type": "string",
"target": "/api/data/DialPlan/choices/?field=DialPlanName&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/DialPlan",
"choices": []
},
"ISP": {
"is_password": false,
"description": "Inter-site prefix if ISP required for inter-site dialing.",
"format": "regex",
"items": {
"is_password": false
},
"required": false,
"readonly": false,
"pattern": "^[0-9]+$",
"title": "Inter Site Prefix",
"type": "string"
}
}
}
},
"schema_version": "1.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/VOSS-Customer-Relation/add/ |
|
The GUI Add form of relation/VOSS-Customer-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-Customer-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-Customer-Relation/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/VOSS-Customer-Relation/[pkid1]", "/api/relation/VOSS-Customer-Relation/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/VOSS-Customer-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-Customer-Relation; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/VOSS-Customer-Relation/export/ |
|
{ "hrefs":["/api/relation/VOSS-Customer-Relation/[pkid1]", "/api/relation/VOSS-Customer-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-Customer-Relation and the JSON format can be used to import instances of relation/VOSS-Customer-Relation.
GET http://[host-proxy]/api/relation/VOSS-Customer-Relation/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/VOSS-Customer-Relation | POST | /api/relation/VOSS-Customer-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-Customer-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-Customer-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-Customer-Relation/ |
|
The relation/VOSS-Customer-Relation schema and all instances as JSON. |
(The list will return 0 to 3 relation/VOSS-Customer-Relation instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 2,
"total_limit": null,
"order_by": "name",
"direction": "asc",
"current": "/api/relation/VOSS-Customer-Relation/?skip=0&limit=3&order_by=name&direction=asc&traversal=down"
},
"operations": [
"field_display_policy",
"update",
"help",
"remove",
"add",
"configuration_template",
"list",
"export",
"get",
"bulk_update",
"export_bulkload_template"
],
"meta": {
"model_type": "relation/VOSS-Customer-Relation",
"summary_attrs": [
{
"name": "name",
"title": "Customer Name"
},
{
"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-Customer-Relation/None/",
"pkid": null
}
]
},
"model_specific_actions": [
"update",
"field_display_policy",
"remove",
"help",
"add",
"configuration_template",
"list",
"export",
"get",
"export_bulkload_template"
],
"schema_version": "1.1",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/relation/VOSS-Customer-Relation/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/VOSS-Customer-Relation/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/relation/VOSS-Customer-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-Customer-Relation/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"method": "GET",
"class": "config",
"href": "/api/relation/VOSS-Customer-Relation/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/relation/VOSS-Customer-Relation/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/relation/VOSS-Customer-Relation/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/VOSS-Customer-Relation/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": [
{
"data": {
"name": "AB_Group",
"InternalCustomerID": "1",
"hierarchy_friendly_name": "AB_Group (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
},
"meta": {
"model_type": "relation/VOSS-Customer-Relation",
"summary_attrs": [
{
"name": "name",
"title": "Customer Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "AB_Group",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5ae89ea2affa931cce38a523",
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/relation/VOSS-Customer-Relation/5ae89ea3affa931cce38a54d/",
"pkid": "5ae89ea3affa931cce38a54d"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae89ea3affa931cce38a54d"
],
"schema_version": null,
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/VOSS-Customer-Relation/5ae89ea3affa931cce38a54d/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/VOSS-Customer-Relation/5ae89ea3affa931cce38a54d/",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/VOSS-Customer-Relation/5ae89ea3affa931cce38a54d/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/VOSS-Customer-Relation/5ae89ea3affa931cce38a54d/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/VOSS-Customer-Relation/5ae89ea3affa931cce38a54d/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "5ae89ea3affa931cce38a54d"
},
{
"data": {
"name": "RND",
"InternalCustomerID": "5",
"hierarchy_friendly_name": "RND (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.RND"
},
"meta": {
"model_type": "relation/VOSS-Customer-Relation",
"summary_attrs": [
{
"name": "name",
"title": "Customer Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "RND",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "6644e9bcf14dbdc7695d37d1",
"href": "/api/data/HierarchyNode/6644e9bcf14dbdc7695d37d1"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/relation/VOSS-Customer-Relation/6644e9bef14dbdc7695d37f4/",
"pkid": "6644e9bef14dbdc7695d37f4"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89bd5affa931cce3863f9",
"6644e9bcf14dbdc7695d37d1",
"6644e9bef14dbdc7695d37f4"
],
"schema_version": null,
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/VOSS-Customer-Relation/6644e9bef14dbdc7695d37f4/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/VOSS-Customer-Relation/6644e9bef14dbdc7695d37f4/",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/VOSS-Customer-Relation/6644e9bef14dbdc7695d37f4/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/VOSS-Customer-Relation/6644e9bef14dbdc7695d37f4/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/VOSS-Customer-Relation/6644e9bef14dbdc7695d37f4/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "6644e9bef14dbdc7695d37f4"
}
]
}
(Show the first instance)
{
"data": {
"name": "AB_Group",
"InternalCustomerID": "1"
},
"meta": {
"model_type": "relation/VOSS-Customer-Relation",
"summary_attrs": [
{
"name": "name",
"title": "Customer Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "AB_Group",
"business_key": {},
"api_version": "21.2",
"cached": true,
"cache_control_policy": "cache_then_device",
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"children": [],
"parent": [
{
"pkid": "5ae89ea2affa931cce38a523",
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523"
}
],
"self": [
{
"href": "/api/relation/VOSS-Customer-Relation/5ae89ea3affa931cce38a54d/",
"pkid": "5ae89ea3affa931cce38a54d"
}
]
},
"schema_version": "1.1",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/VOSS-Customer-Relation/5ae89ea3affa931cce38a54d/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/VOSS-Customer-Relation/5ae89ea3affa931cce38a54d/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/VOSS-Customer-Relation/5ae89ea3affa931cce38a54d/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-Customer-Relation/5ae89ea3affa931cce38a54d/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/VOSS-Customer-Relation/5ae89ea3affa931cce38a54d/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"pkid": "5ae89ea3affa931cce38a54d"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/VOSS-Customer-Relation. | GET | /api/relation/VOSS-Customer-Relation/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/VOSS-Customer-Relation as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/VOSS-Customer-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-Customer-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-Customer-Relation; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/VOSS-Customer-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-Customer-Relation and the JSON format can be used to import instances of relation/VOSS-Customer-Relation.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/VOSS-Customer-Relation/[pkid] | hierarchy=[hierarchy] | The relation/VOSS-Customer-Relation instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/VOSS-Customer-Relation/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/VOSS-Customer-Relation. |