REST API - getWorkItemOrderFilter

The table summarizes the REST API - getWorkItemOrderFilter.

Request

Format 
GET <baseurl>/worklist/workitemorderfilter/<limitcolumns>
Path parameters limitcolumns=short: Number of fields about which information should be returned. (Fields means the fields defined by BRM that can be used in sort/filter criteria expressions for work item lists.). A value of 0 returns information about all fields.

Response

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

Example

Request 
GET <baseurl>/worklist/workitemorderfilter/2
Response 
{
    "xml-fragment": {
        "columnData": [
            {
                "@description": "The integer value that denotes the ID of the work item.",
                "@id": "1",
                "@name": "id",
                "@type": "COL_NUMERIC",
                "@capability": "BOTH_ORDER_FILTER"
            },
            {
                "@description": "The name of the work item.",
                "@id": "2",
                "@name": "name",
                "@type": "COL_STRING",
                "@capability": "FILTER"
            }
        ]
    }
}