[Index]
This captures criteria for filter rules.
Model ref.: data/ModelFilterCriteria
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": "Name of the Model Filter Criteria.",
"title": "Name"
},
"description": {
"type": "string",
"title": "Description"
},
"usage": {
"type": "string",
"description": "Usage of the Model Filter Criteria, example FTP, Overbuild. This is a free text field and can be used to filter on by usage.",
"title": "Usage"
},
"type": {
"format": "uri",
"type": "string",
"description": "Type of element to check for Filter Criteria",
"title": "Type",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"criteria": {
"is_password": false,
"title": "Criteria",
"minItems": 1,
"items": {
"is_password": false,
"type": "object",
"properties": {
"unary_operator": {
"is_password": false,
"description": "Unary operator NOT or nothing.",
"title": "Unary Operator",
"required": false,
"choices": [
{
"value": "NOT",
"title": "NOT"
}
],
"readonly": false,
"type": "string"
},
"attribute": {
"is_password": false,
"description": "Attribute or property of the element to check.",
"title": "Attribute",
"required": true,
"readonly": false,
"type": "string"
},
"condition": {
"is_password": false,
"description": "List of string conditions.",
"title": "Condition",
"required": true,
"choices": [
{
"value": "containsIgnoreCase",
"title": "Contains"
},
{
"value": "contains",
"title": "Contains Exactly"
},
{
"value": "equalsIgnoreCase",
"title": "Equals"
},
{
"value": "isexactly",
"title": "Equals Exactly"
},
{
"value": "regex_search",
"title": "Regex Search"
}
],
"readonly": false,
"type": "string"
},
"value": {
"is_password": false,
"description": "The value to check against the attribute or property.",
"title": "Value",
"required": true,
"readonly": false,
"type": "string"
},
"conditional_operator": {
"is_password": false,
"description": "The operator to apply to the next step, OR or AND.",
"title": "Conditional Operator",
"required": false,
"choices": [
{
"value": "AND",
"title": "AND"
},
{
"value": "OR",
"title": "OR"
}
],
"readonly": false,
"type": "string"
}
}
},
"required": true,
"readonly": false,
"type": "array"
}
},
"schema_version": "0.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/ModelFilterCriteria/add/ |
|
The GUI Add form of data/ModelFilterCriteria 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/ModelFilterCriteria | 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/ModelFilterCriteria/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/ModelFilterCriteria/[pkid1]", "/api/data/ModelFilterCriteria/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/ModelFilterCriteria/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/data/ModelFilterCriteria/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/data/ModelFilterCriteria/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/data/ModelFilterCriteria/[pkid1]", "/api/v0/data/ModelFilterCriteria/[pkid2]",...]}} |
GET http://[host-proxy]/api/data/ModelFilterCriteria/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/ModelFilterCriteria; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/ModelFilterCriteria/export/ |
|
{ "hrefs":["/api/data/ModelFilterCriteria/[pkid1]", "/api/data/ModelFilterCriteria/[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/ModelFilterCriteria and the JSON format can be used to import instances of data/ModelFilterCriteria.
GET http://[host-proxy]/api/data/ModelFilterCriteria/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for data/ModelFilterCriteria | POST | /api/data/ModelFilterCriteria/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag | PATCH | /api/data/ModelFilterCriteria/+tag/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag Version | PATCH | /api/data/ModelFilterCriteria/+tag_version/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/data/ModelFilterCriteria/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/data/ModelFilterCriteria/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Migration Template | GET | /api/data/ModelFilterCriteria/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/ModelFilterCriteria/ |
|
The data/ModelFilterCriteria schema and all instances as JSON. |
(The list will return 0 to 3 data/ModelFilterCriteria instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 9,
"total_limit": null,
"order_by": "name",
"direction": "asc",
"current": "/api/data/ModelFilterCriteria/?skip=0&limit=3&order_by=name&direction=asc&traversal=fulltree"
},
"operations": [
"field_display_policy",
"update",
"help",
"remove",
"move",
"add",
"export",
"list",
"configuration_template",
"get",
"bulk_update_form",
"migration",
"transform",
"export_bulkload_template"
],
"meta": {
"model_type": "data/ModelFilterCriteria",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "usage",
"title": "Usage"
},
{
"name": "type",
"title": "Type"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {
"hierarchy": true,
"unique": [
"name",
"type"
]
},
"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": "0.1",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/data/ModelFilterCriteria/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/ModelFilterCriteria/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"bulk_update_form": {
"method": "GET",
"class": "update",
"href": "/api/data/ModelFilterCriteria/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Bulk Modify"
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/data/ModelFilterCriteria/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/ModelFilterCriteria/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/ModelFilterCriteria/+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/ModelFilterCriteria/+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/ModelFilterCriteria/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/data/ModelFilterCriteria/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"migration": {
"method": "GET",
"class": "migration",
"href": "/api/data/ModelFilterCriteria/migration/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Migration Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/data/ModelFilterCriteria/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/ModelFilterCriteria/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"transform": {
"method": "GET",
"class": "transform",
"href": "/api/data/ModelFilterCriteria/transform/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Transform Template"
}
}
]
},
"resources": [
{
"data": {
"description": "Generic rule for matching a MS 365 User's City to LinkedSite City",
"usage": "Move User",
"criteria": [
{
"attribute": "City",
"conditional_operator": "AND",
"value": "{{ macro.OVERBUILD_SITE_LINKEDSITE_CITY_NAME }}",
"condition": "isexactly"
},
{
"attribute": "City",
"value": "{{ fn.unset }}",
"condition": "equalsIgnoreCase",
"unary_operator": "NOT"
}
],
"type": "device/msgraph/MsolUser",
"name": "Generic MS 365 Match City to LinkedSite City",
"pkid": "6633489b56369e9cff7cd012",
"hierarchy_friendly_name": "sys (System)",
"hierarchy_path": "sys"
},
"meta": {
"model_type": "data/ModelFilterCriteria",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "usage",
"title": "Usage"
},
{
"name": "type",
"title": "Type"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [
"microsoftonly",
"V4UC",
"ba_CommonOverlay"
],
"title": "Generic MS 365 Match City to LinkedSite City - device/msgraph/MsolUser",
"business_key": {
"hierarchy": true,
"unique": [
"name",
"type"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/data/ModelFilterCriteria/6633489b56369e9cff7cd011/",
"pkid": "6633489b56369e9cff7cd011"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"6633489b56369e9cff7cd011"
],
"schema_version": "0.1",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/ModelFilterCriteria/6633489b56369e9cff7cd011/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/ModelFilterCriteria/6633489b56369e9cff7cd011/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/ModelFilterCriteria/6633489b56369e9cff7cd011/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/ModelFilterCriteria/6633489b56369e9cff7cd011/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/ModelFilterCriteria/6633489b56369e9cff7cd011/+tag/",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/data/ModelFilterCriteria/6633489b56369e9cff7cd011/+tag_version/",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/ModelFilterCriteria/6633489b56369e9cff7cd011/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/ModelFilterCriteria/6633489b56369e9cff7cd011/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "6633489b56369e9cff7cd011"
},
{
"data": {
"description": "Generic rule for matching a MS 365 User's City to Site",
"usage": "Move User",
"criteria": [
{
"attribute": "City",
"value": "{{ macro.OVERBUILD_SITE_NAME }}",
"condition": "isexactly"
}
],
"type": "device/msgraph/MsolUser",
"name": "Generic MS 365 Match City to Site",
"pkid": "650fe3bd84eaf2a1ce63732a",
"hierarchy_friendly_name": "sys (System)",
"hierarchy_path": "sys"
},
"meta": {
"model_type": "data/ModelFilterCriteria",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "usage",
"title": "Usage"
},
{
"name": "type",
"title": "Type"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [
"microsoftonly",
"V4UC",
"ba_CommonOverlay"
],
"title": "Generic MS 365 Match City to Site - device/msgraph/MsolUser",
"business_key": {
"hierarchy": true,
"unique": [
"name",
"type"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/data/ModelFilterCriteria/650fe3bd84eaf2a1ce637329/",
"pkid": "650fe3bd84eaf2a1ce637329"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"650fe3bd84eaf2a1ce637329"
],
"schema_version": "0.1",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/ModelFilterCriteria/650fe3bd84eaf2a1ce637329/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/ModelFilterCriteria/650fe3bd84eaf2a1ce637329/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/ModelFilterCriteria/650fe3bd84eaf2a1ce637329/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/ModelFilterCriteria/650fe3bd84eaf2a1ce637329/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/ModelFilterCriteria/650fe3bd84eaf2a1ce637329/+tag/",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/data/ModelFilterCriteria/650fe3bd84eaf2a1ce637329/+tag_version/",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/ModelFilterCriteria/650fe3bd84eaf2a1ce637329/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/ModelFilterCriteria/650fe3bd84eaf2a1ce637329/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "650fe3bd84eaf2a1ce637329"
},
{
"data": {
"description": "Generic rule for matching a MS 365 User's City to Site City",
"usage": "Move User",
"criteria": [
{
"attribute": "City",
"conditional_operator": "AND",
"value": "{{ macro.OVERBUILD_SITE_CITY_NAME }}",
"condition": "isexactly"
},
{
"attribute": "City",
"value": "{{ fn.unset }}",
"condition": "equalsIgnoreCase",
"unary_operator": "NOT"
}
],
"type": "device/msgraph/MsolUser",
"name": "Generic MS 365 Match City to Site City",
"pkid": "650fe3bd84eaf2a1ce637330",
"hierarchy_friendly_name": "sys (System)",
"hierarchy_path": "sys"
},
"meta": {
"model_type": "data/ModelFilterCriteria",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "usage",
"title": "Usage"
},
{
"name": "type",
"title": "Type"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [
"microsoftonly",
"V4UC",
"ba_CommonOverlay"
],
"title": "Generic MS 365 Match City to Site City - device/msgraph/MsolUser",
"business_key": {
"hierarchy": true,
"unique": [
"name",
"type"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/data/ModelFilterCriteria/650fe3bd84eaf2a1ce63732f/",
"pkid": "650fe3bd84eaf2a1ce63732f"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"650fe3bd84eaf2a1ce63732f"
],
"schema_version": "0.1",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/ModelFilterCriteria/650fe3bd84eaf2a1ce63732f/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/ModelFilterCriteria/650fe3bd84eaf2a1ce63732f/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/ModelFilterCriteria/650fe3bd84eaf2a1ce63732f/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/ModelFilterCriteria/650fe3bd84eaf2a1ce63732f/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/ModelFilterCriteria/650fe3bd84eaf2a1ce63732f/+tag/",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/data/ModelFilterCriteria/650fe3bd84eaf2a1ce63732f/+tag_version/",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/ModelFilterCriteria/650fe3bd84eaf2a1ce63732f/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/ModelFilterCriteria/650fe3bd84eaf2a1ce63732f/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "650fe3bd84eaf2a1ce63732f"
}
]
}
(Show the first instance)
{
"data": {
"description": "Generic rule for matching a MS 365 User's City to LinkedSite City",
"usage": "Move User",
"criteria": [
{
"attribute": "City",
"conditional_operator": "AND",
"value": "{{ macro.OVERBUILD_SITE_LINKEDSITE_CITY_NAME }}",
"condition": "isexactly"
},
{
"attribute": "City",
"value": "{{ fn.unset }}",
"condition": "equalsIgnoreCase",
"unary_operator": "NOT"
}
],
"type": "device/msgraph/MsolUser",
"name": "Generic MS 365 Match City to LinkedSite City",
"pkid": "6633489b56369e9cff7cd012"
},
"meta": {
"model_type": "data/ModelFilterCriteria",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "usage",
"title": "Usage"
},
{
"name": "type",
"title": "Type"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [
"microsoftonly",
"V4UC",
"ba_CommonOverlay"
],
"title": "Generic MS 365 Match City to LinkedSite City - device/msgraph/MsolUser",
"business_key": {
"hierarchy": true,
"unique": [
"name",
"type"
]
},
"api_version": "21.2",
"cached": false,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"foreign_key": [],
"children": [],
"self": [
{
"href": "/api/data/ModelFilterCriteria/6633489b56369e9cff7cd011/",
"pkid": "6633489b56369e9cff7cd011"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"6633489b56369e9cff7cd011"
],
"schema_version": "0.1",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/ModelFilterCriteria/6633489b56369e9cff7cd011/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/ModelFilterCriteria/6633489b56369e9cff7cd011/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/ModelFilterCriteria/6633489b56369e9cff7cd011/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/ModelFilterCriteria/6633489b56369e9cff7cd011/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/ModelFilterCriteria/6633489b56369e9cff7cd011/+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/ModelFilterCriteria/6633489b56369e9cff7cd011/+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/ModelFilterCriteria/6633489b56369e9cff7cd011/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/ModelFilterCriteria/6633489b56369e9cff7cd011/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"pkid": "6633489b56369e9cff7cd011"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/ModelFilterCriteria. | GET | /api/data/ModelFilterCriteria/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/ModelFilterCriteria as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Transform Template | GET | /api/data/ModelFilterCriteria/transform/ |
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/ModelFilterCriteria/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/ModelFilterCriteria/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/ModelFilterCriteria/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/ModelFilterCriteria/?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/ModelFilterCriteria; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/ModelFilterCriteria/[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/ModelFilterCriteria and the JSON format can be used to import instances of data/ModelFilterCriteria.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/data/ModelFilterCriteria/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/ModelFilterCriteria/[pkid] | hierarchy=[hierarchy] | The data/ModelFilterCriteria instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/ModelFilterCriteria/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/ModelFilterCriteria. |