Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/view/ReplacePhone_VIEW/add/	hierarchy=[hierarchy] format=json	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]	(For payload specification)

Response is a transaction pkid for the create action.

The GET call to

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/	hierarchy=[hierarchy] modeltype=view/ReplacePhone_VIEW	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 call to create the Field Display Policy Field Display Policy schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
List	GET	/api/view/ReplacePhone_VIEW/	hierarchy=[hierarchy] format=json schema=true	The view/ReplacePhone_VIEW schema and all instances as JSON.

(The list will return 0 to 3 view/ReplacePhone_VIEW instances)

GET http://[host]/api/view/ReplacePhone_VIEW/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

{
     "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/ReplacePhone_VIEW/?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": "1.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/ReplacePhone_VIEW/add/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Add"
                    }
               }, 
               {
                    "export_bulkload_template": {
                         "support_async": false, 
                         "class": "bulkload_template", 
                         "href": "/api/view/ReplacePhone_VIEW/export_bulkload_template/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Export Bulk Load Template"
                    }
               }, 
               {
                    "field_display_policy": {
                         "support_async": false, 
                         "class": "display_policy", 
                         "href": "/api/view/ReplacePhone_VIEW/field_display_policy/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Field Display Policy"
                    }
               }, 
               {
                    "list": {
                         "support_async": false, 
                         "class": "list", 
                         "href": "/api/view/ReplacePhone_VIEW/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "List"
                    }
               }, 
               {
                    "help": {
                         "support_async": false, 
                         "class": "help", 
                         "href": "/api/view/ReplacePhone_VIEW/help?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Help"
                    }
               }
          ], 
          "model_type": "view/ReplacePhone_VIEW", 
          "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/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.

API Reference for view/ReplacePhone_VIEW

GET http://[host-proxy]/api/view/ReplacePhone_VIEW/schema/?hierarchy=[hierarchy]&format=json&schema=1

Get the Add form

Create

Export Bulk Load Template

Field Display Policy

List

GET http://[host]/api/view/ReplacePhone_VIEW/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

Help

Instance API Reference

Get

Help