[Index]
This relation implements the workflows to manage Spark Users.
Model ref.: relation/DropDownFilter
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).",
"title": "Filter Name",
"format": "string",
"required": false,
"readonly": false,
"type": "string"
},
"ddf_action": {
"title": "Select a Dropdown Filter action:",
"type": "string",
"description": "The Dropdown Filter action to perform.",
"choices": [
{
"value": "create",
"title": "Create a Dropdown Filter"
},
{
"value": "merge",
"title": "Merge existing Dropdown Filters"
}
]
},
"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_macro": {
"type": "object",
"properties": {
"macro": {
"required": true,
"type": "string",
"description": "The Macro content written in the syntax of the Macro language.",
"title": "Macro"
},
"name": {
"required": true,
"type": "string",
"description": "The name that is given to the Macro.",
"title": "Name"
},
"description": {
"required": false,
"type": "string",
"description": "Description of the Macro.",
"title": "Description"
}
},
"title": "Ddf Macro"
},
"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,
"choices": [],
"readonly": false,
"title": "Model Type",
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"dropdown_field": {
"required": false,
"type": "string",
"description": "The field to display in the dropdown.",
"title": "Dropdown Field"
},
"parameters": {
"items": {
"type": "object",
"properties": {
"parameter_value": {
"type": "string",
"description": "Parameter Value.",
"title": "Parameter Value"
},
"parameter_title": {
"title": "Parameter Title",
"type": "string",
"description": "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"
}
]
}
}
},
"required": false,
"type": "array",
"title": "Additional Parameters"
},
"filter_fields": {
"items": {
"type": "object",
"properties": {
"filter_field_value": {
"type": "string",
"title": "Filter Field Value "
},
"filter_field_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",
"description": "The condition to match field values on.",
"title": "Filter Condition"
},
"filter_field": {
"type": "string",
"description": "The field to filter dropdown choices on.",
"title": "Filter Field"
}
}
},
"required": false,
"type": "array",
"title": "Filter Fields"
}
}
},
"required": false,
"maxItems": 1,
"type": "array"
},
"target_model_type": {
"is_password": false,
"description": "The target fields's model to apply dropdown choices field to.",
"format": "uri",
"required": true,
"choices": [],
"readonly": false,
"title": "Target Model Name",
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"target_field": {
"is_password": false,
"description": "The target field to apply dropdown choices to.",
"title": "Target Field",
"format": "string",
"required": true,
"readonly": false,
"type": "string"
}
},
"schema_version": "1.0.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/DropDownFilter/add/ |
|
The GUI Add form of relation/DropDownFilter 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/relation/DropDownFilter | 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/relation/DropDownFilter/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/DropDownFilter/[pkid1]", "/api/relation/DropDownFilter/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/DropDownFilter/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=relation/DropDownFilter |
|
{"hrefs": ["/api/relation/DropDownFilter/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=relation/DropDownFilter |
|
{"hrefs": ["/api/relation/DropDownFilter/[pkid1]", "/api/relation/DropDownFilter/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/DropDownFilter; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/DropDownFilter/export/ |
|
{ "hrefs":["/api/relation/DropDownFilter/[pkid1]", "/api/relation/DropDownFilter/[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 relation/DropDownFilter and the JSON format can be used to import instances of relation/DropDownFilter.
GET http://[host-proxy]/api/relation/DropDownFilter/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/DropDownFilter | POST | /api/relation/DropDownFilter/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/relation/DropDownFilter/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/relation/DropDownFilter/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/DropDownFilter/ |
|
The relation/DropDownFilter schema and all instances as JSON. |
(The list will return 0 to 3 relation/DropDownFilter instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"move",
"list",
"update",
"remove",
"add",
"bulk_update",
"export"
],
"pagination": {
"direction": "asc",
"order_by": "filter_name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/relation/DropDownFilter/?skip=0&limit=3&order_by=filter_name&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 0
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "1.0.0",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"self": [
{
"pkid": null,
"href": "/api/relation/DropDownFilter/None/"
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/relation/DropDownFilter/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/DropDownFilter/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=relation/DropDownFilter",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/DropDownFilter/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/relation/DropDownFilter/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/relation/DropDownFilter/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/relation/DropDownFilter/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/relation/DropDownFilter/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/DropDownFilter/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/DropDownFilter",
"model_specific_actions": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"move",
"list",
"update",
"remove",
"add",
"export"
],
"summary_attrs": [
{
"name": "filter_name",
"title": "Filter Name"
},
{
"name": "target_model_type",
"title": "Target Model Name"
},
{
"name": "target_field",
"title": "Target Field"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/DropDownFilter. | GET | /api/relation/DropDownFilter/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/DropDownFilter as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/DropDownFilter/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/DropDownFilter/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=relation/DropDownFilter | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of relation/DropDownFilter; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/DropDownFilter/[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 relation/DropDownFilter and the JSON format can be used to import instances of relation/DropDownFilter.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/DropDownFilter/[pkid] | hierarchy=[hierarchy] | The relation/DropDownFilter instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/DropDownFilter/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/DropDownFilter. |