[Index]
Model ref.: view/SubscriberDeviceProfileUser
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": {
"addSubscriber1": {
"title": "Associate to additional Subscriber",
"description": "Select to display a dropdown to associate another subscriber. If disabled, first select a subscriber to enable this checkbox.",
"type": "boolean"
},
"username1": {
"title": "Username:",
"description": "Select a Subscriber to associate to this Extension Mobility, or clear the dropdown to disassociate from the Subscriber.",
"type": "string"
},
"userLink1": {
"title": "Subscriber:",
"description": "Link to the selected subscriber's edit page.",
"type": "string",
"format": "link"
},
"addSubscriber2": {
"title": "Associate to additional Subscriber",
"description": "Select to display a dropdown to associate another subscriber. If disabled, first select a subscriber to enable this checkbox.",
"type": "boolean"
},
"username2": {
"title": "Username:",
"description": "Select a Subscriber to associate to this Extension Mobility, or clear the dropdown to disassociate from the Subscriber.",
"type": "string"
},
"userLink2": {
"title": "Subscriber:",
"description": "Link to the selected subscriber's edit page.",
"type": "string",
"format": "link"
},
"addSubscriber3": {
"title": "Associate to additional Subscriber",
"description": "Select to display a dropdown to associate another subscriber. If disabled, first select a subscriber to enable this checkbox.",
"type": "boolean"
},
"username3": {
"title": "Username:",
"description": "Select a Subscriber to associate to this Extension Mobility, or clear the dropdown to disassociate from the Subscriber.",
"type": "string"
},
"userLink3": {
"title": "Subscriber:",
"description": "Link to the selected subscriber's edit page.",
"type": "string",
"format": "link"
},
"addSubscriber4": {
"title": "Associate to additional Subscriber",
"description": "Select to display a dropdown to associate another subscriber. If disabled, first select a subscriber to enable this checkbox.",
"type": "boolean"
},
"username4": {
"title": "Username:",
"description": "Select a Subscriber to associate to this Extension Mobility, or clear the dropdown to disassociate from the Subscriber.",
"type": "string"
},
"userLink4": {
"title": "Subscriber:",
"description": "Link to the selected subscriber's edit page.",
"type": "string",
"format": "link"
},
"addSubscriber5": {
"title": "Associate to additional Subscriber",
"description": "Select to display a dropdown to associate another subscriber. If disabled, first select a subscriber to enable this checkbox.",
"type": "boolean"
},
"username5": {
"title": "Username:",
"description": "Select a Subscriber to associate to this Extension Mobility, or clear the dropdown to disassociate from the Subscriber.",
"type": "string"
},
"userLink5": {
"title": "Subscriber:",
"description": "Link to the selected subscriber's edit page.",
"type": "string",
"format": "link"
}
},
"schema_version": "1.2"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/view/SubscriberDeviceProfileUser/add/ |
|
The GUI Add form of view/SubscriberDeviceProfileUser 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/SubscriberDeviceProfileUser | 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/SubscriberDeviceProfileUser | POST | /api/view/SubscriberDeviceProfileUser/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/SubscriberDeviceProfileUser/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/view/SubscriberDeviceProfileUser/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/view/SubscriberDeviceProfileUser/ |
|
The view/SubscriberDeviceProfileUser schema and all instances as JSON. |
(The list will return 0 to 3 view/SubscriberDeviceProfileUser instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": null,
"direction": "asc",
"current": "/api/view/SubscriberDeviceProfileUser/?skip=0&limit=3&order_by=None&direction=asc&traversal=down"
},
"operations": [
"help",
"configuration_template",
"field_display_policy",
"export_bulkload_template",
"transform"
],
"meta": {
"model_type": "view/SubscriberDeviceProfileUser",
"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": [],
"schema_version": "1.2",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/view/SubscriberDeviceProfileUser/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/view/SubscriberDeviceProfileUser/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"method": "GET",
"class": "config",
"href": "/api/view/SubscriberDeviceProfileUser/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/view/SubscriberDeviceProfileUser/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/view/SubscriberDeviceProfileUser/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/view/SubscriberDeviceProfileUser/[pkid] | hierarchy=[hierarchy] | The view/SubscriberDeviceProfileUser instance with [pkid]. |