[Index]
The parameters of a search in the system can be saved for re-use and reference. The available parameters correspond with the parameters of an Advanced Search.
Model ref.: data/SavedSearch
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": {
"name": {
"required": true,
"type": "string",
"description": "Provide a name for the saved search parameters.",
"title": "Name"
},
"filter_tags": {
"type": "string",
"description": "Used to enter a filter string of created search tags to search for.",
"title": "Filter on tags"
},
"searchuri": {
"type": "string",
"description": "DESCRIPTION",
"title": "Search uri"
},
"count_only": {
"type": "boolean",
"description": "Select if only the number of search results should be returned.",
"title": "Return the count only"
},
"filter_model_type": {
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"title": "Model type",
"format": "uri",
"choices": [],
"target_model_type": "",
"type": "string",
"description": "Select from the drop-down control the model type to which the search should be restricted. A selected model type is accompanied by a Model Field."
},
"hierarchy_shallow": {
"type": "boolean",
"description": "Only search for results in models themselves; not in any models that they may contain as resources.",
"title": "Hierarchy shallow traverse"
},
"tags_or": {
"type": "boolean",
"description": "Select if the Filter on tags string of search tags are to be separated by OR.",
"title": "Contains any of the tags (OR)"
},
"limit": {
"type": "string",
"description": "The maximum number of results to return.",
"title": "Limit returned results"
},
"query": {
"type": "string",
"description": "The search query text. By default the case-insensitive text is the search query.",
"title": "Search query"
},
"adv_options": {
"items": {
"type": "object",
"properties": {
"ignore_case": {
"type": "boolean",
"description": "Select to carry out a case-insensitive search on the Filter text.",
"title": "Ignore case"
},
"filter_text": {
"type": "string",
"description": "Search results can be filtered by additional text.",
"title": "Filter text"
},
"model_field": {
"choices": [
{
"value": "",
"title": ""
}
],
"required": true,
"type": "string",
"description": "The selected field of a model to search in if a Model Type is selected to restrict the search.",
"title": "Model field"
},
"condition": {
"type": "string",
"description": "A condition can be specified on the Filtered text regarding its status in search results. Available values are: Contains, Does Not Contain, Starts With, Ends with, Equals, Not Equal.",
"title": "Condition"
}
}
},
"type": "array",
"description": "A set of options to carry out a more refined search.",
"title": "Advanced options"
},
"saved_search": {
"type": "string",
"description": "Enter the name of a saved search to load it. The search is carried out from within the saved search results.",
"title": "Load SavedSearch"
},
"filter_hierarchy": {
"type": "string",
"description": "A hierarchy from which to carry out the search.",
"title": "Hierarchy"
},
"description": {
"type": "string",
"description": "The description of the saved search.",
"title": "Description"
}
},
"schema_version": "0.1.5"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/SavedSearch/add/ |
|
The GUI Add form of data/SavedSearch 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/SavedSearch/ | 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/SavedSearch/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/SavedSearch/[pkid1]", "/api/data/SavedSearch/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/SavedSearch/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/data/SavedSearch/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/data/SavedSearch/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/data/SavedSearch/[pkid1]", "/api/v0/data/SavedSearch/[pkid2]",...]}} |
GET http://[host-proxy]/api/data/SavedSearch/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/SavedSearch; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/SavedSearch/export/ |
|
{ "hrefs":["/api/data/SavedSearch/[pkid1]", "/api/data/SavedSearch/[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/SavedSearch and the JSON format can be used to import instances of data/SavedSearch.
GET http://[host-proxy]/api/data/SavedSearch/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for data/SavedSearch | POST | /api/data/SavedSearch/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/data/SavedSearch/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/data/SavedSearch/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Migration Template | GET | /api/data/SavedSearch/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/SavedSearch/ |
|
The data/SavedSearch schema and all instances as JSON. |
(The list will return 0 to 3 data/SavedSearch instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"move",
"transform",
"add",
"export",
"migration",
"bulk_update_form"
],
"pagination": {
"direction": "asc",
"order_by": "name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/data/SavedSearch/?skip=0&limit=3&order_by=name&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 0
},
"meta": {
"tags": [],
"cached": true,
"title": "?",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"schema_version": "0.1.5",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/data/SavedSearch/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/SavedSearch/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/data/SavedSearch/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Bulk Modify"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/SavedSearch/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/data/SavedSearch/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/data/SavedSearch/+tag/?hierarchy=[hierarchy]",
"class": "tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/data/SavedSearch/+tag_version/?hierarchy=[hierarchy]",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/data/SavedSearch/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/data/SavedSearch/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"migration": {
"support_async": false,
"class": "migration",
"href": "/api/data/SavedSearch/migration/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Migration Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/data/SavedSearch/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/SavedSearch/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/SavedSearch",
"model_specific_actions": [
"add",
"bulk_update_form",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"get",
"help",
"list",
"migration",
"remove",
"run_savedsearch",
"tag",
"tag_version",
"update"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "20.1.1",
"tagged_versions": []
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/SavedSearch. | GET | /api/data/SavedSearch/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/SavedSearch as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/SavedSearch/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/SavedSearch/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/SavedSearch/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/SavedSearch/?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/SavedSearch; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/SavedSearch/[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/SavedSearch and the JSON format can be used to import instances of data/SavedSearch.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/data/SavedSearch/[pkid]/+tag/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/SavedSearch/[pkid]/ | hierarchy=[hierarchy] | The data/SavedSearch instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/SavedSearch/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/SavedSearch. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Execute | GET | /api/tool/Search/[pkid]/ | hierarchy=[hierarchy] |