ItemOptions

Limits the data that is returned with an item.

Parameters

Name	Type	Description
fields	ID (integer) UUID (string) dbname (string) name (string)	An array of objects used to specify the fields to display. Empty by default.
fixedFields	boolean	Combines with the fields array to determine the outputted fields. True by default. See usage notes below.
includeNotes	boolean	When true, the item's notes are included in the response. False by default. The user's note preferences are honored, including the sort order and the number of notes to display. If the user has selected None as the display option for notes, no notes are returned.

Usage

The fixedFields parameter combines with the fields array to determine the outputted fields as follows:

• fixedFields = true and fields is empty:

  System fields listed below are included in output.

• fixedFields = true and fields is populated:

  System fields listed below and specified fields are included.

• fixedFields = false and fields is populated:

  Specified fields are included.

• fixedFields = false and fields is empty:

  All fields are included in output.

• fixedFields is unspecified and fields is populated:

  Specified fields are included.

• fixedFields is unspecified and fields is empty:

  System fields are included.

When fixedFields = true, the following system fields are included:

• Issue Type
• Project
• Title
• Description
• Submitter
• Last Modifier
• Submit Date
• Last Modified Date
• Active/Inactive
• State
• Owner
• Secondary Owner

Example

Return all notes on the item, but only returns the "Title" and "Functional Area" fields:

{fixedFields: false, includeNotes: true, fields: [{id:"54"}, {id: "75"}]}

Response:

"fieldMetadata": [2]
0:  {
"id": 54
"name": "Title"
"dbname": "TITLE"
"syscode": 4
"type": "text"
"renderHtml": false
"password": false
"maxLength": 80
}
1:  {
"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": [1]
0:  {
"title": "Please update this ticket"
"contents": "This ticket needs more details."
"author": {
"id": 8
"name": "Administrator"
}
"modificationDateTime": {
"svalue": "06/28/2016 02:48:23 PM"
"value": 1467146903
}
}

Comments

• Because the TS_ID is subject to change when a process app is promoted, you may need to update the fields parameter with the TS_ID from the target environment after the promote is finished.
• If you specify the database name in fields, do not include the TS_ prefix.
• Avoid using the field name when specifying each field to return in fields; the field name can be changed in SBM Composer at any time.