Data transfer objects glossary

ActionItem

Submit and return.

• Long workflowId.
• Long taskId.

Association

Submit and return.

• Long recordId.
• Long associatedRecordId.
• String associationName.
• String reverseAssociationName.

AssociationDefinition

Return.

• Long sourceModuleId.
• Long associatedModuleId.
• Long associatedObjectTypeId.
• Long sourceObjectTypeId.
• String associationName.
• String inverseAssociationName.
• String moduleName.
• String objectTypeName.

ApplicationInfo

Return.

• String tririgaBuildNumber.
• String dbBuildNumber.
• String apiVersion.

AssociationRecord

Return.

• Array of Associations.
• Long recordId.

AvailableAction

Return.

• Long recordId.
• String currentState.
• Array of Transitions.

ConversionGroup

Return.

• Long ID.
• String name.

Currency

Return.

• String abbreviation.
• String name.
• String symbol.
• String format.
• String delimiter.
• String decimal.

CurrencyConversionRate

Submit and return.

• String conversionGroup. Required for submission.
• String fromCurrency. Required for submission.
• String toCurrency. Required for submission.
• Double conversionRate. Required for submission.
• Date startDate. Required for submission. Follows ISO-8601 date format.
• Date endDate. Required for submission. Follows ISO-8601 date format.
• String frequencyGroup. Optional for submission. If not specified the value defaults to Daily.
• Long ID. Only required for update, otherwise, ID is returned upon creation.

ChildRecord

Return.

• Long childCount.
• String path.

GUI

Return.

• Long childRecordId.
• Long id.
• String label.
• Int moduleId.
• String moduleName.
• String name.
• Long objectTypeId.
• String objectTypeName.
• Long popupId.
• Long recordId.
• String recordName.
• Boolean saveOnPopup.
• Boolean singleTab.
• String state.
• Tab tabs.
• String type.

Tab

Return.

• Long id.
• String instruction.
• String label.
• String name.
• String tabInformation.
• Boolean visible.
• String url.
• Section sections.

Section

Return.

• Field fields.
• Long guiSectionId.
• String guiSectionName.
• Long id.
• String label.
• String name.
• Boolean readOnly.
• Long refModuleId.
• Long refObjectTypeId.
• GuiRow rows.
• String type.
• Int typeId.
• Boolean visible.

Field

Return.

• DataType dataType.
• String displayValue.
• Long guiRootClassificationId.
• String guiRootClassificationName.
• Long guiSectionId.
• String guiSectionName.
• String label.
• Long listId.
• Long listModuleId.
• Boolean liveLink.
• Long locatorField.
• Long locatorModuleId.
• Boolean mobileField.
• Long mobileFieldSeq.
• String name.
• Boolean readOnly.
• Long refObjectTypeId.
• Long refSpecId.
• Boolean required.
• String rootClassification.
• Long rootClassificationId.
• String sectionName.
• Long specId.
• String type.
• String unitOfMeasure.
• Long unitOfMeasureType.
• String value.

HierarchyObjectType

Return.

• Boolean rootOfHierarchy.
• HierarchyObjectType children.

IntegrationRecord

Submit.

• Int moduleId. Required for submission.
• Long objectTypeId. Required for submission.
• String objectTypeName. Required for submission.
• Long guiId. Required to save particular GUI. If the value of guiId is set to -1, the default GUI for the ObjectType specified is used.
• Long ID. Required for update. If the value of ID is set to -1, the record is created.
• Long parentId. ParentId or ObjectPath is required for hierarchies to save this object in the correct path.
• Long projectId. Required to save and update the records in a project. If the value of projectId is set to -1, the scope is set to company level.
• String name. Optional to identify the record by the published name.
• String objectPath. ParentId or ObjectPath is required for hierarchies in order to save this object in the correct path.
• String actionName. Required action to take on the record. Must be a valid action for the record’s current state. If no action occurs and the record is not new, the record by default saves the data that is entered if a valid save action exists for the record’s current state and if the action is present on the form. You can enter a comma-delimited string of sequential actions to take if the object is not changed to a new state. To facilitate loading historical data, you can bypass transitions by adding the word “bypass” to the wanted state. For example, to place a newly loaded record into a retired state, set actionName to “bypass triRetired”. This feature bypasses any transition checks but enforces that the state does exist for the record at some point in its state tree. The entered value is a state (a final destination), not a transition.
• String key. Optional to identify this record in the returned ResponseHelperHeader. If it is not set, a unique number is assigned.
• IntegrationSection[] sections. Required to set at least one section object.

IntegrationSection

Submit.

• String type. Optional. The default value is either “DEFAULT”, “ADD” or “FIND”. “ADD” sections are also known as embedded sections. A “FIND” section is known as a smart section.
• String name. Required. The data section name of the section.
• IntegrationField[] fields. If the section type is “DEFAULT”, there is at least one IntegrationField set.
• IntegrationRows[] rows. If the section type is “ADD” or “FIND”, there is at least one IntegrationRow set.

The following section is an example of an ADD section type.

<dto:IntegrationSection>
	<dto:name>triGroupsDetails</dto:name>
	<dto:rows>
		<dto:IntegrationRows>
			<dto:action>Append</dto:action>
			<dto:fields>
				<dto:IntegrationField>
					<dto:name>User Group</dto:name>
					<dto:value>Admin Group</dto:value>
				</dto:IntegrationField>
			</dto:fields>
		</dto:IntegrationRows>
	</dto:rows>
	<dto:type>Add</dto:type>
</dto:IntegrationSection>

The following section is an example of a FIND section type.

<dto:IntegrationSection>
	<dto:name>triManagedBy</dto:name>
	<dto:rows>
		<dto:IntegrationRows>
			<dto:action>Append</dto:action>
			<dto:recordId>12345</dto:recordId>
			<dto:rowIndex>0</dto:rowIndex>
		</dto:IntegrationRows>
	</dto:rows>
	<dto:type>Find</dto:type>
</dto:IntegrationSection>

IntegrationRows

Submit.

• Int rowIndex. Optional. Used to track the order of your rows.
• Long recordId. If the section type is set to “FIND”, this parameter is required to know which record to associate. If the section type is set to “ADD”, this parameter is not required.
• String action. Optional, by default is set to “APPEND”, which modifies the record. The value of this parameter can also be set to “DELETE”, which removes the record.
• IntegrationField[] fields. Only required if the section type is set to “ADD”. If the section type is set to “FIND”, this parameter is not required.

The following section is an example of a single-record smart section that is populated.

</dto:IntegrationSection>
<!--reports to -->
<dto:IntegrationSection>
	<!--Optional: -->
	<dto:name>triPeopleReportsTo</dto:name>
	<!--Optional: -->
	<dto:rows>
		<!--Zero or more repetitions: -->
		<dto:IntegrationRows>
			<dto:action>Append</dto:action>
			<!--Optional: -->
			<dto:recordId>12776874</dto:recordId>
			<!--Optional: -->
			dto:rowIndex>1</dto:rowIndex>
		</dto:IntegrationRows>
	</dto:rows>
	<!--Optional: -->
	<dto:type>FIND</dto:type>
</dto:IntegrationSection>

IntegrationField

Submit.

• String name.
• String value.

Module

Return.

• Long ID.
• String name.

ListType

Return.

• Long id.
• Boolean system.
• String language.
• String product.
• String type.
• String name.
• String description.
• String label.
• Int sourceType.
• Long sourceClassId.
• Long sourceObjectTypeId.
• Boolean dependentList.
• String parentProduct.
• Long parentId.

ListItem

Return.

• Long ID.
• String value.
• Long languageId.
• Long sequenceNumber.

ObjectType

Return.

• Int moduleId.
• String displayName.
• String description.
• Int type.
• Boolean hasCalendar.
• Boolean auditActions.
• Boolean auditAccess.
• Boolean auditDataChanges.
• Boolean requireExplanation.
• Boolean showSingleTab.
• Boolean approvalHistory.
• Long createdById.
• Section[] sections.

ObjectTypeAction

Return.

• Long moduleId.
• Long objectTypeId.
• Long guiId.
• Long recordId.
• ObjectTypeActionStep[] boActionSteps.

ObjectTypeActionStep

Return.

• String action.
• String label.
• long actionId.
• ObjectTypeActionStep[] objectTypeActionSteps.

BaseObjectType

Return.

• Long ID.
• String name.

ResponseHelperHeader

Return.

• Boolean isAnyFailed. Returns a value of true if any of the records in the request fail. Returns a value of ‘false’ if none of the records in the request have failed.
• Int total. The total number of record results returned by the request.
• Int failed. The number of records that returned a failed response.
• Int successful. The number of records that returned a successful response.
• ResponseHelper[] responseHelpers. An array of responseHelpers containing the result of each record returned in the request.

ResponseHelper

Return.

• Object name – Returns the published name of the record result from the request.
• Object value – Used to display errors returned from a failed request. In some contexts ‘value’ can also contain data pertinent to the request. If no errors occur and no data is returned with the given request type, the value remains empty.
• Object key – The key specified in the request that corresponds to this record result.
• Long recordId – The record ID of this result.
• String status – The status of the request for this record result. The possible values for this parameter are “Successful” or “Error”.

Project

Return.

• Long ID.
• String name.

Record

Return.

• Int moduleId.
• Long objectTypeId.
• String objectTypeName.
• Long guiId.
• String guiName.
• Long ID.
• Long parentId.
• String description.
• String name.
• String currentState.
• String objectPath.

QueryResult

Return.

• ContinuationToken continuationToken.
• Int totalResults.
• QueryResponseHelper[] queryResponseHelpers.

QueryResponseHelper

Return.

• String recordId.
• String boId.
• String assocId.
• String assocBoId.
• QueryResponseColumn[] queryResponseColumns.

QueryResponseColumn

Return.

• Int index.
• String name.
• String label.
• String section.
• String value.
• String uom.
• String displayValue.

ContinuationToken

Return.

String tokenString.

DisplayLabel

Submit.

• String sectionName.
• String fieldname.
• String label. The optional label of the column you want to appear in the results.

FieldSortOrder

Submit.

• String sectionName.
• String fieldname.
• String fieldLabel. The optional label of the column you want to appear in the results.
• Int dataType. Required to determine the sort order. A string value sorts differently than a number value. If you are using a Java client, static constants are in the filter class. The following are options for the value of the dataType parameter.
  • String – 320.
  • Number – 310.
  • Date -330.
  • DateTime – 335.

Filter

Submit.

• String sectionName.
• String fieldname.
• Int operator. Required to know the purpose of the filter. Constants are in this file. The following are options for the value of the operator parameter.
  • After - 21.
  • Before - 20.
  • Contains - 16.
  • Contains (case-sensitive) - 32.
  • Does not contain - 35.
  • Does not contain (case-sensitive) - 34.
  • End with - 31.
  • End with (case-sensitive) - 18.
  • Equals - 10.
  • In - 22.
  • Less than - 12.
  • Less than or equals - 13.
  • More than - 14.
  • More than or equals - 15.
  • Not equals - 11.
  • Not In - 23.
  • Start with - 30.
  • Start with (case-sensitive) - 17.
• Int dataType – Required to determine how the operator type functions. If you are using a java client, static constants are included in this class. The following are options for the value of the dataType parameter.
  • • String – 320.
    • Number – 310.
    • Date -330.
    • DateTime – 335.
• String value – Required to determine the value you want to filter against.

AssociationFilter

Submit.

• String associationName. Required name of the association you want to filter against.
• Int moduleId. Required ID of the module of the associated object.
• Long objectTypeId. Required ID of the object type of the associated object.
• String associationPath. Optional path of the object for use with hierarchies.
• String runTimeData. Comma-delimited IDs of the record you want to filter from.

TriggerActions

Submit.

• Long recordId. Required ID of the record to trigger the action against.
• String actionName. Required valid action name to call against the specified record ID.

HttpSession

Return.

• Long id. The ID of the logged in user.
• String token. The session token for the logged in user.

Transition

Return.

• String action.
• long actionId.
• String actionSequence. The order of the action for a state.
• String label.
• String nextState. The next state that the record will go to when the action is called.
• SubAction[] subActions. An array of SubAction objects.

SubAction

Return.

• String action.
• Long actionId.
• String label.

State

Submit and return.

• String state. The current state of the record.
• Long recordId.
• Transition[] trans. An array of Transition objects.