Editing Work Views

The editWorkListView operation enables you to edit an existing work view.

The editWorkListView request must specify the name and the unique entity ID of the work view to be edited. It can also optionally specify the details of the work view that you want to edit. For example, its description, any sort/filter criteria or the organizational model entities that can access the work view. If any of the optional elements are specified, they overwrite the existing attributes specified for this view.

Note: You only need to pass the data you want to change. Parameters that are not passed are unchanged.

The following steps describe the operations involved when editing a work list view.

Procedure

  1. Use the getEditableWorkListViews operation to retrieve a list of work views that the calling organizational entity has access to. For this operation you must specify:
    • startPosition - the position in the list from which to start the page of results. The list is zero-based. To start at the first item, specify 0.
    • numberOfItems - the number of items from the list to be displayed.
  2. Use the getWorkListViewDetails operation to lock the work list view for editing. You must lock the work list view if you want to edit it. If lockView is true then a lock record is placed against this view for the calling resource ID. The lock is only removed when the view is updated or an explicit deleteWorkListView operation is called.

    The request for this operation must specify the workListViewID for the work list view. The workListViewID is returned in the createWorkListViewResponse when the createWorkListView operation is successful.

  3. Use the editWorkListView operation to edit a work list view. You must specify the workListViewID. Optionally, you can specify the information you want to edit for the work list view. You only need to pass the data you want to change. Parameters that are not passed are unchanged. This information is the same as when you are creating a work list view. See Creating Work List Views for more information.
  4. Once you have finished editing the work list view, unlock it using unlockWorkListView. To use unlockWorkListView, you must specify the workListViewID.