GetItemsByReportFilter

Gets multiple items using a report filter.

Parameters

Name	Type	Description
GetitemsByReportFilter	Function	Gets multiple items using a report filter to identify which items to return.
reportFilter	ID (integer) UUID (string) name (string)	The report filter identifier.

Post Data

You can optionally use the GetItemsByReportFilter function in an HTTP POST and include one or more of the following objects:

Name	Type	Description
itemOptions (optional)	ItemOptions	Use itemOptions to limit the response data. When itemOptions are included, only the specified fields are sent in the response.

Example

URL:

http://AEserverName/jsonapi/getitemsbyreportfilter/1?pagesize=2

Post data:

{fixedFields: false, includeNotes: true, 
→fields: [{dbname:"TITLE"}, {dbname: "FUNCTIONAL_AREA"}]}

Response:

{
  "reportFilter": {
    "id": 1,
    "uuid": "ac956c79-3784-4c92-bdaf-d0f6a98f1ba8",
    "name": "IDM report filter"
  },
  "reportResults": {
    "totalItems": 60,
    "pageSize": 2,
    "firstRecordIndex": 0,
    "rptkey": 284626196
  },
  "table": {
    "id": 1000,
    "uuid": "dc8cd329-b430-436f-bb75-bf90008e6a50",
    "name": "Issues",
    "dbName": "UBG_ISSUES"
  },
  "fieldMetadata": [
    {
      "id": 54,
      "name": "Title",
      "dbname": "TITLE",
      "syscode": 4,
      "type": "text",
      "renderHtml": false,
      "password": false,
      "maxLength": 80
    },
    {
      "id": 75,
      "name": "Functional Area",
      "dbname": "FUNCTIONAL_AREA",
      "syscode": 0,
      "type": "selection",
      "renderHtml": false,
      "isMultiSelect": false
    }
  ],
  "items": [
    {
      "id": {
        "id": 2,
        "uuid": "",
        "itemIdPrefixed": "BUG000002",
        "itemId": "000002",
        "url": "http://AEserverName:80/tmtrack/tmtrack.dll?...Template=view&TableId=1000"
      },
      "fields": {
        "TITLE": {
          "value": "Upgrade from 4.0 does not work correctly"
        },
        "FUNCTIONAL_AREA": {
          "id": 0,
          "name": "(None)"
        }
      }
    },
    {
      "id": {
        "id": 3,
        "uuid": "",
        "itemIdPrefixed": "ENH000005",
        "itemId": "000005",
        "url": "http://AEserverName:80/tmtrack/tmtrack.dll?...Template=view&TableId=1000"
      },
      "fields": {
        "TITLE": {
          "value": "Change icons to more modern look"
        },
        "FUNCTIONAL_AREA": {
          "id": 0,
          "name": "(None)"
        }
      }
    }
  ],
  "result": {
    "type": "OK",
    "msg": ""
  }
}

Comments

Because the TS_ID is subject to change in a promotion context, you may need to update the reportFilter parameter with the TS_ID from the target environment after the promote is finished.