[Index]

API Reference for data/HcsNbnSupportedModelsDAT

HcsNbnSupportedModelsDAT

Model ref.: data/HcsNbnSupportedModelsDAT

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/HcsNbnSupportedModelsDAT/add/
  • hierarchy=[hierarchy]
  • format=json
The GUI Add form of data/HcsNbnSupportedModelsDAT 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/HcsNbnSupportedModelsDAT 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.
  • Bulk Delete

    Task Call URL Parameters Payload
    Bulk delete [pkid1],[pkid2]... DELETE /api/data/HcsNbnSupportedModelsDAT/ hierarchy=[hierarchy] {"hrefs":["/api/data/HcsNbnSupportedModelsDAT/[pkid1]", "/api/data/HcsNbnSupportedModelsDAT/[pkid2]", ...]}
    • For the instance pkids [pkid1],[pkid2], ... that can be added to the DELETE call (the instance pkids to delete), refer to the List GET call for: data/HcsNbnSupportedModelsDAT
      GET http://[host-proxy]/api/data/HcsNbnSupportedModelsDAT/?hierarchy=[hierarchy]&format=json

    List

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

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

    (Show the first instance)

    Instance API Reference

    Modify

    Task Call URL Parameters Payload
    Modify PUT /api/data/HcsNbnSupportedModelsDAT/[pkid] hierarchy=[hierarchy] (For payload specification)

    For Bulk modification, refer to the Bulk Modify section.

    Delete

    Task Call URL Parameters Response
    Delete DELETE /api/data/HcsNbnSupportedModelsDAT/[pkid] hierarchy=[hierarchy]

    Import

    Task Call URL Parameters Payload
    Import POST /api/data/HcsNbnSupportedModelsDAT/[pkid]/import hierarchy=[hierarchy] If payload required:

    Execute

    Task Call URL Parameters Payload
    Execute POST /api/data/HcsNbnSupportedModelsDAT/[pkid]/execute hierarchy=[hierarchy] If payload required:

    Get

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