[Index]
Model ref.: view/WebexTeamsSubscriberQas
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": {
"username": {
"required": true,
"type": "string",
"title": "Username"
},
"existing_username": {
"required": false,
"type": "string",
"description": "Used to determine whether user exists in Automate and therefore pre-populate user data",
"title": "Existing Username"
},
"org_ldap": {
"required": false,
"type": "string",
"description": "Used to determine whether the org is LDAP synced for user add",
"title": "LDAP Synced org"
},
"lookUpForUser": {
"default": true,
"type": "boolean",
"description": "Includes users above site level when searching",
"title": "Include users at higher hierarchy"
},
"first_name": {
"required": false,
"type": "string",
"title": "First name"
},
"last_name": {
"required": false,
"type": "string",
"title": "Last name"
},
"display_name": {
"required": false,
"type": "string",
"title": "Display Name"
},
"email": {
"format": "email",
"pattern": "^([^.@]+)(\\.[^.@]+)*@([^.@]+\\.)+([^.@]+)$",
"required": true,
"title": "Email address",
"type": "string"
},
"send_email": {
"type": "boolean",
"description": "Send Email to user using predefined HTML Email Template. Email template used is 'Quick Add Subscriber'. To enable email feature set 'Allow welcome email to be sent to user after Quick Add Subscriber' in Global Settings.",
"title": "Send welcome email"
},
"send_email_flag": {
"type": "boolean",
"description": "Send Email to user using predefined HTML Email Template. Email template used is 'Quick Add Subscriber'",
"title": "Send Email to user flag"
},
"password": {
"is_password": true,
"description": "The corresponding user password will be set with this password",
"title": "Password",
"required": false,
"type": "string"
},
"department": {
"required": false,
"type": "string",
"title": "Department"
},
"title": {
"required": false,
"type": "string",
"title": "Title"
},
"phone_number": {
"required": false,
"type": "string",
"title": "Phone number"
},
"mobile_phone": {
"required": false,
"type": "string",
"title": "Mobile phone"
},
"automatic_line": {
"type": "boolean",
"description": "Use the next available line from the inventory.",
"title": "Use next available line"
},
"qagroup_name": {
"target": "/api/data/QuickAddGroups/choices/?field=group_name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": true,
"target_attr": "group_name",
"title": "Quick Add Group",
"type": "string",
"target_model_type": "data/QuickAddGroups",
"choices": []
},
"webex_user_status": {
"type": "string",
"title": "User status"
},
"webex_user_exist": {
"type": "boolean",
"title": "webex_user_exist"
},
"custom_string_1": {
"type": "string",
"description": "Custom String",
"title": "Custom String 1"
},
"custom_string_2": {
"type": "string",
"description": "Custom String",
"title": "Custom String 2"
},
"custom_string_3": {
"type": "string",
"description": "Custom String",
"title": "Custom String 3"
},
"custom_string_4": {
"type": "string",
"description": "Custom String",
"title": "Custom String 4"
},
"custom_string_5": {
"type": "string",
"description": "Custom String",
"title": "Custom String 5"
},
"custom_string_6": {
"type": "string",
"description": "Custom String",
"title": "Custom String 6"
},
"custom_string_7": {
"type": "string",
"description": "Custom String",
"title": "Custom String 7"
},
"custom_string_8": {
"type": "string",
"description": "Custom String",
"title": "Custom String 8"
},
"custom_string_9": {
"type": "string",
"description": "Custom String",
"title": "Custom String 9"
},
"custom_string_10": {
"type": "string",
"description": "Custom String",
"title": "Custom String 10"
},
"custom_boolean_1": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 1"
},
"custom_boolean_2": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 2"
},
"custom_boolean_3": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 3"
},
"custom_boolean_4": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 4"
},
"custom_boolean_5": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 5"
},
"custom_boolean_6": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 6"
},
"custom_boolean_7": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 7"
},
"custom_boolean_8": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 8"
},
"custom_boolean_9": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 9"
},
"custom_boolean_10": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 10"
}
},
"schema_version": "4.4"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/view/WebexTeamsSubscriberQas/add/ |
|
The GUI Add form of view/WebexTeamsSubscriberQas 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/WebexTeamsSubscriberQas | 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/WebexTeamsSubscriberQas | POST | /api/view/WebexTeamsSubscriberQas/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/view/WebexTeamsSubscriberQas/ |
|
The view/WebexTeamsSubscriberQas schema and all instances as JSON. |
(The list will return 0 to 3 view/WebexTeamsSubscriberQas instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": null,
"direction": "asc",
"current": "/api/view/WebexTeamsSubscriberQas/?skip=0&limit=3&order_by=None&direction=asc&traversal=down"
},
"operations": [
"add",
"help",
"configuration_template",
"field_display_policy",
"export_bulkload_template",
"transform"
],
"meta": {
"model_type": "view/WebexTeamsSubscriberQas",
"summary_attrs": [
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"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"
],
"schema_version": "4.4",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/view/WebexTeamsSubscriberQas/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/view/WebexTeamsSubscriberQas/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/view/WebexTeamsSubscriberQas/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/view/WebexTeamsSubscriberQas/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for view/WebexTeamsSubscriberQas. | GET | /api/view/WebexTeamsSubscriberQas/help | hierarchy=[hierarchy] | On-line help of Model ref.: view/WebexTeamsSubscriberQas as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/view/WebexTeamsSubscriberQas/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for view/WebexTeamsSubscriberQas. |