[Index]
HcsMoveSubCustomizationsDAT
Model ref.: data/HcsMoveSubCustomizationsDAT
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": "The name of the Move Customization Models", "title": "Name", "required": true, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "SubscribersPhones": { "is_password": false, "title": "Subscribers, Phones, Extention Mobility, RDP", "minItems": 0, "items": { "is_password": false, "type": "object", "properties": { "SubscribersPhones_modelTypeInternal": { "is_password": false, "description": "Customization type that needs to be added to Subscriber Move", "title": "Internal Customization Type", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "SubscribersPhones_knownModelLinkField": { "is_password": false, "description": "Field of existing context model that will be linked to field above", "title": "Context Field", "required": false, "displayable": false, "choices": [ {} ], "readonly": false, "maxLength": 1024, "type": "string" }, "SubscribersPhones_operation": { "is_password": false, "description": "Operation type - Move/Execute Before Group, Move/Execute After Group, Update After Move", "title": "Customization Operation", "required": false, "displayable": 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" } ], "readonly": false, "maxLength": 1024, "type": "string" }, "SubscribersPhones_knownModel": { "is_password": false, "description": "Existing context model that new model will be linked to", "title": "Context Model", "required": false, "displayable": false, "choices": [ { "value": "relation/LineRelation", "title": "relation/LineRelation" }, { "value": "data/InternalNumberInventory", "title": "data/InternalNumberInventory" }, { "value": "relation/Voicemail", "title": "relation/Voicemail" }, { "value": "relation/Subscriber", "title": "relation/Subscriber" }, { "value": "device/cucm/Phone", "title": "device/cucm/Phone" }, { "value": "relation/HcsUserREL", "title": "relation/HcsUserREL" }, { "value": "device/cucm/Line", "title": "device/cucm/Line" }, { "value": "device/cucm/RemoteDestinationProfile", "title": "device/cucm/RemoteDestinationProfile" }, { "value": "device/cucm/DeviceProfile", "title": "device/cucm/DeviceProfile" } ], "readonly": false, "maxLength": 1024, "type": "string" }, "SubscribersPhones_modelType": { "is_password": false, "description": "Customization type that needs to be added to Subscriber Move", "title": "Customization Type", "required": false, "displayable": false, "choices": [ { "value": "DataModel", "title": "DataModel" }, { "value": "DomainModel", "title": "DomainModel" }, { "value": "Device", "title": "Device" }, { "value": "Relation", "title": "Relation" }, { "value": "ProvisioningWorkflow", "title": "ProvisioningWorkflow" } ], "readonly": false, "maxLength": 1024, "type": "string" }, "SubscribersPhones_info": { "is_password": false, "description": "An extra note to remind admins not to use RELs/PWFs for CFT Updates.", "title": "Info", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "SubscribersPhones_modelWhereField": { "is_password": false, "description": "Field that will be linked to existing context models", "title": "Customization Field", "required": false, "displayable": false, "choices": [ {} ], "readonly": false, "maxLength": 1024, "type": "string" }, "SubscribersPhones_cft": { "is_password": false, "description": "Config Template that should be applied to the chosen model", "title": "Configuration Template", "required": false, "displayable": false, "choices": [ {} ], "readonly": false, "maxLength": 1024, "type": "string" }, "SubscribersPhones_modelName": { "is_password": false, "description": "Customization name that needs to be added to Subscriber Move", "title": "Customization Name", "required": false, "displayable": false, "choices": [ {} ], "readonly": false, "maxLength": 1024, "type": "string" } } }, "required": false, "displayable": false, "readonly": false, "type": "array" }, "LinesIni": { "is_password": false, "title": "Lines, INI", "minItems": 0, "items": { "is_password": false, "type": "object", "properties": { "LinesIni_modelType": { "is_password": false, "description": "Customization type that needs to be added to Subscriber Move", "title": "Customization Type", "required": false, "displayable": false, "choices": [ { "value": "DataModel", "title": "DataModel" }, { "value": "DomainModel", "title": "DomainModel" }, { "value": "Device", "title": "Device" }, { "value": "Relation", "title": "Relation" }, { "value": "ProvisioningWorkflow", "title": "ProvisioningWorkflow" } ], "readonly": false, "maxLength": 1024, "type": "string" }, "LinesIni_knownModel": { "is_password": false, "description": "Existing context model that new model will be linked to", "title": "Context Model", "required": false, "displayable": false, "choices": [ { "value": "relation/LineRelation", "title": "relation/LineRelation" }, { "value": "data/InternalNumberInventory", "title": "data/InternalNumberInventory" }, { "value": "relation/Voicemail", "title": "relation/Voicemail" }, { "value": "relation/Subscriber", "title": "relation/Subscriber" }, { "value": "device/cucm/Phone", "title": "device/cucm/Phone" }, { "value": "relation/HcsUserREL", "title": "relation/HcsUserREL" }, { "value": "device/cucm/Line", "title": "device/cucm/Line" }, { "value": "device/cucm/RemoteDestinationProfile", "title": "device/cucm/RemoteDestinationProfile" }, { "value": "device/cucm/DeviceProfile", "title": "device/cucm/DeviceProfile" } ], "readonly": false, "maxLength": 1024, "type": "string" }, "LinesIni_info": { "is_password": false, "description": "An extra note to remind admins not to use RELs/PWFs for CFT Updates.", "title": "Info", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "LinesIni_knownModelLinkField": { "is_password": false, "description": "Field of existing context model that will be linked to field above", "title": "Context Field", "required": false, "displayable": false, "choices": [ {} ], "readonly": false, "maxLength": 1024, "type": "string" }, "LinesIni_modelWhereField": { "is_password": false, "description": "Field that will be linked to existing context models", "title": "Customization Field", "required": false, "displayable": false, "choices": [ {} ], "readonly": false, "maxLength": 1024, "type": "string" }, "LinesIni_cft": { "is_password": false, "description": "Config Template that should be applied to the chosen model", "title": "Configuration Template", "required": false, "displayable": false, "choices": [ {} ], "readonly": false, "maxLength": 1024, "type": "string" }, "LinesIni_modelName": { "is_password": false, "description": "Customization name that needs to be added to Subscriber Move", "title": "Customization Name", "required": false, "displayable": false, "choices": [ {} ], "readonly": false, "maxLength": 1024, "type": "string" }, "LinesIni_operation": { "is_password": false, "description": "Operation type - Move/Execute Before Group, Move/Execute After Group, Update After Move", "title": "Customization Operation", "required": false, "displayable": 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" } ], "readonly": false, "maxLength": 1024, "type": "string" }, "LinesIni_modelTypeInternal": { "is_password": false, "description": "Customization type that needs to be added to Subscriber Move", "title": "Internal Customization Type", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" } } }, "required": false, "displayable": false, "readonly": false, "type": "array" }, "Voicemail": { "is_password": false, "title": "Voicemail", "minItems": 0, "items": { "is_password": false, "type": "object", "properties": { "Voicemail_info": { "is_password": false, "description": "An extra note to remind admins not to use RELs/PWFs for CFT Updates.", "title": "Info", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "Voicemail_knownModelLinkField": { "is_password": false, "description": "Field of existing context model that will be linked to field above", "title": "Context Field", "required": false, "displayable": false, "choices": [ {} ], "readonly": false, "maxLength": 1024, "type": "string" }, "Voicemail_cft": { "is_password": false, "description": "Config Template that should be applied to the chosen model", "title": "Configuration Template", "required": false, "displayable": false, "choices": [ {} ], "readonly": false, "maxLength": 1024, "type": "string" }, "Voicemail_modelType": { "is_password": false, "description": "Customization type that needs to be added to Subscriber Move", "title": "Customization Type", "required": false, "displayable": false, "choices": [ { "value": "DataModel", "title": "DataModel" }, { "value": "DomainModel", "title": "DomainModel" }, { "value": "Device", "title": "Device" }, { "value": "Relation", "title": "Relation" }, { "value": "ProvisioningWorkflow", "title": "ProvisioningWorkflow" } ], "readonly": false, "maxLength": 1024, "type": "string" }, "Voicemail_modelWhereField": { "is_password": false, "description": "Field that will be linked to existing context models", "title": "Customization Field", "required": false, "displayable": false, "choices": [ {} ], "readonly": false, "maxLength": 1024, "type": "string" }, "Voicemail_modelTypeInternal": { "is_password": false, "description": "Customization type that needs to be added to Subscriber Move", "title": "Internal Customization Type", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "Voicemail_knownModel": { "is_password": false, "description": "Existing context model that new model will be linked to", "title": "Context Model", "required": false, "displayable": false, "choices": [ { "value": "relation/LineRelation", "title": "relation/LineRelation" }, { "value": "data/InternalNumberInventory", "title": "data/InternalNumberInventory" }, { "value": "relation/Voicemail", "title": "relation/Voicemail" }, { "value": "relation/Subscriber", "title": "relation/Subscriber" }, { "value": "device/cucm/Phone", "title": "device/cucm/Phone" }, { "value": "relation/HcsUserREL", "title": "relation/HcsUserREL" }, { "value": "device/cucm/Line", "title": "device/cucm/Line" }, { "value": "device/cucm/RemoteDestinationProfile", "title": "device/cucm/RemoteDestinationProfile" }, { "value": "device/cucm/DeviceProfile", "title": "device/cucm/DeviceProfile" } ], "readonly": false, "maxLength": 1024, "type": "string" }, "Voicemail_modelName": { "is_password": false, "description": "Customization name that needs to be added to Subscriber Move", "title": "Customization Name", "required": false, "displayable": false, "choices": [ {} ], "readonly": false, "maxLength": 1024, "type": "string" }, "Voicemail_operation": { "is_password": false, "description": "Operation type - Move/Execute Before Group, Move/Execute After Group, Update After Move", "title": "Customization Operation", "required": false, "displayable": 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" } ], "readonly": false, "maxLength": 1024, "type": "string" } } }, "required": false, "displayable": false, "readonly": false, "type": "array" }, "description": { "is_password": false, "description": "The description of the Move Customization Models", "title": "Description", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "Users": { "is_password": false, "title": "Users", "minItems": 0, "items": { "is_password": false, "type": "object", "properties": { "Users_modelTypeInternal": { "is_password": false, "description": "Customization type that needs to be added to Subscriber Move", "title": "Internal Customization Type", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "Users_knownModelLinkField": { "is_password": false, "description": "Field of existing context model that will be linked to field above", "title": "Context Field", "required": false, "displayable": false, "choices": [ {} ], "readonly": false, "maxLength": 1024, "type": "string" }, "Users_operation": { "is_password": false, "description": "Operation type - Move/Execute Before Group, Move/Execute After Group, Update After Move", "title": "Customization Operation", "required": false, "displayable": 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" } ], "readonly": false, "maxLength": 1024, "type": "string" }, "Users_cft": { "is_password": false, "description": "Config Template that should be applied to the chosen model", "title": "Configuration Template", "required": false, "displayable": false, "choices": [ {} ], "readonly": false, "maxLength": 1024, "type": "string" }, "Users_modelWhereField": { "is_password": false, "description": "Field that will be linked to existing context models", "title": "Customization Field", "required": false, "displayable": false, "choices": [ {} ], "readonly": false, "maxLength": 1024, "type": "string" }, "Users_info": { "is_password": false, "description": "An extra note to remind admins not to use RELs/PWFs for CFT Updates.", "title": "Info", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "Users_modelType": { "is_password": false, "description": "Customization type that needs to be added to Subscriber Move", "title": "Customization Type", "required": false, "displayable": false, "choices": [ { "value": "DataModel", "title": "DataModel" }, { "value": "DomainModel", "title": "DomainModel" }, { "value": "Device", "title": "Device" }, { "value": "Relation", "title": "Relation" }, { "value": "ProvisioningWorkflow", "title": "ProvisioningWorkflow" } ], "readonly": false, "maxLength": 1024, "type": "string" }, "Users_knownModel": { "is_password": false, "description": "Existing context model that new model will be linked to", "title": "Context Model", "required": false, "displayable": false, "choices": [ { "value": "relation/LineRelation", "title": "relation/LineRelation" }, { "value": "data/InternalNumberInventory", "title": "data/InternalNumberInventory" }, { "value": "relation/Voicemail", "title": "relation/Voicemail" }, { "value": "relation/Subscriber", "title": "relation/Subscriber" }, { "value": "device/cucm/Phone", "title": "device/cucm/Phone" }, { "value": "relation/HcsUserREL", "title": "relation/HcsUserREL" }, { "value": "device/cucm/Line", "title": "device/cucm/Line" }, { "value": "device/cucm/RemoteDestinationProfile", "title": "device/cucm/RemoteDestinationProfile" }, { "value": "device/cucm/DeviceProfile", "title": "device/cucm/DeviceProfile" } ], "readonly": false, "maxLength": 1024, "type": "string" }, "Users_modelName": { "is_password": false, "description": "Customization name that needs to be added to Subscriber Move", "title": "Customization Name", "required": false, "displayable": false, "choices": [ {} ], "readonly": false, "maxLength": 1024, "type": "string" } } }, "required": false, "displayable": false, "readonly": false, "type": "array" } }, "schema_version": "1.7" }
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk delete [pkid1],[pkid2]... | DELETE | /api/data/HcsMoveSubCustomizationsDAT/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/HcsMoveSubCustomizationsDAT/[pkid1]", "/api/data/HcsMoveSubCustomizationsDAT/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/HcsMoveSubCustomizationsDAT/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/HcsMoveSubCustomizationsDAT; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/HcsMoveSubCustomizationsDAT/export/ |
|
{ "hrefs":["/api/data/HcsMoveSubCustomizationsDAT/[pkid1]", "/api/data/HcsMoveSubCustomizationsDAT/[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/HcsMoveSubCustomizationsDAT and the JSON format can be used to import instances of data/HcsMoveSubCustomizationsDAT.
GET http://[host-proxy]/api/data/HcsMoveSubCustomizationsDAT/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for data/HcsMoveSubCustomizationsDAT | POST | /api/data/HcsMoveSubCustomizationsDAT/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/data/HcsMoveSubCustomizationsDAT/ |
|
The data/HcsMoveSubCustomizationsDAT schema and all instances as JSON. |
(The list will return 0 to 3 data/HcsMoveSubCustomizationsDAT instances)
{ "operations": [ "field_display_policy", "configuration_template", "help", "get", "export_bulkload_template", "list", "update", "remove", "transform", "add", "export", "migration", "bulk_update_form" ], "pagination": { "direction": "asc", "order_by": "name", "maximum_limit": 2000, "skip": 0, "current": "/api/data/HcsMoveSubCustomizationsDAT/?skip=0&limit=3&order_by=name&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 0 }, "meta": { "tags": [], "cached": true, "title": "title format", "business_key": {}, "schema_version": "1.7", "references": { "device": [ { "pkid": "", "href": "" } ], "children": [], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [] }, "actions": [ { "remove": { "support_async": true, "class": "delete", "href": "/api/data/HcsMoveSubCustomizationsDAT/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/data/HcsMoveSubCustomizationsDAT/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/HcsMoveSubCustomizationsDAT/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "list": { "support_async": false, "class": "list", "href": "/api/data/HcsMoveSubCustomizationsDAT/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/data/HcsMoveSubCustomizationsDAT/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } } ], "model_type": "data/HcsMoveSubCustomizationsDAT", "model_specific_actions": [ "list", "get", "update", "remove", "import", "help", "clone", "export", "export_bulkload_template" ], "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "description", "title": "Description" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "resources": [] }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for data/HcsMoveSubCustomizationsDAT. | GET | /api/data/HcsMoveSubCustomizationsDAT/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/HcsMoveSubCustomizationsDAT as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/data/HcsMoveSubCustomizationsDAT/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/data/HcsMoveSubCustomizationsDAT/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/HcsMoveSubCustomizationsDAT/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/HcsMoveSubCustomizationsDAT/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Import | POST | /api/data/HcsMoveSubCustomizationsDAT/[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/HcsMoveSubCustomizationsDAT; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/HcsMoveSubCustomizationsDAT/[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/HcsMoveSubCustomizationsDAT and the JSON format can be used to import instances of data/HcsMoveSubCustomizationsDAT.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/data/HcsMoveSubCustomizationsDAT/[pkid]/ | hierarchy=[hierarchy] | The data/HcsMoveSubCustomizationsDAT instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/data/HcsMoveSubCustomizationsDAT/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/HcsMoveSubCustomizationsDAT. |