[Index]

API Reference for view/FileUpload

Model ref.: view/FileUpload

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/FileUpload/add/
  • hierarchy=[hierarchy]
  • format=json
The GUI Add form of view/FileUpload 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/FileUpload 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.
  • Instance API Reference