[Index]
Model ref.: view/ResetUCPasswordPinVIEW
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": {
"message_VOSS_password": {
"type": "string",
"description": "If the VOSS-4-UC profile exists, the field will display a message to indicate if the password can be reset or not, depending on the profile status.",
"title": "VOSS Password"
},
"pin": {
"is_password": true,
"type": "string",
"description": "User to provide valid PIN in order to reset selected profiles.",
"title": "PIN"
},
"pexip_username": {
"type": "string",
"description": "Variable to determine whether Pexip Conference exists (pexip_username not empty); will not be displayed in the view.",
"title": "Pexip Conference Name"
},
"cucm": {
"default": "false",
"type": "boolean",
"description": "Check-box to select whether CUCM's password (if CUCM is not LDAP) and PIN will be reset.",
"title": "Reset CUCM"
},
"ldap_voss": {
"type": "string",
"description": "Variable to keep status of whether VOSS user is LDAP (ldap_voss = 'ldap'); will not be displayed in the view.",
"title": "Is User VOSS LDAP?"
},
"message_CUCM_password": {
"type": "string",
"description": "If the CUCM profile exists, the field will display a message to indicate if the password can be reset or not, depending on the profile status.",
"title": "CUCM Password"
},
"message_CUC_pin": {
"type": "string",
"description": "If the CUC profile exists, the field will display a message to indicate how the PIN can be reset.",
"title": "CUC PIN"
},
"webex": {
"default": "false",
"type": "boolean",
"description": "Check-box to select whether WebEx password will be reset.",
"title": "Reset WebEx"
},
"cuc": {
"default": "false",
"type": "boolean",
"description": "Check-box to select whether CUC's password (if CUC is not LDAP) and PIN will be reset.",
"title": "Reset CUC"
},
"cucm_username": {
"type": "string",
"description": "Variable to determine whether CUCM user exists (cucm_username not empty); will not be displayed in the view.",
"title": "CUCM User Name"
},
"message_Webex_password": {
"type": "string",
"description": "If the WebEx profile exists, the field will display a message to indicate how the password can be reset.",
"title": "WebEx Password"
},
"voss_username": {
"type": "string",
"description": "Variable to determine whether VOSS user exists (voss_username not empty); will not be displayed in the view.",
"title": "User name in VOSS"
},
"message_PexIP_pin": {
"type": "string",
"description": "If the Pexip Conference account exists, the field will display a message to indicate how the PIN can be reset.",
"title": "Pexip Conference Host PIN"
},
"message_CUCM_pin": {
"type": "string",
"description": "If the CUCM profile exists, the field will display a message to indicate how the PIN can be reset.",
"title": "CUCM PIN"
},
"user": {
"type": "string",
"description": "Drop-down list of users available on CUCM.",
"title": "User"
},
"ldap_cucm": {
"type": "string",
"description": "Variable to keep status of whether CUCM user is LDAP (ldap_cucm value not empty); will not be displayed in the view.",
"title": "Is User CUCM LDAP?"
},
"ldap_cuc": {
"type": "integer",
"description": "Variable to keep status of whether CUC user is LDAP (ldap_cuc = 2); will not be displayed in the view.",
"title": "Is User CUC LDAP?"
},
"password": {
"is_password": true,
"type": "string",
"description": "User to provide valid password in order to reset selected profiles.",
"title": "Password"
},
"message_CUC_password": {
"type": "string",
"description": "If the CUC profile exists, the field will display a message to indicate if the password can be reset or not, depending on the profile status.",
"title": "CUC Password"
},
"pexip": {
"default": "false",
"type": "boolean",
"description": "Check-box to select whether Pexip Conference PIN will be reset.",
"title": "Reset Pexip Conference"
},
"cuc_username": {
"type": "string",
"description": "Variable to determine whether CUC user exists (cuc_username not empty); will not be displayed in the view.",
"title": "CUC User Name"
},
"webex_username": {
"type": "string",
"description": "Variable to determine whether WebEx user exists (webex_username not empty); will not be displayed in the view.",
"title": "WebEx User Name"
}
},
"schema_version": "2.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/view/ResetUCPasswordPinVIEW/add/ |
|
The GUI Add form of view/ResetUCPasswordPinVIEW 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/ResetUCPasswordPinVIEW/ | 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/ResetUCPasswordPinVIEW | POST | /api/view/ResetUCPasswordPinVIEW/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/view/ResetUCPasswordPinVIEW/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/view/ResetUCPasswordPinVIEW/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/view/ResetUCPasswordPinVIEW/ |
|
The view/ResetUCPasswordPinVIEW schema and all instances as JSON. |
(The list will return 0 to 3 view/ResetUCPasswordPinVIEW 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/ResetUCPasswordPinVIEW/?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": "2.1",
"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/ResetUCPasswordPinVIEW/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/view/ResetUCPasswordPinVIEW/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/view/ResetUCPasswordPinVIEW/+tag/?hierarchy=[hierarchy]",
"class": "tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/view/ResetUCPasswordPinVIEW/+tag_version/?hierarchy=[hierarchy]",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/view/ResetUCPasswordPinVIEW/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/view/ResetUCPasswordPinVIEW/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/view/ResetUCPasswordPinVIEW/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/view/ResetUCPasswordPinVIEW/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"transform": {
"support_async": false,
"class": "transform",
"href": "/api/view/ResetUCPasswordPinVIEW/transform/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Transform Template"
}
}
],
"model_type": "view/ResetUCPasswordPinVIEW",
"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/ResetUCPasswordPinVIEW. | GET | /api/view/ResetUCPasswordPinVIEW/help | hierarchy=[hierarchy] | On-line help of Model ref.: view/ResetUCPasswordPinVIEW as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/view/ResetUCPasswordPinVIEW/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/view/ResetUCPasswordPinVIEW/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/view/ResetUCPasswordPinVIEW/[pkid]/+tag/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/view/ResetUCPasswordPinVIEW/[pkid]/ | hierarchy=[hierarchy] | The view/ResetUCPasswordPinVIEW instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/view/ResetUCPasswordPinVIEW/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for view/ResetUCPasswordPinVIEW. |