[Index]

API Reference for view/GeneralHelperFieldsVIEW

Model ref.: view/GeneralHelperFieldsVIEW

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/view/GeneralHelperFieldsVIEW/add/
  • hierarchy=[hierarchy]
  • format=json
The GUI Add form of view/GeneralHelperFieldsVIEW 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/view/GeneralHelperFieldsVIEW 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.
  • Export Bulk Load Template

    Task Call URL Parameters Response
    Get a compressed format of the Bulk Load spreadsheet template for view/GeneralHelperFieldsVIEW POST /api/view/GeneralHelperFieldsVIEW/export_bulkload_template/
    • hierarchy=[hierarchy]
    • modeltype=view/GeneralHelperFieldsVIEW
    The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz

    List

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

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

    Help

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

    Instance API Reference

    Tag

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

    Help

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