[Index]
HcsMovePhoneCustomizationsDAT
Model ref.: data/HcsMovePhoneCustomizationsDAT
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": { "title": "Name", "description": "The name of the Move Customization Models", "type": "string", "maxLength": 1024, "required": true, "readonly": false, "is_password": false, "displayable": false }, "description": { "title": "Description", "description": "The description of the Move Customization Models", "type": "string", "maxLength": 1024, "required": false, "readonly": false, "is_password": false, "displayable": false }, "LinesIni": { "title": "Lines, INI", "type": "array", "minItems": 0, "required": false, "readonly": false, "is_password": false, "displayable": false, "items": { "type": "object", "is_password": false, "properties": { "LinesIni_operation": { "title": "Customization Operation", "description": "Operation type - Move/Execute Before Group, Move/Execute After Group, Update After Move", "type": "string", "maxLength": 1024, "required": false, "readonly": false, "displayable": false, "is_password": false, "choices": [ { "value": "Move/Execute Before Group", "title": "Move/Execute Before Group" }, { "value": "Move/Execute After Group", "title": "Move/Execute After Group" }, { "value": "Update After Move", "title": "Update After Move" } ] }, "LinesIni_modelType": { "title": "Customization Type", "description": "Customization type that needs to be added to Subscriber Move", "type": "string", "maxLength": 1024, "required": false, "readonly": false, "displayable": false, "is_password": false, "choices": [ { "value": "DataModel", "title": "DataModel" }, { "value": "DomainModel", "title": "DomainModel" }, { "value": "Device", "title": "Device" }, { "value": "Relation", "title": "Relation" }, { "value": "ProvisioningWorkflow", "title": "ProvisioningWorkflow" } ] }, "LinesIni_modelName": { "title": "Customization Name", "description": "Customization name that needs to be added to Subscriber Move", "type": "string", "maxLength": 1024, "required": false, "readonly": false, "displayable": false, "is_password": false, "choices": [ {} ] }, "LinesIni_modelWhereField": { "title": "Customization Field", "description": "Field that will be linked to existing context models", "type": "string", "maxLength": 1024, "required": false, "readonly": false, "displayable": false, "is_password": false, "choices": [ {} ] }, "LinesIni_knownModel": { "title": "Context Model", "description": "Existing context model that new model will be linked to", "type": "string", "maxLength": 1024, "required": false, "readonly": false, "displayable": false, "is_password": false, "choices": [ { "value": "relation/LineRelation", "title": "relation/LineRelation" }, { "value": "data/InternalNumberInventory", "title": "data/InternalNumberInventory" }, { "value": "device/cucm/Line", "title": "device/cucm/Line" }, { "value": "device/cucm/Phone", "title": "device/cucm/Phone" } ] }, "LinesIni_knownModelLinkField": { "title": "Context Field", "description": "Field of existing context model that will be linked to field above", "type": "string", "maxLength": 1024, "required": false, "readonly": false, "displayable": false, "is_password": false, "choices": [ {} ] }, "LinesIni_cft": { "title": "Configuration Template", "description": "Config Template that should be applied to the chosen model", "type": "string", "maxLength": 1024, "required": false, "readonly": false, "displayable": false, "is_password": false, "choices": [ {} ] }, "LinesIni_modelTypeInternal": { "title": "Internal Customization Type", "description": "Customization type that needs to be added to Subscriber Move", "type": "string", "maxLength": 1024, "required": false, "readonly": false, "displayable": false, "is_password": false }, "LinesIni_info": { "title": "Info", "description": "An extra note to remind admins not to use RELs/PWFs for CFT Updates.", "type": "string", "maxLength": 1024, "required": false, "readonly": false, "displayable": false, "is_password": false } } } }, "Phones": { "title": "Phones", "type": "array", "minItems": 0, "required": false, "readonly": false, "is_password": false, "displayable": false, "items": { "type": "object", "is_password": false, "properties": { "Phones_operation": { "title": "Customization Operation", "description": "Operation type - Move/Execute Before Group, Move/Execute After Group, Update After Move", "type": "string", "maxLength": 1024, "required": false, "readonly": false, "displayable": false, "is_password": false, "choices": [ { "value": "Move/Execute Before Group", "title": "Move/Execute Before Group" }, { "value": "Move/Execute After Group", "title": "Move/Execute After Group" }, { "value": "Update After Move", "title": "Update After Move" } ] }, "Phones_modelType": { "title": "Customization Type", "description": "Customization type that needs to be added to Subscriber Move", "type": "string", "maxLength": 1024, "required": false, "readonly": false, "displayable": false, "is_password": false, "choices": [ { "value": "DataModel", "title": "DataModel" }, { "value": "DomainModel", "title": "DomainModel" }, { "value": "Device", "title": "Device" }, { "value": "Relation", "title": "Relation" }, { "value": "ProvisioningWorkflow", "title": "ProvisioningWorkflow" } ] }, "Phones_modelName": { "title": "Customization Name", "description": "Customization name that needs to be added to Subscriber Move", "type": "string", "maxLength": 1024, "required": false, "readonly": false, "displayable": false, "is_password": false, "choices": [ {} ] }, "Phones_modelWhereField": { "title": "Customization Field", "description": "Field that will be linked to existing context models", "type": "string", "maxLength": 1024, "required": false, "readonly": false, "displayable": false, "is_password": false, "choices": [ {} ] }, "Phones_knownModel": { "title": "Context Model", "description": "Existing context model that new model will be linked to", "type": "string", "maxLength": 1024, "required": false, "readonly": false, "displayable": false, "is_password": false, "choices": [ { "value": "relation/LineRelation", "title": "relation/LineRelation" }, { "value": "data/InternalNumberInventory", "title": "data/InternalNumberInventory" }, { "value": "device/cucm/Line", "title": "device/cucm/Line" }, { "value": "device/cucm/Phone", "title": "device/cucm/Phone" } ] }, "Phones_knownModelLinkField": { "title": "Context Field", "description": "Field of existing context model that will be linked to field above", "type": "string", "maxLength": 1024, "required": false, "readonly": false, "displayable": false, "is_password": false, "choices": [ {} ] }, "Phones_cft": { "title": "Configuration Template", "description": "Config Template that should be applied to the chosen model", "type": "string", "maxLength": 1024, "required": false, "readonly": false, "displayable": false, "is_password": false, "choices": [ {} ] }, "Phones_modelTypeInternal": { "title": "Internal Customization Type", "description": "Customization type that needs to be added to Subscriber Move", "type": "string", "maxLength": 1024, "required": false, "readonly": false, "displayable": false, "is_password": false }, "Phones_info": { "title": "Info", "description": "An extra note to remind admins not to use RELs/PWFs for CFT Updates.", "type": "string", "maxLength": 1024, "required": false, "readonly": false, "displayable": false, "is_password": false } } } } }, "schema_version": "1.3" }
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk delete [pkid1],[pkid2]... | DELETE | /api/data/HcsMovePhoneCustomizationsDAT/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/HcsMovePhoneCustomizationsDAT/[pkid1]", "/api/data/HcsMovePhoneCustomizationsDAT/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/HcsMovePhoneCustomizationsDAT/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/HcsMovePhoneCustomizationsDAT; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/HcsMovePhoneCustomizationsDAT/export/ |
|
{ "hrefs":["/api/data/HcsMovePhoneCustomizationsDAT/[pkid1]", "/api/data/HcsMovePhoneCustomizationsDAT/[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/HcsMovePhoneCustomizationsDAT and the JSON format can be used to import instances of data/HcsMovePhoneCustomizationsDAT.
GET http://[host-proxy]/api/data/HcsMovePhoneCustomizationsDAT/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for data/HcsMovePhoneCustomizationsDAT | POST | /api/data/HcsMovePhoneCustomizationsDAT/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/data/HcsMovePhoneCustomizationsDAT/ |
|
The data/HcsMovePhoneCustomizationsDAT schema and all instances as JSON. |
(The list will return 0 to 3 data/HcsMovePhoneCustomizationsDAT instances)
{ "pagination": { "skip": 0, "limit": 3, "maximum_limit": 2000, "total": 1, "total_limit": null, "order_by": "name", "direction": "asc", "current": "/api/data/HcsMovePhoneCustomizationsDAT/?skip=0&limit=3&order_by=name&direction=asc&traversal=fulltree" }, "operations": [ "field_display_policy", "update", "help", "remove", "move", "add", "export", "list", "configuration_template", "get", "bulk_update_form", "migration", "transform", "export_bulkload_template" ], "meta": { "model_type": "data/HcsMovePhoneCustomizationsDAT", "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "description", "title": "Description" }, { "name": "hierarchy_friendly_name", "title": "Located At", "allow_filtering": true } ], "tagged_versions": [], "tags": [], "title": "", "business_key": { "unique": [ "name" ], "hierarchy": true }, "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", "update", "remove", "import", "help", "clone", "export", "export_bulkload_template" ], "schema_version": "1.3", "actions": [ { "remove": { "method": "DELETE", "class": "delete", "href": "/api/data/HcsMovePhoneCustomizationsDAT/?hierarchy=[hierarchy]", "support_async": true, "title": "Delete" } }, { "export": { "method": "POST", "class": "export", "href": "/api/data/HcsMovePhoneCustomizationsDAT/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/HcsMovePhoneCustomizationsDAT/export_bulkload_template/?hierarchy=[hierarchy]", "support_async": false, "title": "Export Bulk Load Template" } }, { "list": { "method": "GET", "class": "list", "href": "/api/data/HcsMovePhoneCustomizationsDAT/?hierarchy=[hierarchy]", "support_async": false, "title": "List" } }, { "help": { "method": "GET", "class": "help", "href": "/api/data/HcsMovePhoneCustomizationsDAT/help?hierarchy=[hierarchy]", "support_async": false, "title": "Help" } } ] }, "resources": [ { "data": { "description": "Default Customizations that will be applied when a Phone Move is executed", "LinesIni": [ { "LinesIni_modelType": "Device", "LinesIni_knownModel": "device/cucm/Line", "LinesIni_knownModelLinkField": "pattern", "LinesIni_modelWhereField": "pattern", "LinesIni_cft": "HcsUpdateLinesWithSiteDefaultDocCFT", "LinesIni_modelName": "device/cucm/Line", "LinesIni_operation": "Update After Move" } ], "Phones": [ { "Phones_knownModelLinkField": "name", "Phones_modelType": "Device", "Phones_cft": "HcsUpdateSubscriberPhoneWithNewSiteDefaultsCFT", "Phones_knownModel": "device/cucm/Phone", "Phones_modelName": "device/cucm/Phone", "Phones_operation": "Update After Move", "Phones_modelWhereField": "name" } ], "name": "Default Move Phone Customizations", "pkid": "5ad5e003affa9343e4d9a47d", "hierarchy_friendly_name": "hcs (Hcs)", "hierarchy_path": "sys.hcs" }, "meta": { "model_type": "data/HcsMovePhoneCustomizationsDAT", "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "description", "title": "Description" }, { "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": "5ad5bacbaffa9343e4d93e01", "href": "/api/data/HierarchyNode/5ad5bacbaffa9343e4d93e01" } ], "foreign_key": [], "self": [ { "href": "/api/data/HcsMovePhoneCustomizationsDAT/5ad5e003affa9343e4d9a47c/", "pkid": "5ad5e003affa9343e4d9a47c" } ] }, "path": [ "6t0ggef2c0deab00hb595101", "5ad5bacbaffa9343e4d93e01", "5ad5e003affa9343e4d9a47c" ], "schema_version": "1.3", "actions": [ { "update": { "method": "PUT", "class": "update", "href": "/api/data/HcsMovePhoneCustomizationsDAT/5ad5e003affa9343e4d9a47c/", "support_async": true, "title": "Modify" } }, { "remove": { "method": "DELETE", "class": "delete", "href": "/api/data/HcsMovePhoneCustomizationsDAT/5ad5e003affa9343e4d9a47c/", "support_async": true, "title": "Delete" } }, { "clone": { "method": "GET", "class": "clone", "href": "/api/data/HcsMovePhoneCustomizationsDAT/5ad5e003affa9343e4d9a47c/clone/?schema=&schema_rules=true", "support_async": false, "title": "Clone" } }, { "import": { "method": "POST", "class": "import", "href": "/api/data/HcsMovePhoneCustomizationsDAT/5ad5e003affa9343e4d9a47c/import/", "support_async": true, "title": "Import" } }, { "export": { "method": "GET", "class": "export", "href": "/api/data/HcsMovePhoneCustomizationsDAT/5ad5e003affa9343e4d9a47c/export/", "support_async": false, "title": "Export", "view": "/api/view/ExportData/add/", "submit": "payload" } }, { "get": { "method": "GET", "class": "get", "href": "/api/data/HcsMovePhoneCustomizationsDAT/5ad5e003affa9343e4d9a47c/", "support_async": false, "title": "Get" } }, { "help": { "method": "GET", "class": "help", "href": "/api/data/HcsMovePhoneCustomizationsDAT/5ad5e003affa9343e4d9a47c/help", "support_async": false, "title": "Help" } } ], "summary": "false" }, "pkid": "5ad5e003affa9343e4d9a47c" } ] }
(Show the first instance)
{ "data": { "description": "Default Customizations that will be applied when a Phone Move is executed", "LinesIni": [ { "LinesIni_modelType": "Device", "LinesIni_knownModel": "device/cucm/Line", "LinesIni_knownModelLinkField": "pattern", "LinesIni_modelWhereField": "pattern", "LinesIni_cft": "HcsUpdateLinesWithSiteDefaultDocCFT", "LinesIni_modelName": "device/cucm/Line", "LinesIni_operation": "Update After Move" } ], "Phones": [ { "Phones_knownModelLinkField": "name", "Phones_modelType": "Device", "Phones_cft": "HcsUpdateSubscriberPhoneWithNewSiteDefaultsCFT", "Phones_knownModel": "device/cucm/Phone", "Phones_modelName": "device/cucm/Phone", "Phones_operation": "Update After Move", "Phones_modelWhereField": "name" } ], "name": "Default Move Phone Customizations", "pkid": "5ad5e003affa9343e4d9a47d" }, "meta": { "model_type": "data/HcsMovePhoneCustomizationsDAT", "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "description", "title": "Description" }, { "name": "hierarchy_friendly_name", "title": "Located At", "allow_filtering": true } ], "tagged_versions": [], "tags": [], "title": "title format", "business_key": { "unique": [ "name" ], "hierarchy": true }, "api_version": "21.2", "cached": false, "references": { "device": [ { "href": "", "pkid": "" } ], "owner": [ { "pkid": "" } ], "parent": [ { "href": "/api/data/HierarchyNode/5ad5bacbaffa9343e4d93e01", "pkid": "5ad5bacbaffa9343e4d93e01" } ], "foreign_key": [], "children": [], "self": [ { "href": "/api/data/HcsMovePhoneCustomizationsDAT/5ad5e003affa9343e4d9a47c/", "pkid": "5ad5e003affa9343e4d9a47c" } ] }, "path": [ "6t0ggef2c0deab00hb595101", "5ad5bacbaffa9343e4d93e01", "5ad5e003affa9343e4d9a47c" ], "schema_version": "1.3", "actions": [ { "update": { "method": "PUT", "class": "update", "href": "/api/data/HcsMovePhoneCustomizationsDAT/5ad5e003affa9343e4d9a47c/?hierarchy=[hierarchy]", "support_async": true, "title": "Modify" } }, { "remove": { "method": "DELETE", "class": "delete", "href": "/api/data/HcsMovePhoneCustomizationsDAT/5ad5e003affa9343e4d9a47c/?hierarchy=[hierarchy]", "support_async": true, "title": "Delete" } }, { "clone": { "method": "GET", "class": "clone", "href": "/api/data/HcsMovePhoneCustomizationsDAT/5ad5e003affa9343e4d9a47c/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true", "support_async": false, "title": "Clone" } }, { "import": { "method": "POST", "class": "import", "href": "/api/data/HcsMovePhoneCustomizationsDAT/5ad5e003affa9343e4d9a47c/import/?hierarchy=[hierarchy]", "support_async": true, "title": "Import" } }, { "export": { "method": "GET", "class": "export", "href": "/api/data/HcsMovePhoneCustomizationsDAT/5ad5e003affa9343e4d9a47c/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/data/HcsMovePhoneCustomizationsDAT/5ad5e003affa9343e4d9a47c/?hierarchy=[hierarchy]", "support_async": false, "title": "Get" } }, { "help": { "method": "GET", "class": "help", "href": "/api/data/HcsMovePhoneCustomizationsDAT/5ad5e003affa9343e4d9a47c/help?hierarchy=[hierarchy]", "support_async": false, "title": "Help" } } ] }, "pkid": "5ad5e003affa9343e4d9a47c" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for data/HcsMovePhoneCustomizationsDAT. | GET | /api/data/HcsMovePhoneCustomizationsDAT/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/HcsMovePhoneCustomizationsDAT as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/data/HcsMovePhoneCustomizationsDAT/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/data/HcsMovePhoneCustomizationsDAT/[pkid] | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/HcsMovePhoneCustomizationsDAT/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/HcsMovePhoneCustomizationsDAT/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Import | POST | /api/data/HcsMovePhoneCustomizationsDAT/[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/HcsMovePhoneCustomizationsDAT; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/HcsMovePhoneCustomizationsDAT/[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/HcsMovePhoneCustomizationsDAT and the JSON format can be used to import instances of data/HcsMovePhoneCustomizationsDAT.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/data/HcsMovePhoneCustomizationsDAT/[pkid] | hierarchy=[hierarchy] | The data/HcsMovePhoneCustomizationsDAT instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/data/HcsMovePhoneCustomizationsDAT/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/HcsMovePhoneCustomizationsDAT. |