[Index]
Model ref.: view/DeleteUnusedRoles
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": {
"description": {
"title": " ",
"type": "string",
"readonly": true,
"default": "Delete Unused Roles",
"maxLength": 1024
},
"notes": {
"title": " ",
"type": "string",
"readonly": true,
"default": "This tool allows you to delete all unused roles at a specified hierarchy/hierarchies or down from a specified hierarchy/hierarchies. Used roles will be skipped. Take caution. It is very destructive and cannot be rolled back. Please select the options from the dropdowns. If you select \"Yes\" in the first dropdown, all the unused roles down from the current Provider hierarchy will be deleted. Models where roles are used are: SiteDefaultsDoc, User, HcsLdapUserSyncDAT, HcsMoveFilterDAT, AuthorizedAdminHierarchy.",
"maxLength": 1024
},
"all_hierarchies": {
"title": "Would you like to delete unused roles at all hierarchies?",
"type": "string",
"default": "Yes",
"choices": [
{
"value": "Yes",
"title": "Yes"
},
{
"value": "No",
"title": "No"
}
],
"maxLength": 1024
},
"direction": {
"title": "Would you like to delete unused roles at a specific hierarchy or down from a specific hierarchy?",
"type": "string",
"default": "At",
"choices": [
{
"value": "At",
"title": "At"
},
{
"value": "Down",
"title": "Down"
}
],
"maxLength": 1024
},
"at_hierarchy": {
"title": "At which hierarchy do you want to delete unused roles?",
"type": "string",
"default": "Provider",
"choices": [
{
"value": "Provider",
"title": "Provider"
},
{
"value": "Reseller",
"title": "Reseller"
},
{
"value": "Customer",
"title": "Customer"
},
{
"value": "Site",
"title": "Site"
}
],
"maxLength": 1024
},
"from_hierarchy": {
"title": "From which hierarchy do you want to delete unused roles?",
"type": "string",
"default": "Reseller",
"choices": [
{
"value": "Reseller",
"title": "Reseller"
},
{
"value": "Customer",
"title": "Customer"
},
{
"value": "IntermediateNode",
"title": "IntermediateNode"
},
{
"value": "Site",
"title": "Site"
}
],
"maxLength": 1024
},
"reseller_scope": {
"title": "All resellers or a subset of resellers?",
"type": "string",
"default": "All",
"choices": [
{
"value": "All",
"title": "All"
},
{
"value": "Specific",
"title": "Specific"
}
],
"maxLength": 1024
},
"reseller_x": {
"title": "Resellers",
"type": "array",
"items": {
"type": "string",
"attr_props": [
{
"name": "resellers_x",
"title": "Chosen Resellers",
"type": "string"
}
],
"maxLength": 1024
}
},
"customer_scope": {
"title": "All customers or a subset of customers?",
"type": "string",
"default": "All",
"choices": [
{
"value": "All",
"title": "All"
},
{
"value": "Specific",
"title": "Specific"
}
],
"maxLength": 1024
},
"customer_x": {
"title": "Customers",
"type": "array",
"items": {
"type": "string",
"attr_props": [
{
"name": "customers_x",
"title": "Chosen Customers",
"type": "string"
}
],
"maxLength": 1024
}
},
"intermediatenode_scope": {
"title": "All IntermediateNodes or a subset of IntermediateNodes?",
"type": "string",
"default": "All",
"choices": [
{
"value": "All",
"title": "All"
},
{
"value": "Specific",
"title": "Specific"
}
],
"maxLength": 1024
},
"intermediatenode_x": {
"title": "IntermediateNodes",
"type": "array",
"items": {
"type": "string",
"attr_props": [
{
"name": "intermediatenodes_x",
"title": "Chosen Customers",
"type": "string"
}
],
"maxLength": 1024
}
},
"site_scope": {
"title": "All sites or a subset of sites?",
"type": "string",
"default": "All",
"choices": [
{
"value": "All",
"title": "All"
},
{
"value": "Specific",
"title": "Specific"
}
],
"maxLength": 1024
},
"site_x": {
"title": "Sites",
"type": "array",
"items": {
"type": "string",
"attr_props": [
{
"name": "sites_x",
"title": "Chosen Sites",
"type": "string"
}
],
"maxLength": 1024
}
},
"confirmation": {
"title": "Confirmation",
"type": "string",
"required": true,
"choices": [
{
"value": "Yes",
"title": "Yes, I confirm that I want to delete unused roles"
}
],
"maxLength": 1024
}
},
"schema_version": "1.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/view/DeleteUnusedRoles/add/ |
|
The GUI Add form of view/DeleteUnusedRoles 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/view/DeleteUnusedRoles | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]shows the View resource has no instance pkid, because a view model stores no instances.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for view/DeleteUnusedRoles | POST | /api/view/DeleteUnusedRoles/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for view/DeleteUnusedRoles. | GET | /api/view/DeleteUnusedRoles/help | hierarchy=[hierarchy] | On-line help of Model ref.: view/DeleteUnusedRoles as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/view/DeleteUnusedRoles/[pkid] | hierarchy=[hierarchy] | The view/DeleteUnusedRoles instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/view/DeleteUnusedRoles/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for view/DeleteUnusedRoles. |