GetWorkViewDetails

Retrieve the details of a specific work view. For example, its description, creation date, whether or not its public and its owner. It can also be used to optionally lock a work view for editing. If you want to edit a work view using the EditWorkListView operation, you must lock it first using this operation.

  • The request must specify the unique entity ID (workViewListID) of the work view to be retrieved. It can also optionally specify whether or not this work view should be locked for editing.
  • The response contains the name of the work view, its unique entity ID and the date it was created and/or modified. It also displays any optional work list view details, if they are specified .
Action getWorkViewDetails
Parameter Notes
  • workListViewID: the unique entity ID of the work view.
  • lockView (Optional): whether or not the work list view should be locked for editing. Set lockView as follows:
    • 0: the work view is not locked
    • 1: a lock record is placed against the view for the calling resource ID. The lock is removed when the view is updated or an explicit unlock is called.
Return WorkViewsResult

Required System Action

viewWorkList.