[Index]
Model ref.: view/DeleteSubscriberService
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": {
"email": {
"type": "string",
"description": "Email address of the Subscriber to remove services from.",
"title": "Email"
},
"userid": {
"type": "string",
"description": "User ID of the Subscriber to remove services from.",
"title": "User ID"
},
"remove_phone": {
"type": "boolean",
"description": "If this field is set the user's Phone(s) will be removed",
"title": "Remove Phone"
},
"remove_phone_method": {
"description": "Remove Phone Method",
"title": "Remove Phone Method",
"default": "none",
"choices": [
{
"value": "phone_name",
"title": "By Phone Name"
},
{
"value": "phone_type",
"title": "By Phone Type"
},
{
"value": "all",
"title": "All"
}
],
"type": "string"
},
"remove_phone_types": {
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"title": "Name"
}
}
},
"type": "array",
"title": "Phone Types"
},
"remove_phone_names": {
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"title": "Name"
}
}
},
"type": "array",
"title": "Phone Names"
},
"remove_voice_mail": {
"type": "boolean",
"description": "If this field is set the user's VoiceMail service will be removed",
"title": "Remove Voice Mail"
},
"remove_extension_mobility": {
"type": "boolean",
"description": "If this field is set the user's Extension Mobility service will be removed",
"title": "Remove Extension Mobility"
},
"remove_snr": {
"type": "boolean",
"description": "If this field is set the user's SNR service will be removed",
"title": "Remove SNR"
},
"remove_uccx_agent": {
"type": "boolean",
"description": "If this field is set the user's Contact Center Express Agent will be removed",
"title": "Remove Contact Center Express Agent"
},
"remove_webex_teams_user": {
"type": "boolean",
"description": "If this field is set the user's Webext Teams services will be removed",
"title": "Remove Webex App"
},
"remove_pexip_conference": {
"type": "boolean",
"description": "If this field is set the user's Pexip Conference services will be removed",
"title": "Remove Pexip Conference"
},
"remove_ms_teams": {
"type": "boolean",
"description": "If this field is set the user's Microsoft Teams services will be removed",
"title": "Remove Microsoft Teams"
},
"remove_ms_o365": {
"type": "boolean",
"description": "If this field is set the user's Microsoft 0365 services will be removed",
"title": "Remove Microsoft 0365"
},
"remove_ms_hybrid": {
"type": "boolean",
"description": "If this field is set the user's Microsoft Hybrid services will be removed",
"title": "Remove Microsoft Hybrid"
},
"remove_all": {
"type": "boolean",
"description": "If this field is set all the user's services will be removed",
"title": "Remove all services"
},
"remove_primary_extension": {
"type": "boolean",
"description": "If this field is set the user's primary extension will be removed",
"title": "Remove primary extension"
}
},
"schema_version": "2.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/view/DeleteSubscriberService/add/ |
|
The GUI Add form of view/DeleteSubscriberService 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/DeleteSubscriberService | 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/DeleteSubscriberService | POST | /api/view/DeleteSubscriberService/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag | PATCH | /api/view/DeleteSubscriberService/+tag/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag Version | PATCH | /api/view/DeleteSubscriberService/+tag_version/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/view/DeleteSubscriberService/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/view/DeleteSubscriberService/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/view/DeleteSubscriberService/ |
|
The view/DeleteSubscriberService schema and all instances as JSON. |
(The list will return 0 to 3 view/DeleteSubscriberService instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": null,
"direction": "asc",
"current": "/api/view/DeleteSubscriberService/?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/DeleteSubscriberService",
"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": "2.0",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/view/DeleteSubscriberService/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/view/DeleteSubscriberService/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/view/DeleteSubscriberService/+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/view/DeleteSubscriberService/+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/view/DeleteSubscriberService/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/view/DeleteSubscriberService/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/view/DeleteSubscriberService/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/view/DeleteSubscriberService/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"transform": {
"method": "GET",
"class": "transform",
"href": "/api/view/DeleteSubscriberService/transform/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Transform Template"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for view/DeleteSubscriberService. | GET | /api/view/DeleteSubscriberService/help | hierarchy=[hierarchy] | On-line help of Model ref.: view/DeleteSubscriberService as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Transform Template | GET | /api/view/DeleteSubscriberService/transform/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/view/DeleteSubscriberService/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/view/DeleteSubscriberService/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/view/DeleteSubscriberService/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/view/DeleteSubscriberService/[pkid] | hierarchy=[hierarchy] | The view/DeleteSubscriberService instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/view/DeleteSubscriberService/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for view/DeleteSubscriberService. |