CreateWorkListView

Create a new work view.

  • The request must specify a name and the details of the new work list view. For example, a description, any sort/filter criteria to be applied to this work view, the organizational entity whose work items you want to view or the resources that can access the work view.
  • The response contains the unique entity ID (workListViewID) of the new work view.
Action CreateWorkListView
Parameter Notes
  • Name: the name of the work view.
  • Description (Optional): description of the work view.
  • Owner (Optional): The resourceID of the owner of this work view. You can get the resourceID from a lookupUser operation. If omitted, the ID of the resource calling the createWorkListView API is used.
  • Public (Optional): whether the work view can be viewed by all TIBCO ActiveMatrix BPM users. If true then it is public.
  • entityID (Optional): the GUID of the organizational entity whose work list you want to retrieve. If the entity is left empty, the view is of the calling resource’s own work list. For a public view, this means each user who logs in has the filter and sort criteria from the view applied to their own work list.
  • orderFilterCriteria (Optional): Specification of sort/filter criteria to be applied to the work item list. See TIBCO ActiveMatrix BPM - BPM Developer’s Guide for more information about order and filter syntax.
  • authors (Optional): Array of XmlModelEntityId objects for entities (GROUPS, POSITIONS, ORGUNITS and RESOURCES) who are allowed to edit the view.
  • users (Optional): Array of XmlModelEntityId objects for resources who are allowed to use the view.
  • customData (Optional): A string attribute used to provide any custom data to be to stored with the work list view. can be used to store any data that you want to associate with your work list view. For example, if you are using a custom client, you may want to specify which work item columns to display when using this work list view. If storing XML data, the value should be wrapped in a CDATA section.
    Note: If you are using the API with TIBCO Openspace you must not use the customData parameter. This is because TIBCO Openspace uses customData to store any of its data that is associated with the work list view. For example, the work item columns to display.
Return WorkListIDResult

Required System Action

viewWorkList.