[Index]

API Reference for data/BusinessAdminSiteManagementLookups

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

Model ref.: data/BusinessAdminSiteManagementLookups

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

Variables are enclosed in square brackets.

For a list of available UUIDs and their dot notations:
GET /api/v0/data/HierarchyNode/?format=json

Get the Add form

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

Create

Task Call URL Parameters Payload
Create POST /api/data/BusinessAdminSiteManagementLookups 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.
  • List

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

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

    Instance API Reference

    Get

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