[Index]
Stores Business Admin Portal per user saved searches.
Model ref.: data/UserSavedSearch
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": {
"user_pkid": {
"title": "User PKID",
"description": "The PKID corresponding to a valid user.",
"type": "string",
"required": true
},
"username": {
"title": "Username",
"description": "The username of the user who created the saved search.",
"type": "string"
},
"name": {
"title": "Saved Search Name",
"description": "The name of the saved search.",
"type": "string"
},
"featureName": {
"title": "Model Type",
"description": "The model type for which the saved search was created.",
"type": "string"
},
"menu_hash": {
"title": "Menu Hash",
"description": "The hash of the menu where this saved search is used. This is used to identify the context in which the saved search was created.",
"type": "string"
},
"list_view_title": {
"title": "List View Title",
"description": "The title to display on the list view for this saved search.",
"type": "string"
},
"query": {
"title": "Query",
"type": "string"
},
"type": {
"title": "Saved Search Type",
"type": "string",
"choices": [
{
"value": "filters",
"title": "filters"
}
]
},
"filters": {
"title": "Configurable Filters",
"description": "Configurable filters for the saved search. These filters can be modified or removed by the user.",
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"condition": {
"type": "string"
},
"value": {
"type": "string"
},
"fromValue": {
"type": "string"
},
"toValue": {
"type": "string"
},
"ignoreCase": {
"title": "Ignore Case",
"type": "boolean"
}
}
}
},
"fixed_filters": {
"title": "Fixed Filters",
"description": "Fixed filters for the saved search. These filters are hidden and cannot be removed by the user.",
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"condition": {
"type": "string"
},
"value": {
"type": "string"
},
"fromValue": {
"type": "string"
},
"toValue": {
"type": "string"
},
"ignoreCase": {
"title": "Ignore Case",
"type": "boolean"
}
}
}
},
"field_display_policy": {
"title": "Field Display Policy",
"description": "Field display policy for the saved search.",
"type": "string"
},
"dropdown_filter": {
"title": "Dropdown Filter",
"type": "boolean"
},
"enabled": {
"title": "Enable Filter",
"type": "boolean"
}
},
"schema_version": "2.0.3"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/UserSavedSearch/add/ |
|
The GUI Add form of data/UserSavedSearch 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/UserSavedSearch | 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/UserSavedSearch/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/UserSavedSearch/[pkid1]", "/api/data/UserSavedSearch/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/UserSavedSearch/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/data/UserSavedSearch/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/data/UserSavedSearch/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/data/UserSavedSearch/[pkid1]", "/api/v0/data/UserSavedSearch/[pkid2]",...]}} |
GET http://[host-proxy]/api/data/UserSavedSearch/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/UserSavedSearch; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/UserSavedSearch/export/ |
|
{ "hrefs":["/api/data/UserSavedSearch/[pkid1]", "/api/data/UserSavedSearch/[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/UserSavedSearch and the JSON format can be used to import instances of data/UserSavedSearch.
GET http://[host-proxy]/api/data/UserSavedSearch/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for data/UserSavedSearch | POST | /api/data/UserSavedSearch/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag | PATCH | /api/data/UserSavedSearch/+tag/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag Version | PATCH | /api/data/UserSavedSearch/+tag_version/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/data/UserSavedSearch/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/data/UserSavedSearch/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Migration Template | GET | /api/data/UserSavedSearch/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/UserSavedSearch/ |
|
The data/UserSavedSearch schema and all instances as JSON. |
(The list will return 0 to 3 data/UserSavedSearch instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 25,
"total_limit": null,
"order_by": "name",
"direction": "asc",
"current": "/api/data/UserSavedSearch/?skip=0&limit=3&order_by=name&direction=asc&traversal=down"
},
"operations": [
"add",
"list",
"get",
"export_bulkload_template",
"migration",
"remove",
"move",
"configuration_template",
"update",
"field_display_policy",
"help",
"bulk_update_form",
"export",
"transform"
],
"meta": {
"model_type": "data/UserSavedSearch",
"summary_attrs": [
{
"name": "username",
"title": "Username"
},
{
"name": "name",
"title": "Name"
},
{
"name": "featureName",
"title": "Featurename"
},
{
"name": "user_pkid",
"title": "User PKID"
},
{
"name": "enabled",
"title": "Enable Filter"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"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": "2.0.3",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/data/UserSavedSearch/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/UserSavedSearch/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"bulk_update_form": {
"method": "GET",
"class": "update",
"href": "/api/data/UserSavedSearch/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Bulk Modify"
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/data/UserSavedSearch/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/UserSavedSearch/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/UserSavedSearch/+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/UserSavedSearch/+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/UserSavedSearch/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/data/UserSavedSearch/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"migration": {
"method": "GET",
"class": "migration",
"href": "/api/data/UserSavedSearch/migration/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Migration Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/data/UserSavedSearch/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/UserSavedSearch/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"transform": {
"method": "GET",
"class": "transform",
"href": "/api/data/UserSavedSearch/transform/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Transform Template"
}
}
]
},
"resources": [
{
"data": {
"user_pkid": "63f78853c33191b9204fa52b",
"username": "sysadmin",
"name": "Default",
"featureName": "data/InternalNumberInventory",
"dropdown_filter": true,
"enabled": true,
"pkid": "67810a75ca96054460370c1e",
"hierarchy_friendly_name": "sys (System)",
"hierarchy_path": "sys"
},
"meta": {
"model_type": "data/UserSavedSearch",
"summary_attrs": [
{
"name": "username",
"title": "Username"
},
{
"name": "name",
"title": "Name"
},
{
"name": "featureName",
"title": "Featurename"
},
{
"name": "user_pkid",
"title": "User PKID"
},
{
"name": "enabled",
"title": "Enable Filter"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [
"V4UC",
"ba_CommonOverlay"
],
"title": "Default",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": [],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"href": "/api/data/UserSavedSearch/67810a75ca96054460370c1d/",
"pkid": "67810a75ca96054460370c1d"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"67810a75ca96054460370c1d"
],
"schema_version": "2.0.3",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/UserSavedSearch/67810a75ca96054460370c1d/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/UserSavedSearch/67810a75ca96054460370c1d/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/UserSavedSearch/67810a75ca96054460370c1d/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/UserSavedSearch/67810a75ca96054460370c1d/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/UserSavedSearch/67810a75ca96054460370c1d/+tag/",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/data/UserSavedSearch/67810a75ca96054460370c1d/+tag_version/",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/UserSavedSearch/67810a75ca96054460370c1d/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/UserSavedSearch/67810a75ca96054460370c1d/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "67810a75ca96054460370c1d"
},
{
"data": {
"user_pkid": "63f78853c33191b9204fa52b",
"username": "sysadmin",
"name": "Default",
"featureName": "data/InternalNumberInventory",
"filters": [
{
"field": "status",
"condition": "equals",
"value": "macro.RegexAvailableOrUsedMCR",
"fromValue": "Status",
"ignoreCase": true
},
{
"field": "reserved_for",
"condition": "notequal",
"ignoreCase": false
}
],
"dropdown_filter": true,
"enabled": true,
"pkid": "6893878541f63fe774b72335",
"hierarchy_friendly_name": "sys (System)",
"hierarchy_path": "sys"
},
"meta": {
"model_type": "data/UserSavedSearch",
"summary_attrs": [
{
"name": "username",
"title": "Username"
},
{
"name": "name",
"title": "Name"
},
{
"name": "featureName",
"title": "Featurename"
},
{
"name": "user_pkid",
"title": "User PKID"
},
{
"name": "enabled",
"title": "Enable Filter"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [
"V4UC",
"ba_CommonOverlay"
],
"title": "Default",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": [],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"href": "/api/data/UserSavedSearch/6893878541f63fe774b72334/",
"pkid": "6893878541f63fe774b72334"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"6893878541f63fe774b72334"
],
"schema_version": "2.0.3",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/UserSavedSearch/6893878541f63fe774b72334/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/UserSavedSearch/6893878541f63fe774b72334/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/UserSavedSearch/6893878541f63fe774b72334/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/UserSavedSearch/6893878541f63fe774b72334/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/UserSavedSearch/6893878541f63fe774b72334/+tag/",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/data/UserSavedSearch/6893878541f63fe774b72334/+tag_version/",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/UserSavedSearch/6893878541f63fe774b72334/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/UserSavedSearch/6893878541f63fe774b72334/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "6893878541f63fe774b72334"
},
{
"data": {
"user_pkid": "63f78853c33191b9204fa52b",
"username": "sysadmin",
"name": "Default",
"featureName": "data/InternalNumberInventory",
"filters": [
{
"field": "status",
"condition": "equals",
"value": "macro.RegexAvailableOrUsedMCR",
"fromValue": "Status",
"ignoreCase": true
},
{
"field": "reserved_for",
"condition": "notequal",
"ignoreCase": false
}
],
"dropdown_filter": true,
"enabled": true,
"pkid": "689da489cc18d4e18ab5ade5",
"hierarchy_friendly_name": "sys (System)",
"hierarchy_path": "sys"
},
"meta": {
"model_type": "data/UserSavedSearch",
"summary_attrs": [
{
"name": "username",
"title": "Username"
},
{
"name": "name",
"title": "Name"
},
{
"name": "featureName",
"title": "Featurename"
},
{
"name": "user_pkid",
"title": "User PKID"
},
{
"name": "enabled",
"title": "Enable Filter"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [
"V4UC",
"ba_CommonOverlay"
],
"title": "Default",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": [],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"href": "/api/data/UserSavedSearch/689da489cc18d4e18ab5ade4/",
"pkid": "689da489cc18d4e18ab5ade4"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"689da489cc18d4e18ab5ade4"
],
"schema_version": "2.0.3",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/UserSavedSearch/689da489cc18d4e18ab5ade4/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/UserSavedSearch/689da489cc18d4e18ab5ade4/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/UserSavedSearch/689da489cc18d4e18ab5ade4/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/UserSavedSearch/689da489cc18d4e18ab5ade4/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/UserSavedSearch/689da489cc18d4e18ab5ade4/+tag/",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/data/UserSavedSearch/689da489cc18d4e18ab5ade4/+tag_version/",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/UserSavedSearch/689da489cc18d4e18ab5ade4/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/UserSavedSearch/689da489cc18d4e18ab5ade4/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "689da489cc18d4e18ab5ade4"
}
]
}
(Show the first instance)
{
"data": {
"user_pkid": "63f78853c33191b9204fa52b",
"username": "sysadmin",
"name": "Default",
"featureName": "data/InternalNumberInventory",
"dropdown_filter": true,
"enabled": true,
"pkid": "67810a75ca96054460370c1e"
},
"meta": {
"model_type": "data/UserSavedSearch",
"summary_attrs": [
{
"name": "name",
"title": "Saved Search Name"
},
{
"name": "enabled",
"title": "Enable Filter"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [
"V4UC",
"ba_CommonOverlay"
],
"title": "Default",
"business_key": {},
"api_version": "21.2",
"cached": false,
"references": {
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": [],
"owner": [
{
"pkid": ""
}
],
"children": [],
"self": [
{
"href": "/api/data/UserSavedSearch/67810a75ca96054460370c1d/",
"pkid": "67810a75ca96054460370c1d"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"67810a75ca96054460370c1d"
],
"schema_version": "2.0.3",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/UserSavedSearch/67810a75ca96054460370c1d/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/UserSavedSearch/67810a75ca96054460370c1d/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/UserSavedSearch/67810a75ca96054460370c1d/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/UserSavedSearch/67810a75ca96054460370c1d/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/UserSavedSearch/67810a75ca96054460370c1d/+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/UserSavedSearch/67810a75ca96054460370c1d/+tag_version/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/UserSavedSearch/67810a75ca96054460370c1d/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/UserSavedSearch/67810a75ca96054460370c1d/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"pkid": "67810a75ca96054460370c1d"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/UserSavedSearch. | GET | /api/data/UserSavedSearch/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/UserSavedSearch as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Transform Template | GET | /api/data/UserSavedSearch/transform/ |
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/UserSavedSearch/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/UserSavedSearch/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/UserSavedSearch/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/UserSavedSearch/?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/UserSavedSearch; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/UserSavedSearch/[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/UserSavedSearch and the JSON format can be used to import instances of data/UserSavedSearch.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/data/UserSavedSearch/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/UserSavedSearch/[pkid] | hierarchy=[hierarchy] | The data/UserSavedSearch instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/UserSavedSearch/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/UserSavedSearch. |