[Index]

API Reference for view/ResetUCPasswordPinVIEW

Model ref.: view/ResetUCPasswordPinVIEW

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

    Tag

    Task Call URL Parameters Response
    Tag PATCH /api/view/ResetUCPasswordPinVIEW/+tag/
    • hierarchy=[hierarchy]
    • format=json
     

    Tag Version

    Task Call URL Parameters Response
    Tag Version PATCH /api/view/ResetUCPasswordPinVIEW/+tag_version/
    • hierarchy=[hierarchy]
    • format=json
     

    Configuration Template

    Task Call URL Parameters Response
    Configuration Template GET /api/view/ResetUCPasswordPinVIEW/configuration_template/ hierarchy=[hierarchy]
    • POST call to create the Configuration Template
    • Configuration Template 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/ConfigurationTemplate/?hierarchy=[hierarchy]

    Field Display Policy

    Task Call URL Parameters Response
    Field Display Policy GET /api/view/ResetUCPasswordPinVIEW/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/ResetUCPasswordPinVIEW/
    • hierarchy=[hierarchy]
    • format=json
    • schema=true
    The view/ResetUCPasswordPinVIEW schema and all instances as JSON.

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

    Help

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

    Transform Template

    Task Call URL Parameters Response
    Transform Template GET /api/view/ResetUCPasswordPinVIEW/transform/
    • hierarchy=[hierarchy]
    • format=json
     

    Instance API Reference

    Clone

    Task Call URL Parameters Response
    Clone instance with [pkid]. The schema rules are applied. GET /api/view/ResetUCPasswordPinVIEW/[pkid]/clone/?schema=&schema_rules=true
    • hierarchy=[hierarchy]
    A JSON payload with:
    • A POST action URL.
    • The unchanged model [pkid] payload to be modified to create a new instance.
    • For the instance pkids that can cloned, refer to the List GET call for view/ResetUCPasswordPinVIEW
    • GET http://[host-proxy]/api/view/ResetUCPasswordPinVIEW/?hierarchy=[hierarchy]&format=json
    • Use the POST action in the response with a modification of the response payload to create the clone.

    Tag

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

    Get

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

    Help

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