[Index]
Model ref.: relation/NumberFilter
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": {
"type": "string"
},
"name": {
"type": "string"
},
"featureName": {
"type": "string"
},
"query": {
"type": "string"
},
"type": {
"type": "string",
"choices": [
{
"value": "filters",
"title": "filters"
}
]
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"condition": {
"type": "string"
},
"value": {
"type": "string"
},
"fromValue": {
"type": "string"
},
"toValue": {
"type": "string"
}
}
}
},
"dropdown_filter": {
"title": "Dropdown Filter",
"type": "boolean"
},
"enabled": {
"title": "Enable Filter",
"type": "boolean"
},
"no_instance": {
"title": "No Instance",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"is_password": false,
"title": "Name",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"minItems": 1
}
},
"schema_version": "0.1"
}
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/relation/NumberFilter/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/NumberFilter/[pkid1]", "/api/relation/NumberFilter/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/NumberFilter/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/relation/NumberFilter/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/relation/NumberFilter/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/relation/NumberFilter/[pkid1]", "/api/v0/relation/NumberFilter/[pkid2]",...]}} |
GET http://[host-proxy]/api/relation/NumberFilter/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=relation/NumberFilter |
|
{"hrefs": ["/api/relation/NumberFilter/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=relation/NumberFilter |
|
{"hrefs": ["/api/relation/NumberFilter/[pkid1]", "/api/relation/NumberFilter/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/NumberFilter; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/NumberFilter/export/ |
|
{ "hrefs":["/api/relation/NumberFilter/[pkid1]", "/api/relation/NumberFilter/[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/NumberFilter and the JSON format can be used to import instances of relation/NumberFilter.
GET http://[host-proxy]/api/relation/NumberFilter/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/NumberFilter | POST | /api/relation/NumberFilter/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag | PATCH | /api/relation/NumberFilter/+tag/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag Version | PATCH | /api/relation/NumberFilter/+tag_version/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/relation/NumberFilter/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/relation/NumberFilter/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/NumberFilter/ |
|
The relation/NumberFilter schema and all instances as JSON. |
(The list will return 0 to 3 relation/NumberFilter instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 8,
"total_limit": null,
"order_by": "username",
"direction": "asc",
"current": "/api/relation/NumberFilter/?skip=0&limit=3&order_by=username&direction=asc&traversal=fulltree"
},
"operations": [
"update",
"get",
"list",
"add",
"tag",
"bulk_update_form",
"export",
"help",
"bulk_update",
"tag_version",
"move",
"remove",
"configuration_template",
"export_bulkload_template",
"clone",
"field_display_policy"
],
"meta": {
"model_type": "relation/NumberFilter",
"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": [],
"self": [
{
"href": "/api/relation/NumberFilter/None/",
"pkid": null
}
]
},
"model_specific_actions": [
"export",
"help",
"update",
"tag_version",
"get",
"move",
"list",
"remove",
"configuration_template",
"add",
"export_bulkload_template",
"clone",
"tag",
"bulk_update_form",
"field_display_policy"
],
"schema_version": "0.1",
"actions": [
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/NumberFilter/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"bulk_update_form": {
"method": "GET",
"class": "update",
"href": "/api/relation/NumberFilter/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Bulk Modify"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=relation/NumberFilter",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/relation/NumberFilter/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/relation/NumberFilter/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/relation/NumberFilter/+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/relation/NumberFilter/+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/relation/NumberFilter/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/relation/NumberFilter/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/relation/NumberFilter/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/NumberFilter/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": [
{
"data": {
"user_pkid": "63f78853c33191b9204fa52b",
"username": "sysadmin",
"name": "Default",
"featureName": "data/InternalNumberInventory",
"dropdown_filter": true,
"enabled": true,
"pkid": "674ec9863cf4a97cfb516305",
"hierarchy_friendly_name": "sys (System)",
"hierarchy_path": "sys"
},
"meta": {
"model_type": "relation/NumberFilter",
"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/relation/NumberFilter/674ec9863cf4a97cfb516304/",
"pkid": "674ec9863cf4a97cfb516304"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"674ec9863cf4a97cfb516304"
],
"schema_version": "2.0.0",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/NumberFilter/674ec9863cf4a97cfb516304/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/NumberFilter/674ec9863cf4a97cfb516304/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/relation/NumberFilter/674ec9863cf4a97cfb516304/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/674ec9863cf4a97cfb516304/?model_type=relation/NumberFilter",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/NumberFilter/674ec9863cf4a97cfb516304/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/relation/NumberFilter/674ec9863cf4a97cfb516304/+tag/",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/relation/NumberFilter/674ec9863cf4a97cfb516304/+tag_version/",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/NumberFilter/674ec9863cf4a97cfb516304/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/NumberFilter/674ec9863cf4a97cfb516304/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "674ec9863cf4a97cfb516304"
},
{
"data": {
"user_pkid": "63f78853c33191b9204fa52b",
"username": "sysadmin",
"name": "Show Unused Numbers (Site Only)",
"featureName": "data/InternalNumberInventory",
"dropdown_filter": true,
"enabled": true,
"pkid": "674ec9863cf4a97cfb516309",
"hierarchy_friendly_name": "sys (System)",
"hierarchy_path": "sys"
},
"meta": {
"model_type": "relation/NumberFilter",
"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": "Show Unused Numbers (Site Only)",
"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/relation/NumberFilter/674ec9863cf4a97cfb516308/",
"pkid": "674ec9863cf4a97cfb516308"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"674ec9863cf4a97cfb516308"
],
"schema_version": "2.0.0",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/NumberFilter/674ec9863cf4a97cfb516308/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/NumberFilter/674ec9863cf4a97cfb516308/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/relation/NumberFilter/674ec9863cf4a97cfb516308/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/674ec9863cf4a97cfb516308/?model_type=relation/NumberFilter",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/NumberFilter/674ec9863cf4a97cfb516308/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/relation/NumberFilter/674ec9863cf4a97cfb516308/+tag/",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/relation/NumberFilter/674ec9863cf4a97cfb516308/+tag_version/",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/NumberFilter/674ec9863cf4a97cfb516308/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/NumberFilter/674ec9863cf4a97cfb516308/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "674ec9863cf4a97cfb516308"
},
{
"data": {
"user_pkid": "63f78853c33191b9204fa52b",
"username": "sysadmin",
"name": "Show Unused Numbers",
"featureName": "data/InternalNumberInventory",
"dropdown_filter": true,
"enabled": true,
"pkid": "674ec9863cf4a97cfb51630d",
"hierarchy_friendly_name": "sys (System)",
"hierarchy_path": "sys"
},
"meta": {
"model_type": "relation/NumberFilter",
"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": "Show Unused Numbers",
"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/relation/NumberFilter/674ec9863cf4a97cfb51630c/",
"pkid": "674ec9863cf4a97cfb51630c"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"674ec9863cf4a97cfb51630c"
],
"schema_version": "2.0.0",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/NumberFilter/674ec9863cf4a97cfb51630c/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/NumberFilter/674ec9863cf4a97cfb51630c/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/relation/NumberFilter/674ec9863cf4a97cfb51630c/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/674ec9863cf4a97cfb51630c/?model_type=relation/NumberFilter",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/NumberFilter/674ec9863cf4a97cfb51630c/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/relation/NumberFilter/674ec9863cf4a97cfb51630c/+tag/",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/relation/NumberFilter/674ec9863cf4a97cfb51630c/+tag_version/",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/NumberFilter/674ec9863cf4a97cfb51630c/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/NumberFilter/674ec9863cf4a97cfb51630c/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "674ec9863cf4a97cfb51630c"
}
]
}
(Show the first instance)
{
"data": {
"user_pkid": "63f78853c33191b9204fa52b",
"username": "sysadmin",
"name": "Default",
"featureName": "data/InternalNumberInventory",
"dropdown_filter": true,
"enabled": true,
"no_instance": []
},
"meta": {
"model_type": "relation/NumberFilter",
"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": "Default",
"business_key": {},
"api_version": "21.2",
"cached": true,
"cache_control_policy": "cache_then_device",
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"self": [
{
"href": "/api/relation/NumberFilter/674ec9863cf4a97cfb516304/",
"pkid": "674ec9863cf4a97cfb516304"
}
]
},
"schema_version": "0.1",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/NumberFilter/674ec9863cf4a97cfb516304/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/NumberFilter/674ec9863cf4a97cfb516304/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/relation/NumberFilter/674ec9863cf4a97cfb516304/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/674ec9863cf4a97cfb516304/?hierarchy=[hierarchy]&model_type=relation/NumberFilter",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/NumberFilter/674ec9863cf4a97cfb516304/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/relation/NumberFilter/674ec9863cf4a97cfb516304/+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/relation/NumberFilter/674ec9863cf4a97cfb516304/+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/relation/NumberFilter/674ec9863cf4a97cfb516304/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/NumberFilter/674ec9863cf4a97cfb516304/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"pkid": "674ec9863cf4a97cfb516304"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/NumberFilter. | GET | /api/relation/NumberFilter/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/NumberFilter as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/NumberFilter/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/NumberFilter/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/relation/NumberFilter/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/relation/NumberFilter/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=relation/NumberFilter | 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/NumberFilter; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/NumberFilter/[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/NumberFilter and the JSON format can be used to import instances of relation/NumberFilter.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/relation/NumberFilter/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/NumberFilter/[pkid] | hierarchy=[hierarchy] | The relation/NumberFilter instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/NumberFilter/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/NumberFilter. |