[Index]
Hcs Reseller Delete Customizations DAT
Model ref.: data/HcsResellerDeleteCustomizationsDAT
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 Delete Customization Models",
"title": "Name",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"description": {
"is_password": false,
"description": "The description of the Delete Customization Models",
"title": "Description",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"removeLowerHierarchyArtifacts": {
"is_password": false,
"title": "Lower Hierarchies",
"minItems": 0,
"items": {
"is_password": false,
"type": "object",
"properties": {
"removeLowerHierarchyArtifacts_modelType": {
"is_password": false,
"description": "Customizations type which need to be added to CD",
"title": "Customizations Type",
"required": true,
"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"
},
"removeLowerHierarchyArtifacts_modelName": {
"is_password": false,
"description": "Customizations name which need to be added to CD",
"title": "Customizations Name",
"required": true,
"displayable": false,
"choices": [
{
"value": " ",
"title": " "
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"removeLowerHierarchyArtifacts_operation": {
"is_password": false,
"description": "Operation type - Pre/Post",
"title": "Customizations Operation",
"required": true,
"displayable": false,
"choices": [
{
"value": "Pre",
"title": "Pre"
},
{
"value": "Post",
"title": "Post"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"required": false,
"displayable": false,
"readonly": false,
"type": "array"
},
"removeMisc1": {
"is_password": false,
"title": "Remove CPEs, Bulkload artifacts, Saved Searches, NorthBound Notifications",
"minItems": 0,
"items": {
"is_password": false,
"type": "object",
"properties": {
"removeMisc1_modelType": {
"is_password": false,
"description": "Customizations type which need to be added to CD",
"title": "Customizations Type",
"required": true,
"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"
},
"removeMisc1_modelName": {
"is_password": false,
"description": "Customizations name which need to be added to CD",
"title": "Customizations Name",
"required": true,
"displayable": false,
"choices": [
{
"value": " ",
"title": " "
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"removeMisc1_operation": {
"is_password": false,
"description": "Operation type - Pre/Post",
"title": "Customizations Operation",
"required": true,
"displayable": false,
"choices": [
{
"value": "Pre",
"title": "Pre"
},
{
"value": "Post",
"title": "Post"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"required": false,
"displayable": false,
"readonly": false,
"type": "array"
},
"setCucmUserLocal": {
"is_password": false,
"title": "Set CUCM User Status to Local Active",
"minItems": 0,
"items": {
"is_password": false,
"type": "object",
"properties": {
"setCucmUserLocal_modelType": {
"is_password": false,
"description": "Customizations type which need to be added to CD",
"title": "Customizations Type",
"required": true,
"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"
},
"setCucmUserLocal_modelName": {
"is_password": false,
"description": "Customizations name which need to be added to CD",
"title": "Customizations Name",
"required": true,
"displayable": false,
"choices": [
{
"value": " ",
"title": " "
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"setCucmUserLocal_operation": {
"is_password": false,
"description": "Operation type - Pre/Post",
"title": "Customizations Operation",
"required": true,
"displayable": false,
"choices": [
{
"value": "Pre",
"title": "Pre"
},
{
"value": "Post",
"title": "Post"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"required": false,
"displayable": false,
"readonly": false,
"type": "array"
},
"removeSubMgmt": {
"is_password": false,
"title": "Remove Subscriber Management Items",
"minItems": 0,
"items": {
"is_password": false,
"type": "object",
"properties": {
"removeSubMgmt_modelType": {
"is_password": false,
"description": "Customizations type which need to be added to CD",
"title": "Customizations Type",
"required": true,
"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"
},
"removeSubMgmt_modelName": {
"is_password": false,
"description": "Customizations name which need to be added to CD",
"title": "Customizations Name",
"required": true,
"displayable": false,
"choices": [
{
"value": " ",
"title": " "
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"removeSubMgmt_operation": {
"is_password": false,
"description": "Operation type - Pre/Post",
"title": "Customizations Operation",
"required": true,
"displayable": false,
"choices": [
{
"value": "Pre",
"title": "Pre"
},
{
"value": "Post",
"title": "Post"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"required": false,
"displayable": false,
"readonly": false,
"type": "array"
},
"purgeUsers": {
"is_password": false,
"title": "Purge LDAP Users",
"minItems": 0,
"items": {
"is_password": false,
"type": "object",
"properties": {
"purgeUsers_modelType": {
"is_password": false,
"description": "Customizations type which need to be added to CD",
"title": "Customizations Type",
"required": true,
"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"
},
"purgeUsers_modelName": {
"is_password": false,
"description": "Customizations name which need to be added to CD",
"title": "Customizations Name",
"required": true,
"displayable": false,
"choices": [
{
"value": " ",
"title": " "
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"purgeUsers_operation": {
"is_password": false,
"description": "Operation type - Pre/Post",
"title": "Customizations Operation",
"required": true,
"displayable": false,
"choices": [
{
"value": "Pre",
"title": "Pre"
},
{
"value": "Post",
"title": "Post"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"required": false,
"displayable": false,
"readonly": false,
"type": "array"
},
"removeUsers": {
"is_password": false,
"title": "Remove User Management Items",
"minItems": 0,
"items": {
"is_password": false,
"type": "object",
"properties": {
"removeUsers_modelType": {
"is_password": false,
"description": "Customizations type which need to be added to CD",
"title": "Customizations Type",
"required": true,
"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"
},
"removeUsers_modelName": {
"is_password": false,
"description": "Customizations name which need to be added to CD",
"title": "Customizations Name",
"required": true,
"displayable": false,
"choices": [
{
"value": " ",
"title": " "
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"removeUsers_operation": {
"is_password": false,
"description": "Operation type - Pre/Post",
"title": "Customizations Operation",
"required": true,
"displayable": false,
"choices": [
{
"value": "Pre",
"title": "Pre"
},
{
"value": "Post",
"title": "Post"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"required": false,
"displayable": false,
"readonly": false,
"type": "array"
},
"removeLdap": {
"is_password": false,
"title": "Remove LDAP Management Items",
"minItems": 0,
"items": {
"is_password": false,
"type": "object",
"properties": {
"removeLdap_modelType": {
"is_password": false,
"description": "Customizations type which need to be added to CD",
"title": "Customizations Type",
"required": true,
"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"
},
"removeLdap_modelName": {
"is_password": false,
"description": "Customizations name which need to be added to CD",
"title": "Customizations Name",
"required": true,
"displayable": false,
"choices": [
{
"value": " ",
"title": " "
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"removeLdap_operation": {
"is_password": false,
"description": "Operation type - Pre/Post",
"title": "Customizations Operation",
"required": true,
"displayable": false,
"choices": [
{
"value": "Pre",
"title": "Pre"
},
{
"value": "Post",
"title": "Post"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"required": false,
"displayable": false,
"readonly": false,
"type": "array"
},
"removeSSO": {
"is_password": false,
"title": "Remove SSO Management Items",
"minItems": 0,
"items": {
"is_password": false,
"type": "object",
"properties": {
"removeSSO_modelType": {
"is_password": false,
"description": "Customizations type which need to be added to CD",
"title": "Customizations Type",
"required": true,
"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"
},
"removeSSO_modelName": {
"is_password": false,
"description": "Customizations name which need to be added to CD",
"title": "Customizations Name",
"required": true,
"displayable": false,
"choices": [
{
"value": " ",
"title": " "
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"removeSSO_operation": {
"is_password": false,
"description": "Operation type - Pre/Post",
"title": "Customizations Operation",
"required": true,
"displayable": false,
"choices": [
{
"value": "Pre",
"title": "Pre"
},
{
"value": "Post",
"title": "Post"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"required": false,
"displayable": false,
"readonly": false,
"type": "array"
},
"removeDp": {
"is_password": false,
"title": "Remove Dial Plan Items",
"minItems": 0,
"items": {
"is_password": false,
"type": "object",
"properties": {
"removeDp_modelType": {
"is_password": false,
"description": "Customizations type which need to be added to CD",
"title": "Customizations Type",
"required": true,
"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"
},
"removeDp_modelName": {
"is_password": false,
"description": "Customizations name which need to be added to CD",
"title": "Customizations Name",
"required": true,
"displayable": false,
"choices": [
{
"value": " ",
"title": " "
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"removeDp_operation": {
"is_password": false,
"description": "Operation type - Pre/Post",
"title": "Customizations Operation",
"required": true,
"displayable": false,
"choices": [
{
"value": "Pre",
"title": "Pre"
},
{
"value": "Post",
"title": "Post"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"required": false,
"displayable": false,
"readonly": false,
"type": "array"
},
"purgeDevices": {
"is_password": false,
"title": "Purge Associated Devices",
"minItems": 0,
"items": {
"is_password": false,
"type": "object",
"properties": {
"purgeDevices_modelType": {
"is_password": false,
"description": "Customizations type which need to be added to CD",
"title": "Customizations Type",
"required": true,
"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"
},
"purgeDevices_modelName": {
"is_password": false,
"description": "Customizations name which need to be added to CD",
"title": "Customizations Name",
"required": true,
"displayable": false,
"choices": [
{
"value": " ",
"title": " "
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"purgeDevices_operation": {
"is_password": false,
"description": "Operation type - Pre/Post",
"title": "Customizations Operation",
"required": true,
"displayable": false,
"choices": [
{
"value": "Pre",
"title": "Pre"
},
{
"value": "Post",
"title": "Post"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"required": false,
"displayable": false,
"readonly": false,
"type": "array"
},
"deleteDevices": {
"is_password": false,
"title": "Delete Device Management Items",
"minItems": 0,
"items": {
"is_password": false,
"type": "object",
"properties": {
"deleteDevices_modelType": {
"is_password": false,
"description": "Customizations type which need to be added to CD",
"title": "Customizations Type",
"required": true,
"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"
},
"deleteDevices_modelName": {
"is_password": false,
"description": "Customizations name which need to be added to CD",
"title": "Customizations Name",
"required": true,
"displayable": false,
"choices": [
{
"value": " ",
"title": " "
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"deleteDevices_operation": {
"is_password": false,
"description": "Operation type - Pre/Post",
"title": "Customizations Operation",
"required": true,
"displayable": false,
"choices": [
{
"value": "Pre",
"title": "Pre"
},
{
"value": "Post",
"title": "Post"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"required": false,
"displayable": false,
"readonly": false,
"type": "array"
},
"removeEntitlement": {
"is_password": false,
"title": "Remove Entitlement Items",
"minItems": 0,
"items": {
"is_password": false,
"type": "object",
"properties": {
"removeEntitlement_modelType": {
"is_password": false,
"description": "Customizations type which need to be added to CD",
"title": "Customizations Type",
"required": true,
"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"
},
"removeEntitlement_modelName": {
"is_password": false,
"description": "Customizations name which need to be added to CD",
"title": "Customizations Name",
"required": true,
"displayable": false,
"choices": [
{
"value": " ",
"title": " "
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"removeEntitlement_operation": {
"is_password": false,
"description": "Operation type - Pre/Post",
"title": "Customizations Operation",
"required": true,
"displayable": false,
"choices": [
{
"value": "Pre",
"title": "Pre"
},
{
"value": "Post",
"title": "Post"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"required": false,
"displayable": false,
"readonly": false,
"type": "array"
},
"removeRole": {
"is_password": false,
"title": "Remove Role Management Items",
"minItems": 0,
"items": {
"is_password": false,
"type": "object",
"properties": {
"removeRole_modelType": {
"is_password": false,
"description": "Customizations type which need to be added to CD",
"title": "Customizations Type",
"required": true,
"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"
},
"removeRole_modelName": {
"is_password": false,
"description": "Customizations name which need to be added to CD",
"title": "Customizations Name",
"required": true,
"displayable": false,
"choices": [
{
"value": " ",
"title": " "
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"removeRole_operation": {
"is_password": false,
"description": "Operation type - Pre/Post",
"title": "Customizations Operation",
"required": true,
"displayable": false,
"choices": [
{
"value": "Pre",
"title": "Pre"
},
{
"value": "Post",
"title": "Post"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"required": false,
"displayable": false,
"readonly": false,
"type": "array"
},
"removeMisc2": {
"is_password": false,
"title": "Remove Files, DataSyncs, Events, Schedules, Logs, Reports",
"minItems": 0,
"items": {
"is_password": false,
"type": "object",
"properties": {
"removeMisc2_modelType": {
"is_password": false,
"description": "Customizations type which need to be added to CD",
"title": "Customizations Type",
"required": true,
"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"
},
"removeMisc2_modelName": {
"is_password": false,
"description": "Customizations name which need to be added to CD",
"title": "Customizations Name",
"required": true,
"displayable": false,
"choices": [
{
"value": " ",
"title": " "
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"removeMisc2_operation": {
"is_password": false,
"description": "Operation type - Pre/Post",
"title": "Customizations Operation",
"required": true,
"displayable": false,
"choices": [
{
"value": "Pre",
"title": "Pre"
},
{
"value": "Post",
"title": "Post"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"required": false,
"displayable": false,
"readonly": false,
"type": "array"
},
"deleteReseller": {
"is_password": false,
"title": "Delete Reseller",
"minItems": 0,
"items": {
"is_password": false,
"type": "object",
"properties": {
"deleteReseller_modelType": {
"is_password": false,
"description": "Customizations type which need to be added to CD",
"title": "Customizations Type",
"required": true,
"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"
},
"deleteReseller_modelName": {
"is_password": false,
"description": "Customizations name which need to be added to CD",
"title": "Customizations Name",
"required": true,
"displayable": false,
"choices": [
{
"value": " ",
"title": " "
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"deleteReseller_operation": {
"is_password": false,
"description": "Operation type - Pre/Post",
"title": "Customizations Operation",
"required": true,
"displayable": false,
"choices": [
{
"value": "Pre",
"title": "Pre"
},
{
"value": "Post",
"title": "Post"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"required": false,
"displayable": false,
"readonly": false,
"type": "array"
}
},
"schema_version": "2.7"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/HcsResellerDeleteCustomizationsDAT/add/ |
|
The GUI Add form of data/HcsResellerDeleteCustomizationsDAT 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/HcsResellerDeleteCustomizationsDAT | 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/HcsResellerDeleteCustomizationsDAT/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/HcsResellerDeleteCustomizationsDAT/[pkid1]", "/api/data/HcsResellerDeleteCustomizationsDAT/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/HcsResellerDeleteCustomizationsDAT/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/HcsResellerDeleteCustomizationsDAT; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/HcsResellerDeleteCustomizationsDAT/export/ |
|
{ "hrefs":["/api/data/HcsResellerDeleteCustomizationsDAT/[pkid1]", "/api/data/HcsResellerDeleteCustomizationsDAT/[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/HcsResellerDeleteCustomizationsDAT and the JSON format can be used to import instances of data/HcsResellerDeleteCustomizationsDAT.
GET http://[host-proxy]/api/data/HcsResellerDeleteCustomizationsDAT/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for data/HcsResellerDeleteCustomizationsDAT | POST | /api/data/HcsResellerDeleteCustomizationsDAT/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/HcsResellerDeleteCustomizationsDAT/ |
|
The data/HcsResellerDeleteCustomizationsDAT schema and all instances as JSON. |
(The list will return 0 to 3 data/HcsResellerDeleteCustomizationsDAT instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 1,
"total_limit": null,
"order_by": "name",
"direction": "asc",
"current": "/api/data/HcsResellerDeleteCustomizationsDAT/?skip=0&limit=3&order_by=name&direction=asc&traversal=down"
},
"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/HcsResellerDeleteCustomizationsDAT",
"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": {},
"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.7",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/data/HcsResellerDeleteCustomizationsDAT/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/HcsResellerDeleteCustomizationsDAT/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/data/HcsResellerDeleteCustomizationsDAT/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/HcsResellerDeleteCustomizationsDAT/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/data/HcsResellerDeleteCustomizationsDAT/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/HcsResellerDeleteCustomizationsDAT/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": [
{
"data": {
"pkid": "5ad5d9e0affa9343e4d99ad3",
"name": "Default Reseller Delete Customizations",
"description": "Default Customizations for Reseller Hierarchy",
"hierarchy_friendly_name": "hcs (Hcs)",
"hierarchy_path": "sys.hcs"
},
"meta": {
"model_type": "data/HcsResellerDeleteCustomizationsDAT",
"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/HcsResellerDeleteCustomizationsDAT/5ad5d9e0affa9343e4d99ad2/",
"pkid": "5ad5d9e0affa9343e4d99ad2"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ad5d9e0affa9343e4d99ad2"
],
"schema_version": "2.7",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/HcsResellerDeleteCustomizationsDAT/5ad5d9e0affa9343e4d99ad2/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/HcsResellerDeleteCustomizationsDAT/5ad5d9e0affa9343e4d99ad2/",
"support_async": true,
"title": "Delete"
}
},
{
"import": {
"method": "POST",
"class": "import",
"href": "/api/data/HcsResellerDeleteCustomizationsDAT/5ad5d9e0affa9343e4d99ad2/import/",
"support_async": true,
"title": "Import"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/HcsResellerDeleteCustomizationsDAT/5ad5d9e0affa9343e4d99ad2/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"execute": {
"method": "POST",
"class": "execute",
"href": "/api/data/HcsResellerDeleteCustomizationsDAT/5ad5d9e0affa9343e4d99ad2/execute/",
"support_async": true,
"title": "Execute"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/HcsResellerDeleteCustomizationsDAT/5ad5d9e0affa9343e4d99ad2/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/HcsResellerDeleteCustomizationsDAT/5ad5d9e0affa9343e4d99ad2/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "5ad5d9e0affa9343e4d99ad2"
}
]
}
(Show the first instance)
{
"data": {
"name": "Default Reseller Delete Customizations",
"description": "Default Customizations for Reseller Hierarchy",
"pkid": "5ad5d9e0affa9343e4d99ad3"
},
"meta": {
"model_type": "data/HcsResellerDeleteCustomizationsDAT",
"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": false,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"href": "/api/data/HierarchyNode/5ad5bacbaffa9343e4d93e01",
"pkid": "5ad5bacbaffa9343e4d93e01"
}
],
"foreign_key": [],
"children": [],
"self": [
{
"href": "/api/data/HcsResellerDeleteCustomizationsDAT/5ad5d9e0affa9343e4d99ad2/",
"pkid": "5ad5d9e0affa9343e4d99ad2"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ad5d9e0affa9343e4d99ad2"
],
"schema_version": "2.7",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/HcsResellerDeleteCustomizationsDAT/5ad5d9e0affa9343e4d99ad2/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/HcsResellerDeleteCustomizationsDAT/5ad5d9e0affa9343e4d99ad2/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"import": {
"method": "POST",
"class": "import",
"href": "/api/data/HcsResellerDeleteCustomizationsDAT/5ad5d9e0affa9343e4d99ad2/import/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Import"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/HcsResellerDeleteCustomizationsDAT/5ad5d9e0affa9343e4d99ad2/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/HcsResellerDeleteCustomizationsDAT/5ad5d9e0affa9343e4d99ad2/execute/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Execute"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/HcsResellerDeleteCustomizationsDAT/5ad5d9e0affa9343e4d99ad2/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/HcsResellerDeleteCustomizationsDAT/5ad5d9e0affa9343e4d99ad2/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"pkid": "5ad5d9e0affa9343e4d99ad2"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/HcsResellerDeleteCustomizationsDAT. | GET | /api/data/HcsResellerDeleteCustomizationsDAT/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/HcsResellerDeleteCustomizationsDAT as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/HcsResellerDeleteCustomizationsDAT/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/HcsResellerDeleteCustomizationsDAT/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Import | POST | /api/data/HcsResellerDeleteCustomizationsDAT/[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/HcsResellerDeleteCustomizationsDAT; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/HcsResellerDeleteCustomizationsDAT/[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/HcsResellerDeleteCustomizationsDAT and the JSON format can be used to import instances of data/HcsResellerDeleteCustomizationsDAT.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Execute | POST | /api/data/HcsResellerDeleteCustomizationsDAT/[pkid]/execute | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/HcsResellerDeleteCustomizationsDAT/[pkid] | hierarchy=[hierarchy] | The data/HcsResellerDeleteCustomizationsDAT instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/HcsResellerDeleteCustomizationsDAT/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/HcsResellerDeleteCustomizationsDAT. |