REST API - editWorkListView

The table summarizes the REST API - editWorkListView.

Request

Format 
PUT <baseurl>/worklist/worklistview/<viewid>
Path parameters viewid: The unique ID of the work list view.

Note: You will need to have set getWorkListViewDetails with the edit flag lockview=true first.

Query parameters apiversion=version (optional, default = 1): Defines the format in which the operation returns its response. If version is:
  • < 2, the response is returned as an unwrapped primitive.
  • 2, the response data is wrapped as an XML fragment.
Body WorkListViewEdit element (from the WorkListService schema)

Response

JSON Returns a JSON representation of the content of the editWorkListViewResponse element.
XML Returns the content of the editWorkListViewResponse element (from the WorkListService schema)

Example

Request 
PUT <baseurl>/worklist/worklistview/2
Request body 
<WorkListViewEdit name="Pending" description="Pending orders" public="true"> 
 <entityID entity-type="RESOURCE" guid="9178DD52-C6AE-468E-AF31-10EA78CC500B"/>
  <orderFilterCriteria xmlns="">
    <order>id ASC , startDate DESC</order>
    <filter>(appName='GetandViewData')</filter>
  </orderFilterCriteria>
<users entity-type="RESOURCE" guid="269D9CBC-9869-4BC3-B632-7857070C0BDB"/>
</WorkListViewEdit>
Response 
2