[Index]
HcsVossCustomerDAT
Model ref.: data/HcsVossCustomerDAT
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,
"description": "Customer's name",
"title": "Name",
"pattern": "^[A-Za-z0-9_\\- ]+$",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 64,
"type": "string"
},
"directoryDomain": {
"is_password": false,
"description": "Customer's directory domain name",
"title": "Directory Domain",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"shared_uc_apps": {
"is_password": false,
"description": "Indicates whether the Customer shares UC Application instances",
"title": "Shared UC Applications",
"default": "false",
"required": false,
"displayable": false,
"readonly": false,
"type": "boolean"
},
"create_admin": {
"is_password": false,
"description": "Indiates whether or not an Admin User should be created",
"title": "Create Local Admin",
"default": "true",
"required": false,
"displayable": false,
"readonly": false,
"type": "boolean"
},
"HierarchyPath": {
"is_password": false,
"description": "Customer entity's hierarchy",
"title": "Hierarchy Path",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"migrate": {
"is_password": false,
"description": "Migrate HCM-F Models to CUCDM Models",
"title": "Migrate from HCM-F to CUCDM",
"default": "false",
"required": false,
"displayable": false,
"readonly": false,
"type": "boolean"
},
"disableNumMgmt": {
"is_password": false,
"description": "Disables number management",
"title": "Disable Number Management",
"default": "false",
"required": false,
"displayable": false,
"readonly": false,
"type": "boolean"
},
"publicSector": {
"default": "false",
"type": "boolean",
"title": "Public Sector"
},
"inactiveBilling": {
"default": "false",
"type": "boolean",
"title": "Inactive Billing"
},
"misc_data": {
"is_password": false,
"description": "Miscellaneous data used at run-time",
"title": "Misc Data",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"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"
}
},
"schema_version": "2.5"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/HcsVossCustomerDAT/add/ |
|
The GUI Add form of data/HcsVossCustomerDAT 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/data/HcsVossCustomerDAT | 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/data/HcsVossCustomerDAT/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/HcsVossCustomerDAT/[pkid1]", "/api/data/HcsVossCustomerDAT/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/HcsVossCustomerDAT/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/HcsVossCustomerDAT; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/HcsVossCustomerDAT/export/ |
|
{ "hrefs":["/api/data/HcsVossCustomerDAT/[pkid1]", "/api/data/HcsVossCustomerDAT/[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 data/HcsVossCustomerDAT and the JSON format can be used to import instances of data/HcsVossCustomerDAT.
GET http://[host-proxy]/api/data/HcsVossCustomerDAT/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for data/HcsVossCustomerDAT | POST | /api/data/HcsVossCustomerDAT/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/HcsVossCustomerDAT/ |
|
The data/HcsVossCustomerDAT schema and all instances as JSON. |
(The list will return 0 to 3 data/HcsVossCustomerDAT instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 1,
"total_limit": null,
"order_by": "name",
"direction": "asc",
"current": "/api/data/HcsVossCustomerDAT/?skip=0&limit=3&order_by=name&direction=asc&traversal=down"
},
"operations": [
"help",
"bulk_update_form",
"update",
"add",
"export",
"get",
"list",
"export_bulkload_template",
"migration",
"remove",
"transform",
"configuration_template",
"field_display_policy"
],
"meta": {
"model_type": "data/HcsVossCustomerDAT",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "directoryDomain",
"title": "Directory Domain"
},
{
"name": "shared_uc_apps",
"title": "Shared UC Applications"
},
{
"name": "disableNumMgmt",
"title": "Disable Number Management"
},
{
"name": "publicSector",
"title": "Public Sector"
},
{
"name": "inactiveBilling",
"title": "Inactive Billing"
},
{
"name": "custom_string_1",
"title": "Custom String 1"
},
{
"name": "custom_string_2",
"title": "Custom String 2"
},
{
"name": "custom_string_3",
"title": "Custom String 3"
},
{
"name": "custom_boolean_1",
"title": "Custom Boolean 1"
},
{
"name": "custom_boolean_2",
"title": "Custom Boolean 2"
},
{
"name": "custom_boolean_3",
"title": "Custom Boolean 3"
},
{
"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": []
},
"model_specific_actions": [
"list",
"get",
"add",
"update",
"remove",
"import",
"execute",
"export",
"export_bulkload_template",
"help"
],
"schema_version": "2.5",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/data/HcsVossCustomerDAT/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/HcsVossCustomerDAT/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/data/HcsVossCustomerDAT/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/data/HcsVossCustomerDAT/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/data/HcsVossCustomerDAT/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/HcsVossCustomerDAT/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": [
{
"data": {
"directoryDomain": "AB_Group.com",
"name": "AB_Group",
"pkid": "5df0b66bce894e001275a92d",
"migrate": false,
"create_admin": false,
"misc_data": "",
"HierarchyPath": "sys.hcs.CS-P.CS-AB",
"disableNumMgmt": false,
"shared_uc_apps": false,
"hierarchy_friendly_name": "AB_Group (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
},
"meta": {
"model_type": "data/HcsVossCustomerDAT",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "directoryDomain",
"title": "Directory Domain"
},
{
"name": "shared_uc_apps",
"title": "Shared UC Applications"
},
{
"name": "disableNumMgmt",
"title": "Disable Number Management"
},
{
"name": "publicSector",
"title": "Public Sector"
},
{
"name": "inactiveBilling",
"title": "Inactive Billing"
},
{
"name": "custom_string_1",
"title": "Custom String 1"
},
{
"name": "custom_string_2",
"title": "Custom String 2"
},
{
"name": "custom_string_3",
"title": "Custom String 3"
},
{
"name": "custom_boolean_1",
"title": "Custom Boolean 1"
},
{
"name": "custom_boolean_2",
"title": "Custom Boolean 2"
},
{
"name": "custom_boolean_3",
"title": "Custom Boolean 3"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "title format",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5df0b66bce894e001275a913",
"href": "/api/data/HierarchyNode/5df0b66bce894e001275a913"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/data/HcsVossCustomerDAT/5df0b66bce894e001275a92c/",
"pkid": "5df0b66bce894e001275a92c"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5da4c643ce894e0012225c90",
"5df0b338ce894e001275535c",
"5df0b3a3ce894e0012756904",
"5df0b66bce894e001275a913",
"5df0b66bce894e001275a92c"
],
"schema_version": "2.5",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/HcsVossCustomerDAT/5df0b66bce894e001275a92c/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/HcsVossCustomerDAT/5df0b66bce894e001275a92c/",
"support_async": true,
"title": "Delete"
}
},
{
"import": {
"method": "POST",
"class": "import",
"href": "/api/data/HcsVossCustomerDAT/5df0b66bce894e001275a92c/import/",
"support_async": true,
"title": "Import"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/HcsVossCustomerDAT/5df0b66bce894e001275a92c/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"execute": {
"method": "POST",
"class": "execute",
"href": "/api/data/HcsVossCustomerDAT/5df0b66bce894e001275a92c/execute/",
"support_async": true,
"title": "Execute"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/HcsVossCustomerDAT/5df0b66bce894e001275a92c/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/HcsVossCustomerDAT/5df0b66bce894e001275a92c/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "5df0b66bce894e001275a92c"
}
]
}
(Show the first instance)
{
"data": {
"directoryDomain": "AB_Group.com",
"name": "AB_Group",
"migrate": false,
"create_admin": false,
"misc_data": "",
"HierarchyPath": "sys.hcs.CS-P.CS-AB",
"disableNumMgmt": false,
"shared_uc_apps": false,
"pkid": "5df0b66bce894e001275a92d"
},
"meta": {
"model_type": "data/HcsVossCustomerDAT",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "directoryDomain",
"title": "Directory Domain"
},
{
"name": "shared_uc_apps",
"title": "Shared UC Applications"
},
{
"name": "disableNumMgmt",
"title": "Disable Number Management"
},
{
"name": "publicSector",
"title": "Public Sector"
},
{
"name": "inactiveBilling",
"title": "Inactive Billing"
},
{
"name": "custom_string_1",
"title": "Custom String 1"
},
{
"name": "custom_string_2",
"title": "Custom String 2"
},
{
"name": "custom_string_3",
"title": "Custom String 3"
},
{
"name": "custom_boolean_1",
"title": "Custom Boolean 1"
},
{
"name": "custom_boolean_2",
"title": "Custom Boolean 2"
},
{
"name": "custom_boolean_3",
"title": "Custom Boolean 3"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "title format",
"business_key": {},
"api_version": "21.2",
"cached": false,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"href": "/api/data/HierarchyNode/5df0b66bce894e001275a913",
"pkid": "5df0b66bce894e001275a913"
}
],
"foreign_key": [],
"children": [],
"self": [
{
"href": "/api/data/HcsVossCustomerDAT/5df0b66bce894e001275a92c/",
"pkid": "5df0b66bce894e001275a92c"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5da4c643ce894e0012225c90",
"5df0b338ce894e001275535c",
"5df0b3a3ce894e0012756904",
"5df0b66bce894e001275a913",
"5df0b66bce894e001275a92c"
],
"schema_version": "2.5",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/HcsVossCustomerDAT/5df0b66bce894e001275a92c/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/HcsVossCustomerDAT/5df0b66bce894e001275a92c/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"import": {
"method": "POST",
"class": "import",
"href": "/api/data/HcsVossCustomerDAT/5df0b66bce894e001275a92c/import/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Import"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/HcsVossCustomerDAT/5df0b66bce894e001275a92c/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"execute": {
"method": "POST",
"class": "execute",
"href": "/api/data/HcsVossCustomerDAT/5df0b66bce894e001275a92c/execute/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Execute"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/HcsVossCustomerDAT/5df0b66bce894e001275a92c/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/HcsVossCustomerDAT/5df0b66bce894e001275a92c/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"pkid": "5df0b66bce894e001275a92c"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/HcsVossCustomerDAT. | GET | /api/data/HcsVossCustomerDAT/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/HcsVossCustomerDAT as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/HcsVossCustomerDAT/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/HcsVossCustomerDAT/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Import | POST | /api/data/HcsVossCustomerDAT/[pkid]/import | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of data/HcsVossCustomerDAT; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/HcsVossCustomerDAT/[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 data/HcsVossCustomerDAT and the JSON format can be used to import instances of data/HcsVossCustomerDAT.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Execute | POST | /api/data/HcsVossCustomerDAT/[pkid]/execute | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/HcsVossCustomerDAT/[pkid] | hierarchy=[hierarchy] | The data/HcsVossCustomerDAT instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/HcsVossCustomerDAT/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/HcsVossCustomerDAT. |