[Index]
Singleton model for scheduled purge of expired AnomalyDetectionRun records. Triggered by data/Schedule on a 24-hour interval.
Model ref.: data/AnomalyDetectionRunCleanup
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": {
"title": "Name",
"description": "Name of this cleanup task instance",
"type": "string",
"maxLength": 1024
}
},
"schema_version": "1.0.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/AnomalyDetectionRunCleanup/add/ |
|
The GUI Add form of data/AnomalyDetectionRunCleanup 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/AnomalyDetectionRunCleanup | 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/AnomalyDetectionRunCleanup/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/AnomalyDetectionRunCleanup/[pkid1]", "/api/data/AnomalyDetectionRunCleanup/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/AnomalyDetectionRunCleanup/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/data/AnomalyDetectionRunCleanup/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/data/AnomalyDetectionRunCleanup/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Migration Template | GET | /api/data/AnomalyDetectionRunCleanup/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/AnomalyDetectionRunCleanup/ |
|
The data/AnomalyDetectionRunCleanup schema and all instances as JSON. |
(The list will return 0 to 3 data/AnomalyDetectionRunCleanup instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 1,
"total_limit": null,
"order_by": "name",
"direction": "asc",
"current": "/api/data/AnomalyDetectionRunCleanup/?skip=0&limit=3&order_by=name&direction=asc&traversal=down"
},
"operations": [
"add",
"bulk_update_form",
"list",
"update",
"transform",
"migration",
"remove",
"export",
"help",
"configuration_template",
"field_display_policy",
"get",
"export_bulkload_template"
],
"meta": {
"model_type": "data/AnomalyDetectionRunCleanup",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {
"unique": [
"name"
],
"hierarchy": false
},
"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",
"execute",
"get",
"list",
"remove",
"configuration_template",
"field_display_policy",
"migration"
],
"schema_version": "1.0.0",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/data/AnomalyDetectionRunCleanup/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/AnomalyDetectionRunCleanup/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"configuration_template": {
"method": "GET",
"class": "config",
"href": "/api/data/AnomalyDetectionRunCleanup/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/data/AnomalyDetectionRunCleanup/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"migration": {
"method": "GET",
"class": "migration",
"href": "/api/data/AnomalyDetectionRunCleanup/migration/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Migration Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/data/AnomalyDetectionRunCleanup/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
}
]
},
"resources": [
{
"data": {
"name": "Purge Expired Detection Runs",
"pkid": "69ee2ec476a8a1f92ddfe0a7",
"hierarchy_friendly_name": "sys (System)",
"hierarchy_path": "sys"
},
"meta": {
"model_type": "data/AnomalyDetectionRunCleanup",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [
"base",
"core",
"anomaly-detection"
],
"title": "Purge Expired Detection Runs",
"business_key": {
"unique": [
"name"
],
"hierarchy": false
},
"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/AnomalyDetectionRunCleanup/69ee2ec476a8a1f92ddfe0a6/",
"pkid": "69ee2ec476a8a1f92ddfe0a6"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"69ee2ec476a8a1f92ddfe0a6"
],
"schema_version": "1.0.0",
"actions": [
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/AnomalyDetectionRunCleanup/69ee2ec476a8a1f92ddfe0a6/",
"support_async": true,
"title": "Delete"
}
},
{
"execute": {
"method": "POST",
"class": "execute",
"href": "/api/data/AnomalyDetectionRunCleanup/69ee2ec476a8a1f92ddfe0a6/execute/",
"support_async": true,
"title": "Execute"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/AnomalyDetectionRunCleanup/69ee2ec476a8a1f92ddfe0a6/",
"support_async": false,
"title": "Get"
}
}
],
"summary": "false"
},
"pkid": "69ee2ec476a8a1f92ddfe0a6"
}
]
}
(Show the first instance)
{
"data": {
"name": "Purge Expired Detection Runs",
"pkid": "69ee2ec476a8a1f92ddfe0a7"
},
"meta": {
"model_type": "data/AnomalyDetectionRunCleanup",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [
"base",
"core",
"anomaly-detection"
],
"title": "Purge Expired Detection Runs",
"business_key": {
"unique": [
"name"
],
"hierarchy": false
},
"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/AnomalyDetectionRunCleanup/69ee2ec476a8a1f92ddfe0a6/",
"pkid": "69ee2ec476a8a1f92ddfe0a6"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"69ee2ec476a8a1f92ddfe0a6"
],
"schema_version": "1.0.0",
"actions": [
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/AnomalyDetectionRunCleanup/69ee2ec476a8a1f92ddfe0a6/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"execute": {
"method": "POST",
"class": "execute",
"href": "/api/data/AnomalyDetectionRunCleanup/69ee2ec476a8a1f92ddfe0a6/execute/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Execute"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/AnomalyDetectionRunCleanup/69ee2ec476a8a1f92ddfe0a6/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
}
]
},
"pkid": "69ee2ec476a8a1f92ddfe0a6"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/AnomalyDetectionRunCleanup/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Execute | POST | /api/data/AnomalyDetectionRunCleanup/[pkid]/execute | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/AnomalyDetectionRunCleanup/[pkid] | hierarchy=[hierarchy] | The data/AnomalyDetectionRunCleanup instance with [pkid]. |