[Index]
HcsMoveRestrictionsDAT
Model ref.: data/HcsMoveRestrictionsDAT
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": {
"roleCheck": {
"is_password": false,
"description": "When checked, the user move will fail if the destination role is not valid for the destination hierarchy",
"title": "Check Role on Hierarchy",
"default": "true",
"required": false,
"displayable": false,
"readonly": false,
"type": "boolean"
},
"countryCheck": {
"is_password": false,
"description": "When checked, the user move will fail if the Country configured on Site is not the same between from and to Site",
"title": "Check Country on Sites",
"default": "true",
"required": false,
"displayable": false,
"readonly": false,
"type": "boolean"
},
"dpCheck": {
"is_password": false,
"description": "When checked, the user move will fail if the DialPlan is SLC based",
"title": "Check DialPlan Configuration",
"default": "true",
"required": false,
"displayable": false,
"readonly": false,
"type": "boolean"
},
"name": {
"is_password": false,
"description": "A set of restrictions to be applied or ignored when executing a User Move",
"title": "Name",
"default": "User Move Restrictions",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"ndlrCheck": {
"is_password": false,
"description": "When checked, the user move will fail if the NDLRs do not match",
"title": "Check NDLR",
"default": "true",
"required": false,
"displayable": false,
"readonly": false,
"type": "boolean"
},
"siteDefaultsCheck": {
"is_password": false,
"description": "When checked, the user move will fail if the following target Site Defaults settings are not specified: Line Defaults > Default CUCM Line CSS, Line Defaults > Default CUCM Line Partition, General Defaults > Default CUCM Location, General Defaults > Default CUCM Device Pool",
"title": "Check Site Defaults",
"default": "true",
"required": false,
"displayable": false,
"readonly": false,
"type": "boolean"
},
"moveSubCheck": {
"is_password": false,
"description": "When checked, the Site To Site Subscriber Move feature is supported",
"title": "Site To Site Subscriber Move Supported",
"default": "true",
"required": false,
"displayable": false,
"readonly": false,
"type": "boolean"
},
"syncToCheck": {
"is_password": false,
"description": "When checked, the user move will fail if the SyncTo hierarchy is not the parent of both from and to hierarchies",
"title": "Check Sync-To Hierarchy",
"default": "true",
"required": false,
"displayable": false,
"readonly": false,
"type": "boolean"
},
"ucResourceCheck": {
"is_password": false,
"description": "When checked, the user move will fail if the User has UC Resources configured. (Devices-CSS, Lines-Partitions, DNs, Extensions, Phone Profiles, RDPs)",
"title": "Check UCApp Resources",
"default": "false",
"required": false,
"displayable": false,
"readonly": false,
"type": "boolean"
}
},
"schema_version": "1.4"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/HcsMoveRestrictionsDAT/add/ |
|
The GUI Add form of data/HcsMoveRestrictionsDAT 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/HcsMoveRestrictionsDAT/ | 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/HcsMoveRestrictionsDAT/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/HcsMoveRestrictionsDAT/[pkid1]", "/api/data/HcsMoveRestrictionsDAT/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/HcsMoveRestrictionsDAT/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/HcsMoveRestrictionsDAT; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/HcsMoveRestrictionsDAT/export/ |
|
{ "hrefs":["/api/data/HcsMoveRestrictionsDAT/[pkid1]", "/api/data/HcsMoveRestrictionsDAT/[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/HcsMoveRestrictionsDAT and the JSON format can be used to import instances of data/HcsMoveRestrictionsDAT.
GET http://[host-proxy]/api/data/HcsMoveRestrictionsDAT/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for data/HcsMoveRestrictionsDAT | POST | /api/data/HcsMoveRestrictionsDAT/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/HcsMoveRestrictionsDAT/ |
|
The data/HcsMoveRestrictionsDAT schema and all instances as JSON. |
(The list will return 0 to 3 data/HcsMoveRestrictionsDAT instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"move",
"transform",
"add",
"export",
"migration",
"bulk_update_form"
],
"pagination": {
"direction": "asc",
"order_by": "name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/data/HcsMoveRestrictionsDAT/?skip=0&limit=3&order_by=name&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 1
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "1.4",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/data/HcsMoveRestrictionsDAT/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/HcsMoveRestrictionsDAT/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/HcsMoveRestrictionsDAT/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/data/HcsMoveRestrictionsDAT/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/data/HcsMoveRestrictionsDAT/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/HcsMoveRestrictionsDAT/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/HcsMoveRestrictionsDAT",
"model_specific_actions": [
"list",
"get",
"add",
"update",
"remove",
"import",
"execute",
"export",
"export_bulkload_template",
"help"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "moveSubCheck",
"title": "Site To Site Subscriber Move Supported"
},
{
"name": "dpCheck",
"title": "Check DialPlan Configuration"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "20.1.1",
"tagged_versions": []
},
"resources": [
{
"pkid": "5e8399d1ce894e0015b9a999",
"meta": {
"tags": [],
"cached": true,
"title": "title format",
"business_key": {},
"schema_version": "1.4",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5e8399d1ce894e0015b9a999",
"href": "/api/data/HcsMoveRestrictionsDAT/5e8399d1ce894e0015b9a999/"
}
],
"parent": [
{
"pkid": "5e839364ce894e0015b96604",
"href": "/api/data/HierarchyNode/5e839364ce894e0015b96604"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/HcsMoveRestrictionsDAT/5e8399d1ce894e0015b9a999/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/HcsMoveRestrictionsDAT/5e8399d1ce894e0015b9a999/",
"method": "DELETE",
"title": "Delete"
}
},
{
"import": {
"support_async": true,
"method": "POST",
"href": "/api/data/HcsMoveRestrictionsDAT/5e8399d1ce894e0015b9a999/import/",
"class": "import",
"title": "Import"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/HcsMoveRestrictionsDAT/5e8399d1ce894e0015b9a999/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"execute": {
"support_async": true,
"class": "execute",
"href": "/api/data/HcsMoveRestrictionsDAT/5e8399d1ce894e0015b9a999/execute/",
"method": "POST",
"title": "Execute"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/HcsMoveRestrictionsDAT/5e8399d1ce894e0015b9a999/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/HcsMoveRestrictionsDAT/5e8399d1ce894e0015b9a999/help",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/HcsMoveRestrictionsDAT",
"path": [
"6t0ggef2c0deab00hb595101",
"5e839364ce894e0015b96604",
"5e8399d1ce894e0015b9a999"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "moveSubCheck",
"title": "Site To Site Subscriber Move Supported"
},
{
"name": "dpCheck",
"title": "Check DialPlan Configuration"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "20.1.1",
"tagged_versions": []
},
"data": {
"roleCheck": true,
"countryCheck": true,
"dpCheck": false,
"name": "User Move Restrictions",
"pkid": "5e8399d1ce894e0015b9a99a",
"ndlrCheck": true,
"siteDefaultsCheck": true,
"syncToCheck": true,
"moveSubCheck": true,
"hierarchy_friendly_name": "hcs (Hcs)",
"ucResourceCheck": false,
"hierarchy_path": "sys.hcs"
}
}
]
}
(Show the first instance)
{
"pkid": "5e8399d1ce894e0015b9a999",
"meta": {
"tags": [],
"cached": false,
"title": "title format",
"business_key": {},
"schema_version": "1.4",
"references": {
"parent": [
{
"pkid": "5e839364ce894e0015b96604",
"href": "/api/data/HierarchyNode/5e839364ce894e0015b96604"
}
],
"self": [
{
"pkid": "5e8399d1ce894e0015b9a999",
"href": "/api/data/HcsMoveRestrictionsDAT/5e8399d1ce894e0015b9a999/"
}
],
"foreign_key": [],
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/HcsMoveRestrictionsDAT/5e8399d1ce894e0015b9a999/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/HcsMoveRestrictionsDAT/5e8399d1ce894e0015b9a999/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"import": {
"support_async": true,
"method": "POST",
"href": "/api/data/HcsMoveRestrictionsDAT/5e8399d1ce894e0015b9a999/import/?hierarchy=[hierarchy]",
"class": "import",
"title": "Import"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/HcsMoveRestrictionsDAT/5e8399d1ce894e0015b9a999/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"execute": {
"support_async": true,
"class": "execute",
"href": "/api/data/HcsMoveRestrictionsDAT/5e8399d1ce894e0015b9a999/execute/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Execute"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/HcsMoveRestrictionsDAT/5e8399d1ce894e0015b9a999/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/HcsMoveRestrictionsDAT/5e8399d1ce894e0015b9a999/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/HcsMoveRestrictionsDAT",
"path": [
"6t0ggef2c0deab00hb595101",
"5e839364ce894e0015b96604",
"5e8399d1ce894e0015b9a999"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "moveSubCheck",
"title": "Site To Site Subscriber Move Supported"
},
{
"name": "dpCheck",
"title": "Check DialPlan Configuration"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "20.1.1",
"tagged_versions": []
},
"data": {
"roleCheck": true,
"countryCheck": true,
"dpCheck": false,
"name": "User Move Restrictions",
"pkid": "5e8399d1ce894e0015b9a99a",
"ndlrCheck": true,
"siteDefaultsCheck": true,
"moveSubCheck": true,
"syncToCheck": true,
"ucResourceCheck": false
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/HcsMoveRestrictionsDAT. | GET | /api/data/HcsMoveRestrictionsDAT/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/HcsMoveRestrictionsDAT as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/HcsMoveRestrictionsDAT/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/HcsMoveRestrictionsDAT/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Import | POST | /api/data/HcsMoveRestrictionsDAT/[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/HcsMoveRestrictionsDAT; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/HcsMoveRestrictionsDAT/[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/HcsMoveRestrictionsDAT and the JSON format can be used to import instances of data/HcsMoveRestrictionsDAT.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Execute | POST | /api/data/HcsMoveRestrictionsDAT/[pkid]/execute/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/HcsMoveRestrictionsDAT/[pkid]/ | hierarchy=[hierarchy] | The data/HcsMoveRestrictionsDAT instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/HcsMoveRestrictionsDAT/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/HcsMoveRestrictionsDAT. |