Action requested Event (Published by Task Definitions Widget)
The user requested an action on selected task definitions.
This can be one of the built-in actions create and open or a custom
action configured for the widget.
Event Name
com.ibm.widget.ActionRequested
General purpose: The user requested an action to be performed.
{
"type" : "object",
"description" : "Reference action for items.",
"extends": "com.ibm.widget.ActionItems.schema.json",
"properties" : {
"action" : { "type":"string",
"description":"Depicts the requested action e.g. edit"},
"type" : { "type": "string", "optional": true,
"description":"Depicts object type for this action e.g. a template to create an item from."},
"parentId" : {"type":"string", "optional":true,
"description":"Parent item, if published by a tree widget."},
"listName" : {"type":"string", "optional":true,
"description":"Name of list containing these items, if published by a list widget."},
"domain" : {"type":"string", "optional":true,
"description":"Identifies the domain that is used for the list containing the items. This is set when Federated services are used."},
"propertyMetaData" : {"type":"array", "optional":true,
"description":"Meta data about additional properties included for items.",
"items": { "properties": {
"name": {"type":"string",
"description":"Name of the additional property. Note that the
property name is prefixed with an underscore to disambiguate it from properties
defined in this schema. See items[].name in result of
query attributes resources e.g. /tasks/query/{query}/attributes."},
"type": {"type":"string",
"enum" : ["STRING", "ID", "NUMBER", "DECIMAL", "BOOLEAN", "TIMESTAMP" ],
"description":"Type of the additional property e.g. STRING. See items[].type
in result of query attributes resources e.g. /tasks/query/{query}/attributes."},
"content": {"type":"string", "optional":true,
"description":"Known content type of the property e.g. TASK.STATE. See
items[].content in result of query attributes resources e.g.
/tasks/query/{query}/attributes."},
"displayName": {"type":"string",
"description":"The display name of the property."},
"description" : { "type": "string", "optional":true,
"description": "Description of the property."
} }
},
"items" : { "type":"array", "optional":true,
"items": { "properties": {
"id" : { "type": "string" },
"type" : { "type": "string" },
"name" : { "type": "string", "optional":true,
"description": "Display name for this item" },
"systemID" : { "type": "string", "optional":true,
"description": "Identifies the system the item originates. This is set and required when Federated services are used." },
"systemType": {"type":"string", "optional":true,
"enum" : ["SYSTEM_TYPE_ICM", "SYSTEM_TYPE_WLE", "SYSTEM_TYPE_WPS" ],
"description":"Type of the system. Is only set if using the Federated services"}
} }
}
} }
The payload object contains the following specific values:
action
Identifies the requested action. Built-in actions are
open
Open task definitions
create
Create new tasks
id
Task definition identifier
type
com.ibm.task.TaskTemplate
If federated task services are used, no task definition is selected and the
"create" built-in action is requested, the additional domain property is included.
In addition it contains the visible properties for each item and meta data about them.