GetItem

Gets a primary or auxiliary item.

Parameters

Name Type Description
GetItem Function

Returns a primary or auxiliary item.

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

The primary or auxiliary table identifier.

item
  • ID (integer)
  • UUID (string)

The item identifier.

Post Data

You can optionally use the GetItem 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, plus fields required by the transition, are sent in the response.

getTransitions

(optional)

boolean

Include getTransitions to return a list of transitions that are currently available for this item.

Example

URL:

http://AEserverName/jsonapi/GetItem/1000/109

Post data:

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

Response:

{
  "item": {
    "id": {
      "id": 109,
      "uuid": "c1e62a05-5dd1-46e7-9cdc-b91518893b23",
      "itemIdPrefixed": "BUG000173",
      "itemId": "000173",
      "url": "http://AEserverName:80/tmtrack/tmtrack.dll?...&TableId=1000"
    },
    "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
      }
    ],
    "fields": {
      "TITLE": {
        "value": "Image Builder crashes my system."
      },
      "FUNCTIONAL_AREA": {
        "id": 30,
        "name": "User Interface"
      }
    },
    "notes": []
  },
  "result": {
    "type": "OK",
    "msg": ""
  }
}

Comments

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