[Index]
Dropdown Filter Form
Model ref.: data/DropdownFilterForm
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"properties": {
"filter_name": {
"is_password": false,
"description": "The name of the dropdown filter to be created (Prefix: DD__ + target model + target field).",
"format": "string",
"required": false,
"readonly": false,
"title": "Filter Name",
"type": "string"
},
"ddf_action": {
"choices": [
{
"value": "create",
"title": "Create a Dropdown Filter"
},
{
"value": "merge",
"title": "Merge existing Dropdown Filters"
}
],
"type": "string",
"description": "The Dropdown Filter action to perform.",
"title": "Select a Dropdown Filter action:"
},
"target_model_type": {
"is_password": false,
"description": "The target fields's model to apply dropdown choices field to.",
"format": "uri",
"required": true,
"readonly": false,
"title": "Target Model Name",
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"target_field": {
"is_password": false,
"description": "The target field to apply dropdown choices to.",
"format": "string",
"required": true,
"readonly": false,
"title": "Target Field",
"type": "string"
},
"ddf_merge": {
"description": "Merge multiple Dropdown filters",
"title": "Dropdown Filters to merge",
"minItems": 2,
"items": {
"type": "object",
"properties": {
"ddf": {
"type": "string",
"description": "Dropdown Filter to merge.",
"title": "Dropdown Filter"
}
}
},
"required": false,
"maxItems": 2,
"type": "array"
},
"ddf_create": {
"description": "Create a Dropdown filter.",
"title": "Dropdown Filter specifications",
"minItems": 1,
"items": {
"type": "object",
"properties": {
"model_type": {
"is_password": false,
"description": "Model Type to be selected for Dropdown choice selection.",
"format": "uri",
"required": false,
"readonly": false,
"title": "Model Type",
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"dropdown_field": {
"required": false,
"type": "string",
"description": "The field to display in the dropdown.",
"title": "Dropdown Field"
},
"filter_fields": {
"items": {
"type": "object",
"properties": {
"filter_field": {
"type": "string",
"description": "The field to filter dropdown choices on.",
"title": "Filter Field"
},
"filter_field_condition": {
"description": "The condition to match field values on.",
"title": "Filter Condition",
"default": "Contains",
"choices": [
{
"value": "contains",
"title": "Contains"
},
{
"value": "notcontains",
"title": "Does Not Contain"
},
{
"value": "equals",
"title": "Equals"
},
{
"value": "notequals",
"title": "Does Not Equal"
}
],
"type": "string"
},
"filter_field_value": {
"type": "string",
"title": "Filter Field Value "
}
}
},
"required": false,
"type": "array",
"title": "Filter Fields"
},
"parameters": {
"items": {
"type": "object",
"properties": {
"parameter_title": {
"choices": [
{
"value": "direction",
"title": "Direction"
},
{
"value": "device",
"title": "Device"
},
{
"value": "ndl",
"title": "NDL"
},
{
"value": "limit",
"title": "Limit"
},
{
"value": "skip",
"title": "Skip"
},
{
"value": "title",
"title": "Title"
}
],
"type": "string",
"description": "Parameter Title.",
"title": "Parameter Title"
},
"parameter_value": {
"type": "string",
"description": "Parameter Value.",
"title": "Parameter Value"
}
}
},
"required": false,
"type": "array",
"title": "Additional Parameters"
}
}
},
"required": false,
"maxItems": 1,
"type": "array"
}
},
"schema_version": "1.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/DropdownFilterForm/add/ |
|
The GUI Add form of data/DropdownFilterForm 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.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Create | POST | /api/data/DropdownFilterForm | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/data/DropdownFilterForm/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/DropdownFilterForm/[pkid1]", "/api/data/DropdownFilterForm/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/DropdownFilterForm/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/data/DropdownFilterForm/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/data/DropdownFilterForm/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/data/DropdownFilterForm/[pkid1]", "/api/v0/data/DropdownFilterForm/[pkid2]",...]}} |
GET http://[host-proxy]/api/data/DropdownFilterForm/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/DropdownFilterForm; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/DropdownFilterForm/export/ |
|
{ "hrefs":["/api/data/DropdownFilterForm/[pkid1]", "/api/data/DropdownFilterForm/[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/DropdownFilterForm and the JSON format can be used to import instances of data/DropdownFilterForm.
GET http://[host-proxy]/api/data/DropdownFilterForm/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for data/DropdownFilterForm | POST | /api/data/DropdownFilterForm/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag | PATCH | /api/data/DropdownFilterForm/+tag/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag Version | PATCH | /api/data/DropdownFilterForm/+tag_version/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/data/DropdownFilterForm/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/data/DropdownFilterForm/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Migration Template | GET | /api/data/DropdownFilterForm/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/DropdownFilterForm/ |
|
The data/DropdownFilterForm schema and all instances as JSON. |
(The list will return 0 to 3 data/DropdownFilterForm instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": "filter_name",
"direction": "asc",
"current": "/api/data/DropdownFilterForm/?skip=0&limit=3&order_by=filter_name&direction=asc&traversal=fulltree"
},
"operations": [
"field_display_policy",
"update",
"help",
"remove",
"add",
"export",
"list",
"configuration_template",
"get",
"bulk_update_form",
"migration",
"transform",
"export_bulkload_template"
],
"meta": {
"model_type": "data/DropdownFilterForm",
"summary_attrs": [
{
"name": "filter_name",
"title": "Filter Name"
},
{
"name": "target_model_type",
"title": "Target Model Name"
},
{
"name": "target_field",
"title": "Target Field"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "?",
"business_key": {
"hierarchy": true,
"unique": [
"filter_name"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": []
},
"model_specific_actions": [
"add",
"bulk_update_form",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"get",
"help",
"list",
"migration",
"transform",
"remove",
"tag",
"tag_version",
"update"
],
"schema_version": "1.0",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/data/DropdownFilterForm/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/DropdownFilterForm/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"bulk_update_form": {
"method": "GET",
"class": "update",
"href": "/api/data/DropdownFilterForm/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Bulk Modify"
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/data/DropdownFilterForm/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/data/DropdownFilterForm/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/DropdownFilterForm/+tag/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/data/DropdownFilterForm/+tag_version/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"configuration_template": {
"method": "GET",
"class": "config",
"href": "/api/data/DropdownFilterForm/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/data/DropdownFilterForm/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"migration": {
"method": "GET",
"class": "migration",
"href": "/api/data/DropdownFilterForm/migration/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Migration Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/data/DropdownFilterForm/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/DropdownFilterForm/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"transform": {
"method": "GET",
"class": "transform",
"href": "/api/data/DropdownFilterForm/transform/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Transform Template"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/DropdownFilterForm. | GET | /api/data/DropdownFilterForm/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/DropdownFilterForm as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Transform Template | GET | /api/data/DropdownFilterForm/transform/ |
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/DropdownFilterForm/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/DropdownFilterForm/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/DropdownFilterForm/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/DropdownFilterForm/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of data/DropdownFilterForm; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/DropdownFilterForm/[pkid]/export |
|
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/DropdownFilterForm and the JSON format can be used to import instances of data/DropdownFilterForm.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/data/DropdownFilterForm/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/DropdownFilterForm/[pkid] | hierarchy=[hierarchy] | The data/DropdownFilterForm instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/DropdownFilterForm/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/DropdownFilterForm. |