Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/view/CustomFields/add/	hierarchy=[hierarchy] format=json	The GUI Add form of view/CustomFields 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/CustomFields	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
Tag	PATCH	/api/view/CustomFields/+tag/	hierarchy=[hierarchy] format=json

Task	Call	URL	Parameters	Response
Configuration Template	GET	/api/view/CustomFields/configuration_template/	hierarchy=[hierarchy]	POST call to create the Configuration Template Configuration Template 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/ConfigurationTemplate/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Field Display Policy	GET	/api/view/CustomFields/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/CustomFields/	hierarchy=[hierarchy] format=json schema=true	The view/CustomFields schema and all instances as JSON.

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

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

{
     "pagination": {
          "skip": 0,
          "limit": 3,
          "maximum_limit": 2000,
          "total": 0,
          "total_limit": null,
          "order_by": null,
          "direction": "asc",
          "current": "/api/view/CustomFields/?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/CustomFields",
          "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": null,
          "actions": [
               {
                    "add": {
                         "method": "GET",
                         "class": "add",
                         "href": "/api/view/CustomFields/add/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Add"
                    }
               },
               {
                    "tag": {
                         "method": "PATCH",
                         "class": "tag",
                         "href": "/api/view/CustomFields/+tag/?hierarchy=[hierarchy]",
                         "support_async": true,
                         "title": "Tag",
                         "view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
                    }
               },
               {
                    "configuration_template": {
                         "method": "GET",
                         "class": "config",
                         "href": "/api/view/CustomFields/configuration_template/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Configuration Template"
                    }
               },
               {
                    "field_display_policy": {
                         "method": "GET",
                         "class": "display_policy",
                         "href": "/api/view/CustomFields/field_display_policy/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Field Display Policy"
                    }
               },
               {
                    "list": {
                         "method": "GET",
                         "class": "list",
                         "href": "/api/view/CustomFields/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "List"
                    }
               },
               {
                    "help": {
                         "method": "GET",
                         "class": "help",
                         "href": "/api/view/CustomFields/help?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Help"
                    }
               }
          ]
     },
     "resources": []
}

Task	Call	URL	Parameters	Response
Get the on-line Help for view/CustomFields.	GET	/api/view/CustomFields/help	hierarchy=[hierarchy]	On-line help of Model ref.: view/CustomFields as HTML

Task	Call	URL	Parameters	Response
Clone instance with [pkid]. The schema rules are applied.	GET	/api/view/CustomFields/[pkid]/clone/?schema=&schema_rules=true	hierarchy=[hierarchy]	A JSON payload with: A POST action URL. The unchanged model [pkid] payload to be modified to create a new instance.

For the instance pkids that can cloned, refer to the List GET call for view/CustomFields

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

Use the POST action in the response with a modification of the response payload to create the clone.

Task	Call	URL	Parameters	Payload
Tag	PATCH	/api/view/CustomFields/[pkid]/+tag	hierarchy=[hierarchy]	If payload required:

Task	Call	URL	Parameters	Response
Get	GET	/api/view/CustomFields/[pkid]	hierarchy=[hierarchy]	The view/CustomFields instance with [pkid].

Task	Call	URL	Parameters	Response
Help	GET	/api/view/CustomFields/[pkid]/help	hierarchy=[hierarchy]	The on-line Help for view/CustomFields.

API Reference for view/CustomFields

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

Get the Add form

Create

Tag

Configuration Template

Field Display Policy

List

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

Help

Instance API Reference

Clone

Tag

Get

Help