GetItemsByListingReport

Gets primary or auxiliary items from a listing report.

Parameters

There are two ways to specify the report. Parameters differ depending on the option you use.

Option 1 (report):

Name	Type	Description
`GetitemsByListingReport`	Function	Returns primary or auxiliary items from a specified listing report.
`report`	`ID` (integer) `UUID` (string)	The listing report identifier.

Option 2 (table and reportReferenceName):

Name	Type	Description
`GetitemsByListingReport`	Function	Returns a primary or auxiliary item.
`table`	`ID` (integer) `UUID` (string) `dbname` (string) `name` (string)	The table identifier.
`reportReferenceName`	string	The reference name for the report, used in combination with the table identifier. For example: UBG_ISSUES.IDM_all_active_crs

Name

Type

Description

GetitemsByListingReport

Function

Returns a primary or auxiliary item.

table

ID (integer)
UUID (string)
dbname (string)
name (string)

The table identifier.

reportReferenceName

string

The reference name for the report, used in combination with the table identifier.

For example:

UBG_ISSUES.IDM_all_active_crs

Post Data

Name	Type	Description
`itemOptions` (optional)	ItemOptions	Use `itemOptions` to limit the response data. When `itemOptions` are included, only the specified fields, plus fields required by the transition, are sent in the response.
`hasruntimeparams` (optional)	integer	Use `hasruntimeparams` with query-at-runtime reports to fill in the blanks in the report filter. For example: example: &hasruntimeparams=1&f80v1=0
`pagesize` (optional)	integer	Report results honor the user's page size preferences. You can override this setting using `pagesize`, but the results will still be limited to the maximum that is set in the system setting "MaxItemsPerPage". For example: example: &pagesize=5000
`rptkey` and `recno` (both optional)	integer	Reports cache the result set under the key value `rptkey`. A second page of report results can be requested by repeating the report call and appending `rptkey` and the desired starting index (0-based) to the URL. For example: example: &rptkey=1312321&recno=20

Example

URL:

http://AEserverName/jsonapi/getitemsbylistingreport/106?pagesize=2

Post data:

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

Response:

{
  "report": {
    "id": 106,
    "uuid": "8949036c-c217-480b-9214-f831fda3155f",
    "name": "All Issues With Reject Count > 0",
    "comment": "",
    "url": "tmtrack.dll?ReportPage&Template=reports%2Flist&ReportId=106",
    "refURL": "tmtrack.dll?ReportPage&template=reports%2Flist&ReportUUID=
→8949036c-c217-480b-9214-f831fda3155f&embedded"
  },
  "reportResults": {
    "totalItems": 6,
    "pageSize": 2,
    "firstRecordIndex": 0,
    "rptkey": 1846002703
  },
  "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": 109,
        "uuid": "",
        "itemIdPrefixed": "BUG000173",
        "itemId": "000173",
        "url": "http://AEserverName:80/tmtrack/tmtrack.dll?...view&TableId=1000"
      },
      "fields": {
        "TITLE": {
          "value": "Image Builder crashes my system."
        },
        "FUNCTIONAL_AREA": {
          "id": 30,
          "name": "User Interface"
        }
      }
    },
    {
      "id": {
        "id": 47,
        "uuid": "",
        "itemIdPrefixed": "BUG000084",
        "itemId": "000084",
        "url": "http://AEserverName:80/tmtrack/tmtrack.dll?...view&TableId=1000"
      },
      "fields": {
        "TITLE": {
          "value": "Program shuts down"
        },
        "FUNCTIONAL_AREA": {
          "id": 30,
          "name": "User Interface"
        }
      }
    }
  ],
  "result": {
    "type": "OK",
    "msg": ""
  }
}

Comments

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