[Index]
Hcs IntermediateNode Delete Customizations DAT
Model ref.: data/HcsIntermediateNodeDeleteCustomizationsDAT
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": {
"removeLdap": {
"is_password": false,
"title": "Remove LDAP Management Items",
"minItems": 0,
"items": {
"is_password": false,
"type": "object",
"properties": {
"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_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_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_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_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_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"
},
"name": {
"is_password": false,
"description": "The name of the Delete Customization Models",
"title": "Name",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"removeMisc2": {
"is_password": false,
"title": "Remove Files, DataSyncs, Events, Schedules, Logs, Reports",
"minItems": 0,
"items": {
"is_password": false,
"type": "object",
"properties": {
"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_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_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_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"
},
"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_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"
}
}
},
"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_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"
},
"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"
}
}
},
"required": false,
"displayable": false,
"readonly": false,
"type": "array"
},
"deleteIntermediateNode": {
"is_password": false,
"title": "Delete Intermediate Node",
"minItems": 0,
"items": {
"is_password": false,
"type": "object",
"properties": {
"deleteIntermediateNode_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"
},
"deleteIntermediateNode_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"
},
"deleteIntermediateNode_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_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"
},
"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"
}
}
},
"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_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"
},
"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_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"
}
}
},
"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_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"
},
"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"
}
}
},
"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_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"
},
"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"
}
}
},
"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"
},
"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_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"
},
"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"
}
}
},
"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"
},
"removeLowerHierarchyArtifacts": {
"is_password": false,
"title": "Lower Hierarchies",
"minItems": 0,
"items": {
"is_password": false,
"type": "object",
"properties": {
"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"
},
"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_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"
}
}
},
"required": false,
"displayable": false,
"readonly": false,
"type": "array"
},
"description": {
"is_password": false,
"description": "The description of the Delete Customization Models",
"title": "Description",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
}
},
"schema_version": "2.7"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/HcsIntermediateNodeDeleteCustomizationsDAT/add/ |
|
The GUI Add form of data/HcsIntermediateNodeDeleteCustomizationsDAT 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/HcsIntermediateNodeDeleteCustomizationsDAT/ | 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/HcsIntermediateNodeDeleteCustomizationsDAT/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/HcsIntermediateNodeDeleteCustomizationsDAT/[pkid1]", "/api/data/HcsIntermediateNodeDeleteCustomizationsDAT/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/HcsIntermediateNodeDeleteCustomizationsDAT/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/HcsIntermediateNodeDeleteCustomizationsDAT; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/HcsIntermediateNodeDeleteCustomizationsDAT/export/ |
|
{ "hrefs":["/api/data/HcsIntermediateNodeDeleteCustomizationsDAT/[pkid1]", "/api/data/HcsIntermediateNodeDeleteCustomizationsDAT/[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/HcsIntermediateNodeDeleteCustomizationsDAT and the JSON format can be used to import instances of data/HcsIntermediateNodeDeleteCustomizationsDAT.
GET http://[host-proxy]/api/data/HcsIntermediateNodeDeleteCustomizationsDAT/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for data/HcsIntermediateNodeDeleteCustomizationsDAT | POST | /api/data/HcsIntermediateNodeDeleteCustomizationsDAT/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/HcsIntermediateNodeDeleteCustomizationsDAT/ |
|
The data/HcsIntermediateNodeDeleteCustomizationsDAT schema and all instances as JSON. |
(The list will return 0 to 3 data/HcsIntermediateNodeDeleteCustomizationsDAT 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/HcsIntermediateNodeDeleteCustomizationsDAT/?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": "2.7",
"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/HcsIntermediateNodeDeleteCustomizationsDAT/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/HcsIntermediateNodeDeleteCustomizationsDAT/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/HcsIntermediateNodeDeleteCustomizationsDAT/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/HcsIntermediateNodeDeleteCustomizationsDAT/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/data/HcsIntermediateNodeDeleteCustomizationsDAT/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/HcsIntermediateNodeDeleteCustomizationsDAT/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/HcsIntermediateNodeDeleteCustomizationsDAT",
"model_specific_actions": [
"list",
"get",
"add",
"update",
"remove",
"import",
"execute",
"export",
"export_bulkload_template",
"help"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"resources": [
{
"pkid": "5dcc867633fc9b0018e948e9",
"meta": {
"tags": [],
"cached": true,
"title": "title format",
"business_key": {},
"schema_version": "2.7",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5dcc867633fc9b0018e948e9",
"href": "/api/data/HcsIntermediateNodeDeleteCustomizationsDAT/5dcc867633fc9b0018e948e9/"
}
],
"parent": [
{
"pkid": "5dcc7ff74544b7001862482f",
"href": "/api/data/HierarchyNode/5dcc7ff74544b7001862482f"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/HcsIntermediateNodeDeleteCustomizationsDAT/5dcc867633fc9b0018e948e9/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/HcsIntermediateNodeDeleteCustomizationsDAT/5dcc867633fc9b0018e948e9/",
"method": "DELETE",
"title": "Delete"
}
},
{
"import": {
"support_async": true,
"method": "POST",
"href": "/api/data/HcsIntermediateNodeDeleteCustomizationsDAT/5dcc867633fc9b0018e948e9/import/",
"class": "import",
"title": "Import"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/HcsIntermediateNodeDeleteCustomizationsDAT/5dcc867633fc9b0018e948e9/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"execute": {
"support_async": true,
"class": "execute",
"href": "/api/data/HcsIntermediateNodeDeleteCustomizationsDAT/5dcc867633fc9b0018e948e9/execute/",
"method": "POST",
"title": "Execute"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/HcsIntermediateNodeDeleteCustomizationsDAT/5dcc867633fc9b0018e948e9/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/HcsIntermediateNodeDeleteCustomizationsDAT/5dcc867633fc9b0018e948e9/help",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/HcsIntermediateNodeDeleteCustomizationsDAT",
"path": [
"6t0ggef2c0deab00hb595101",
"5dcc7ff74544b7001862482f",
"5dcc867633fc9b0018e948e9"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"data": {
"pkid": "5dcc867633fc9b0018e948ea",
"hierarchy_friendly_name": "hcs (Hcs)",
"description": "Default Customizations for IntermediateNode Hierarchy",
"name": "Default IntermediateNode Delete Customizations",
"hierarchy_path": "sys.hcs"
}
}
]
}
(Show the first instance)
{
"pkid": "5dcc867633fc9b0018e948e9",
"meta": {
"tags": [],
"cached": false,
"title": "title format",
"business_key": {},
"schema_version": "2.7",
"references": {
"parent": [
{
"pkid": "5dcc7ff74544b7001862482f",
"href": "/api/data/HierarchyNode/5dcc7ff74544b7001862482f"
}
],
"self": [
{
"pkid": "5dcc867633fc9b0018e948e9",
"href": "/api/data/HcsIntermediateNodeDeleteCustomizationsDAT/5dcc867633fc9b0018e948e9/"
}
],
"foreign_key": [],
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/HcsIntermediateNodeDeleteCustomizationsDAT/5dcc867633fc9b0018e948e9/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/HcsIntermediateNodeDeleteCustomizationsDAT/5dcc867633fc9b0018e948e9/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"import": {
"support_async": true,
"method": "POST",
"href": "/api/data/HcsIntermediateNodeDeleteCustomizationsDAT/5dcc867633fc9b0018e948e9/import/?hierarchy=[hierarchy]",
"class": "import",
"title": "Import"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/HcsIntermediateNodeDeleteCustomizationsDAT/5dcc867633fc9b0018e948e9/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"execute": {
"support_async": true,
"class": "execute",
"href": "/api/data/HcsIntermediateNodeDeleteCustomizationsDAT/5dcc867633fc9b0018e948e9/execute/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Execute"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/HcsIntermediateNodeDeleteCustomizationsDAT/5dcc867633fc9b0018e948e9/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/HcsIntermediateNodeDeleteCustomizationsDAT/5dcc867633fc9b0018e948e9/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/HcsIntermediateNodeDeleteCustomizationsDAT",
"path": [
"6t0ggef2c0deab00hb595101",
"5dcc7ff74544b7001862482f",
"5dcc867633fc9b0018e948e9"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"data": {
"pkid": "5dcc867633fc9b0018e948ea",
"name": "Default IntermediateNode Delete Customizations",
"description": "Default Customizations for IntermediateNode Hierarchy"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/HcsIntermediateNodeDeleteCustomizationsDAT. | GET | /api/data/HcsIntermediateNodeDeleteCustomizationsDAT/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/HcsIntermediateNodeDeleteCustomizationsDAT as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/HcsIntermediateNodeDeleteCustomizationsDAT/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/HcsIntermediateNodeDeleteCustomizationsDAT/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Import | POST | /api/data/HcsIntermediateNodeDeleteCustomizationsDAT/[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/HcsIntermediateNodeDeleteCustomizationsDAT; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/HcsIntermediateNodeDeleteCustomizationsDAT/[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/HcsIntermediateNodeDeleteCustomizationsDAT and the JSON format can be used to import instances of data/HcsIntermediateNodeDeleteCustomizationsDAT.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Execute | POST | /api/data/HcsIntermediateNodeDeleteCustomizationsDAT/[pkid]/execute/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/HcsIntermediateNodeDeleteCustomizationsDAT/[pkid]/ | hierarchy=[hierarchy] | The data/HcsIntermediateNodeDeleteCustomizationsDAT instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/HcsIntermediateNodeDeleteCustomizationsDAT/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/HcsIntermediateNodeDeleteCustomizationsDAT. |