[Index]
Model ref.: view/ReplacePhone_VIEW
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": {
"_trigger": {
"title": "_Trigger",
"description": "This _trigger field is for future use (improvements in upcoming iterations)",
"type": "string"
},
"existing_phone": {
"title": "Device Name",
"description": "Existing device which will be cloned",
"type": "string"
},
"existing_phone_type": {
"title": "Product",
"description": "Model type of existing device",
"type": "string"
},
"existing_phone_protocol": {
"title": "Device Protocol",
"description": "Protocol used by existing device",
"type": "string"
},
"existing_phone_pbt": {
"title": "Phone Button Template",
"description": "Phone Button Template used by existing device",
"type": "string"
},
"existing_phone_line": {
"title": "Line 1",
"description": "First DN on the existing device",
"type": "string"
},
"username": {
"title": "Username",
"description": "User that is currently associated with this existing device",
"type": "string"
},
"entitlement_profile": {
"title": "Entitlement Profile",
"description": "Entitlement Profile of the currently associated user (if any)",
"type": "string"
},
"replacement_phone": {
"title": "Device Name",
"description": "New name to be given to target replacement device",
"type": "string",
"pattern": "^([sS][eE][pP]|[B][O][T]|[T][A][B]|[T][C][T]|[C][S][F]|[aA][tT][aA])[0-9a-fA-F]{12}$"
},
"_message": {
"title": " ",
"description": "Phone fields below are hidden when a Phone CFT is specified",
"type": "string",
"default": "The above CFT will be used to supply replacement values for the phone fields."
},
"replacement_model": {
"title": "Product",
"description": "Model-type of replacement device",
"type": "string"
},
"replacement_description": {
"title": "Description",
"description": "Description string to use for target replacement device",
"type": "string"
},
"protocol": {
"title": "Device Protocol",
"description": "Protocol to use for target replacement device",
"type": "string"
},
"pbt": {
"title": "Phone Button Template",
"description": "Phone Button Template to use for target replacement device",
"type": "string"
},
"security_profile": {
"title": "Security Profile",
"description": "Security Profile to use for target replacement device",
"type": "string"
},
"cft": {
"title": "Phone Template",
"description": "(optional) Phone CFT can be selected here. If specified, then it will be used for parameter over-ride.",
"type": "string"
},
"product_macro_check": {
"title": "Product CFT Macro Check",
"description": "Field to house a check if product on cft is a macro or literal value. ",
"type": "boolean"
},
"protocol_macro_check": {
"title": "Protocol CFT Macro Check",
"description": "Field to house a check if protocol on cft is a macro or literal value. ",
"type": "boolean"
},
"pbt_macro_check": {
"title": "PBT CFT Macro Check",
"description": "Field to house a check if pbt on cft is a macro or literal value. ",
"type": "boolean"
},
"security_profile_macro_check": {
"title": "Security Profile CFT Macro Check",
"description": "Field to house a check if Security Profile on cft is a macro or literal value. ",
"type": "boolean"
},
"product_macro_field_eval": {
"title": "Product CFT field evaluation",
"description": "Field to house the evaluated value of Projuct from cft",
"type": "string"
},
"protocol_macro_field_eval": {
"title": "Protocol CFT field evaluation",
"description": "Field to house the evaluated value of Protocol from cft",
"type": "string"
},
"pbt_macro_field_eval": {
"title": "PBT CFT field evaluation",
"description": "Field to house the evaluated value of PBT from cft",
"type": "string"
},
"security_profile_field_eval": {
"title": "Security Profile CFT field evaluation",
"description": "Field to house the evaluated value of Security Profile from cft",
"type": "string"
}
},
"schema_version": "1.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/view/ReplacePhone_VIEW/add/ |
|
The GUI Add form of view/ReplacePhone_VIEW 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/ReplacePhone_VIEW | 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/ReplacePhone_VIEW | POST | /api/view/ReplacePhone_VIEW/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/view/ReplacePhone_VIEW/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/view/ReplacePhone_VIEW/ |
|
The view/ReplacePhone_VIEW schema and all instances as JSON. |
(The list will return 0 to 3 view/ReplacePhone_VIEW instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": null,
"direction": "asc",
"current": "/api/view/ReplacePhone_VIEW/?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/ReplacePhone_VIEW",
"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": "1.1",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/view/ReplacePhone_VIEW/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/view/ReplacePhone_VIEW/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/view/ReplacePhone_VIEW/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/view/ReplacePhone_VIEW/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/view/ReplacePhone_VIEW/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for view/ReplacePhone_VIEW. | GET | /api/view/ReplacePhone_VIEW/help | hierarchy=[hierarchy] | On-line help of Model ref.: view/ReplacePhone_VIEW as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/view/ReplacePhone_VIEW/[pkid] | hierarchy=[hierarchy] | The view/ReplacePhone_VIEW instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/view/ReplacePhone_VIEW/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for view/ReplacePhone_VIEW. |