[Index]

API Reference for view/ReplacePhone_VIEW

Model ref.: view/ReplacePhone_VIEW

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/ReplacePhone_VIEW/add/
  • hierarchy=[hierarchy]
  • format=json
The GUI Add form of view/ReplacePhone_VIEW 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/ReplacePhone_VIEW/ 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/ReplacePhone_VIEW POST /api/view/ReplacePhone_VIEW/export_bulkload_template/
    • hierarchy=[hierarchy]
    • modeltype=view/ReplacePhone_VIEW
    The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz

    Field Display Policy

    Task Call URL Parameters Response
    Field Display Policy GET /api/view/ReplacePhone_VIEW/field_display_policy/ hierarchy=[hierarchy]
    • POST call to create the Field Display Policy
    • Field Display Policy schema

    • Use the returned properties to create the POST payload data for the .
    • For a description of the schema that shows properties to add to the POST payload:
    • The POST call is of the format:
      • POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]

    List

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

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

    Help

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

    Instance API Reference

    Get

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

    Help

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