[Index]
View to dynamically display device and links.
Model ref.: view/UserProvisioningStatus
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": { "msexchange_hierarchy": { "type": "string", "description": "MS Exchange User Hierarchy", "title": "MS Exchange User Hierarchy" }, "azure_hierarchy": { "type": "string", "description": "MS 365 User Hierarchy", "title": "MS 365 User Hierarchy" }, "msexchange_user_link": { "format": "link", "type": "string", "description": "MS Exchange User", "title": "MS Exchange User" }, "ldap_hierarchy": { "type": "string", "description": "LDAP User Hierarchy", "title": "LDAP User Hierarchy" }, "uccx_hierarchy": { "type": "string", "description": "UCCX User Hierarchy", "title": "UCCX User Hierarchy" }, "spark_hierarchy": { "type": "string", "description": "Webex App User Hierarchy", "title": "Webex App User Hierarchy" }, "cucm_bkey_20": { "type": "string", "description": "CUCM servers where the user exists.", "title": "CUCM 20" }, "spark_user_link": { "format": "link", "type": "string", "description": "Link to Webex App User", "title": "Webex App User" }, "hcmf_hierarchy": { "type": "string", "description": "HCMF User Hierarchy", "title": "HCMF User Hierarchy" }, "cucm_bkey_23": { "type": "string", "description": "CUCM servers where the user exists.", "title": "CUCM 23" }, "msteams_bkey": { "type": "string", "description": "MS Teams tenant where the user exists.", "title": "MS Teams Tenant" }, "msteams_hierarchy": { "type": "string", "description": "MS Teams User Hierarchy", "title": "MS Teams User Hierarchy" }, "cuc_user_link": { "format": "link", "type": "string", "description": "Link to CUC User", "title": "CUC User" }, "cucm_bkey_4": { "type": "string", "description": "CUCM servers where the user exists.", "title": "CUCM 4" }, "cucm_bkey": { "type": "string", "description": "CUCM server where the user exists.", "title": "CUCM Server" }, "spark_bkey": { "type": "string", "description": "Webex App server where the user exists.", "title": "Webex App Server" }, "cuc_hierarchy": { "type": "string", "description": "UUC User Hierarchy", "title": "CUC User Hierarchy" }, "cucm_bkey_30": { "type": "string", "description": "CUCM servers where the user exists.", "title": "CUCM 30" }, "cucm_bkey_14": { "type": "string", "description": "CUCM servers where the user exists.", "title": "CUCM 14" }, "cucm_bkey_15": { "type": "string", "description": "CUCM servers where the user exists.", "title": "CUCM 15" }, "cucm_bkey_16": { "type": "string", "description": "CUCM servers where the user exists.", "title": "CUCM 16" }, "cucm_bkey_17": { "type": "string", "description": "CUCM servers where the user exists.", "title": "CUCM 17" }, "cucm_bkey_10": { "type": "string", "description": "CUCM servers where the user exists.", "title": "CUCM 10" }, "cucm_bkey_11": { "type": "string", "description": "CUCM servers where the user exists.", "title": "CUCM 11" }, "cucm_bkey_12": { "type": "string", "description": "CUCM servers where the user exists.", "title": "CUCM 12" }, "cucm_bkey_13": { "type": "string", "description": "CUCM servers where the user exists.", "title": "CUCM 13" }, "pexip_user_link": { "format": "link", "type": "string", "description": "Link to Pexip User", "title": "Pexip" }, "cucm_bkey_18": { "type": "string", "description": "CUCM servers where the user exists.", "title": "CUCM 18" }, "cucm_bkey_19": { "type": "string", "description": "CUCM servers where the user exists.", "title": "CUCM 19" }, "hcmf_bkey": { "type": "string", "description": "HCMF server where the user exists.", "title": "HCMF Server" }, "username": { "type": "string", "description": "Username field as a placeholder, this field is not used.", "title": "VOSS User" }, "update_hybrid_status_link": { "format": "link", "type": "string", "description": "Update a Subscriber's Multi-Vendor Hybrid Status", "title": "Update Multi Vendor Hybrid Status" }, "cucm_bkey_26": { "type": "string", "description": "CUCM servers where the user exists.", "title": "CUCM 26" }, "ldap_bkey": { "type": "string", "description": "LDAP server where the user exists.", "title": "LDAP Server" }, "cucm_bkey_2": { "type": "string", "description": "CUCM servers where the user exists.", "title": "CUCM 2" }, "cucm_bkey_3": { "type": "string", "description": "CUCM servers where the user exists.", "title": "CUCM 3" }, "cucm_bkey_1": { "type": "string", "description": "CUCM servers where the user exists.", "title": "CUCM 1" }, "cucm_bkey_6": { "type": "string", "description": "CUCM servers where the user exists.", "title": "CUCM 6" }, "cucm_bkey_7": { "type": "string", "description": "CUCM servers where the user exists.", "title": "CUCM 7" }, "cucm_hierarchy": { "type": "string", "description": "UUCM User Hierarchy", "title": "CUCM User Hierarchy" }, "cucm_bkey_5": { "type": "string", "description": "CUCM servers where the user exists.", "title": "CUCM 5" }, "cucm_bkey_27": { "type": "string", "description": "CUCM servers where the user exists.", "title": "CUCM 27" }, "cucm_bkey_8": { "type": "string", "description": "CUCM servers where the user exists.", "title": "CUCM 8" }, "pexip_hierarchy": { "type": "string", "description": "Pexip Conference Hierarchy", "title": "Pexip Conference Hierarchy" }, "msexchange_bkey": { "type": "string", "description": "MS Exchange tenant where the user exists.", "title": "MS Exchange Tenant" }, "msteams_user_link": { "format": "link", "type": "string", "description": "MS Teams User", "title": "MS Teams User" }, "cucm_bkey_29": { "type": "string", "description": "CUCM servers where the user exists.", "title": "CUCM 29" }, "cucm_bkey_28": { "type": "string", "description": "CUCM servers where the user exists.", "title": "CUCM 28" }, "cucm_bkey_9": { "type": "string", "description": "CUCM servers where the user exists.", "title": "CUCM 9" }, "cucm_user_link": { "format": "link", "type": "string", "description": "Link to CUCM User", "title": "CUCM User" }, "cucm_bkey_25": { "type": "string", "description": "CUCM servers where the user exists.", "title": "CUCM 25" }, "cuc_bkey": { "type": "string", "description": "CUC server where the user exists.", "title": "CUC Server" }, "uccx_user_link": { "format": "link", "type": "string", "description": "Link to UCCX Agent", "title": "UCCX Agent" }, "azure_user_link": { "format": "link", "type": "string", "description": "MS 365 User", "title": "MS 365 User" }, "cucm_bkey_21": { "type": "string", "description": "CUCM servers where the user exists.", "title": "CUCM 21" }, "azure_bkey": { "type": "string", "description": "MS 365 tenant where the user exists.", "title": "MS 365 Tenant" }, "uccx_bkey": { "type": "string", "description": "UCCX server where the agent exists.", "title": "UCCX Server" }, "cucm_bkey_22": { "type": "string", "description": "CUCM servers where the user exists.", "title": "CUCM 22" }, "pexip_bkey": { "type": "string", "description": "Pexip server where the user exists.", "title": "Pexip Server" }, "cucm_bkey_24": { "type": "string", "description": "CUCM servers where the user exists.", "title": "CUCM 24" }, "hide_not_provisioned": { "type": "boolean", "description": "Hide/Show provisioned and un-provisioned data.", "title": "Provisioned" }, "cucm_ldap_directory": { "type": "string", "description": "CUCM LDAP Directory.", "title": "CUCM LDAP Directory" }, "voss_hierarchy": { "type": "string", "description": "VOSS User Hierarchy", "title": "VOSS User Hierarchy" } }, "schema_version": "1.0" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/view/UserProvisioningStatus/add/ |
|
The GUI Add form of view/UserProvisioningStatus 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/UserProvisioningStatus | 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 |
---|---|---|---|---|
Configuration Template | GET | /api/view/UserProvisioningStatus/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/view/UserProvisioningStatus/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/view/UserProvisioningStatus/ |
|
The view/UserProvisioningStatus schema and all instances as JSON. |
(The list will return 0 to 3 view/UserProvisioningStatus instances)
{ "operations": [ "add", "help", "configuration_template", "field_display_policy", "export_bulkload_template", "transform" ], "pagination": { "direction": "asc", "order_by": null, "maximum_limit": 2000, "skip": 0, "current": "/api/view/UserProvisioningStatus/?skip=0&limit=3&order_by=None&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 0 }, "meta": { "tags": [], "cached": true, "title": "", "business_key": {}, "schema_version": "1.0", "references": { "device": [ { "pkid": "", "href": "" } ], "children": [], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [] }, "actions": [ { "add": { "support_async": false, "class": "add", "href": "/api/view/UserProvisioningStatus/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "tag": { "title": "Tag", "support_async": true, "method": "PATCH", "href": "/api/view/UserProvisioningStatus/+tag/?hierarchy=[hierarchy]", "class": "tag", "view": "/api/view/TagNameForm/add/?auth_token=[authtoken] } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/view/UserProvisioningStatus/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/view/UserProvisioningStatus/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/view/UserProvisioningStatus/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/view/UserProvisioningStatus/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } } ], "model_type": "view/UserProvisioningStatus", "model_specific_actions": [ "add" ], "summary_attrs": [ { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "resources": [] }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for view/UserProvisioningStatus. | GET | /api/view/UserProvisioningStatus/help | hierarchy=[hierarchy] | On-line help of Model ref.: view/UserProvisioningStatus as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Tag | PATCH | /api/view/UserProvisioningStatus/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/view/UserProvisioningStatus/[pkid] | hierarchy=[hierarchy] | The view/UserProvisioningStatus instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/view/UserProvisioningStatus/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for view/UserProvisioningStatus. |