REST API - getWorkListViewDetails

The table summarizes the REST API - getWorkListViewDetails.

Request

Format 
POST <baseurl>/worklist/worklistview/<viewid>/<lockview>
Path parameters
  • viewid: The unique ID of the work list view.
  • lockview: Should this work list view be locked for editing? A lock record will be placed against this view for the calling resource ID. This lock is only removed when the view is updated or an explicit unlock is called.

Response

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

Example

Request 
POST <baseurl>/worklist/worklistview/2/true
Response 
{
    "xml-fragment": {
        "@workViewID": "2",
        "@name": "test",
        "@description": "vdesc",
        "@owner": "tibco-admin",
        "@locker": "",
        "@creationDate": "2013-01-23T15:06:56.230Z",
        "@modificationDate": "2013-01-23T16:16:52.463Z",
        "@public": "false",
        "orderFilterCriteria": {
            "filter": "(appName='GetandViewData')"
        },
        "customData": "<ClientView><Columns><Column name=\"name\" isSelected=\"true\" sortDirection=\"true\" isSort=\"false\"/><Column name=\"appInstanceDescription\" isSelected=\"true\" sortDirection=\"true\" isSort=\"false\"/><Column name=\"description\" isSelected=\"true\" sortDirection=\"true\" isSort=\"false\"/><Column name=\"state\" isSelected=\"true\" sortDirection=\"true\" isSort=\"false\"/><Column name=\"id\" isSelected=\"true\" sortDirection=\"true\" isSort=\"false\"/><Column name=\"priority\" isSelected=\"true\" sortDirection=\"true\" isSort=\"false\"/><Column name=\"startDate\" isSelected=\"true\" sortDirection=\"true\" isSort=\"false\"/><Column name=\"endDate\" isSelected=\"true\" sortDirection=\"true\" isSort=\"false\"/><PageSize size=\"10\"/></Columns></ClientView>"
    }
}