[Index]

API Reference for data/ConfigurationTemplate

Configuration Templates are applied to data models and domain models. When they are created, all the attribute fields of the model are exposed. Default values or macros can then be assigned to these fields as required. For array elements of the related data- and domain models, a list and a variable can be specified to loop through so that a value is applied to the model array. More than one Configuration Template can be created for a model. When an instance of the model is added or updated, the Configuration Template that has been enabled for the model applies.

Model ref.: data/ConfigurationTemplate

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

Bulk Delete

Task Call URL Parameters Payload
Bulk delete [pkid1],[pkid2]... DELETE /api/data/ConfigurationTemplate/ hierarchy=[hierarchy] {"hrefs":["/api/data/ConfigurationTemplate/[pkid1]", "/api/data/ConfigurationTemplate/[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/ConfigurationTemplate
    GET http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]&format=json

Bulk Modify

Task Call URL Parameters Response
Bulk Modify GET /api/data/ConfigurationTemplate/bulk_update/?schema=&schema_rules=true
  • hierarchy=[hierarchy]
  • format=json
  • pkids=pkid1,pkid2,...
    In JSON format:
  • POST call to update the instances of data/ConfigurationTemplate
  • data/ConfigurationTemplate schema to create POST payload.
Task Call URL Parameters Payload
Bulk Modify POST /api/data/ConfigurationTemplate/bulk_update/
  • hierarchy=[hierarchy]
  • format=json
For example:
{"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/data/ConfigurationTemplate/[pkid1]", "/api/v0/data/ConfigurationTemplate/[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/ConfigurationTemplate/?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/ConfigurationTemplate; optionally with tag_version at [version] and Configuration Template as [configtemplate]. POST /api/data/ConfigurationTemplate/export/
  • hierarchy=[hierarchy]
  • version=[version]
  • schema=
  • schema_rules=
  • template_name=[configtemplate]
  • export_format=[raw_xlsx|xlsx|json]
{ "hrefs":["/api/data/ConfigurationTemplate/[pkid1]", "/api/data/ConfigurationTemplate/[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/ConfigurationTemplate and the JSON format can be used to import instances of data/ConfigurationTemplate.

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

Export Bulk Load Template

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

Migration Template

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

List

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

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

(Show the first instance)

Help

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

Instance API Reference

Modify

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

Clone

Task Call URL Parameters Response
Clone instance with [pkid]. The schema rules are applied. GET /api/data/ConfigurationTemplate/[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/ConfigurationTemplate
  • GET http://[host-proxy]/api/data/ConfigurationTemplate/?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/ConfigurationTemplate; optionally with tag_version at [version] and Configuration Template as [configtemplate]. GET /api/data/ConfigurationTemplate/[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/ConfigurationTemplate and the JSON format can be used to import instances of data/ConfigurationTemplate.

For Bulk Export, refer to the Bulk Export section.

Tag

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

Get

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

Help

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