[Index]
Access profiles define model types that a user is permitted to access. Access profiles are assigned to users via Roles
Model ref.: data/AccessProfile
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"properties": {
"name": {
"title": "Name",
"description": "The name that is given to the Access Profile.",
"type": "string",
"required": true
},
"description": {
"title": "Description",
"description": "A description for the Access Profile.",
"type": "string",
"required": false
},
"full_access": {
"title": "Full Access",
"description": "Enabling this flag, grants the user full system access.",
"type": "boolean",
"required": false
},
"miscellaneous_permissions": {
"title": "Miscellaneous Permissions",
"description": "The list of miscellaneous operations permitted by this Access Profile.",
"type": "array",
"required": false,
"items": {
"type": "string",
"choices": [
{
"value": "",
"title": ""
}
]
}
},
"dashboard_permissions": {
"title": "Dashboard Permissions",
"type": "object",
"properties": {
"dashboard_permission_groups": {
"title": "Dashboard Permission Groups",
"description": "The list of dashboard permission groups that are permitted by this Access Profile.",
"type": "array",
"items": {
"type": "string"
}
},
"specific_permissions": {
"title": "Specific Permissions",
"description": "The list of specific resources permissions that are permitted by this Access Profile.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"type_specific_permissions": {
"title": "Type Specific Permissions",
"description": "The list of types that are permitted by this Access Profile.",
"type": "array",
"required": false,
"items": {
"type": "object",
"properties": {
"type": {
"title": "Permitted Type",
"description": "The type that is permitted by this Access Profile. This field supports the use of the * wildcard.",
"type": "string",
"format": "uri",
"required": true,
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "",
"choices": []
},
"operations": {
"title": "Permitted Operations",
"description": "The operations that are permitted by this Access Profile for the given type.",
"type": "array",
"required": true,
"items": {
"type": "string",
"choices": [
{
"value": "",
"title": ""
}
]
}
}
}
}
}
},
"schema_version": "0.1.9"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/AccessProfile/add/ |
|
The GUI Add form of data/AccessProfile 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/AccessProfile | 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/AccessProfile/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/AccessProfile/[pkid1]", "/api/data/AccessProfile/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/AccessProfile/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/data/AccessProfile/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/data/AccessProfile/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/data/AccessProfile/[pkid1]", "/api/v0/data/AccessProfile/[pkid2]",...]}} |
GET http://[host-proxy]/api/data/AccessProfile/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/AccessProfile; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/AccessProfile/export/ |
|
{ "hrefs":["/api/data/AccessProfile/[pkid1]", "/api/data/AccessProfile/[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/AccessProfile and the JSON format can be used to import instances of data/AccessProfile.
GET http://[host-proxy]/api/data/AccessProfile/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for data/AccessProfile | POST | /api/data/AccessProfile/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag | PATCH | /api/data/AccessProfile/+tag/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag Version | PATCH | /api/data/AccessProfile/+tag_version/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/data/AccessProfile/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/data/AccessProfile/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Migration Template | GET | /api/data/AccessProfile/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/AccessProfile/ |
|
The data/AccessProfile schema and all instances as JSON. |
(The list will return 0 to 3 data/AccessProfile instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 33,
"total_limit": null,
"order_by": "name",
"direction": "asc",
"current": "/api/data/AccessProfile/?skip=0&limit=3&order_by=name&direction=asc&traversal=fulltree"
},
"operations": [
"field_display_policy",
"update",
"help",
"remove",
"add",
"export",
"list",
"configuration_template",
"get",
"bulk_update_form",
"migration",
"transform",
"export_bulkload_template"
],
"meta": {
"model_type": "data/AccessProfile",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {
"unique": [
"name"
],
"hierarchy": true
},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": []
},
"model_specific_actions": [
"add",
"bulk_update_form",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"get",
"help",
"list",
"migration",
"remove",
"tag",
"tag_version",
"update"
],
"schema_version": "0.1.9",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/data/AccessProfile/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/AccessProfile/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"bulk_update_form": {
"method": "GET",
"class": "update",
"href": "/api/data/AccessProfile/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Bulk Modify"
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/data/AccessProfile/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/AccessProfile/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/AccessProfile/+tag/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/data/AccessProfile/+tag_version/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"configuration_template": {
"method": "GET",
"class": "config",
"href": "/api/data/AccessProfile/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/data/AccessProfile/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"migration": {
"method": "GET",
"class": "migration",
"href": "/api/data/AccessProfile/migration/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Migration Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/data/AccessProfile/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/AccessProfile/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": [
{
"data": {
"name": "default_selfservice_access_profile",
"description": "Default Access profile for selfservice users",
"dashboard_permissions": {
"specific_permissions": [
"User",
"Cisco UCM User",
"Cisco UCM Phone",
"Cisco UCM Device Profile",
"Cisco UCM Line",
"Cisco UCM Remote Destination",
"Cisco Webex User",
"Cisco CUC Call Handler",
"Cisco CUC User",
"Cisco UCM Remote Destination Profile",
"Microsoft Teams User",
"Microsoft Teams Client Configuration",
"Microsoft Teams Auto Attendant",
"Microsoft Teams Call Queue"
]
},
"type_specific_permissions": [
{
"type": "data/User",
"operations": [
"read",
"update"
]
},
{
"type": "data/Role",
"operations": [
"read",
"update"
]
},
{
"type": "data/Theme",
"operations": [
"read",
"update"
]
},
{
"type": "device/cucm/User",
"operations": [
"read",
"update"
]
},
{
"type": "device/cucm/Phone",
"operations": [
"read",
"update",
"create"
]
},
{
"type": "device/cucm/DeviceProfile",
"operations": [
"read",
"update"
]
},
{
"type": "device/cucm/Line",
"operations": [
"read",
"update"
]
},
{
"type": "device/cucm/RemoteDestination",
"operations": [
"read",
"update",
"delete",
"create"
]
},
{
"type": "device/cucm/Css",
"operations": [
"read",
"update"
]
},
{
"type": "data/SelfServiceLinks",
"operations": [
"read",
"update"
]
},
{
"type": "data/SelfServiceRequests",
"operations": [
"create"
]
},
{
"type": "tool/RelationalQuery",
"operations": [
"get_user_data"
]
},
{
"type": "device/cuc/UserPassword",
"operations": [
"read",
"update"
]
},
{
"type": "device/cuc/UserPin",
"operations": [
"read",
"update"
]
},
{
"type": "device/webex/User",
"operations": [
"read",
"update"
]
},
{
"type": "device/cucm/PhoneButtonTemplate",
"operations": [
"read",
"update"
]
},
{
"type": "device/cucm/TodAccess",
"operations": [
"read",
"update",
"create",
"delete"
]
},
{
"type": "device/cucm/TimeSchedule",
"operations": [
"read",
"update",
"create",
"delete"
]
},
{
"type": "device/cucm/TimePeriod",
"operations": [
"read",
"update",
"create",
"delete"
]
},
{
"type": "data/SelfServiceTranslation",
"operations": [
"read",
"update"
]
},
{
"type": "device/cuc/AlternateExtension",
"operations": [
"read",
"update",
"create",
"delete"
]
},
{
"type": "device/cuc/MessageHandler",
"operations": [
"read",
"update",
"create"
]
},
{
"type": "device/cuc/NotificationDevice",
"operations": [
"read",
"update"
]
},
{
"type": "device/cuc/PhoneDevice",
"operations": [
"read",
"update",
"create",
"delete"
]
},
{
"type": "device/cuc/Callhandler",
"operations": [
"read",
"update"
]
},
{
"type": "device/cuc/CallhandlerMenuEntry",
"operations": [
"read",
"update"
]
},
{
"type": "device/cuc/SmsDevice",
"operations": [
"create",
"delete",
"read",
"update"
]
},
{
"type": "data/SelfServiceFeatureDisplayPolicy",
"operations": [
"read"
]
},
{
"type": "device/cuc/User",
"operations": [
"read",
"update",
"create"
]
},
{
"type": "view/SSVoicemail",
"operations": [
"read",
"create"
]
},
{
"type": "device/cucm/RemoteDestinationProfile",
"operations": [
"read",
"update",
"create"
]
},
{
"type": "data/GS_FMC_UserExtended_DAT",
"operations": [
"read",
"update",
"bulk_update",
"configuration_template",
"create",
"delete",
"export",
"export_bulkload_template",
"field_display_policy",
"migration",
"tag",
"tag_version",
"transform"
]
},
{
"type": "view/GS_FMCv2_VIEW",
"operations": [
"read",
"create"
]
},
{
"type": "view/GS_FMCv2_SSUPDATE_VIEW",
"operations": [
"read",
"create"
]
},
{
"type": "tool/Macro",
"operations": [
"execute",
"help",
"read"
]
},
{
"type": "data/SelfServiceUserSettings",
"operations": [
"read",
"update",
"delete",
"create"
]
},
{
"type": "view/SelfServiceCallForward",
"operations": [
"read",
"create"
]
},
{
"type": "view/SSRemoteDestination",
"operations": [
"read",
"create"
]
}
],
"miscellaneous_permissions": [
"copilot_chat"
],
"pkid": "5ad5b465affa9343e4d92fc0",
"hierarchy_friendly_name": "sys (System)",
"hierarchy_path": "sys"
},
"meta": {
"model_type": "data/AccessProfile",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [
"V4UC",
"ba_CommonOverlay"
],
"title": "default_selfservice_access_profile",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/data/AccessProfile/5ad5b465affa9343e4d92fbf/",
"pkid": "5ad5b465affa9343e4d92fbf"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5b465affa9343e4d92fbf"
],
"system_resource": true,
"schema_version": "0.1.9",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/AccessProfile/5ad5b465affa9343e4d92fbf/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/AccessProfile/5ad5b465affa9343e4d92fbf/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/AccessProfile/5ad5b465affa9343e4d92fbf/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/AccessProfile/5ad5b465affa9343e4d92fbf/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/AccessProfile/5ad5b465affa9343e4d92fbf/+tag/",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/data/AccessProfile/5ad5b465affa9343e4d92fbf/+tag_version/",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/AccessProfile/5ad5b465affa9343e4d92fbf/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/AccessProfile/5ad5b465affa9343e4d92fbf/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "5ad5b465affa9343e4d92fbf"
},
{
"data": {
"description": "Default Access profile for selfservice users",
"name": "default_selfservice_access_profile_TEST",
"type_specific_permissions": [
{
"operations": [
"read",
"update"
],
"type": "data/User"
},
{
"operations": [
"read",
"update"
],
"type": "data/Theme"
},
{
"operations": [
"read",
"update"
],
"type": "device/cucm/User"
},
{
"operations": [
"read",
"update",
"create"
],
"type": "device/cucm/Phone"
},
{
"operations": [
"read",
"update"
],
"type": "device/cucm/DeviceProfile"
},
{
"operations": [
"read",
"update"
],
"type": "device/cucm/Line"
},
{
"operations": [
"read",
"update",
"delete",
"create"
],
"type": "device/cucm/RemoteDestination"
},
{
"operations": [
"read",
"update"
],
"type": "device/cucm/Css"
},
{
"operations": [
"read",
"update"
],
"type": "data/SelfServiceLinks"
},
{
"operations": [
"create"
],
"type": "data/SelfServiceRequests"
},
{
"operations": [
"get_user_data"
],
"type": "tool/RelationalQuery"
},
{
"operations": [
"read",
"update"
],
"type": "device/cuc/UserPassword"
},
{
"operations": [
"read",
"update"
],
"type": "device/cuc/UserPin"
},
{
"operations": [
"read",
"update"
],
"type": "device/webex/User"
},
{
"operations": [
"read",
"update"
],
"type": "device/cucm/PhoneButtonTemplate"
},
{
"operations": [
"read",
"update",
"create",
"delete"
],
"type": "device/cucm/TodAccess"
},
{
"operations": [
"read",
"update",
"create",
"delete"
],
"type": "device/cucm/TimeSchedule"
},
{
"operations": [
"read",
"update",
"create",
"delete"
],
"type": "device/cucm/TimePeriod"
},
{
"operations": [
"read",
"update"
],
"type": "data/SelfServiceTranslation"
},
{
"operations": [
"read",
"update",
"create",
"delete"
],
"type": "device/cuc/AlternateExtension"
},
{
"operations": [
"read",
"update",
"create"
],
"type": "device/cuc/MessageHandler"
},
{
"operations": [
"read",
"update"
],
"type": "device/cuc/NotificationDevice"
},
{
"operations": [
"read",
"update",
"create",
"delete"
],
"type": "device/cuc/PhoneDevice"
},
{
"operations": [
"read",
"update"
],
"type": "device/cuc/Callhandler"
},
{
"operations": [
"read",
"update"
],
"type": "device/cuc/CallhandlerMenuEntry"
},
{
"operations": [
"create",
"delete",
"read",
"update"
],
"type": "device/cuc/SmsDevice"
},
{
"operations": [
"read"
],
"type": "data/SelfServiceFeatureDisplayPolicy"
},
{
"operations": [
"read",
"update",
"create"
],
"type": "device/cuc/User"
},
{
"operations": [
"read",
"create"
],
"type": "view/SSVoicemail"
},
{
"operations": [
"read",
"update",
"create"
],
"type": "device/cucm/RemoteDestinationProfile"
},
{
"operations": [
"read",
"update",
"bulk_update",
"configuration_template",
"create",
"delete",
"export",
"export_bulkload_template",
"field_display_policy",
"migration",
"tag",
"tag_version",
"transform"
],
"type": "data/GS_FMC_UserExtended_DAT"
},
{
"operations": [
"execute",
"help",
"read"
],
"type": "tool/Macro"
},
{
"operations": [
"read",
"update",
"delete",
"create"
],
"type": "data/SelfServiceUserSettings"
},
{
"operations": [
"read",
"create"
],
"type": "view/SelfServiceCallForward"
}
],
"miscellaneous_permissions": [
"copilot_chat"
],
"dashboard_permissions": {
"specific_permissions": [
"User",
"Cisco UCM User",
"Cisco UCM Phone",
"Cisco UCM Device Profile",
"Cisco UCM Line",
"Cisco UCM Remote Destination",
"Cisco Webex User",
"Cisco CUC Call Handler",
"Cisco CUC User",
"Cisco UCM Remote Destination Profile"
]
},
"pkid": "650fe3dd84eaf2a1ce637b1b",
"hierarchy_friendly_name": "sys (System)",
"hierarchy_path": "sys"
},
"meta": {
"model_type": "data/AccessProfile",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [
"V4UC",
"ba_CommonOverlay"
],
"title": "default_selfservice_access_profile_TEST",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/data/AccessProfile/650fe3dd84eaf2a1ce637b1a/",
"pkid": "650fe3dd84eaf2a1ce637b1a"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"650fe3dd84eaf2a1ce637b1a"
],
"system_resource": true,
"schema_version": "0.1.9",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/AccessProfile/650fe3dd84eaf2a1ce637b1a/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/AccessProfile/650fe3dd84eaf2a1ce637b1a/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/AccessProfile/650fe3dd84eaf2a1ce637b1a/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/AccessProfile/650fe3dd84eaf2a1ce637b1a/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/AccessProfile/650fe3dd84eaf2a1ce637b1a/+tag/",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/data/AccessProfile/650fe3dd84eaf2a1ce637b1a/+tag_version/",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/AccessProfile/650fe3dd84eaf2a1ce637b1a/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/AccessProfile/650fe3dd84eaf2a1ce637b1a/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "650fe3dd84eaf2a1ce637b1a"
},
{
"data": {
"name": "DenyAll",
"pkid": "5abb946faffa931ce72a7474",
"hierarchy_friendly_name": "sys (System)",
"hierarchy_path": "sys"
},
"meta": {
"model_type": "data/AccessProfile",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [
"base",
"core"
],
"title": "DenyAll",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/data/AccessProfile/5abb946faffa931ce72a7473/",
"pkid": "5abb946faffa931ce72a7473"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5abb946faffa931ce72a7473"
],
"system_resource": true,
"schema_version": "0.1.9",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/AccessProfile/5abb946faffa931ce72a7473/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/AccessProfile/5abb946faffa931ce72a7473/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/AccessProfile/5abb946faffa931ce72a7473/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/AccessProfile/5abb946faffa931ce72a7473/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/AccessProfile/5abb946faffa931ce72a7473/+tag/",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/data/AccessProfile/5abb946faffa931ce72a7473/+tag_version/",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/AccessProfile/5abb946faffa931ce72a7473/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/AccessProfile/5abb946faffa931ce72a7473/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "5abb946faffa931ce72a7473"
}
]
}
(Show the first instance)
{
"data": {
"name": "default_selfservice_access_profile",
"description": "Default Access profile for selfservice users",
"dashboard_permissions": {
"specific_permissions": [
"User",
"Cisco UCM User",
"Cisco UCM Phone",
"Cisco UCM Device Profile",
"Cisco UCM Line",
"Cisco UCM Remote Destination",
"Cisco Webex User",
"Cisco CUC Call Handler",
"Cisco CUC User",
"Cisco UCM Remote Destination Profile",
"Microsoft Teams User",
"Microsoft Teams Client Configuration",
"Microsoft Teams Auto Attendant",
"Microsoft Teams Call Queue"
]
},
"type_specific_permissions": [
{
"type": "data/User",
"operations": [
"read",
"update"
]
},
{
"type": "data/Role",
"operations": [
"read",
"update"
]
},
{
"type": "data/Theme",
"operations": [
"read",
"update"
]
},
{
"type": "device/cucm/User",
"operations": [
"read",
"update"
]
},
{
"type": "device/cucm/Phone",
"operations": [
"read",
"update",
"create"
]
},
{
"type": "device/cucm/DeviceProfile",
"operations": [
"read",
"update"
]
},
{
"type": "device/cucm/Line",
"operations": [
"read",
"update"
]
},
{
"type": "device/cucm/RemoteDestination",
"operations": [
"read",
"update",
"delete",
"create"
]
},
{
"type": "device/cucm/Css",
"operations": [
"read",
"update"
]
},
{
"type": "data/SelfServiceLinks",
"operations": [
"read",
"update"
]
},
{
"type": "data/SelfServiceRequests",
"operations": [
"create"
]
},
{
"type": "tool/RelationalQuery",
"operations": [
"get_user_data"
]
},
{
"type": "device/cuc/UserPassword",
"operations": [
"read",
"update"
]
},
{
"type": "device/cuc/UserPin",
"operations": [
"read",
"update"
]
},
{
"type": "device/webex/User",
"operations": [
"read",
"update"
]
},
{
"type": "device/cucm/PhoneButtonTemplate",
"operations": [
"read",
"update"
]
},
{
"type": "device/cucm/TodAccess",
"operations": [
"read",
"update",
"create",
"delete"
]
},
{
"type": "device/cucm/TimeSchedule",
"operations": [
"read",
"update",
"create",
"delete"
]
},
{
"type": "device/cucm/TimePeriod",
"operations": [
"read",
"update",
"create",
"delete"
]
},
{
"type": "data/SelfServiceTranslation",
"operations": [
"read",
"update"
]
},
{
"type": "device/cuc/AlternateExtension",
"operations": [
"read",
"update",
"create",
"delete"
]
},
{
"type": "device/cuc/MessageHandler",
"operations": [
"read",
"update",
"create"
]
},
{
"type": "device/cuc/NotificationDevice",
"operations": [
"read",
"update"
]
},
{
"type": "device/cuc/PhoneDevice",
"operations": [
"read",
"update",
"create",
"delete"
]
},
{
"type": "device/cuc/Callhandler",
"operations": [
"read",
"update"
]
},
{
"type": "device/cuc/CallhandlerMenuEntry",
"operations": [
"read",
"update"
]
},
{
"type": "device/cuc/SmsDevice",
"operations": [
"create",
"delete",
"read",
"update"
]
},
{
"type": "data/SelfServiceFeatureDisplayPolicy",
"operations": [
"read"
]
},
{
"type": "device/cuc/User",
"operations": [
"read",
"update",
"create"
]
},
{
"type": "view/SSVoicemail",
"operations": [
"read",
"create"
]
},
{
"type": "device/cucm/RemoteDestinationProfile",
"operations": [
"read",
"update",
"create"
]
},
{
"type": "data/GS_FMC_UserExtended_DAT",
"operations": [
"read",
"update",
"bulk_update",
"configuration_template",
"create",
"delete",
"export",
"export_bulkload_template",
"field_display_policy",
"migration",
"tag",
"tag_version",
"transform"
]
},
{
"type": "view/GS_FMCv2_VIEW",
"operations": [
"read",
"create"
]
},
{
"type": "view/GS_FMCv2_SSUPDATE_VIEW",
"operations": [
"read",
"create"
]
},
{
"type": "tool/Macro",
"operations": [
"execute",
"help",
"read"
]
},
{
"type": "data/SelfServiceUserSettings",
"operations": [
"read",
"update",
"delete",
"create"
]
},
{
"type": "view/SelfServiceCallForward",
"operations": [
"read",
"create"
]
},
{
"type": "view/SSRemoteDestination",
"operations": [
"read",
"create"
]
}
],
"miscellaneous_permissions": [
"copilot_chat"
],
"pkid": "5ad5b465affa9343e4d92fc0"
},
"meta": {
"model_type": "data/AccessProfile",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [
"V4UC",
"ba_CommonOverlay"
],
"title": "default_selfservice_access_profile",
"business_key": {
"unique": [
"name"
],
"hierarchy": true
},
"api_version": "21.2",
"cached": false,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"foreign_key": [],
"children": [],
"self": [
{
"href": "/api/data/AccessProfile/5ad5b465affa9343e4d92fbf/",
"pkid": "5ad5b465affa9343e4d92fbf"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5b465affa9343e4d92fbf"
],
"system_resource": true,
"schema_version": "0.1.9",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/AccessProfile/5ad5b465affa9343e4d92fbf/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/AccessProfile/5ad5b465affa9343e4d92fbf/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/AccessProfile/5ad5b465affa9343e4d92fbf/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/AccessProfile/5ad5b465affa9343e4d92fbf/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/AccessProfile/5ad5b465affa9343e4d92fbf/+tag/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/data/AccessProfile/5ad5b465affa9343e4d92fbf/+tag_version/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/AccessProfile/5ad5b465affa9343e4d92fbf/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/AccessProfile/5ad5b465affa9343e4d92fbf/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"pkid": "5ad5b465affa9343e4d92fbf"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/AccessProfile. | GET | /api/data/AccessProfile/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/AccessProfile as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/AccessProfile/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/AccessProfile/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/AccessProfile/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/AccessProfile/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of data/AccessProfile; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/AccessProfile/[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/AccessProfile and the JSON format can be used to import instances of data/AccessProfile.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/data/AccessProfile/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/AccessProfile/[pkid] | hierarchy=[hierarchy] | The data/AccessProfile instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/AccessProfile/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/AccessProfile. |