[Index]
Transform instructions to transform data instances between different API versions.
Model ref.: data/Transform
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": "The name that is given to the Configuration Template.",
"title": "Name"
},
"description": {
"required": false,
"type": "string",
"description": "A description for the Configuration Template instance.",
"title": "Description"
},
"target_model_type": {
"required": true,
"type": "string",
"description": "The target model type and name that the Configuration Template applies to.",
"title": "Target Model Type"
},
"from_version": {
"type": "string",
"description": "The API version the data instance will be transformed from.",
"title": "From Version"
},
"to_version": {
"type": "string",
"description": "The API version the data instance will be transformed to.",
"title": "To Version"
},
"order": {
"minimum": 0,
"type": "integer",
"description": "An integer indicating the order in which the transforms must be applied if multilpes are found.",
"title": "Order"
},
"pre_conditions": {
"description": "If all of these conditions are met, the transform will commence",
"title": "Pre-Conditions",
"items": {
"type": "object",
"properties": {
"condition": {
"required": true,
"type": "string",
"description": "A macro based condition",
"title": "Condition"
}
}
},
"required": false,
"type": "array"
},
"post_conditions": {
"description": "If all of these conditions are met it means the transform was successful",
"title": "Post-Conditions",
"items": {
"type": "object",
"properties": {
"condition": {
"required": true,
"type": "string",
"description": "A macro based condition",
"title": "Condition"
}
}
},
"required": false,
"type": "array"
},
"foreach": {
"description": "Iterates over the list returned by the macro and appends array elements to the specified field.",
"title": "Foreach Elements",
"items": {
"type": "object",
"properties": {
"property": {
"required": true,
"type": "string",
"description": "The field/property to iterate over.",
"title": "Property"
},
"macro_list": {
"required": true,
"type": "string",
"description": "The macro that produces the list to iterate over.",
"title": "Macro List"
},
"context_var": {
"required": true,
"type": "string",
"description": "The context variable that will contain the data from the iteration.",
"title": "Context Variable"
}
}
},
"required": false,
"type": "array"
},
"template": {
"required": true,
"type": "string",
"description": "The contents of the template, such as defaults and macros. The names shown in the template are determined by the attribute names of the Target Model Type.",
"title": "Template"
},
"override_list_items": {
"description": "A Flag to allow the merge_it function to override list values when merging",
"title": "Override list items when merging",
"default": "false",
"required": false,
"type": "boolean"
}
},
"schema_version": "1.0.3"
}
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/data/Transform/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/Transform/[pkid1]", "/api/data/Transform/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/Transform/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/data/Transform/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/data/Transform/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/data/Transform/[pkid1]", "/api/v0/data/Transform/[pkid2]",...]}} |
GET http://[host-proxy]/api/data/Transform/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/Transform; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/Transform/export/ |
|
{ "hrefs":["/api/data/Transform/[pkid1]", "/api/data/Transform/[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/Transform and the JSON format can be used to import instances of data/Transform.
GET http://[host-proxy]/api/data/Transform/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for data/Transform | POST | /api/data/Transform/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag | PATCH | /api/data/Transform/+tag/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag Version | PATCH | /api/data/Transform/+tag_version/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/data/Transform/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/data/Transform/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/Transform/ |
|
The data/Transform schema and all instances as JSON. |
(The list will return 0 to 3 data/Transform instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 26,
"total_limit": null,
"order_by": "name",
"direction": "asc",
"current": "/api/data/Transform/?skip=0&limit=3&order_by=name&direction=asc&traversal=down"
},
"operations": [
"field_display_policy",
"update",
"help",
"remove",
"move",
"export",
"list",
"configuration_template",
"get",
"bulk_update_form",
"migration",
"export_bulkload_template"
],
"meta": {
"model_type": "data/Transform",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "from_version",
"title": "From Version"
},
{
"name": "to_version",
"title": "To Version"
},
{
"name": "target_model_type",
"title": "Target Model Type"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {
"hierarchy": true,
"unique": [
"name",
"target_model_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": [
"bulk_update_form",
"clone",
"configuration_template",
"execute",
"export",
"export_bulkload_template",
"field_display_policy",
"get",
"help",
"list",
"remove",
"tag",
"tag_version",
"update"
],
"schema_version": "1.0.3",
"actions": [
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/Transform/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"bulk_update_form": {
"method": "GET",
"class": "update",
"href": "/api/data/Transform/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Bulk Modify"
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/data/Transform/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/Transform/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/Transform/+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/Transform/+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/Transform/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/data/Transform/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/data/Transform/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/Transform/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": [
{
"data": {
"name": "HcsEntitlementCatalogDAT_10.1.2to_10.6.1_VT",
"pkid": "5ad5d299affa9343e4d98fd7",
"from_version": "10.1.2",
"to_version": "10.6.1",
"template": {
"snr": "(( True ))"
},
"target_model_type": "data/HcsEntitlementCatalogDAT",
"order": 1,
"hierarchy_friendly_name": "hcs (Hcs)",
"hierarchy_path": "sys.hcs"
},
"meta": {
"model_type": "data/Transform",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "from_version",
"title": "From Version"
},
{
"name": "to_version",
"title": "To Version"
},
{
"name": "target_model_type",
"title": "Target Model Type"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [
{
"pkid": "5ad5d299affa9343e4d98fd8",
"version": "0.1.1",
"href": "/api/v0/data/Transform/5ad5d299affa9343e4d98fd6/?cached=5ad5d299affa9343e4d98fd8"
}
],
"tags": [
"V4UC",
"ba_dcpld__SYSdotHCS"
],
"title": "HcsEntitlementCatalogDAT_10.1.2to_10.6.1_VT - data/HcsEntitlementCatalogDAT",
"business_key": {
"hierarchy": true,
"unique": [
"name",
"target_model_type"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5ad5bacbaffa9343e4d93e01",
"href": "/api/data/HierarchyNode/5ad5bacbaffa9343e4d93e01"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/data/Transform/5ad5d299affa9343e4d98fd6/",
"pkid": "5ad5d299affa9343e4d98fd6"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ad5d299affa9343e4d98fd6"
],
"version_tag": "0.1.1",
"schema_version": "1.0.3",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/Transform/5ad5d299affa9343e4d98fd6/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/Transform/5ad5d299affa9343e4d98fd6/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/Transform/5ad5d299affa9343e4d98fd6/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/Transform/5ad5d299affa9343e4d98fd6/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/Transform/5ad5d299affa9343e4d98fd6/+tag/",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/data/Transform/5ad5d299affa9343e4d98fd6/+tag_version/",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"execute": {
"method": "POST",
"class": "execute",
"href": "/api/data/Transform/5ad5d299affa9343e4d98fd6/execute/",
"support_async": true,
"title": "Execute"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/Transform/5ad5d299affa9343e4d98fd6/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/Transform/5ad5d299affa9343e4d98fd6/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "5ad5d299affa9343e4d98fd6"
},
{
"data": {
"name": "HcsEntitlementCatalogDAT_10.6.2to_10.6.3_VT",
"pkid": "5ad5d29caffa9343e4d98fdf",
"from_version": "10.6.2",
"to_version": "10.6.3",
"template": {
"webex": "(( True ))",
"cmr": "(( True ))"
},
"target_model_type": "data/HcsEntitlementCatalogDAT",
"order": 1,
"hierarchy_friendly_name": "hcs (Hcs)",
"hierarchy_path": "sys.hcs"
},
"meta": {
"model_type": "data/Transform",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "from_version",
"title": "From Version"
},
{
"name": "to_version",
"title": "To Version"
},
{
"name": "target_model_type",
"title": "Target Model Type"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [
{
"pkid": "5ad5d29caffa9343e4d98fe0",
"version": "0.1.1",
"href": "/api/v0/data/Transform/5ad5d29caffa9343e4d98fde/?cached=5ad5d29caffa9343e4d98fe0"
}
],
"tags": [
"V4UC",
"ba_dcpld__SYSdotHCS"
],
"title": "HcsEntitlementCatalogDAT_10.6.2to_10.6.3_VT - data/HcsEntitlementCatalogDAT",
"business_key": {
"hierarchy": true,
"unique": [
"name",
"target_model_type"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5ad5bacbaffa9343e4d93e01",
"href": "/api/data/HierarchyNode/5ad5bacbaffa9343e4d93e01"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/data/Transform/5ad5d29caffa9343e4d98fde/",
"pkid": "5ad5d29caffa9343e4d98fde"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ad5d29caffa9343e4d98fde"
],
"version_tag": "0.1.1",
"schema_version": "1.0.3",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/Transform/5ad5d29caffa9343e4d98fde/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/Transform/5ad5d29caffa9343e4d98fde/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/Transform/5ad5d29caffa9343e4d98fde/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/Transform/5ad5d29caffa9343e4d98fde/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/Transform/5ad5d29caffa9343e4d98fde/+tag/",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/data/Transform/5ad5d29caffa9343e4d98fde/+tag_version/",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"execute": {
"method": "POST",
"class": "execute",
"href": "/api/data/Transform/5ad5d29caffa9343e4d98fde/execute/",
"support_async": true,
"title": "Execute"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/Transform/5ad5d29caffa9343e4d98fde/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/Transform/5ad5d29caffa9343e4d98fde/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "5ad5d29caffa9343e4d98fde"
},
{
"data": {
"name": "HcsEntitlementProfileDAT_10.1.2to_10.6.1_VT",
"pkid": "5ad5d29aaffa9343e4d98fdb",
"from_version": "10.1.2",
"to_version": "10.6.1",
"template": {
"snr": "(( True ))"
},
"target_model_type": "data/HcsEntitlementProfileDAT",
"order": 1,
"hierarchy_friendly_name": "hcs (Hcs)",
"hierarchy_path": "sys.hcs"
},
"meta": {
"model_type": "data/Transform",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "from_version",
"title": "From Version"
},
{
"name": "to_version",
"title": "To Version"
},
{
"name": "target_model_type",
"title": "Target Model Type"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [
{
"pkid": "5ad5d29baffa9343e4d98fdc",
"version": "0.1.1",
"href": "/api/v0/data/Transform/5ad5d29aaffa9343e4d98fda/?cached=5ad5d29baffa9343e4d98fdc"
}
],
"tags": [
"V4UC",
"ba_dcpld__SYSdotHCS"
],
"title": "HcsEntitlementProfileDAT_10.1.2to_10.6.1_VT - data/HcsEntitlementProfileDAT",
"business_key": {
"hierarchy": true,
"unique": [
"name",
"target_model_type"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5ad5bacbaffa9343e4d93e01",
"href": "/api/data/HierarchyNode/5ad5bacbaffa9343e4d93e01"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/data/Transform/5ad5d29aaffa9343e4d98fda/",
"pkid": "5ad5d29aaffa9343e4d98fda"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ad5d29aaffa9343e4d98fda"
],
"version_tag": "0.1.1",
"schema_version": "1.0.3",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/Transform/5ad5d29aaffa9343e4d98fda/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/Transform/5ad5d29aaffa9343e4d98fda/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/Transform/5ad5d29aaffa9343e4d98fda/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/Transform/5ad5d29aaffa9343e4d98fda/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/Transform/5ad5d29aaffa9343e4d98fda/+tag/",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/data/Transform/5ad5d29aaffa9343e4d98fda/+tag_version/",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"execute": {
"method": "POST",
"class": "execute",
"href": "/api/data/Transform/5ad5d29aaffa9343e4d98fda/execute/",
"support_async": true,
"title": "Execute"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/Transform/5ad5d29aaffa9343e4d98fda/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/Transform/5ad5d29aaffa9343e4d98fda/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "5ad5d29aaffa9343e4d98fda"
}
]
}
(Show the first instance)
{
"data": {
"name": "HcsEntitlementCatalogDAT_10.1.2to_10.6.1_VT",
"from_version": "10.1.2",
"to_version": "10.6.1",
"template": {
"snr": "(( True ))"
},
"target_model_type": "data/HcsEntitlementCatalogDAT",
"order": 1,
"pkid": "5ad5d299affa9343e4d98fd7"
},
"meta": {
"model_type": "data/Transform",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "from_version",
"title": "From Version"
},
{
"name": "to_version",
"title": "To Version"
},
{
"name": "target_model_type",
"title": "Target Model Type"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [
{
"pkid": "5ad5d299affa9343e4d98fd8",
"version": "0.1.1",
"href": "/api/v0/data/Transform/5ad5d299affa9343e4d98fd6/?cached=5ad5d299affa9343e4d98fd8"
}
],
"tags": [
"V4UC",
"ba_dcpld__SYSdotHCS"
],
"title": "HcsEntitlementCatalogDAT_10.1.2to_10.6.1_VT - data/HcsEntitlementCatalogDAT",
"business_key": {
"hierarchy": true,
"unique": [
"name",
"target_model_type"
]
},
"api_version": "21.2",
"cached": false,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"href": "/api/data/HierarchyNode/5ad5bacbaffa9343e4d93e01",
"pkid": "5ad5bacbaffa9343e4d93e01"
}
],
"foreign_key": [],
"children": [],
"self": [
{
"href": "/api/data/Transform/5ad5d299affa9343e4d98fd6/",
"pkid": "5ad5d299affa9343e4d98fd6"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ad5d299affa9343e4d98fd6"
],
"version_tag": "0.1.1",
"schema_version": "1.0.3",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/Transform/5ad5d299affa9343e4d98fd6/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/Transform/5ad5d299affa9343e4d98fd6/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/Transform/5ad5d299affa9343e4d98fd6/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/Transform/5ad5d299affa9343e4d98fd6/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/Transform/5ad5d299affa9343e4d98fd6/+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/Transform/5ad5d299affa9343e4d98fd6/+tag_version/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"execute": {
"method": "POST",
"class": "execute",
"href": "/api/data/Transform/5ad5d299affa9343e4d98fd6/execute/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Execute"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/Transform/5ad5d299affa9343e4d98fd6/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/Transform/5ad5d299affa9343e4d98fd6/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"pkid": "5ad5d299affa9343e4d98fd6"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/Transform. | GET | /api/data/Transform/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/Transform as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/Transform/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/Transform/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/Transform/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/Transform/?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/Transform; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/Transform/[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/Transform and the JSON format can be used to import instances of data/Transform.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/data/Transform/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Execute | POST | /api/data/Transform/[pkid]/execute | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/Transform/[pkid] | hierarchy=[hierarchy] | The data/Transform instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/Transform/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/Transform. |