HPE Content Manager SDK 8.3
Search Clauses

Using Search Clauses

Search clauses may be used with TrimMainObjectSearch either via the TrimSearchClause class or as strings via TrimMainObjectSearch.SetSearchString. Given that search clauses may be captioned it is a good idea when using them as strings to use their internal name. This document lists all search clauses along with their internal names.

Interrogating metadata

The information about search clauses, like much of the CM metadata, is available via the SDK. In this case we can use the SearchClauseDef to get information about each search clause. This Powershell script was used to build the table below.

Code Sample

Add-Type -Path "[PATH TO cm BINARIES]\HP.HPTRIM.SDK.dll"
$database.Id = "[YOUR DATABASE id]"
$database.WorkgroupServerName = "[YOUR SERVER NAME]"
$database.Connect()
try {
$file = New-Object System.IO.StreamWriter("c:\\temp\\searchClauses.txt", $false)
foreach ($objectDef in [HP.HPTRIM.SDK.ObjectDef]::SelectAllSearchableObjects($database)) {
$file.WriteLine("## {0} {{#search_clauses_{0}}}", $objectDef.Id)
$file.WriteLine("Name | Internal Name | Parameter Type | Is Sortable | Tooltip")
$file.WriteLine("-------------------------------|----------------------|--------------------------------|-------------|---------")
foreach ($searchClauseId in [HP.HPTRIM.SDK.SearchClauseDef]::GetAllSearchClauseIds($objectDef.Id, $database)) {
$searchClauseDef = New-Object HP.HPTRIM.SDK.SearchClauseDef($searchClauseId, $database);
$parName = $searchClauseDef.ParameterFormat.ToString()
If ($searchClauseDef.ParameterFormat -eq [HP.HPTRIM.SDK.PropertyFormats]::Enum)
{
$parName = [string]::Format("HP.HPTRIM.SDK.{0}", $searchClauseDef.GetEnumTypeParameter());
}
ElseIf ($searchClauseDef.ParameterFormat -eq [HP.HPTRIM.SDK.PropertyFormats]::Object)
{
$parName = [string]::Format("HP.HPTRIM.SDK.{0}", $searchClauseDef.GetObjectTypeParameter($objectDef.Id));
}
$file.WriteLine("{0,-30} | {1,-20} | {2,-30} | {3,-11} | {4}",
$searchClauseDef.Name, $searchClauseDef.InternalName, $parName, $searchClauseDef.CanSort($objectDef.Id), $searchClauseDef.GetTooltip($objectDef.Id));
}
$file.WriteLine("");
$file.WriteLine("");
}
} catch{
"Error: "
$error[0]
}
finally {
$file.Dispose()
$database.Dispose()
}

List of search clauses by object type

ActionDef

Name Internal Name Parameter Type Is Sortable Tooltip
name adfName String True Selects Actions based on a value for Action Name.
audit unkAudit HP.HPTRIM.SDK.History False Selects Actions that are involved with the specified Historical Event.
all unkAll Boolean False Selects all Actions within this dataset.
assignable adfAssignable Boolean True Selects Actions based on a value for Assignable.
batch unkBatch Number False Selects Actions by calculating a batch number based on the unique row identifier of the object. Requires a batch number and a number of batches parameters.
updated unkUpdated Datetime True Selects Actions based on when they were last updated.
default unkDefault String False Selects all Actions based on a generic interpretation of a string value (usually by matching the name property).
isProcedure adfIsProcedure Boolean True Selects Actions based on a value for Is Procedure?.
updatedBy unkUpdatedBy HP.HPTRIM.SDK.Location True Selects Actions based on who they were last updated by.
none unkNone Boolean False Selects no Actions.
saved unkSaved HP.HPTRIM.SDK.SavedSearch False Selects Actions that satisfy a specified saved search.
uri unkUri BigNumber True Selects Actions based on a unique identifier value.

Activity

Name Internal Name Parameter Type Is Sortable Tooltip
audit unkAudit HP.HPTRIM.SDK.History False Selects Activities that are involved with the specified Historical Event.
id wacId Number True Selects Activities based on a value for Activity ID.
all unkAll Boolean False Selects all Activities within this dataset.
assignee wacAssignee HP.HPTRIM.SDK.Location True Selects Activities based on a value for Assigned To.
record wacRecord HP.HPTRIM.SDK.Record False Selects Activities with the specified record as an associated document.
authorizedBy wacAuthorizedBy HP.HPTRIM.SDK.Location False Selects Activities authorized by the specified location
batch unkBatch Number False Selects Activities by calculating a batch number based on the unique row identifier of the object. Requires a batch number and a number of batches parameters.
doneBy wacDoneBy HP.HPTRIM.SDK.Location True Selects Activities based on a value for Completed By.
doneOnTime wacDoneOnTime Boolean False Selects Activities based on a value for Completed On Time.
assignedOn wacAssignedOn Datetime True Selects Activities based on a value for Date Assigned.
updated unkUpdated Datetime True Selects Activities based on when they were last updated.
default unkDefault String False Selects all Activities based on a generic interpretation of a string value (usually by matching the name property).
dueOn wacDueOn Datetime True Selects Activities based on a value for Due Date.
earliestStartOn wacEarliestStartOn Datetime True Selects Activities based on a value for Earliest Start Date.
escalatedTo wacEscalatedTo HP.HPTRIM.SDK.Location True Selects Activities based on a value for Escalated To.
authorizedOn wacAuthorizedOn Datetime True Selects Activities based on a value for Final Completion Date.
compound wacCompound Boolean False Selects Activities that are compound activities
doneOn wacDoneOn Datetime True Selects Activities based on a value for Interim Completion Date.
done wacDone Boolean False Selects Activities based on a value for Is Complete.
overdue wacOverdue Boolean False Selects Activities based on a value for Is Overdue.
child wacChild Boolean False Selects Activities that are subordinate activities
insideTemplate wacInsideTemplate Boolean False Selects Activities that are within a template
updatedBy unkUpdatedBy HP.HPTRIM.SDK.Location True Selects Activities based on who they were last updated by.
latestStartOn wacLatestStartOn Datetime True Selects Activities based on a value for Latest Start Date.
name wacName String True Selects Activities based on a value for Name.
none unkNone Boolean False Selects no Activities.
pendingAuthorizationBy wacPendingAuthorizationBy HP.HPTRIM.SDK.Location False Selects Activities awaiting authorization from the specified location
priority wacPriority HP.HPTRIM.SDK.Priority True Selects Activities based on a value for Priority.
canStart wacCanStart Boolean False Selects Activities that can now be worked on
saved unkSaved HP.HPTRIM.SDK.SavedSearch False Selects Activities that satisfy a specified saved search.
startedOn wacStartedOn Datetime True Selects Activities based on a value for Start Date.
supervisor wacSupervisor HP.HPTRIM.SDK.Location True Selects Activities based on a value for Supervisor.
suspendedUntil wacSuspendedUntil Datetime True Selects Activities based on a value for Suspended Until.
template wacTemplate HP.HPTRIM.SDK.WorkflowTemplate True Selects Activities based on a value for Template.
top unkTop Boolean False Selects all top-level Activities (those that have no parent or are not enclosed within any other Activity).
uri unkUri BigNumber True Selects Activities based on a unique identifier value.
skipped wacSkipped Boolean False Selects Activities based on a value for Was Skipped.
ccto wacCcto HP.HPTRIM.SDK.Location False Selects Activities having the specified location on the cc list
within wacWithin HP.HPTRIM.SDK.Activity False Selects Activities Selects subordinate activities of a specified parent activity
workflow wacWorkflow HP.HPTRIM.SDK.Workflow True Selects Activities based on a value for Workflow.

AgendaItem

Name Internal Name Parameter Type Is Sortable Tooltip
acl unkAcl HP.HPTRIM.SDK.Location False Selects Agenda Items having selected locations in a particular access control.
audit unkAudit HP.HPTRIM.SDK.History False Selects Agenda Items that are involved with the specified Historical Event.
attached agiAttached HP.HPTRIM.SDK.AgendaItemAttachment False Selects Agenda Items with an associated Agenda Item Attachment having selected property values.
name agiName String True Selects Agenda Items based on a value for Agenda Item Description.
number agiNumber String True Selects Agenda Items based on a value for Agenda Item Number.
type agiType HP.HPTRIM.SDK.AgendaItemType True Selects Agenda Items based on a value for Agenda Item Type.
all unkAll Boolean False Selects all Agenda Items within this dataset.
batch unkBatch Number False Selects Agenda Items by calculating a batch number based on the unique row identifier of the object. Requires a batch number and a number of batches parameters.
carriedOverFrom agiCarriedOverFrom HP.HPTRIM.SDK.AgendaItem True Selects Agenda Items based on a value for Carried Forward From Item.
approvedOn agiApprovedOn Datetime True Selects Agenda Items based on a value for Date Approved.
updated unkUpdated Datetime True Selects Agenda Items based on when they were last updated.
submittedOn agiSubmittedOn Datetime True Selects Agenda Items based on a value for Date Submitted.
default unkDefault String False Selects all Agenda Items based on a generic interpretation of a string value (usually by matching the name property).
numberx agiNumberx String True Selects Agenda Items based on a value for Expanded Number.
meeting agiMeeting HP.HPTRIM.SDK.Meeting True Selects Agenda Items based on a value for For meeting.
meetingType agiMeetingType HP.HPTRIM.SDK.MeetingType True Selects Agenda Items based on a value for For meeting type.
approved agiApproved Boolean False Selects Agenda Items based on a value for Is Approved.
pending agiPending Boolean False Selects Agenda Items based on a value for Is Pending Item.
section agiSection Boolean False Selects Agenda Items based on a value for Is Section Heading.
standing agiStanding Boolean False Selects Agenda Items based on a value for Is Standing Item.
order agiOrder Number True Selects Agenda Items based on a value for Item Order Number.
updatedBy unkUpdatedBy HP.HPTRIM.SDK.Location True Selects Agenda Items based on who they were last updated by.
none unkNone Boolean False Selects no Agenda Items.
approver agiApprover HP.HPTRIM.SDK.Location True Selects Agenda Items based on a value for Requiring Approval By.
saved unkSaved HP.HPTRIM.SDK.SavedSearch False Selects Agenda Items that satisfy a specified saved search.
submittedBy agiSubmittedBy HP.HPTRIM.SDK.Location True Selects Agenda Items based on a value for Submitted By.
parent agiParent HP.HPTRIM.SDK.AgendaItem True Selects Agenda Items based on a value for Subordinate Item Of.
top unkTop Boolean True Selects all top-level Agenda Items (those that have no parent or are not enclosed within any other Agenda Item).
uri unkUri BigNumber True Selects Agenda Items based on a unique identifier value.

Alert

Name Internal Name Parameter Type Is Sortable Tooltip
all unkAll Boolean False Selects all Alerts within this dataset.
batch unkBatch Number False Selects Alerts by calculating a batch number based on the unique row identifier of the object. Requires a batch number and a number of batches parameters.
updated unkUpdated Datetime True Selects Alerts based on when they were last updated.
eventType altEventType HP.HPTRIM.SDK.Events True Selects Alerts based on a value for Event Type.
updatedBy unkUpdatedBy HP.HPTRIM.SDK.Location True Selects Alerts based on who they were last updated by.
none unkNone Boolean False Selects no Alerts.
objectType altObjectType HP.HPTRIM.SDK.BaseObjectTypes True Selects Alerts based on a value for Object Type.
saved unkSaved HP.HPTRIM.SDK.SavedSearch False Selects Alerts that satisfy a specified saved search.
user altUser HP.HPTRIM.SDK.Location False Selects Alerts that are subscribed to by the specified location
subscriber altSubscriber HP.HPTRIM.SDK.AlertSubscriber False Selects Alerts with an associated Alert Subscriber having selected property values.
uri unkUri BigNumber True Selects Alerts based on a unique identifier value.

Classification

Name Internal Name Parameter Type Is Sortable Tooltip
acl unkAcl HP.HPTRIM.SDK.Location False Selects Classifications having selected locations in a particular access control.
copyacl unkCopyacl HP.HPTRIM.SDK.Location False Selects Classifications having selected locations in a particular access control in the copied access control set.
audit unkAudit HP.HPTRIM.SDK.History False Selects Classifications that are involved with the specified Historical Event.
activeFrom unkActiveFrom Date True Selects Classifications that have a Date Active From value matching the specified date range.
activeTo unkActiveTo Date True Selects Classifications that have a Date Active To value matching the specified date range.
all unkAll Boolean False Selects all Classifications within this dataset.
approved plnApproved Boolean True Selects Classifications based on a value for Approved.
approver plnApprover HP.HPTRIM.SDK.Location True Selects Classifications based on a value for Approver.
batch unkBatch Number False Selects Classifications by calculating a batch number based on the unique row identifier of the object. Requires a batch number and a number of batches parameters.
usable unkUsable Boolean False Selects Classifications that satisfy the can use or view criteria.
viewRecords plnViewRecords Boolean False Selects Classifications that satisfy the view record access control
title plnTitle String False Selects Classifications based on a value for Classification title.
word plnWord String False Selects Classifications based on the Classification Word index.
updated unkUpdated Datetime True Selects Classifications based on when they were last updated.
default unkDefault String False Selects all Classifications based on a generic interpretation of a string value (usually by matching the name property).
numberx plnNumberx String True Selects Classifications based on a value for Expanded Number.
favorite unkFavorite Boolean False Selects favourite Classifications.
pendingAuto plnPendingAuto Boolean True Selects Classifications based on a value for Holding Bay For records requiring automatic classification.
home plnHome HP.HPTRIM.SDK.Location True Selects Classifications based on a value for Home.
active unkActive Boolean True Selects Classifications that are active.
updatedBy unkUpdatedBy HP.HPTRIM.SDK.Location True Selects Classifications based on who they were last updated by.
secure plnSecure Boolean False Selects Classifications that have have a security profile no higher than that of the current user
name plnName String True Selects Classifications based on a value for Name.
none unkNone Boolean False Selects no Classifications.
number plnNumber String True Selects Classifications based on a value for Number.
owner plnOwner HP.HPTRIM.SDK.Location True Selects Classifications based on a value for Owner.
parent plnParent HP.HPTRIM.SDK.Classification True Selects Classifications based on a value for Parent classification.
parentOf plnParentOf HP.HPTRIM.SDK.Classification False Selects Classifications that are the parent(s) of the selected item(s)
class plnClass HP.HPTRIM.SDK.RecordClass True Selects Classifications based on a value for Record Class.
recordType plnRecordType HP.HPTRIM.SDK.RecordType True Selects Classifications based on a value for Restrict To Record Type.
schedule plnSchedule HP.HPTRIM.SDK.Schedule True Selects Classifications based on a value for Retention schedule.
sapobject plnSapobject String False Selects Classifications that have been linked to the specified SAP Business Object
saved unkSaved HP.HPTRIM.SDK.SavedSearch False Selects Classifications that satisfy a specified saved search.
top unkTop Boolean True Selects all top-level Classifications (those that have no parent or are not enclosed within any other Classification).
uri unkUri BigNumber True Selects Classifications based on a unique identifier value.
label unkLabel HP.HPTRIM.SDK.UserLabel False Selects Classifications with a specified User Label.

Communication

Name Internal Name Parameter Type Is Sortable Tooltip
audit unkAudit HP.HPTRIM.SDK.History False Selects Communications that are involved with the specified Historical Event.
all unkAll Boolean False Selects all Communications within this dataset.
batch unkBatch Number False Selects Communications by calculating a batch number based on the unique row identifier of the object. Requires a batch number and a number of batches parameters.
detail cmmDetail HP.HPTRIM.SDK.CommunicationDetail False Selects Communications with an associated Communication Detail having selected property values.
updated unkUpdated Datetime True Selects Communications based on when they were last updated.
dated cmmDated Datetime True Selects Communications based on a value for Date Of Communication.
direction cmmDirection HP.HPTRIM.SDK.CommunicationDirection True Selects Communications based on a value for Direction.
updatedBy unkUpdatedBy HP.HPTRIM.SDK.Location True Selects Communications based on who they were last updated by.
medium cmmMedium HP.HPTRIM.SDK.CommunicationMedium True Selects Communications based on a value for Medium.
none unkNone Boolean False Selects no Communications.
record cmmRecord HP.HPTRIM.SDK.Record True Selects Communications based on a value for Record.
viewable cmmViewable Boolean False Selects Communications based on a value for Record is viewable.
saved unkSaved HP.HPTRIM.SDK.SavedSearch False Selects Communications that satisfy a specified saved search.
uri unkUri BigNumber True Selects Communications based on a unique identifier value.

Consignment

Name Internal Name Parameter Type Is Sortable Tooltip
audit unkAudit HP.HPTRIM.SDK.History False Selects Consignments that are involved with the specified Historical Event.
all unkAll Boolean False Selects all Consignments within this dataset.
batch unkBatch Number False Selects Consignments by calculating a batch number based on the unique row identifier of the object. Requires a batch number and a number of batches parameters.
cutoffDate conCutoffDate Datetime True Selects Consignments based on a value for Cutoff Date.
updated unkUpdated Datetime True Selects Consignments based on when they were last updated.
default unkDefault String False Selects all Consignments based on a generic interpretation of a string value (usually by matching the name property).
disposalDate conDisposalDate Datetime True Selects Consignments based on a value for Disposal Date.
done conDone Boolean False Selects Consignments based on a value for Is Complete.
updatedBy unkUpdatedBy HP.HPTRIM.SDK.Location True Selects Consignments based on who they were last updated by.
none unkNone Boolean False Selects no Consignments.
number conNumber String True Selects Consignments based on a value for Number.
archivist conArchivist HP.HPTRIM.SDK.Location True Selects Consignments based on a value for Responsible Archivist.
saved unkSaved HP.HPTRIM.SDK.SavedSearch False Selects Consignments that satisfy a specified saved search.
transferLocation conTransferLocation HP.HPTRIM.SDK.Location True Selects Consignments based on a value for Transfer To location.
uri unkUri BigNumber True Selects Consignments based on a unique identifier value.

ConsignmentApprover

Name Internal Name Parameter Type Is Sortable Tooltip
all unkAll Boolean False Selects all Consignment Record Approvers within this dataset.
approver coaApprover HP.HPTRIM.SDK.Location True Selects Consignment Record Approvers based on a value for Approver.
batch unkBatch Number False Selects Consignment Record Approvers by calculating a batch number based on the unique row identifier of the object. Requires a batch number and a number of batches parameters.
consignment coaConsignment HP.HPTRIM.SDK.Consignment True Selects Consignment Record Approvers based on a value for Consignment.
updated unkUpdated Datetime True Selects Consignment Record Approvers based on when they were last updated.
updatedBy unkUpdatedBy HP.HPTRIM.SDK.Location True Selects Consignment Record Approvers based on who they were last updated by.
none unkNone Boolean False Selects no Consignment Record Approvers.
record coaRecord HP.HPTRIM.SDK.Record True Selects Consignment Record Approvers based on a value for Record.
saved unkSaved HP.HPTRIM.SDK.SavedSearch False Selects Consignment Record Approvers that satisfy a specified saved search.
status coaStatus HP.HPTRIM.SDK.ConsignmentItemApprovalStatus True Selects Consignment Record Approvers based on a value for Status.
uri unkUri BigNumber True Selects Consignment Record Approvers based on a unique identifier value.

ConsignmentIssue

Name Internal Name Parameter Type Is Sortable Tooltip
all unkAll Boolean False Selects all Consignment Issues within this dataset.
batch unkBatch Number False Selects Consignment Issues by calculating a batch number based on the unique row identifier of the object. Requires a batch number and a number of batches parameters.
consignment cisConsignment HP.HPTRIM.SDK.Consignment True Selects Consignment Issues based on a value for Consignment.
updated unkUpdated Datetime True Selects Consignment Issues based on when they were last updated.
issueType cisIssueType HP.HPTRIM.SDK.ConsignmentItemIssueType True Selects Consignment Issues based on a value for Issue Type.
updatedBy unkUpdatedBy HP.HPTRIM.SDK.Location True Selects Consignment Issues based on who they were last updated by.
none unkNone Boolean False Selects no Consignment Issues.
reviewer cisReviewer HP.HPTRIM.SDK.Location True Selects Consignment Issues based on a value for Reviewer.
saved unkSaved HP.HPTRIM.SDK.SavedSearch False Selects Consignment Issues that satisfy a specified saved search.
uri unkUri BigNumber True Selects Consignment Issues based on a unique identifier value.

DocumentQueue

Name Internal Name Parameter Type Is Sortable Tooltip
acl unkAcl HP.HPTRIM.SDK.Location False Selects Document Queues having selected locations in a particular access control.
audit unkAudit HP.HPTRIM.SDK.History False Selects Document Queues that are involved with the specified Historical Event.
all unkAll Boolean False Selects all Document Queues within this dataset.
auto dcqAuto Boolean True Selects Document Queues based on a value for Allow Automatic Processing.
batch unkBatch Number False Selects Document Queues by calculating a batch number based on the unique row identifier of the object. Requires a batch number and a number of batches parameters.
usable unkUsable Boolean False Selects Document Queues that satisfy the can use or view criteria.
updated unkUpdated Datetime True Selects Document Queues based on when they were last updated.
default unkDefault String False Selects all Document Queues based on a generic interpretation of a string value (usually by matching the name property).
container dcqContainer HP.HPTRIM.SDK.Record True Selects Document Queues based on a value for Default container.
favorite unkFavorite Boolean False Selects favourite Document Queues.
updatedBy unkUpdatedBy HP.HPTRIM.SDK.Location True Selects Document Queues based on who they were last updated by.
location dcqLocation String False Selects Document Queues based on a value for Location.
machine dcqMachine String True Selects Document Queues based on a value for Machine.
name dcqName String True Selects Document Queues based on a value for Name.
none unkNone Boolean False Selects no Document Queues.
saved unkSaved HP.HPTRIM.SDK.SavedSearch False Selects Document Queues that satisfy a specified saved search.
type dcqType HP.HPTRIM.SDK.QueueTypes True Selects Document Queues based on a value for Type.
uri unkUri BigNumber True Selects Document Queues based on a unique identifier value.
label unkLabel HP.HPTRIM.SDK.UserLabel False Selects Document Queues with a specified User Label.

EmailLink

Name Internal Name Parameter Type Is Sortable Tooltip
all unkAll Boolean False Selects all Email Links within this dataset.
batch unkBatch Number False Selects Email Links by calculating a batch number based on the unique row identifier of the object. Requires a batch number and a number of batches parameters.
updated unkUpdated Datetime True Selects Email Links based on when they were last updated.
user rmbUser HP.HPTRIM.SDK.Location True Selects Email Links based on a value for Email Link Owner.
updatedBy unkUpdatedBy HP.HPTRIM.SDK.Location True Selects Email Links based on who they were last updated by.
type rmbType HP.HPTRIM.SDK.EmailLinkType True Selects Email Links based on a value for Link Type.
classification rmbClassification HP.HPTRIM.SDK.Classification False Selects Email Links based on a value for Linked classification.
record rmbRecord HP.HPTRIM.SDK.Record False Selects Email Links based on a value for Linked record.
matter rmbMatter HP.HPTRIM.SDK.Record True Selects Email Links based on a value for Matter record.
none unkNone Boolean False Selects no Email Links.
fileAs rmbFileAs HP.HPTRIM.SDK.RecordType True Selects Email Links based on a value for Record Type.
saved unkSaved HP.HPTRIM.SDK.SavedSearch False Selects Email Links that satisfy a specified saved search.
fileInSubFoldersAs rmbFileInSubFoldersAs HP.HPTRIM.SDK.RecordType True Selects Email Links based on a value for Sub Folder record type.
uri unkUri BigNumber True Selects Email Links based on a unique identifier value.

FieldDefinition

Name Internal Name Parameter Type Is Sortable Tooltip
acl unkAcl HP.HPTRIM.SDK.Location False Selects Additional Fields having selected locations in a particular access control.
audit unkAudit HP.HPTRIM.SDK.History False Selects Additional Fields that are involved with the specified Historical Event.
all unkAll Boolean False Selects all Additional Fields within this dataset.
batch unkBatch Number False Selects Additional Fields by calculating a batch number based on the unique row identifier of the object. Requires a batch number and a number of batches parameters.
updated unkUpdated Datetime True Selects Additional Fields based on when they were last updated.
default unkDefault String False Selects all Additional Fields based on a generic interpretation of a string value (usually by matching the name property).
format fldFormat HP.HPTRIM.SDK.UserFieldFormats True Selects Additional Fields based on a value for Format.
inIdolSchema fldInIdolSchema Boolean True Selects Additional Fields based on a value for Is Searchable.
updatedBy unkUpdatedBy HP.HPTRIM.SDK.Location True Selects Additional Fields based on who they were last updated by.
lookupSet fldLookupSet HP.HPTRIM.SDK.LookupSet True Selects Additional Fields based on a value for Lookup Set.
name fldName String True Selects Additional Fields based on a value for Name.
none unkNone Boolean False Selects no Additional Fields.
sapkey fldSapkey String True Selects Additional Fields based on a value for SAP KeySet Field.
saved unkSaved HP.HPTRIM.SDK.SavedSearch False Selects Additional Fields that satisfy a specified saved search.
uri unkUri BigNumber True Selects Additional Fields based on a unique identifier value.
usedFor fldUsedFor HP.HPTRIM.SDK.BaseObjectTypes False Selects Additional Fields that are used by trim objects of the specified type
forLocations fldForLocations HP.HPTRIM.SDK.LocationType False Selects Additional Fields that are used by locations of the specified type.
forRecords fldForRecords HP.HPTRIM.SDK.RecordType False Selects Additional Fields that are used by records of the specified record type
visible fldVisible Boolean False Selects Additional Fields based on a value for View additional field Value.

History

Name Internal Name Parameter Type Is Sortable Tooltip
all unkAll Boolean False Selects all Historical Events within this dataset.
batch unkBatch Number False Selects Historical Events by calculating a batch number based on the unique row identifier of the object. Requires a batch number and a number of batches parameters.
clientIPA hisClientIPA String True Selects Historical Events based on a value for Client IP Address.
computer hisComputer String True Selects Historical Events based on a value for Computer Name.
connectionIPA hisConnectionIPA String True Selects Historical Events based on a value for Connection IP Address.
updated unkUpdated Datetime True Selects Historical Events based on when they were last updated.
event hisEvent HP.HPTRIM.SDK.Events True Selects Historical Events based on a value for Event.
date hisDate Datetime True Selects Historical Events based on a value for Event Date.
activity hisActivity HP.HPTRIM.SDK.Activity False Selects Historical Events based on a value for For activity.
location hisLocation HP.HPTRIM.SDK.Location False Selects Historical Events based on a value for For location.
object hisObject HP.HPTRIM.SDK.Unknown False Selects Historical Events that occurred for the specified object
objectType hisObjectType HP.HPTRIM.SDK.BaseObjectTypes True Selects Historical Events based on a value for For Object Type.
record hisRecord HP.HPTRIM.SDK.Record False Selects Historical Events based on a value for For record.
workflow hisWorkflow HP.HPTRIM.SDK.Workflow False Selects Historical Events based on a value for For workflow.
updatedBy unkUpdatedBy HP.HPTRIM.SDK.Location True Selects Historical Events based on who they were last updated by.
changedTo hisChangedTo HP.HPTRIM.SDK.Location False Selects Historical Events based on a value for Moved To location.
none unkNone Boolean False Selects no Historical Events.
type hisType HP.HPTRIM.SDK.HistoryTypes False Selects Historical Events based on a value for Record Event.
saved unkSaved HP.HPTRIM.SDK.SavedSearch False Selects Historical Events that satisfy a specified saved search.
breach hisBreach Boolean True Selects Historical Events based on a value for Security Violation.
uri unkUri BigNumber True Selects Historical Events based on a unique identifier value.
user hisUser HP.HPTRIM.SDK.Location True Selects Historical Events based on a value for Updated By.
login hisLogin String True Selects Historical Events based on a value for Updated By (Login User Name).

Hold

Name Internal Name Parameter Type Is Sortable Tooltip
audit unkAudit HP.HPTRIM.SDK.History False Selects Holds that are involved with the specified Historical Event.
activeFrom unkActiveFrom Date True Selects Holds that have a Date Active From value matching the specified date range.
activeTo unkActiveTo Date True Selects Holds that have a Date Active To value matching the specified date range.
all unkAll Boolean False Selects all Holds within this dataset.
record lglRecord HP.HPTRIM.SDK.Record False Selects Holds that have been applied to the specified record
batch unkBatch Number False Selects Holds by calculating a batch number based on the unique row identifier of the object. Requires a batch number and a number of batches parameters.
contact lglContact HP.HPTRIM.SDK.Location True Selects Holds based on a value for Contact.
updated unkUpdated Datetime True Selects Holds based on when they were last updated.
default unkDefault String False Selects all Holds based on a generic interpretation of a string value (usually by matching the name property).
external lglExternal String True Selects Holds based on a value for External Id.
name lglName String True Selects Holds based on a value for Hold Title.
active unkActive Boolean True Selects Holds that are active.
updatedBy unkUpdatedBy HP.HPTRIM.SDK.Location True Selects Holds based on who they were last updated by.
none unkNone Boolean False Selects no Holds.
saved unkSaved HP.HPTRIM.SDK.SavedSearch False Selects Holds that satisfy a specified saved search.
uri unkUri BigNumber True Selects Holds based on a unique identifier value.

Jurisdiction

Name Internal Name Parameter Type Is Sortable Tooltip
audit unkAudit HP.HPTRIM.SDK.History False Selects Jurisdictions that are involved with the specified Historical Event.
activeFrom unkActiveFrom Date True Selects Jurisdictions that have a Date Active From value matching the specified date range.
activeTo unkActiveTo Date True Selects Jurisdictions that have a Date Active To value matching the specified date range.
all unkAll Boolean False Selects all Jurisdictions within this dataset.
batch unkBatch Number False Selects Jurisdictions by calculating a batch number based on the unique row identifier of the object. Requires a batch number and a number of batches parameters.
updated unkUpdated Datetime True Selects Jurisdictions based on when they were last updated.
default unkDefault String False Selects all Jurisdictions based on a generic interpretation of a string value (usually by matching the name property).
description jrsDescription String True Selects Jurisdictions based on a value for Description.
favorite unkFavorite Boolean False Selects favourite Jurisdictions.
hasMember jrsHasMember HP.HPTRIM.SDK.Jurisdiction False Selects Jurisdictions that have the specified jurisdiction as a member.
active unkActive Boolean True Selects Jurisdictions that are active.
updatedBy unkUpdatedBy HP.HPTRIM.SDK.Location True Selects Jurisdictions based on who they were last updated by.
members jrsMembers HP.HPTRIM.SDK.Jurisdiction False Selects Jurisdictions that are members of a specified jurisdiction
none unkNone Boolean False Selects no Jurisdictions.
saved unkSaved HP.HPTRIM.SDK.SavedSearch False Selects Jurisdictions that satisfy a specified saved search.
name jrsName String True Selects Jurisdictions based on a value for Short Name.
top unkTop Boolean False Selects all top-level Jurisdictions (those that have no parent or are not enclosed within any other Jurisdiction).
uri unkUri BigNumber True Selects Jurisdictions based on a unique identifier value.
label unkLabel HP.HPTRIM.SDK.UserLabel False Selects Jurisdictions with a specified User Label.

Keyword

Name Internal Name Parameter Type Is Sortable Tooltip
acl unkAcl HP.HPTRIM.SDK.Location False Selects Thesaurus Terms having selected locations in a particular access control.
audit unkAudit HP.HPTRIM.SDK.History False Selects Thesaurus Terms that are involved with the specified Historical Event.
activeFrom unkActiveFrom Date True Selects Thesaurus Terms that have a Date Active From value matching the specified date range.
activeTo unkActiveTo Date True Selects Thesaurus Terms that have a Date Active To value matching the specified date range.
all unkAll Boolean False Selects all Thesaurus Terms within this dataset.
attachedTo thsAttachedTo HP.HPTRIM.SDK.Record False Selects Thesaurus Terms that have been attached to the specified records
batch unkBatch Number False Selects Thesaurus Terms by calculating a batch number based on the unique row identifier of the object. Requires a batch number and a number of batches parameters.
broader thsBroader HP.HPTRIM.SDK.Keyword False Selects Thesaurus Terms that are broader terms of a specified thesaurus term
usable unkUsable Boolean False Selects Thesaurus Terms that satisfy the can use or view criteria.
updated unkUpdated Datetime True Selects Thesaurus Terms based on when they were last updated.
default unkDefault String False Selects all Thesaurus Terms based on a generic interpretation of a string value (usually by matching the name property).
favorite unkFavorite Boolean False Selects favourite Thesaurus Terms.
inTitleOf thsInTitleOf HP.HPTRIM.SDK.Record False Selects Thesaurus Terms that have been used to title the specified records
active unkActive Boolean True Selects Thesaurus Terms that are active.
forbidden thsForbidden Boolean True Selects Thesaurus Terms based on a value for Is Forbidden.
primary thsPrimary Boolean True Selects Thesaurus Terms based on a value for Is Primary Term.
updatedBy unkUpdatedBy HP.HPTRIM.SDK.Location True Selects Thesaurus Terms based on who they were last updated by.
narrower thsNarrower HP.HPTRIM.SDK.Keyword False Selects Thesaurus Terms that are narrower terms of a specified thesaurus term
nonPreferredFormsOf thsNonPreferredFormsOf HP.HPTRIM.SDK.Keyword False Selects Thesaurus Terms that are non-preferred forms of the specified thesaurus term
none unkNone Boolean False Selects no Thesaurus Terms.
related thsRelated HP.HPTRIM.SDK.Keyword False Selects Thesaurus Terms that are related terms of a specified thesaurus term
saved unkSaved HP.HPTRIM.SDK.SavedSearch False Selects Thesaurus Terms that satisfy a specified saved search.
source thsSource String True Selects Thesaurus Terms based on a value for Source Authority.
name thsName String True Selects Thesaurus Terms based on a value for Term.
uri unkUri BigNumber True Selects Thesaurus Terms based on a unique identifier value.
usedFor thsUsedFor HP.HPTRIM.SDK.Keyword False Selects Thesaurus Terms that are used in preference to the specified thesaurus term
label unkLabel HP.HPTRIM.SDK.UserLabel False Selects Thesaurus Terms with a specified User Label.
word thsWord String False Selects Thesaurus Terms based on the Thesaurus Word index.

Location

Name Internal Name Parameter Type Is Sortable Tooltip
acl unkAcl HP.HPTRIM.SDK.Location False Selects Locations having selected locations in a particular access control.
audit unkAudit HP.HPTRIM.SDK.History False Selects Locations that are involved with the specified Historical Event.
activeFrom unkActiveFrom Date True Selects Locations that have a Date Active From value matching the specified date range.
activeTo unkActiveTo Date True Selects Locations that have a Date Active To value matching the specified date range.
administeredBy locAdministeredBy HP.HPTRIM.SDK.Location False Selects Locations that the specified location. are administered by.
administratorOf locAdministratorOf HP.HPTRIM.SDK.Location False Selects Locations that are adminstrators of the specified location.
all unkAll Boolean False Selects all Locations within this dataset.
barcode unkBarcode String False Selects Locations by barcode.
batch unkBatch Number False Selects Locations by calculating a batch number based on the unique row identifier of the object. Requires a batch number and a number of batches parameters.
usable unkUsable Boolean False Selects Locations that satisfy the can use or view criteria.
communication locCommunication HP.HPTRIM.SDK.Communication False Selects Locations that are associated with the specified communication
recipientOf locRecipientOf HP.HPTRIM.SDK.Communication False Selects Locations that are recipients of the specified communication
senderOf locSenderOf HP.HPTRIM.SDK.Communication False Selects Locations that are senders of the specified communication
contactOf locContactOf HP.HPTRIM.SDK.Record False Selects Locations that are contacts of the specified record
updated unkUpdated Datetime True Selects Locations based on when they were last updated.
dob locDob Date False Selects Locations based on a value for Date Of Birth.
default unkDefault String False Selects all Locations based on a generic interpretation of a string value (usually by matching the name property).
jurisdiction locJurisdiction HP.HPTRIM.SDK.Jurisdiction True Selects Locations based on a value for Default jurisdiction.
delegateOf locDelegateOf HP.HPTRIM.SDK.Location False Selects Locations that are delegates of the specified location.
delegateTo locDelegateTo HP.HPTRIM.SDK.Location False Selects Locations that have been delegated to by the specified location.
email locEmail String False Selects Locations with a specified email address
favorite unkFavorite Boolean False Selects favourite Locations.
givenNames locGivenNames String False Selects Locations based on a value for First Names.
fbarcode unkFbarcode String False Selects Locations by foreign barcode.
hasMember locHasMember HP.HPTRIM.SDK.Location False Selects Locations that have the specified location as a member.
hasOther locHasOther HP.HPTRIM.SDK.Location False Selects Locations that have the specified location as an 'other' relationship.
id locId String True Selects Locations based on a value for ID Number.
initials locInitials String False Selects Locations based on a value for Initials.
internal locInternal Boolean True Selects Locations based on a value for Internal.
active unkActive Boolean True Selects Locations that are active.
surname locSurname String False Selects Locations based on a value for Last Name.
surnamePrefix locSurnamePrefix String False Selects Locations based on a value for Last Name Prefix.
updatedBy unkUpdatedBy HP.HPTRIM.SDK.Location True Selects Locations based on who they were last updated by.
type locType HP.HPTRIM.SDK.LocationType True Selects Locations based on a value for Location Type.
members locMembers HP.HPTRIM.SDK.Location False Selects Locations that are members of a specified location.
name locName String False Selects Locations that have a name matching the supplied value (uses name parsing techniques)
sortName locSortName String True Selects Locations based on a value for Name.
login locLogin String False Selects Locations that have the specified network login
none unkNone Boolean False Selects no Locations.
others locOthers HP.HPTRIM.SDK.Location False Selects Locations that have an 'other' relationship to a specified location.
phone locPhone String False Selects Locations with the specified phone number.
address locAddress HP.HPTRIM.SDK.LocationAddress False Selects Locations with an associated Physical Address having selected property values.
review locReview Datetime True Selects Locations based on a value for Review Date.
saved unkSaved HP.HPTRIM.SDK.SavedSearch False Selects Locations that satisfy a specified saved search.
securityLevel locSecurityLevel HP.HPTRIM.SDK.SecurityLevel False Selects Locations that have the specified security level
supervisedBy locSupervisedBy HP.HPTRIM.SDK.Location False Selects Locations that have a supervisor of a specified location.
supervisorOf locSupervisorOf HP.HPTRIM.SDK.Location False Selects Locations that are the supervisor of the specified location.
uri unkUri BigNumber True Selects Locations based on a unique identifier value.
unique locUnique String True Selects Locations based on a value for Unique Name.
usingAddressOf locUsingAddressOf HP.HPTRIM.SDK.Location True Selects Locations based on a value for Use Address Of.
label unkLabel HP.HPTRIM.SDK.UserLabel False Selects Locations with a specified User Label.

LookupItem

Name Internal Name Parameter Type Is Sortable Tooltip
acl unkAcl HP.HPTRIM.SDK.Location False Selects Lookup Items having selected locations in a particular access control.
audit unkAudit HP.HPTRIM.SDK.History False Selects Lookup Items that are involved with the specified Historical Event.
all unkAll Boolean False Selects all Lookup Items within this dataset.
batch unkBatch Number False Selects Lookup Items by calculating a batch number based on the unique row identifier of the object. Requires a batch number and a number of batches parameters.
usable unkUsable Boolean False Selects Lookup Items that satisfy the can use or view criteria.
updated unkUpdated Datetime True Selects Lookup Items based on when they were last updated.
default unkDefault String False Selects all Lookup Items based on a generic interpretation of a string value (usually by matching the name property).
abbreviation lkiAbbreviation String True Selects Lookup Items based on a value for Item Abbreviation.
name lkiName String True Selects Lookup Items based on a value for Item Value.
updatedBy unkUpdatedBy HP.HPTRIM.SDK.Location True Selects Lookup Items based on who they were last updated by.
set lkiSet HP.HPTRIM.SDK.LookupSet True Selects Lookup Items based on a value for Lookup Set.
none unkNone Boolean False Selects no Lookup Items.
saved unkSaved HP.HPTRIM.SDK.SavedSearch False Selects Lookup Items that satisfy a specified saved search.
uri unkUri BigNumber True Selects Lookup Items based on a unique identifier value.

LookupSet

Name Internal Name Parameter Type Is Sortable Tooltip
acl unkAcl HP.HPTRIM.SDK.Location False Selects Lookup Sets having selected locations in a particular access control.
audit unkAudit HP.HPTRIM.SDK.History False Selects Lookup Sets that are involved with the specified Historical Event.
all unkAll Boolean False Selects all Lookup Sets within this dataset.
batch unkBatch Number False Selects Lookup Sets by calculating a batch number based on the unique row identifier of the object. Requires a batch number and a number of batches parameters.
usable unkUsable Boolean False Selects Lookup Sets that satisfy the can use or view criteria.
updated unkUpdated Datetime True Selects Lookup Sets based on when they were last updated.
default unkDefault String False Selects all Lookup Sets based on a generic interpretation of a string value (usually by matching the name property).
updatedBy unkUpdatedBy HP.HPTRIM.SDK.Location True Selects Lookup Sets based on who they were last updated by.
name cdsName String True Selects Lookup Sets based on a value for Lookup Set.
none unkNone Boolean False Selects no Lookup Sets.
saved unkSaved HP.HPTRIM.SDK.SavedSearch False Selects Lookup Sets that satisfy a specified saved search.
type cdsType HP.HPTRIM.SDK.LookupSetType True Selects Lookup Sets based on a value for Type.
uri unkUri BigNumber True Selects Lookup Sets based on a unique identifier value.
authority cdsAuthority Boolean False Selects Lookup Sets that use the authority style for items.

Meeting

Name Internal Name Parameter Type Is Sortable Tooltip
acl unkAcl HP.HPTRIM.SDK.Location False Selects Meetings having selected locations in a particular access control.
audit unkAudit HP.HPTRIM.SDK.History False Selects Meetings that are involved with the specified Historical Event.
agenda mtgAgenda HP.HPTRIM.SDK.Record True Selects Meetings based on a value for Agenda.
issue mtgIssue Datetime True Selects Meetings based on a value for Agenda Issue Date.
open mtgOpen Boolean False Selects Meetings based on a value for Agenda Open.
all unkAll Boolean False Selects all Meetings within this dataset.
record mtgRecord HP.HPTRIM.SDK.Record False Selects Meetings that are associated with the specified records
batch unkBatch Number False Selects Meetings by calculating a batch number based on the unique row identifier of the object. Requires a batch number and a number of batches parameters.
usable unkUsable Boolean False Selects Meetings that satisfy the can use or view criteria.
updated unkUpdated Datetime True Selects Meetings based on when they were last updated.
default unkDefault String False Selects all Meetings based on a generic interpretation of a string value (usually by matching the name property).
updatedBy unkUpdatedBy HP.HPTRIM.SDK.Location True Selects Meetings based on who they were last updated by.
date mtgDate Datetime True Selects Meetings based on a value for Meeting Date.
document mtgDocument HP.HPTRIM.SDK.MeetingDocument False Selects Meetings with an associated Meeting Document having selected property values.
name mtgName String True Selects Meetings based on a value for Meeting Name.
invite mtgInvite HP.HPTRIM.SDK.MeetingInvitation False Selects Meetings with an associated Meeting Participant having selected property values.
place mtgPlace HP.HPTRIM.SDK.Location True Selects Meetings based on a value for Meeting Place.
type mtgType HP.HPTRIM.SDK.MeetingType True Selects Meetings based on a value for Meeting Type.
minutes mtgMinutes HP.HPTRIM.SDK.Record True Selects Meetings based on a value for Minutes.
none unkNone Boolean False Selects no Meetings.
pending mtgPending Boolean False Selects Meetings based on a value for Pending.
saved unkSaved HP.HPTRIM.SDK.SavedSearch False Selects Meetings that satisfy a specified saved search.
cutoff mtgCutoff Datetime True Selects Meetings based on a value for Submission Cutoff Date.
uri unkUri BigNumber True Selects Meetings based on a unique identifier value.

MeetingType

Name Internal Name Parameter Type Is Sortable Tooltip
acl unkAcl HP.HPTRIM.SDK.Location False Selects Meeting Types having selected locations in a particular access control.
copyacl unkCopyacl HP.HPTRIM.SDK.Location False Selects Meeting Types having selected locations in a particular access control in the copied access control set.
audit unkAudit HP.HPTRIM.SDK.History False Selects Meeting Types that are involved with the specified Historical Event.
all unkAll Boolean False Selects all Meeting Types within this dataset.
batch unkBatch Number False Selects Meeting Types by calculating a batch number based on the unique row identifier of the object. Requires a batch number and a number of batches parameters.
usable unkUsable Boolean False Selects Meeting Types that satisfy the can use or view criteria.
updated unkUpdated Datetime True Selects Meeting Types based on when they were last updated.
default unkDefault String False Selects all Meeting Types based on a generic interpretation of a string value (usually by matching the name property).
updatedBy unkUpdatedBy HP.HPTRIM.SDK.Location True Selects Meeting Types based on who they were last updated by.
name mgmName String True Selects Meeting Types based on a value for Meeting Name.
place mgmPlace HP.HPTRIM.SDK.Location True Selects Meeting Types based on a value for Meeting Place.
none unkNone Boolean False Selects no Meeting Types.
saved unkSaved HP.HPTRIM.SDK.SavedSearch False Selects Meeting Types that satisfy a specified saved search.
uri unkUri BigNumber True Selects Meeting Types based on a unique identifier value.

MinuteItem

Name Internal Name Parameter Type Is Sortable Tooltip
action mniAction HP.HPTRIM.SDK.MinuteItemActionArising False Selects Minute Items with an associated Action Item Arising having selected property values.
audit unkAudit HP.HPTRIM.SDK.History False Selects Minute Items that are involved with the specified Historical Event.
all unkAll Boolean False Selects all Minute Items within this dataset.
batch unkBatch Number False Selects Minute Items by calculating a batch number based on the unique row identifier of the object. Requires a batch number and a number of batches parameters.
updated unkUpdated Datetime True Selects Minute Items based on when they were last updated.
default unkDefault String False Selects all Minute Items based on a generic interpretation of a string value (usually by matching the name property).
name mniName String True Selects Minute Items based on a value for Description.
agenda mniAgenda HP.HPTRIM.SDK.AgendaItem True Selects Minute Items based on a value for For agenda item.
motion mniMotion Boolean False Selects Minute Items based on a value for Is Motion.
order mniOrder Number True Selects Minute Items based on a value for Item Order Number.
updatedBy unkUpdatedBy HP.HPTRIM.SDK.Location True Selects Minute Items based on who they were last updated by.
meeting mniMeeting HP.HPTRIM.SDK.Meeting False Selects Minute Items based on a value for Meeting.
type mniType HP.HPTRIM.SDK.MinuteItemType True Selects Minute Items based on a value for Minute Item Type.
none unkNone Boolean False Selects no Minute Items.
outcome mniOutcome HP.HPTRIM.SDK.MotionOutcome True Selects Minute Items based on a value for Outcome.
proposer mniProposer HP.HPTRIM.SDK.Location True Selects Minute Items based on a value for Proposed By.
saved unkSaved HP.HPTRIM.SDK.SavedSearch False Selects Minute Items that satisfy a specified saved search.
seconder mniSeconder HP.HPTRIM.SDK.Location True Selects Minute Items based on a value for Seconded By.
uri unkUri BigNumber True Selects Minute Items based on a unique identifier value.

MinuteItemType

Name Internal Name Parameter Type Is Sortable Tooltip
acl unkAcl HP.HPTRIM.SDK.Location False Selects Minute Item Types having selected locations in a particular access control.
audit unkAudit HP.HPTRIM.SDK.History False Selects Minute Item Types that are involved with the specified Historical Event.
all unkAll Boolean False Selects all Minute Item Types within this dataset.
batch unkBatch Number False Selects Minute Item Types by calculating a batch number based on the unique row identifier of the object. Requires a batch number and a number of batches parameters.
usable unkUsable Boolean False Selects Minute Item Types that satisfy the can use or view criteria.
updated unkUpdated Datetime True Selects Minute Item Types based on when they were last updated.
default unkDefault String False Selects all Minute Item Types based on a generic interpretation of a string value (usually by matching the name property).
updatedBy unkUpdatedBy HP.HPTRIM.SDK.Location True Selects Minute Item Types based on who they were last updated by.
name mitName String True Selects Minute Item Types based on a value for Minute Item Type Name.
none unkNone Boolean False Selects no Minute Item Types.
saved unkSaved HP.HPTRIM.SDK.SavedSearch False Selects Minute Item Types that satisfy a specified saved search.
uri unkUri BigNumber True Selects Minute Item Types based on a unique identifier value.

Notification

Name Internal Name Parameter Type Is Sortable Tooltip
all unkAll Boolean False Selects all Notifications within this dataset.
batch unkBatch Number False Selects Notifications by calculating a batch number based on the unique row identifier of the object. Requires a batch number and a number of batches parameters.
updated unkUpdated Datetime True Selects Notifications based on when they were last updated.
eventDate ntfEventDate Datetime True Selects Notifications based on a value for Event Date.
eventType ntfEventType HP.HPTRIM.SDK.Events True Selects Notifications based on a value for Event Type.
updatedBy unkUpdatedBy HP.HPTRIM.SDK.Location True Selects Notifications based on who they were last updated by.
none unkNone Boolean False Selects no Notifications.
objectType ntfObjectType HP.HPTRIM.SDK.BaseObjectTypes True Selects Notifications based on a value for Object Type.
saved unkSaved HP.HPTRIM.SDK.SavedSearch False Selects Notifications that satisfy a specified saved search.
uri unkUri BigNumber True Selects Notifications based on a unique identifier value.

OfflineRecord

Name Internal Name Parameter Type Is Sortable Tooltip
all unkAll Boolean False Selects all Offline Records within this dataset.
batch unkBatch Number False Selects Offline Records by calculating a batch number based on the unique row identifier of the object. Requires a batch number and a number of batches parameters.
container offContainer HP.HPTRIM.SDK.OfflineRecord True Selects Offline Records based on a value for Container (Offline).
updated unkUpdated Datetime True Selects Offline Records based on when they were last updated.
default unkDefault String False Selects all Offline Records based on a generic interpretation of a string value (usually by matching the name property).
extension offExtension String True Selects Offline Records based on a value for Extension.
updatedBy unkUpdatedBy HP.HPTRIM.SDK.Location True Selects Offline Records based on who they were last updated by.
none unkNone Boolean False Selects no Offline Records.
saved unkSaved HP.HPTRIM.SDK.SavedSearch False Selects Offline Records that satisfy a specified saved search.
status offStatus HP.HPTRIM.SDK.OfflineStatus True Selects Offline Records based on a value for Status.
title offTitle String True Selects Offline Records based on a value for Title.
top unkTop Boolean False Selects all top-level Offline Records (those that have no parent or are not enclosed within any other Offline Record).
uri unkUri BigNumber True Selects Offline Records based on a unique identifier value.

Origin

Name Internal Name Parameter Type Is Sortable Tooltip
acl unkAcl HP.HPTRIM.SDK.Location False Selects Origins having selected locations in a particular access control.
audit unkAudit HP.HPTRIM.SDK.History False Selects Origins that are involved with the specified Historical Event.
all unkAll Boolean False Selects all Origins within this dataset.
auto ognAuto Boolean True Selects Origins based on a value for Auto Start.
batch unkBatch Number False Selects Origins by calculating a batch number based on the unique row identifier of the object. Requires a batch number and a number of batches parameters.
usable unkUsable Boolean False Selects Origins that satisfy the can use or view criteria.
loadedOn ognLoadedOn Datetime True Selects Origins based on a value for Date Last Loaded.
updated unkUpdated Datetime True Selects Origins based on when they were last updated.
default unkDefault String False Selects all Origins based on a generic interpretation of a string value (usually by matching the name property).
updatedBy unkUpdatedBy HP.HPTRIM.SDK.Location True Selects Origins based on who they were last updated by.
name ognName String True Selects Origins based on a value for Name.
none unkNone Boolean False Selects no Origins.
type ognType HP.HPTRIM.SDK.OriginType True Selects Origins based on a value for Origin Type.
machine ognMachine String True Selects Origins based on a value for Run On Computer.
saved unkSaved HP.HPTRIM.SDK.SavedSearch False Selects Origins that satisfy a specified saved search.
source ognSource String True Selects Origins based on a value for Source.
uri unkUri BigNumber True Selects Origins based on a unique identifier value.

OriginHistory

Name Internal Name Parameter Type Is Sortable Tooltip
all unkAll Boolean False Selects all Origin Run Histories within this dataset.
batch unkBatch Number False Selects Origin Run Histories by calculating a batch number based on the unique row identifier of the object. Requires a batch number and a number of batches parameters.
runOn oghRunOn Datetime True Selects Origin Run Histories based on a value for Date Import Run.
updated unkUpdated Datetime True Selects Origin Run Histories based on when they were last updated.
updatedBy unkUpdatedBy HP.HPTRIM.SDK.Location True Selects Origin Run Histories based on who they were last updated by.
none unkNone Boolean False Selects no Origin Run Histories.
origin oghOrigin HP.HPTRIM.SDK.Origin True Selects Origin Run Histories based on a value for Origin.
saved unkSaved HP.HPTRIM.SDK.SavedSearch False Selects Origin Run Histories that satisfy a specified saved search.
source oghSource String True Selects Origin Run Histories based on a value for Source.
uri unkUri BigNumber True Selects Origin Run Histories based on a unique identifier value.

Record

Name Internal Name Parameter Type Is Sortable Tooltip
acl unkAcl HP.HPTRIM.SDK.Location False Selects Records having selected locations in a particular access control.
accession recAccession Number True Selects Records based on a value for Accession Number.
audit unkAudit HP.HPTRIM.SDK.History False Selects Records that are involved with the specified Historical Event.
activity recActivity HP.HPTRIM.SDK.Activity False Selects Records that are associated with the specified activity
addressee recAddressee HP.HPTRIM.SDK.Location False Selects Records that have an addressee of the specified location
all unkAll Boolean False Selects all Records within this dataset.
allParts recAllParts HP.HPTRIM.SDK.Record False Selects Records that have in the same part series as the specified record
allRelated recAllRelated HP.HPTRIM.SDK.Record False Selects Records that have any relationship with the specified record (excludes parts, versions, series, alt container and SharePoint relationship types)
allVersions recAllVersions HP.HPTRIM.SDK.Record False Selects Records that have in the same version series as the specified record
altContains recAltContains HP.HPTRIM.SDK.Record False Selects Records that have the alternatively within relationship with the specified record
anyWord recAnyWord String False Selects Records based on the Any Word index.
assignee recAssignee HP.HPTRIM.SDK.Location False Selects Records based on a value for Assignee.
assigneex recAssigneex HP.HPTRIM.SDK.RecordLocation False Selects Records with an associated assignee having selected property values
atHome recAtHome Boolean False Selects Records that are at home (i.e. assignee is same as home)
keyword recKeyword HP.HPTRIM.SDK.Keyword False Selects Records that have the specified thesaurus term attached.
index recIndex HP.HPTRIM.SDK.RecordKeyword False Selects Records with an associated Attached thesaurus term having selected property values.
attachedTo recAttachedTo HP.HPTRIM.SDK.Record False Selects Records that have the attached to relationship with the specified record
author recAuthor HP.HPTRIM.SDK.Location False Selects Records that have an author of the specified location
partRule recPartRule HP.HPTRIM.SDK.AutoPartRule True Selects Records based on a value for Automated Part Rule.
barcode unkBarcode String False Selects Records by barcode.
batch unkBatch Number False Selects Records by calculating a batch number based on the unique row identifier of the object. Requires a batch number and a number of batches parameters.
usable unkUsable Boolean False Selects Records that satisfy the can use or view criteria.
canUseClass recCanUseClass Boolean False Selects Records based on a value for Can Use Classification.
checkedInBy recCheckedInBy HP.HPTRIM.SDK.Location False Selects Records based on a value for Checked In By.
lockedOn recLockedOn Datetime False Selects Records based on a value for Checked Out On.
checkedOutBy recCheckedOutBy HP.HPTRIM.SDK.Location False Selects Records based on a value for Checked Out To.
classification recClassification HP.HPTRIM.SDK.Classification True Selects Records based on a value for Classification.
client recClient HP.HPTRIM.SDK.Location False Selects Records that have a client contact of the specified location
clientOf recClientOf HP.HPTRIM.SDK.Record False Selects Records that are the Client record of the specified records
clientRecord recClientRecord HP.HPTRIM.SDK.Record True Selects Records based on a value for Client record.
party recParty HP.HPTRIM.SDK.Location False Selects Records that have the specified location attached as an interested party.
partyEx recPartyEx HP.HPTRIM.SDK.RecordClientMatterParty False Selects Records with an associated Client/Matter Party having selected property values.
role recRole HP.HPTRIM.SDK.Location False Selects Records that have the specified location attached as playing a role for the client.
roleEx recRoleEx HP.HPTRIM.SDK.RecordClientMatterRole False Selects Records with an associated Client/Matter Role having selected property values.
communication recCommunication HP.HPTRIM.SDK.Communication False Selects Records that were associated with the specified communication
consignment recConsignment HP.HPTRIM.SDK.Consignment True Selects Records based on a value for Consignment.
consignmentNumber recConsignmentNumber String True Selects Records based on a value for Consignment Number.
contactx recContactx HP.HPTRIM.SDK.RecordLocation False Selects Records with an associated Contact having selected property values.
contact recContact HP.HPTRIM.SDK.Location False Selects Records that have a contact attached matching the location details specified.
container recContainer HP.HPTRIM.SDK.Record True Selects Records based on a value for Container.
containerEx recContainerEx HP.HPTRIM.SDK.Record False Selects Records that are contained within or are alternately contained within the specified record
contains recContains HP.HPTRIM.SDK.Record False Selects Records that are a container for the specified records
containsEx recContainsEx HP.HPTRIM.SDK.Record False Selects Records that are either a container or an alternate container for the specified records
contentBlockIn recContentBlockIn HP.HPTRIM.SDK.Record False Selects Records that have the is a document content block within relationship with the specified record
myContent recMyContent Boolean False Selects Records that are in your favorite content blocks tray.
copyOf recCopyOf HP.HPTRIM.SDK.Record False Selects Records that have the copy of relationship with the specified record
creator recCreator HP.HPTRIM.SDK.Location False Selects Records based on a value for Creator.
currentVersion recCurrentVersion HP.HPTRIM.SDK.Record False Selects Records that are the most recently finalized version of the specified record
transferredOn recTransferredOn Datetime False Selects Records that had disposition changed to archived (custody transferred) on the specified date.
archivedOn recArchivedOn Datetime False Selects Records that had disposition changed to archived (keep forever) on the specified date.
closedOn recClosedOn Datetime True Selects Records based on a value for Date Closed.
createdOn recCreatedOn Datetime True Selects Records based on a value for Date Created.
finalisedOn recFinalisedOn Datetime True Selects Records based on a value for Date Declared As Final.
destroyedOn recDestroyedOn Datetime False Selects Records that had disposition changed to destroyed on the specified date.
dueOn recDueOn Datetime True Selects Records based on a value for Date Due.
imported recImported Datetime True Selects Records based on a value for Date Imported.
inactiveOn recInactiveOn Datetime True Selects Records based on a value for Date Inactive.
updated unkUpdated Datetime True Selects Records based on when they were last updated.
editedOn recEditedOn Datetime False Selects Records based on a value for Date Modified.
publishedOn recPublishedOn Datetime True Selects Records based on a value for Date Published.
receivedOn recReceivedOn Datetime True Selects Records based on a value for Date Received.
registeredOn recRegisteredOn Datetime True Selects Records based on a value for Date Registered.
supersededOn recSupersededOn Datetime True Selects Records based on a value for Date Superseded.
archiveOn recArchiveOn Datetime False Selects Records that are due to have a disposition change to archived (keep forever) on the specified date.
transferOn recTransferOn Datetime False Selects Records that are due to have a disposition change to archived (custody transferred) on the specified date.
destroyOn recDestroyOn Datetime False Selects Records that are due to have a disposition change to destroyed on the specified date.
makeInactiveOn recMakeInactiveOn Datetime False Selects Records that are due to have a disposition change to inactive on the specified date.
default unkDefault String False Selects all Records based on a generic interpretation of a string value (usually by matching the name property).
derivedFrom recDerivedFrom HP.HPTRIM.SDK.Record False Selects Records that have the derived from relationship with the specified record
disposition recDisposition HP.HPTRIM.SDK.RecordDisp True Selects Records based on a value for Disposition.
content recContent String False Selects Records that have a document with contents matching the content index search clause supplied.
accessedOn recAccessedOn Datetime False Selects Records based on a value for Document Last Accessed Date.
store recStore HP.HPTRIM.SDK.ElectronicStore False Selects Records based on a value for Document Store.
myTemplates recMyTemplates Boolean False Selects Records that are in your favorite document templates tray.
returnOn recReturnOn Datetime False Selects Records due for return by a specified date.
conversationId recConversationId String False Selects Records based on a value for Email Conversation Id.
messageId recMessageId String False Selects Records based on a value for Email Message Id.
enclosed recEnclosed Boolean False Selects Records that have a container and are enclosed in that container
numberx recNumberx String True Selects Records based on a value for Expanded Number.
extension recExtension String False Selects Records based on a value for Extension.
external recExternal String True Selects Records based on a value for External ID.
favorite unkFavorite Boolean False Selects favourite Records.
final recFinal Boolean False Selects Records that have been finalized.
firstPart recFirstPart HP.HPTRIM.SDK.Record False Selects Records that have the first part of relationship with the specified record
firstVersionOf recFirstVersionOf HP.HPTRIM.SDK.Record False Selects Records that have the first version of relationship with the specified record
folderOrigin recFolderOrigin HP.HPTRIM.SDK.Origin True Selects Records based on a value for Folder Origin.
fbarcode unkFbarcode String False Selects Records by foreign barcode.
emailLink recEmailLink HP.HPTRIM.SDK.EmailLink False Selects Records that are contained within the specified email link
altContainer recAltContainer HP.HPTRIM.SDK.Record False Selects Records that have the alternatively contains relationship with the specified record
hasAttachment recHasAttachment HP.HPTRIM.SDK.Record False Selects Records that have the has attachment relationship with the specified record
hasContentBlock recHasContentBlock HP.HPTRIM.SDK.Record False Selects Records that have the contains document content block relationship with the specified record
hasContents recHasContents Boolean True Selects Records based on a value for Has Contents.
hasDerivation recHasDerivation HP.HPTRIM.SDK.Record False Selects Records that have the derivations relationship with the specified record
attachments recAttachments Boolean False Selects Records based on a value for Has Email Attachments.
hasFirstPart recHasFirstPart HP.HPTRIM.SDK.Record False Selects Records that have the has first part of relationship with the specified record
hasFirstVersion recHasFirstVersion HP.HPTRIM.SDK.Record False Selects Records that have the has first version of relationship with the specified record
hasRedaction recHasRedaction HP.HPTRIM.SDK.Record False Selects Records that have the was redacted to relationship with the specified record
hasReply recHasReply HP.HPTRIM.SDK.Record False Selects Records that have the has reply relationship with the specified record
sameClient recSameClient HP.HPTRIM.SDK.Record False Selects Records that share the same client as the specified record
sameContact recSameContact HP.HPTRIM.SDK.Record False Selects Records that share the same contact as the specified record
hasSite recHasSite HP.HPTRIM.SDK.Record False Selects Records that have the contains sharepoint list or site relationship with the specified record
hold recHold HP.HPTRIM.SDK.Hold False Selects Records that are associated with the specified hold
home recHome HP.HPTRIM.SDK.Location False Selects Records based on a value for Home.
homex recHomex HP.HPTRIM.SDK.RecordLocation False Selects Records with an associated home having selected property values
idol recIdol String False Selects Records that match the specified IDOL query string.
holdingBay recHoldingBay HP.HPTRIM.SDK.Space False Selects Records based on a value for In Holding Bay.
replyTo recReplyTo HP.HPTRIM.SDK.Record False Selects Records that have the reply to relationship with the specified record
inSpList recInSpList HP.HPTRIM.SDK.Record False Selects Records that represent SharePoint list items within the nominated SharePoint list.
space recSpace HP.HPTRIM.SDK.Space False Selects Records based on a value for In space.
spaceOrBay recSpaceOrBay HP.HPTRIM.SDK.Space False Selects Records based on a value for In space Or Holding Bay.
mime recMime String False Selects Records based on a value for Internet Media Type.
electronic recElectronic Boolean False Selects Records based on a value for Is Electronic.
hasHold recHasHold Boolean True Selects Records based on a value for Is in one or more holds.
supersededBy recSupersededBy HP.HPTRIM.SDK.Record False Selects Records that have the is superseded by relationship with the specified record
jurisdiction recJurisdiction HP.HPTRIM.SDK.Jurisdiction False Selects Records that have the specified jurisdiction.
actionedOn recActionedOn Datetime True Selects Records based on a value for Last Action Date.
updatedBy unkUpdatedBy HP.HPTRIM.SDK.Location True Selects Records based on who they were last updated by.
latestPart recLatestPart HP.HPTRIM.SDK.Record False Selects Records that are the latest part of the specified record
latestVersion recLatestVersion HP.HPTRIM.SDK.Record False Selects Records that are the latest version of the specified record
linkOf recLinkOf HP.HPTRIM.SDK.Record False Selects Records that have an document that contains an embedded link to record
linksTo recLinksTo HP.HPTRIM.SDK.Record False Selects Records that is an embedded link of the the specified record
matterOf recMatterOf HP.HPTRIM.SDK.Record False Selects Records that are the Matter record of the specified records
matterRecord recMatterRecord HP.HPTRIM.SDK.Record True Selects Records based on a value for Matter record.
media recMedia HP.HPTRIM.SDK.MediaTypes True Selects Records based on a value for Media Type.
meeting recMeeting HP.HPTRIM.SDK.Meeting False Selects Records associated with the specified meeting.
missing recMissing Boolean False Selects Records that have an unknown assignee
myContainers recMyContainers Boolean False Selects Records that are in your recently used containers tray.
none unkNone Boolean False Selects no Records.
notes recNotes String False Selects Records based on the Notes Word index.
offline recOffline HP.HPTRIM.SDK.OfflineRecord False Selects Records that are associated with the specified offline records
originalOf recOriginalOf HP.HPTRIM.SDK.Record False Selects Records that have the original of relationship with the specified record
origin recOrigin HP.HPTRIM.SDK.Origin False Selects Records based on a value for Originated From.
originRun recOriginRun HP.HPTRIM.SDK.OriginHistory True Selects Records based on a value for Originated From Run.
otherContact recOtherContact HP.HPTRIM.SDK.Location False Selects Records that have an other type of contact of the specified location
owner recOwner HP.HPTRIM.SDK.Location False Selects Records based on a value for Owner.
priority recPriority String True Selects Records based on a value for Priority.
myDocuments recMyDocuments Boolean False Selects Records that are in your recently accessed documents tray.
action recAction HP.HPTRIM.SDK.RecordAction False Selects Records that have the specified action(s) attached
class recClass HP.HPTRIM.SDK.RecordClass True Selects Records based on a value for Record Class.
number recNumber String True Selects Records based on a value for Record Number.
type recType HP.HPTRIM.SDK.RecordType True Selects Records based on a value for Record Type.
dueTray recDueTray Boolean False Selects Records that you or your position have a current action to be completed.
inTray recInTray Boolean False Selects Records that you or your position are the current assignee of.
workTray recWorkTray Boolean False Selects Records that are in your working records tray.
redactionOf recRedactionOf HP.HPTRIM.SDK.Record False Selects Records that have the redaction of relationship with the specified record
related recRelated HP.HPTRIM.SDK.Record False Selects Records that have the related to relationship with the specified record
representative recRepresentative HP.HPTRIM.SDK.Location False Selects Records that have a representative of the specified location
request recRequest HP.HPTRIM.SDK.Request False Selects Records that are associated with the specified request
requestor recRequestor HP.HPTRIM.SDK.Location False Selects Records that have been requested by the specified location
requestedOn recRequestedOn Datetime False Selects Records that have been requested on the specified date/time
review recReview Datetime True Selects Records based on a value for Retention Review Date.
schedule recSchedule HP.HPTRIM.SDK.Schedule True Selects Records based on a value for Retention schedule.
reviewStatus recReviewStatus HP.HPTRIM.SDK.PendingEventReviewFilter False Selects Records that have a review date set indicating the desired review status
revisionEx recRevisionEx HP.HPTRIM.SDK.RecordRevision False Selects Records with an associated Revision having selected property values.
conversation recConversation HP.HPTRIM.SDK.Record False Selects Records that are in the same email message conversation as the specified record
sapcustomer recSapcustomer String False Selects Records based on a value for SAP Customer.
sapcustomerid recSapcustomerid String False Selects Records based on a value for SAP Customer ID.
sapdoc recSapdoc String False Selects Records based on a value for SAP Document.
saprepos recSaprepos String False Selects Records based on a value for SAP Repository.
saved unkSaved HP.HPTRIM.SDK.SavedSearch False Selects Records that satisfy a specified saved search.
task recTask HP.HPTRIM.SDK.ScheduledTask False Selects Records that have the specified vital review task(s) attached
securityCaveat recSecurityCaveat HP.HPTRIM.SDK.SecurityCaveat False Selects Records that have the specified security caveat
securityLevel recSecurityLevel HP.HPTRIM.SDK.SecurityLevel False Selects Records that have the specified security level
isSeriesOf recIsSeriesOf HP.HPTRIM.SDK.Record False Selects Records that are a series record of the specified record
spGUID recSpGUID String True Selects Records based on a value for SharePoint GUID.
spList recSpList HP.HPTRIM.SDK.SharePointItem False Selects Records that represent the SharePoint List for the specified SharePoint items
spLirId recSpLirId BigNumber False Selects Records that represent a SharePoint List Item with the nominated Id.
spLirURL recSpLirURL String False Selects Records that represent a SharePoint List Item with the nominated URL.
spType recSpType HP.HPTRIM.SDK.SpElementType False Selects Records that are the specified type of SharePoint object.
spRecord recSpRecord HP.HPTRIM.SDK.SharePointItem False Selects Records that manage the specified SharePoint items
spFarmGUID recSpFarmGUID String True Selects Records based on a value for SharePoint Server Farm ID.
spSiteCollectionGUID recSpSiteCollectionGUID String True Selects Records that represent a SharePoint Site within the nominated site collection.
spURL recSpURL String True Selects Records based on a value for SharePoint URL.
documentSize recDocumentSize BigNumber False Selects Records based on a value for Size.
supersedes recSupersedes HP.HPTRIM.SDK.Record False Selects Records that have the supersedes relationship with the specified record
typedTitle recTypedTitle String True Selects Records based on a value for Title (Free Text Part).
generatedTitle recGeneratedTitle String True Selects Records based on a value for Title (Structured Part).
title recTitle String False Selects Records based on the Title Word index.
todo recTodo HP.HPTRIM.SDK.TodoItem False Selects Records referenced by the specificed to do item.
uri unkUri BigNumber True Selects Records based on a unique identifier value.
label unkLabel HP.HPTRIM.SDK.UserLabel False Selects Records with a specified User Label.
relatedEx recRelatedEx HP.HPTRIM.SDK.Record False Selects Records that have the specified relationship with the specified records
relatedReverseEx recRelatedReverseEx HP.HPTRIM.SDK.Record False Selects Records that have the specified reverse record relationship with the specified records
inSeries recInSeries HP.HPTRIM.SDK.Record False Selects Records that are in the specified series record
inSite recInSite HP.HPTRIM.SDK.Record False Selects Records that have the within sharepoint site relationship with the specified record
workflow recWorkflow HP.HPTRIM.SDK.Workflow False Selects Records that are associated with the specified workflow

RecordAction

Name Internal Name Parameter Type Is Sortable Tooltip
name racName String True Selects Record Actions based on a value for Action.
audit unkAudit HP.HPTRIM.SDK.History False Selects Record Actions that are involved with the specified Historical Event.
all unkAll Boolean False Selects all Record Actions within this dataset.
barcode unkBarcode String False Selects Record Actions by barcode.
batch unkBatch Number False Selects Record Actions by calculating a batch number based on the unique row identifier of the object. Requires a batch number and a number of batches parameters.
completedBy racCompletedBy HP.HPTRIM.SDK.Location True Selects Record Actions based on a value for Completed By location.
doneOn racDoneOn Datetime True Selects Record Actions based on a value for Completed On.
doneOnTime racDoneOnTime Boolean False Selects Record Actions based on a value for Completed On Time.
updated unkUpdated Datetime True Selects Record Actions based on when they were last updated.
default unkDefault String False Selects all Record Actions based on a generic interpretation of a string value (usually by matching the name property).
done racDone Boolean False Selects Record Actions based on a value for Done.
dueOn racDueOn Datetime True Selects Record Actions based on a value for Due Date.
fbarcode unkFbarcode String False Selects Record Actions by foreign barcode.
updatedBy unkUpdatedBy HP.HPTRIM.SDK.Location True Selects Record Actions based on who they were last updated by.
none unkNone Boolean False Selects no Record Actions.
overdue racOverdue Boolean False Selects Record Actions based on a value for Overdue.
parent racParent HP.HPTRIM.SDK.RecordAction True Selects Record Actions based on a value for Parent record action.
procedure racProcedure Boolean False Selects Record Actions based on a value for Procedure.
canStart racCanStart Boolean False Selects Record Actions that can now be worked on
record racRecord HP.HPTRIM.SDK.Record True Selects Record Actions based on a value for Record.
assignee racAssignee HP.HPTRIM.SDK.Location True Selects Record Actions based on a value for Responsible location.
saved unkSaved HP.HPTRIM.SDK.SavedSearch False Selects Record Actions that satisfy a specified saved search.
startOn racStartOn Datetime True Selects Record Actions based on a value for Start Date.
top unkTop Boolean True Selects all top-level Record Actions (those that have no parent or are not enclosed within any other Record Action).
uri unkUri BigNumber True Selects Record Actions based on a unique identifier value.

RecordType

Name Internal Name Parameter Type Is Sortable Tooltip
acl unkAcl HP.HPTRIM.SDK.Location False Selects Record Types having selected locations in a particular access control.
copyacl unkCopyacl HP.HPTRIM.SDK.Location False Selects Record Types having selected locations in a particular access control in the copied access control set.
audit unkAudit HP.HPTRIM.SDK.History False Selects Record Types that are involved with the specified Historical Event.
activeFrom unkActiveFrom Date True Selects Record Types that have a Date Active From value matching the specified date range.
activeTo unkActiveTo Date True Selects Record Types that have a Date Active To value matching the specified date range.
field rtyField HP.HPTRIM.SDK.FieldDefinition False Selects Record Types that use the specified additional field
all unkAll Boolean False Selects all Record Types within this dataset.
archive rtyArchive Boolean True Selects Record Types based on a value for Allow Retention Schedule.
action rtyAction HP.HPTRIM.SDK.ActionDef True Selects Record Types based on a value for Assigned action.
assignee rtyAssignee HP.HPTRIM.SDK.Location True Selects Record Types based on a value for Assignee.
batch unkBatch Number False Selects Record Types by calculating a batch number based on the unique row identifier of the object. Requires a batch number and a number of batches parameters.
behaviour rtyBehaviour HP.HPTRIM.SDK.RecordBehaviour True Selects Record Types based on a value for Behaves Like.
usable unkUsable Boolean False Selects Record Types that satisfy the can use or view criteria.
level rtyLevel Number True Selects Record Types based on a value for Container Level.
updated unkUpdated Datetime True Selects Record Types based on when they were last updated.
default unkDefault String False Selects all Record Types based on a generic interpretation of a string value (usually by matching the name property).
media rtyMedia HP.HPTRIM.SDK.MediaTypes True Selects Record Types based on a value for Default Media Type.
externalId rtyExternalId String True Selects Record Types based on a value for External ID.
hasElecDocSupport rtyHasElecDocSupport Boolean False Selects Record Types that support Electronic Documents.
home rtyHome HP.HPTRIM.SDK.Location True Selects Record Types based on a value for Home.
space rtySpace Boolean False Selects Record Types that can be stored in the space management system
template rtyTemplate HP.HPTRIM.SDK.WorkflowTemplate True Selects Record Types based on a value for Initiate workflow based on a template.
active unkActive Boolean True Selects Record Types that are active.
updatedBy unkUpdatedBy HP.HPTRIM.SDK.Location True Selects Record Types based on who they were last updated by.
name rtyName String True Selects Record Types based on a value for Name.
none unkNone Boolean False Selects no Record Types.
owner rtyOwner HP.HPTRIM.SDK.Location True Selects Record Types based on a value for Owner.
lir rtyLir Boolean True Selects Record Types based on a value for Records can be SharePoint List Item records.
hasMatter rtyHasMatter Boolean True Selects Record Types based on a value for Records Must Belong To A Matter.
ackRequests rtyAckRequests Boolean True Selects Record Types based on a value for Requests Need Acknowledgement before Completion.
schedule rtySchedule HP.HPTRIM.SDK.Schedule True Selects Record Types based on a value for Retention schedule.
saprepository rtySaprepository String True Selects Record Types based on a value for SAP Repository ID.
saved unkSaved HP.HPTRIM.SDK.SavedSearch False Selects Record Types that satisfy a specified saved search.
sortOrder rtySortOrder String True Selects Record Types based on a value for Sort Order.
classification rtyClassification HP.HPTRIM.SDK.Classification True Selects Record Types based on a value for Starting classification.
store rtyStore HP.HPTRIM.SDK.ElectronicStore True Selects Record Types based on a value for Store Name.
titling rtyTitling HP.HPTRIM.SDK.TitlingMethods True Selects Record Types based on a value for Titling Method.
census rtyCensus Boolean True Selects Record Types based on a value for Track during Census.
uri unkUri BigNumber True Selects Record Types based on a unique identifier value.

Report

Name Internal Name Parameter Type Is Sortable Tooltip
acl unkAcl HP.HPTRIM.SDK.Location False Selects Reports having selected locations in a particular access control.
all unkAll Boolean False Selects all Reports within this dataset.
batch unkBatch Number False Selects Reports by calculating a batch number based on the unique row identifier of the object. Requires a batch number and a number of batches parameters.
usable unkUsable Boolean False Selects Reports that satisfy the can use or view criteria.
updated unkUpdated Datetime True Selects Reports based on when they were last updated.
default unkDefault String False Selects all Reports based on a generic interpretation of a string value (usually by matching the name property).
favorite unkFavorite Boolean False Selects favourite Reports.
type rptType HP.HPTRIM.SDK.BaseObjectTypes True Selects Reports based on a value for For Object Type.
updatedBy unkUpdatedBy HP.HPTRIM.SDK.Location True Selects Reports based on who they were last updated by.
name rptName String True Selects Reports based on a value for Name.
none unkNone Boolean False Selects no Reports.
saved unkSaved HP.HPTRIM.SDK.SavedSearch False Selects Reports that satisfy a specified saved search.
uri unkUri BigNumber True Selects Reports based on a unique identifier value.
label unkLabel HP.HPTRIM.SDK.UserLabel False Selects Reports with a specified User Label.

Request

Name Internal Name Parameter Type Is Sortable Tooltip
audit unkAudit HP.HPTRIM.SDK.History False Selects Requests that are involved with the specified Historical Event.
all unkAll Boolean False Selects all Requests within this dataset.
batch unkBatch Number False Selects Requests by calculating a batch number based on the unique row identifier of the object. Requires a batch number and a number of batches parameters.
completedOn rcqCompletedOn Datetime True Selects Requests based on a value for Date Completed.
createdOn rcqCreatedOn Datetime True Selects Requests based on a value for Date Created.
updated unkUpdated Datetime True Selects Requests based on when they were last updated.
dueOn rcqDueOn Datetime True Selects Requests based on a value for Date Required.
statusDate rcqStatusDate Datetime True Selects Requests based on a value for Date Status Changed.
deliverTo rcqDeliverTo HP.HPTRIM.SDK.Location True Selects Requests based on a value for Delivery/Pickup Location.
athome rcqAthome Boolean False Selects Requests that are for records that are currently at their home location.
done rcqDone Boolean False Selects Requests based on a value for Is Complete.
isCurrent rcqIsCurrent Boolean False Selects Requests that are the currently outstanding retrieval request for the records they are associated with.
updatedBy unkUpdatedBy HP.HPTRIM.SDK.Location True Selects Requests based on who they were last updated by.
none unkNone Boolean False Selects no Requests.
priority rcqPriority HP.HPTRIM.SDK.RequestPriority True Selects Requests based on a value for Priority.
record rcqRecord HP.HPTRIM.SDK.Record True Selects Requests based on a value for Record.
assignee rcqAssignee HP.HPTRIM.SDK.Location False Selects Requests based on a value for Record assignee.
type rcqType HP.HPTRIM.SDK.RequestTypes True Selects Requests based on a value for Request Type.
by rcqBy HP.HPTRIM.SDK.Location True Selects Requests based on a value for Requested By.
saved unkSaved HP.HPTRIM.SDK.SavedSearch False Selects Requests that satisfy a specified saved search.
serviceLocation rcqServiceLocation HP.HPTRIM.SDK.Location True Selects Requests based on a value for Service Location.
space rcqSpace HP.HPTRIM.SDK.Space True Selects Requests that are for records with home location within the nominated spaces.
status rcqStatus HP.HPTRIM.SDK.RequestStatus True Selects Requests based on a value for Status.
uri unkUri BigNumber True Selects Requests based on a unique identifier value.

SavedSearch

Name Internal Name Parameter Type Is Sortable Tooltip
acl unkAcl HP.HPTRIM.SDK.Location False Selects Saved Searches having selected locations in a particular access control.
audit unkAudit HP.HPTRIM.SDK.History False Selects Saved Searches that are involved with the specified Historical Event.
all unkAll Boolean False Selects all Saved Searches within this dataset.
batch unkBatch Number False Selects Saved Searches by calculating a batch number based on the unique row identifier of the object. Requires a batch number and a number of batches parameters.
canEdit srhCanEdit Boolean False Selects Saved Searches based on a value for Can edit query.
canExecute srhCanExecute Boolean False Selects Saved Searches based on a value for Can execute query.
usable unkUsable Boolean False Selects Saved Searches that satisfy the can use or view criteria.
updated unkUpdated Datetime True Selects Saved Searches based on when they were last updated.
default unkDefault String False Selects all Saved Searches based on a generic interpretation of a string value (usually by matching the name property).
favorite unkFavorite Boolean False Selects favourite Saved Searches.
fullName srhFullName String False Selects Saved Searches based on a value for Full Name.
public srhPublic Boolean False Selects Saved Searches based on a value for Is Public.
group srhGroup Boolean True Selects Saved Searches based on a value for Is Search Group.
updatedBy unkUpdatedBy HP.HPTRIM.SDK.Location True Selects Saved Searches based on who they were last updated by.
name srhName String True Selects Saved Searches based on a value for Name.
none unkNone Boolean False Selects no Saved Searches.
type srhType HP.HPTRIM.SDK.BaseObjectTypes True Selects Saved Searches based on a value for Object Type.
old srhOld Boolean True Selects Saved Searches based on a value for Old Format.
owner srhOwner HP.HPTRIM.SDK.Location True Selects Saved Searches based on a value for Owner.
saved unkSaved HP.HPTRIM.SDK.SavedSearch False Selects Saved Searches that satisfy a specified saved search.
top unkTop Boolean True Selects all top-level Saved Searches (those that have no parent or are not enclosed within any other Saved Search).
uri unkUri BigNumber True Selects Saved Searches based on a unique identifier value.
label unkLabel HP.HPTRIM.SDK.UserLabel False Selects Saved Searches with a specified User Label.
parent srhParent HP.HPTRIM.SDK.SavedSearch True Selects Saved Searches based on a value for Within Search Group.

Schedule

Name Internal Name Parameter Type Is Sortable Tooltip
acl unkAcl HP.HPTRIM.SDK.Location False Selects Schedules having selected locations in a particular access control.
audit unkAudit HP.HPTRIM.SDK.History False Selects Schedules that are involved with the specified Historical Event.
activeFrom unkActiveFrom Date True Selects Schedules that have a Date Active From value matching the specified date range.
activeTo unkActiveTo Date True Selects Schedules that have a Date Active To value matching the specified date range.
agency schAgency Boolean True Selects Schedules based on a value for Agency Specific.
all unkAll Boolean False Selects all Schedules within this dataset.
barcode unkBarcode String False Selects Schedules by barcode.
batch unkBatch Number False Selects Schedules by calculating a batch number based on the unique row identifier of the object. Requires a batch number and a number of batches parameters.
usable unkUsable Boolean False Selects Schedules that satisfy the can use or view criteria.
updated unkUpdated Datetime True Selects Schedules based on when they were last updated.
default unkDefault String False Selects all Schedules based on a generic interpretation of a string value (usually by matching the name property).
favorite unkFavorite Boolean False Selects favourite Schedules.
fbarcode unkFbarcode String False Selects Schedules by foreign barcode.
active unkActive Boolean True Selects Schedules that are active.
updatedBy unkUpdatedBy HP.HPTRIM.SDK.Location True Selects Schedules based on who they were last updated by.
none unkNone Boolean False Selects no Schedules.
parentOf schParentOf HP.HPTRIM.SDK.Schedule False Selects Schedules that are the parent(s) of the selected item(s)
parent schParent HP.HPTRIM.SDK.Schedule True Selects Schedules based on a value for Parent schedule.
saved unkSaved HP.HPTRIM.SDK.SavedSearch False Selects Schedules that satisfy a specified saved search.
name schName String True Selects Schedules based on a value for Schedule Number.
word schWord String False Selects Schedules based on the Schedule Word index.
source schSource String True Selects Schedules based on a value for Source.
top unkTop Boolean True Selects all top-level Schedules (those that have no parent or are not enclosed within any other Schedule).
trigger schTrigger HP.HPTRIM.SDK.ScheduleTrigger False Selects Schedules with an associated Trigger having selected property values.
uri unkUri BigNumber True Selects Schedules based on a unique identifier value.
label unkLabel HP.HPTRIM.SDK.UserLabel False Selects Schedules with a specified User Label.

ScheduledTask

Name Internal Name Parameter Type Is Sortable Tooltip
all unkAll Boolean False Selects all Scheduled Tasks within this dataset.
assignee tskAssignee HP.HPTRIM.SDK.Location True Selects Scheduled Tasks based on a value for Assigned To.
objectType tskObjectType HP.HPTRIM.SDK.BaseObjectTypes True Selects Scheduled Tasks based on a value for Attached To.
classification tskClassification HP.HPTRIM.SDK.Classification False Selects Scheduled Tasks that are attached to the specified classifications
record tskRecord HP.HPTRIM.SDK.Record False Selects Scheduled Tasks that are attached to the specified records
batch unkBatch Number False Selects Scheduled Tasks by calculating a batch number based on the unique row identifier of the object. Requires a batch number and a number of batches parameters.
date tskDate Datetime True Selects Scheduled Tasks based on a value for Commencement date.
updated unkUpdated Datetime True Selects Scheduled Tasks based on when they were last updated.
folders tskFolders Boolean False Selects Scheduled Tasks for records that are folders.
done tskDone Boolean False Selects Scheduled Tasks that have been completed.
updatedBy unkUpdatedBy HP.HPTRIM.SDK.Location True Selects Scheduled Tasks based on who they were last updated by.
none unkNone Boolean False Selects no Scheduled Tasks.
overdue tskOverdue Boolean False Selects Scheduled Tasks that are overdue.
saved unkSaved HP.HPTRIM.SDK.SavedSearch False Selects Scheduled Tasks that satisfy a specified saved search.
uri unkUri BigNumber True Selects Scheduled Tasks based on a unique identifier value.

SearchForm

Name Internal Name Parameter Type Is Sortable Tooltip
acl unkAcl HP.HPTRIM.SDK.Location False Selects Search Forms having selected locations in a particular access control.
all unkAll Boolean False Selects all Search Forms within this dataset.
batch unkBatch Number False Selects Search Forms by calculating a batch number based on the unique row identifier of the object. Requires a batch number and a number of batches parameters.
usable unkUsable Boolean False Selects Search Forms that satisfy the can use or view criteria.
updated unkUpdated Datetime True Selects Search Forms based on when they were last updated.
default unkDefault String False Selects all Search Forms based on a generic interpretation of a string value (usually by matching the name property).
favorite unkFavorite Boolean False Selects favourite Search Forms.
updatedBy unkUpdatedBy HP.HPTRIM.SDK.Location True Selects Search Forms based on who they were last updated by.
name sfmName String True Selects Search Forms based on a value for Name.
none unkNone Boolean False Selects no Search Forms.
type sfmType HP.HPTRIM.SDK.BaseObjectTypes True Selects Search Forms based on a value for Object Type.
saved unkSaved HP.HPTRIM.SDK.SavedSearch False Selects Search Forms that satisfy a specified saved search.
uri unkUri BigNumber True Selects Search Forms based on a unique identifier value.
label unkLabel HP.HPTRIM.SDK.UserLabel False Selects Search Forms with a specified User Label.

SecurityCaveat

Name Internal Name Parameter Type Is Sortable Tooltip
abbreviation scvAbbreviation String True Selects Security Caveats based on a value for Abbreviation.
audit unkAudit HP.HPTRIM.SDK.History False Selects Security Caveats that are involved with the specified Historical Event.
activeFrom unkActiveFrom Date True Selects Security Caveats that have a Date Active From value matching the specified date range.
activeTo unkActiveTo Date True Selects Security Caveats that have a Date Active To value matching the specified date range.
all unkAll Boolean False Selects all Security Caveats within this dataset.
batch unkBatch Number False Selects Security Caveats by calculating a batch number based on the unique row identifier of the object. Requires a batch number and a number of batches parameters.
held scvHeld Boolean False Selects Security Caveats that are also held by the currently logged-in user
updated unkUpdated Datetime True Selects Security Caveats based on when they were last updated.
default unkDefault String False Selects all Security Caveats based on a generic interpretation of a string value (usually by matching the name property).
name scvName String True Selects Security Caveats based on a value for Description.
caveatNumber scvCaveatNumber Number True Selects Security Caveats based on a value for ID.
active unkActive Boolean True Selects Security Caveats that are active.
updatedBy unkUpdatedBy HP.HPTRIM.SDK.Location True Selects Security Caveats based on who they were last updated by.
none unkNone Boolean False Selects no Security Caveats.
saved unkSaved HP.HPTRIM.SDK.SavedSearch False Selects Security Caveats that satisfy a specified saved search.
uri unkUri BigNumber True Selects Security Caveats based on a unique identifier value.

SecurityLevel

Name Internal Name Parameter Type Is Sortable Tooltip
abbreviation slvAbbreviation String True Selects Security Levels based on a value for Abbreviation.
audit unkAudit HP.HPTRIM.SDK.History False Selects Security Levels that are involved with the specified Historical Event.
activeFrom unkActiveFrom Date True Selects Security Levels that have a Date Active From value matching the specified date range.
activeTo unkActiveTo Date True Selects Security Levels that have a Date Active To value matching the specified date range.
all unkAll Boolean False Selects all Security Levels within this dataset.
batch unkBatch Number False Selects Security Levels by calculating a batch number based on the unique row identifier of the object. Requires a batch number and a number of batches parameters.
held slvHeld Boolean False Selects Security Levels that are at or below the currently logged in users security level
updated unkUpdated Datetime True Selects Security Levels based on when they were last updated.
default unkDefault String False Selects all Security Levels based on a generic interpretation of a string value (usually by matching the name property).
name slvName String True Selects Security Levels based on a value for Description.
active unkActive Boolean True Selects Security Levels that are active.
updatedBy unkUpdatedBy HP.HPTRIM.SDK.Location True Selects Security Levels based on who they were last updated by.
none unkNone Boolean False Selects no Security Levels.
levelNumber slvLevelNumber Number True Selects Security Levels based on a value for Ranking.
saved unkSaved HP.HPTRIM.SDK.SavedSearch False Selects Security Levels that satisfy a specified saved search.
uri unkUri BigNumber True Selects Security Levels based on a unique identifier value.

SharePointItem

Name Internal Name Parameter Type Is Sortable Tooltip
all unkAll Boolean False Selects all SharePoint Documents within this dataset.
batch unkBatch Number False Selects SharePoint Documents by calculating a batch number based on the unique row identifier of the object. Requires a batch number and a number of batches parameters.
updated unkUpdated Datetime True Selects SharePoint Documents based on when they were last updated.
default unkDefault String False Selects all SharePoint Documents based on a generic interpretation of a string value (usually by matching the name property).
updatedBy unkUpdatedBy HP.HPTRIM.SDK.Location True Selects SharePoint Documents based on who they were last updated by.
listId spiListId BigNumber True Selects SharePoint Documents based on a value for List Item Id.
record spiRecord HP.HPTRIM.SDK.Record True Selects SharePoint Documents based on a value for List Item record.
list spiList HP.HPTRIM.SDK.Record True Selects SharePoint Documents based on a value for List record.
none unkNone Boolean False Selects no SharePoint Documents.
viewable spiViewable Boolean False Selects SharePoint Documents based on a value for Record is viewable.
saved unkSaved HP.HPTRIM.SDK.SavedSearch False Selects SharePoint Documents that satisfy a specified saved search.
uniqueId spiUniqueId String True Selects SharePoint Documents based on a value for SharePoint Identifier.
synchPending spiSynchPending Boolean True Selects SharePoint Documents that are currently needing synchronization
uri unkUri BigNumber True Selects SharePoint Documents based on a unique identifier value.

Space

Name Internal Name Parameter Type Is Sortable Tooltip
acl unkAcl HP.HPTRIM.SDK.Location False Selects Spaces having selected locations in a particular access control.
audit unkAudit HP.HPTRIM.SDK.History False Selects Spaces that are involved with the specified Historical Event.
all unkAll Boolean False Selects all Spaces within this dataset.
barcode unkBarcode String False Selects Spaces by barcode.
batch unkBatch Number False Selects Spaces by calculating a batch number based on the unique row identifier of the object. Requires a batch number and a number of batches parameters.
usable unkUsable Boolean False Selects Spaces that satisfy the can use or view criteria.
updated unkUpdated Datetime True Selects Spaces based on when they were last updated.
default unkDefault String False Selects all Spaces based on a generic interpretation of a string value (usually by matching the name property).
favorite unkFavorite Boolean False Selects favourite Spaces.
fbarcode unkFbarcode String False Selects Spaces by foreign barcode.
bay spmBay Boolean True Selects Spaces based on a value for Has Holding Bay.
lowest spmLowest Boolean True Selects Spaces based on a value for Is Lowest Level.
updatedBy unkUpdatedBy HP.HPTRIM.SDK.Location True Selects Spaces based on who they were last updated by.
none unkNone Boolean False Selects no Spaces.
parentOf spmParentOf HP.HPTRIM.SDK.Space False Selects Spaces that are the parent(s) of the selected item(s)
saved unkSaved HP.HPTRIM.SDK.SavedSearch False Selects Spaces that satisfy a specified saved search.
key spmKey String True Selects Spaces based on a value for Search Key.
number spmNumber String True Selects Spaces based on a value for Space Number.
top unkTop Boolean True Selects all top-level Spaces (those that have no parent or are not enclosed within any other Space).
uri unkUri BigNumber True Selects Spaces based on a unique identifier value.
label unkLabel HP.HPTRIM.SDK.UserLabel False Selects Spaces with a specified User Label.
within spmWithin HP.HPTRIM.SDK.Space True Selects Spaces based on a value for Within space.

TodoItem

Name Internal Name Parameter Type Is Sortable Tooltip
audit unkAudit HP.HPTRIM.SDK.History False Selects To Do Items that are involved with the specified Historical Event.
all unkAll Boolean False Selects all To Do Items within this dataset.
assignee tdoAssignee HP.HPTRIM.SDK.Location True Selects To Do Items based on a value for Assignee.
batch unkBatch Number False Selects To Do Items by calculating a batch number based on the unique row identifier of the object. Requires a batch number and a number of batches parameters.
done tdoDone Boolean False Selects To Do Items based on a value for Completed.
creator tdoCreator HP.HPTRIM.SDK.Location True Selects To Do Items based on a value for Created By.
doneOn tdoDoneOn Datetime True Selects To Do Items based on a value for Date Completed.
dueOn tdoDueOn Datetime True Selects To Do Items based on a value for Date Due.
updated unkUpdated Datetime True Selects To Do Items based on when they were last updated.
default unkDefault String False Selects all To Do Items based on a generic interpretation of a string value (usually by matching the name property).
updatedBy unkUpdatedBy HP.HPTRIM.SDK.Location True Selects To Do Items based on who they were last updated by.
none unkNone Boolean False Selects no To Do Items.
overdue tdoOverdue Boolean False Selects To Do Items based on a value for Overdue.
priority tdoPriority HP.HPTRIM.SDK.Priority True Selects To Do Items based on a value for Priority.
saved unkSaved HP.HPTRIM.SDK.SavedSearch False Selects To Do Items that satisfy a specified saved search.
name tdoName String True Selects To Do Items based on a value for To Be Done.
reference tdoReference HP.HPTRIM.SDK.TodoItemItemReference False Selects To Do Items with an associated To Do Item Reference having selected property values.
uri unkUri BigNumber True Selects To Do Items based on a unique identifier value.

UserLabel

Name Internal Name Parameter Type Is Sortable Tooltip
all unkAll Boolean False Selects all User Labels within this dataset.
stuckOn lblStuckOn HP.HPTRIM.SDK.Unknown False Selects User Labels that have been attached the specified HPE Records Manager object
batch unkBatch Number False Selects User Labels by calculating a batch number based on the unique row identifier of the object. Requires a batch number and a number of batches parameters.
dateCreated lblDateCreated Datetime True Selects User Labels based on a value for Date Created.
updated unkUpdated Datetime True Selects User Labels based on when they were last updated.
default unkDefault String False Selects all User Labels based on a generic interpretation of a string value (usually by matching the name property).
fullName lblFullName String False Selects User Labels based on a value for Full user label Name.
updatedBy unkUpdatedBy HP.HPTRIM.SDK.Location True Selects User Labels based on who they were last updated by.
none unkNone Boolean False Selects no User Labels.
owner lblOwner HP.HPTRIM.SDK.Location True Selects User Labels based on a value for Owner.
parentOf lblParentOf HP.HPTRIM.SDK.UserLabel False Selects User Labels that are the parent(s) of the selected item(s)
parent lblParent HP.HPTRIM.SDK.UserLabel True Selects User Labels based on a value for Parent user label.
saved unkSaved HP.HPTRIM.SDK.SavedSearch False Selects User Labels that satisfy a specified saved search.
top unkTop Boolean True Selects all top-level User Labels (those that have no parent or are not enclosed within any other User Label).
uri unkUri BigNumber True Selects User Labels based on a unique identifier value.
name lblName String True Selects User Labels based on a value for User Label Name.
type lblType HP.HPTRIM.SDK.UserLabelType True Selects User Labels based on a value for User Label Type.

Workflow

Name Internal Name Parameter Type Is Sortable Tooltip
acl unkAcl HP.HPTRIM.SDK.Location False Selects Workflows having selected locations in a particular access control.
audit unkAudit HP.HPTRIM.SDK.History False Selects Workflows that are involved with the specified Historical Event.
all unkAll Boolean False Selects all Workflows within this dataset.
record wkfRecord HP.HPTRIM.SDK.Record False Selects Workflows associated with the specified record
template wkfTemplate HP.HPTRIM.SDK.WorkflowTemplate True Selects Workflows based on a value for Based On template.
batch unkBatch Number False Selects Workflows by calculating a batch number based on the unique row identifier of the object. Requires a batch number and a number of batches parameters.
usable unkUsable Boolean False Selects Workflows that satisfy the can use or view criteria.
customer wkfCustomer HP.HPTRIM.SDK.Location True Selects Workflows based on a value for Client.
done wkfDone Boolean False Selects Workflows based on a value for Complete.
activity wkfActivity HP.HPTRIM.SDK.Activity False Selects Workflows that contain the specified activity
doneOn wkfDoneOn Datetime True Selects Workflows based on a value for Date Completed.
dueOn wkfDueOn Datetime True Selects Workflows based on a value for Date Due.
destroyOn wkfDestroyOn Datetime True Selects Workflows based on a value for Date Due For Destruction.
updated unkUpdated Datetime True Selects Workflows based on when they were last updated.
registeredOn wkfRegisteredOn Datetime True Selects Workflows based on a value for Date Registered.
startedOn wkfStartedOn Datetime True Selects Workflows based on a value for Date Started.
default unkDefault String False Selects all Workflows based on a generic interpretation of a string value (usually by matching the name property).
container wkfContainer HP.HPTRIM.SDK.Record True Selects Workflows based on a value for Default container.
favorite unkFavorite Boolean False Selects favourite Workflows.
initiator wkfInitiator HP.HPTRIM.SDK.Record True Selects Workflows based on a value for Initiating record.
job wkfJob String False Selects Workflows based on a value for Job Number.
jobx wkfJobx String True Selects Workflows based on a value for Job Number (Expanded).
updatedBy unkUpdatedBy HP.HPTRIM.SDK.Location True Selects Workflows based on who they were last updated by.
name wkfName String True Selects Workflows based on a value for Name.
none unkNone Boolean False Selects no Workflows.
overdue wkfOverdue Boolean False Selects Workflows based on a value for Overdue.
priority wkfPriority HP.HPTRIM.SDK.Priority True Selects Workflows based on a value for Priority.
saved unkSaved HP.HPTRIM.SDK.SavedSearch False Selects Workflows that satisfy a specified saved search.
scheduledStartOn wkfScheduledStartOn Datetime True Selects Workflows based on a value for Scheduled Start Date.
uri unkUri BigNumber True Selects Workflows based on a unique identifier value.
label unkLabel HP.HPTRIM.SDK.UserLabel False Selects Workflows with a specified User Label.
creator wkfCreator HP.HPTRIM.SDK.Location True Selects Workflows based on a value for Workflow Creator.
supervisor wkfSupervisor HP.HPTRIM.SDK.Location True Selects Workflows based on a value for Workflow Supervisor.

WorkflowTemplate

Name Internal Name Parameter Type Is Sortable Tooltip
acl unkAcl HP.HPTRIM.SDK.Location False Selects Templates having selected locations in a particular access control.
copyacl unkCopyacl HP.HPTRIM.SDK.Location False Selects Templates having selected locations in a particular access control in the copied access control set.
audit unkAudit HP.HPTRIM.SDK.History False Selects Templates that are involved with the specified Historical Event.
activeFrom unkActiveFrom Date True Selects Templates that have a Date Active From value matching the specified date range.
activeTo unkActiveTo Date True Selects Templates that have a Date Active To value matching the specified date range.
all unkAll Boolean False Selects all Templates within this dataset.
batch unkBatch Number False Selects Templates by calculating a batch number based on the unique row identifier of the object. Requires a batch number and a number of batches parameters.
usable unkUsable Boolean False Selects Templates that satisfy the can use or view criteria.
updated unkUpdated Datetime True Selects Templates based on when they were last updated.
dateRegistered wktDateRegistered Datetime True Selects Templates based on a value for Date Registered.
default unkDefault String False Selects all Templates based on a generic interpretation of a string value (usually by matching the name property).
favorite unkFavorite Boolean False Selects favourite Templates.
active unkActive Boolean True Selects Templates that are active.
updatedBy unkUpdatedBy HP.HPTRIM.SDK.Location True Selects Templates based on who they were last updated by.
name wktName String True Selects Templates based on a value for Name.
none unkNone Boolean False Selects no Templates.
priority wktPriority HP.HPTRIM.SDK.Priority True Selects Templates based on a value for Priority.
saved unkSaved HP.HPTRIM.SDK.SavedSearch False Selects Templates that satisfy a specified saved search.
uri unkUri BigNumber True Selects Templates based on a unique identifier value.
label unkLabel HP.HPTRIM.SDK.UserLabel False Selects Templates with a specified User Label.
supervisor wktSupervisor HP.HPTRIM.SDK.Location True Selects Templates based on a value for Workflow Supervisor.

ZipCode

Name Internal Name Parameter Type Is Sortable Tooltip
all unkAll Boolean False Selects all Postal Codes within this dataset.
batch unkBatch Number False Selects Postal Codes by calculating a batch number based on the unique row identifier of the object. Requires a batch number and a number of batches parameters.
city zipCity String True Selects Postal Codes based on a value for City.
country zipCountry String True Selects Postal Codes based on a value for Country.
updated unkUpdated Datetime True Selects Postal Codes based on when they were last updated.
default unkDefault String False Selects all Postal Codes based on a generic interpretation of a string value (usually by matching the name property).
updatedBy unkUpdatedBy HP.HPTRIM.SDK.Location True Selects Postal Codes based on who they were last updated by.
none unkNone Boolean False Selects no Postal Codes.
postcode zipPostcode String True Selects Postal Codes based on a value for Postal Code.
region zipRegion String True Selects Postal Codes based on a value for Region.
saved unkSaved HP.HPTRIM.SDK.SavedSearch False Selects Postal Codes that satisfy a specified saved search.
state zipState String True Selects Postal Codes based on a value for State.
uri unkUri BigNumber True Selects Postal Codes based on a unique identifier value.