[Index]
Defines the schema for the Links Dashboard Widget.
Model ref.: data/DashboardWidgetLinks
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": {
"title": {
"title": "Title",
"description": "The title to be displayed for this widget.",
"type": "string",
"required": true
},
"description": {
"title": "Description",
"description": "The description to be displayed for this widget.",
"type": "string"
},
"links": {
"title": "Links",
"description": "List of links that belong to section.",
"type": "array",
"required": false,
"readonly": false,
"items": {
"type": "object",
"properties": {
"link_text": {
"title": "Link Text",
"description": "Text for the link",
"type": "string",
"required": false,
"readonly": false,
"displayable": true
},
"description": {
"title": "Description",
"description": "A description of the Link.",
"type": "string",
"required": false,
"readonly": false
},
"icon": {
"title": "Icon",
"description": "The icon to be used for this link.",
"type": "string",
"format": "uri",
"required": false,
"readonly": false,
"target": "/api/data/Icons/choices/?choice_title=icon_name&field=icon_value&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "icon_value",
"target_title": "icon_name",
"target_model_type": "data/Icons",
"choices": []
},
"condition": {
"title": "Condition",
"description": "Only show this link if this condition evaluates to true.",
"type": "string",
"required": false,
"readonly": false,
"displayable": true
},
"display": {
"title": "Display As",
"description": "Select the display format of the model types of the menu item. The format can be a Form for a single instance, or a List for more than one instance.",
"type": "string",
"required": false,
"readonly": false,
"default": "list",
"choices": [
{
"value": "form",
"title": "Form"
},
{
"value": "inlinelist",
"title": "Inline List"
},
{
"value": "list",
"title": "List"
},
{
"value": "externalLink",
"title": "External Link"
},
{
"value": "dashboard",
"title": "Dashboard"
}
]
},
"type": {
"title": "Type",
"description": "The selected model type from the Type drop-down list to associate with the Title.",
"type": "string",
"format": "uri",
"required": false,
"readonly": false,
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"href": {
"title": "Href",
"description": "If a direct reference to a model type is used for the menu item, the specified path.",
"type": "string",
"required": false,
"readonly": false
},
"field_display_policy": {
"title": "Field Display Policy",
"description": "The selected Field Display Policy that is associated with the Menu Item.",
"type": "string",
"format": "uri",
"required": false,
"readonly": false,
"target": "/api/data/FieldDisplayPolicy/template_choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "name",
"target_model_type": "data/FieldDisplayPolicy",
"choices": []
},
"configuration_template": {
"title": "Configuration Template",
"description": "The selected Configuration Template that is associated with the Menu Item.",
"type": "string",
"format": "uri",
"required": false,
"readonly": false,
"target": "/api/data/ConfigurationTemplate/template_choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "name",
"target_model_type": "data/ConfigurationTemplate",
"choices": []
},
"dashboard": {
"title": "Dashboard",
"description": "The selected Dashboard that is associated with the Menu Item (only available on the New Admin GUI).",
"type": "string",
"format": "uri",
"target": "/api/data/Dashboard/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "name",
"target_model_type": "data/Dashboard",
"choices": []
},
"filter_options": {
"title": "Fixed Filters",
"description": "Filters that can't be removed by end user. Applicable to display as = 'list'",
"type": "array",
"required": false,
"readonly": false,
"items": {
"type": "object",
"properties": {
"filter_by": {
"title": "Field Name",
"type": "string",
"required": false,
"readonly": false
},
"operation": {
"title": "Operation",
"type": "string",
"required": false,
"readonly": false,
"choices": [
{
"value": "contains",
"title": "Contains"
},
{
"value": "notcontain",
"title": "Does Not Contain"
},
{
"value": "startswith",
"title": "Starts With"
},
{
"value": "endswith",
"title": "Ends With"
},
{
"value": "equals",
"title": "Equals"
},
{
"value": "notequal",
"title": "Not Equal"
}
]
},
"filterValue": {
"title": "Filter Value",
"type": "string",
"required": false,
"readonly": false
},
"ignore_case": {
"title": "Ignore Case",
"type": "boolean",
"required": false,
"readonly": false
}
}
}
},
"configurable_options": {
"title": "Configurable Filters",
"description": "Filters suggested to end users and my be cleared. Applicable to display as = 'list'",
"type": "array",
"required": false,
"readonly": false,
"items": {
"type": "object",
"properties": {
"filter_by": {
"title": "Field Name",
"type": "string",
"required": false,
"readonly": false
},
"operation": {
"title": "Operation",
"type": "string",
"required": false,
"readonly": false,
"choices": [
{
"value": "contains",
"title": "Contains"
},
{
"value": "notcontain",
"title": "Does Not Contain"
},
{
"value": "startswith",
"title": "Starts With"
},
{
"value": "endswith",
"title": "Ends With"
},
{
"value": "equals",
"title": "Equals"
},
{
"value": "notequal",
"title": "Not Equal"
}
]
},
"filterValue": {
"title": "Filter Value",
"type": "string",
"required": false,
"readonly": false
},
"ignore_case": {
"title": "Ignore Case",
"type": "boolean",
"required": false,
"readonly": false
}
}
}
},
"default_model_type": {
"title": "Set as default Model Type",
"description": "Use this menu entry configuration as the default for this model type. The selected Field Display Policy and Configuration Template will be used for the corresponding model in cases like search, when not navigating from a menu or dashboard.",
"type": "boolean",
"required": false,
"readonly": false
}
}
}
}
},
"schema_version": "0.5"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/DashboardWidgetLinks/add/ |
|
The GUI Add form of data/DashboardWidgetLinks 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/DashboardWidgetLinks | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/DashboardWidgetLinks/ |
|
The data/DashboardWidgetLinks schema and all instances as JSON. |
(The list will return 0 to 3 data/DashboardWidgetLinks instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": "title",
"direction": "asc",
"current": "/api/data/DashboardWidgetLinks/?skip=0&limit=3&order_by=title&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/DashboardWidgetLinks",
"summary_attrs": [
{
"name": "title",
"title": "Title"
},
{
"name": "links",
"title": "Links"
},
{
"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": [
"get",
"add",
"list"
],
"schema_version": "0.5",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/data/DashboardWidgetLinks/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/data/DashboardWidgetLinks/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/DashboardWidgetLinks/[pkid] | hierarchy=[hierarchy] | The data/DashboardWidgetLinks instance with [pkid]. |