[Index]

API Reference for data/GeneralHelp

Data model that will allow additions to the general help section for the online help.

Model ref.: data/GeneralHelp

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/GeneralHelp/add/
  • hierarchy=[hierarchy]
  • format=json
 The GUI Add form of data/GeneralHelp 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/GeneralHelp 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/GeneralHelp/ hierarchy=[hierarchy] {"hrefs":["/api/data/GeneralHelp/[pkid1]", "/api/data/GeneralHelp/[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/GeneralHelp 
      GET http://[host-proxy]/api/data/GeneralHelp/?hierarchy=[hierarchy]&format=json

    Bulk Modify

    Task Call URL Parameters Response
    Bulk Modify GET /api/data/GeneralHelp/bulk_update/?schema=&schema_rules=true
    • hierarchy=[hierarchy]
    • format=json
    • pkids=pkid1,pkid2,...
      In JSON format:
    • POST call to update the instances of data/GeneralHelp
    • data/GeneralHelp schema to create POST payload.
    Task Call URL Parameters Payload
    Bulk Modify POST /api/data/GeneralHelp/bulk_update/
    • hierarchy=[hierarchy]
    • format=json
    		 For example:
    {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/data/GeneralHelp/[pkid1]", "/api/v0/data/GeneralHelp/[pkid2]",...]}}
    • To get a list of model instance pkids that are available to Bulk Modify, use the GET call:
      GET http://[host-proxy]/api/data/GeneralHelp/?hierarchy=[hierarchy]&format=json
    • The POST payload is in JSON format (refer to the Payload example) and contains:
      • data in name-value update pairs according to the returned schema
      • meta (empty - for a valid payload)
      • request_meta with the hrefs list of instances to update

    Bulk Export

    Task Call URL Parameters Payload
    Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/GeneralHelp; optionally with tag_version at [version] and Configuration Template as [configtemplate]. POST /api/data/GeneralHelp/export/
    • hierarchy=[hierarchy]
    • version=[version]
    • schema=
    • schema_rules=
    • template_name=[configtemplate]
    • export_format=[raw_xlsx|xlsx|json]
    		 { "hrefs":["/api/data/GeneralHelp/[pkid1]", "/api/data/GeneralHelp/[pkid2]",...]}}

    For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:

            Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
        Content-Language:en
        Content-Type:application/x-zip

    For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:

            Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

    For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:

            Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

    The XLSX format can be used to bulk load instances of data/GeneralHelp and the JSON format can be used to import instances of data/GeneralHelp.

    • To get the list of all instance pkids [pkid1],[pkid2], ..., use the List GET call for data/GeneralHelp: 
    •  GET http://[host-proxy]/api/data/GeneralHelp/?hierarchy=[hierarchy]

    Export Bulk Load Template

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

    Tag

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

    Tag Version

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

    Configuration Template

    Task Call URL Parameters Response
    Configuration Template GET /api/data/GeneralHelp/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/data/GeneralHelp/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]

    Migration Template

    Task Call URL Parameters Response
    Migration Template GET /api/data/GeneralHelp/migration/
    • hierarchy=[hierarchy]
    • format=json
    		  

    List

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

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

    (Show the first instance)

    Help

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

    Instance API Reference

    Modify

    Task Call URL Parameters Payload
    Modify PUT /api/data/GeneralHelp/[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/GeneralHelp/[pkid] hierarchy=[hierarchy]

    Clone

    Task Call URL Parameters Response
    Clone instance with [pkid]. The schema rules are applied. GET /api/data/GeneralHelp/[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 data/GeneralHelp
    • GET http://[host-proxy]/api/data/GeneralHelp/?hierarchy=[hierarchy]&format=json
    • Use the POST action in the response with a modification of the response payload to create the clone.

    Export

    Task Call URL Parameters Response
    Get a selected [export_format] of the schema and a single instance with [pkid] of data/GeneralHelp; optionally with tag_version at [version] and Configuration Template as [configtemplate]. GET /api/data/GeneralHelp/[pkid]/export
    • hierarchy=[hierarchy]
    • version=[version]
    • schema=
    • schema_rules=
    • template_name=[configtemplate]
    • export_format=[raw_xlsx|xlsx|json]
    		 The response is an attachment. Refer to the list below.

    For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:

            Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

    For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:

            Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

    For export_format=json, the response is a time stamped zip file of data in JSON and a response format:

            Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
        Content-Language:en
        Content-Type:application/x-zip

    The XLSX format can be used to bulk load instances of data/GeneralHelp and the JSON format can be used to import instances of data/GeneralHelp.

    For Bulk Export, refer to the Bulk Export section.

    Tag

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

    Get

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

    Help

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