Class: PreviewWorkItemFromListRequest

tibco.objectapi.service.request.PreviewWorkItemFromListRequest

new PreviewWorkItemFromListRequest(entityType, entityGuid)

Object PreviewWorkItemFromListRequest Usage: RestApiService.getWorkListService().previewWorkItemFromList(request, callback);
Parameters:
Name Type Description
entityType string Enumerated value that defines the type of organization model entity; for a complete list of entity types, see "AUDIT Option Attributes" in the developer guide.
entityGuid string GUID of the organization model entity.
Since:
  • 4.0.0

Members

fields :Array.<string>

Query parameter: 'field' (Java type: List) (optional) This is the field name you require data back for.
Type:
  • Array.<string>
Since:
  • 4.0.0

ids :Array.<number>

Query parameter: 'id' (Java type: List) The IDs of one or more work items to be previewed. All work items must be from the work list of the same organizational entity.
Type:
  • Array.<number>
Since:
  • 4.0.0

requireWorkType :boolean

Query parameter: 'requireworktype' (optional) If true, the response includes Work Type information.
Type:
  • boolean
Since:
  • 4.0.0

versions :Array.<number>

Query parameter: 'version' (Java type: List) Major version number of the organization model in which an organization model entity resides. If not specified, the default value will be the latest version of the organization model.
Type:
  • Array.<number>
Since:
  • 4.0.0