API Reference for data/BusinessAdminBaseLookups

Utility model to allow Business Admin Portal to perform macro lookups.

The full URL would include the host-proxy name: https://[host-proxy].

Variables are enclosed in square brackets.

[hierarchy] is the hierarchy.

as UUID. For example: 6t0ggef2c0deab00hb595101
in dot notation. E.g. ProviderName.CustomerName.LocationName

[pkid] is the ID of the resource instance. Refer to the List reference below.

[filename] refers to a file

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

Response is a transaction pkid for the create action.

Use the GET call to

tool/Transaction/[trans pkid]

to inspect the created resource and its instance pkid.

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

(The list will return 0 to 3 data/BusinessAdminBaseLookups instances)

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

{
     "operations": [
          "field_display_policy", 
          "configuration_template", 
          "help", 
          "get", 
          "export_bulkload_template", 
          "list", 
          "update", 
          "remove", 
          "move", 
          "transform", 
          "add", 
          "export", 
          "migration", 
          "bulk_update_form"
     ], 
     "pagination": {
          "direction": "asc", 
          "order_by": "name", 
          "maximum_limit": 2000, 
          "skip": 0, 
          "current": "/api/data/BusinessAdminBaseLookups/?skip=0&limit=3&order_by=name&direction=asc&traversal=default", 
          "limit": 3, 
          "total_limit": null, 
          "total": 0
     }, 
     "meta": {
          "tags": [], 
          "cached": true, 
          "title": "?", 
          "business_key": {
               "hierarchy": true, 
               "unique": [
                    "name"
               ]
          }, 
          "schema_version": "1.0.0", 
          "references": {
               "device": [
                    {
                         "pkid": "", 
                         "href": ""
                    }
               ], 
               "children": [], 
               "parent": [
                    {
                         "pkid": "6t0ggef2c0deab00hb595101", 
                         "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
                    }
               ], 
               "foreign_key": []
          }, 
          "actions": [
               {
                    "add": {
                         "support_async": false, 
                         "class": "add", 
                         "href": "/api/data/BusinessAdminBaseLookups/add/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Add"
                    }
               }, 
               {
                    "list": {
                         "support_async": false, 
                         "class": "list", 
                         "href": "/api/data/BusinessAdminBaseLookups/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "List"
                    }
               }
          ], 
          "model_type": "data/BusinessAdminBaseLookups", 
          "model_specific_actions": [
               "add", 
               "get", 
               "list"
          ], 
          "summary_attrs": [
               {
                    "name": "name", 
                    "title": "Name"
               }, 
               {
                    "allow_filtering": true, 
                    "name": "hierarchy_friendly_name", 
                    "title": "Located At"
               }
          ], 
          "api_version": "20.1.1", 
          "tagged_versions": []
     }, 
     "resources": []
}

Instance API Reference

[pkid] is the ID of the resource instance.

If a payload is required, inspect the schema for payload details.

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

API Reference for data/BusinessAdminBaseLookups

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

Get the Add form

Create

List

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

Instance API Reference

Get