Web service methods

The following methods are available in the Connector for Business Applications web service.

acceptActionItems
Accepts the action items as belonging to the currently authenticated user.
associateRecords
Creates an association between two records. If a reverse association is defined for this forward association, the reverse association is also created.
deassociateRecords
Deletes the specified associations between two records.
deleteCurrencyConversionRates
Deletes specified currency conversion rates. Only future conversion rates can be deleted such as where the start date is greater than the current system time.
getActionItems
Gets the ActionItems in the queue associated with the user ID of the current session.
getAllAssociatedRecords
Gets the records associated with the recordIds.
getApplicationInfo
Gets information about the version of the application and database, and the IBM TRIRIGA connector for business applications.
getAssociatedRecords
Gets the records that are associated with the given record though the given association. This method functions exactly as the getAllAssociatedRecords method, except it only takes one recordID instead of an array.
getAssociationDefinitions
Gets the association definitions that exist for the specified object type.
getAssociationDefinitionsByName
Gets the association definitions that are connected to a specified object type.
getAvailableActions
Retrieves the current state of each object specified in the recordIds array. It also returns all the available state transitions and their subAction information.
getChildren
Gets the records that are children of the record with a specified ID.
getCurrencies
Gets a list of the currencies available in the system.
getCurrencyConversionGroups
Gets a list of all allowed currency conversion groups.
getCurrencyConversionRates
Gets a list of all of the currency conversion rates in the system.
getDefaultGUI
Gets the metadata for the default GUI for a specific record.
getDefaultGUIActions
Gets the default GUI actions for a new record.
getDefaultGuiId
Gets the default GUI ID for the object type.
getDefaultGuiStructure
Gets the default GUI structure for the object type.
getGUI
Gets GUI metadata for a GUI ID and record ID.
getGUIs
Gets the metadata headers of all the GUIs for a particular object type. This lightweight method is useful for making a quick call to retrieve the GUI name or IDs for use with other methods. This method filters out alternative forms that are retrieved. Alternative forms are not returned for selection on the GUI.
getGUIsByName
Gets the metadata headers of all the GUIs for a particular object type. This lightweight method is useful for making a quick call to retrieve the GUI name or ids for use with other methods. This call is identical to the getGUIs method, except it takes in the String names of ObjectType and module instead of the objectTypeId.
getGUIStateTransitions
Retrieve the entire GUI state transition tree for the GUI object.
getHierarchyMetadata
Gets the permissible structure of the hierarchy that can be created from the object types in a hierarchy module. The method specifies which object type must be used to create the record that is the root of the hierarchy and what types of records can appear under each type of record.
getHierarchyMetadataByModuleId
Gets the permissible structure of the hierarchy that can be created from the object types in a hierarchy module. The method specifies which object type must be used to create the record that is the root of the hierarchy and what types of records can appear under each type of record.
getHierarchyMetadataByModuleName
Gets the permissible structure of the hierarchy that can be created from the object types in a hierarchy module. The method specifies which object type must be used to create the record that is the root of the hierarchy and what types of records can appear under each type of record.
getHttpSession
Gets the session information for the logged in user.
getListByTypes
Gets the list types for the object type IDs that are passed in.
getListItems
Gets the possible list values for a list ID.
getModuleId
Gets the record ID for the module.
getModules
Gets the name and ID of all modules.
getNamedQueryType
Gets the type of query. Can be used to determine whether to call runNamedMetricQuery or runNamedQuery.
getObjectType
Gets the object type for an object type ID.
getObjectTypeActions
Gets the available actions for the boId, guiId, and record ID.
getObjectTypeByName
Gets a full object type definition for the object by name.
getObjectTypeId
Gets the record ID for the object type.
getObjectTypeListByModuleId
Get all the base object types for a module by module ID.
getObjectTypeListByModuleName
Gets all of the definitions for a specific module..
getProjectId
Gets the record ID of a project.
getProjects
Gets all of the projects that the user has access to.
getRecordDataHeaders
Gets raw header data for record IDs.
getRecordState
Retrieves the current state for each of the record IDs passed in.
getRequiredGuiFieldNames
Gets the GUI field names that have the read-only attributes set to true.
getRootRecordId
Gets the root record ID for a module.
getTargetRecords
Gets the target records for an object type and section.
getUserLicenses
Gets the licenses for the user that is making the request.
putCurrencyConversionRates
Adds or updates conversion rates. If an added currency conversion rate overlaps a previously added rate, it supersedes the previously added rate. If the ID for the conversion rate is populated, the rate is updated. If the ID is set to a value of -1, a new conversion rate is created.
register
Used with a CustomBusinessConnectTask from the CustomTask object in workflow to register the IBM TRIRIGA Connector for Business Applications client with the active session user.
runDynamicQuery
Runs a query that uses a set of parameters.
runDynamicQueryContinue
Continue to run a query that uses a set of parameters. The query runs each time runDynamicQueryContinue is run. The results might not be as expected if the data is modified between executions of runDynamicQuery and runDynamicQueryContinue or runDynamicQueryContinue and runDynamicQueryContinue.
runNamedMetricQuery
Runs a pre-defined metric query that is stored in the platform in the Report Manager.
runNamedMetricQueryContinue
Retrieves the next batch of records from a metric query where the result size is larger than the maximumResultCount specified in the original call.
runNamedQuery
Runs a pre-defined query that is stored in the platform in the Report Manager.
runNamedQueryContinue
Retrieves the next batch of records from a query where the result size is larger than the maximumResultCount specified in the original call.
runNamedQueryMultiBo
Runs a pre-defined query that is stored in the platform in the Report Manager. This method supports queries that are defined with multiple associated business objects.
runNamedQueryMultiBoContinue
Retrieves the next batch of records from a query where the result size is larger than the maximumResultCount specified in the original call.
runNamedQueryMultiBoLocalized
Runs a pre-defined query that is stored in the platform in the Report Manager. This method supports queries that are defined with multiple associated business objects.
saveRecord
Saves specified records into TRIRIGA.
terminateSession
Used to end a user session.
triggerActions
Triggers the state transition actions on the records that are specified in the TriggerActions Array.

Parent topic: Integrating data with the TRIRIGA Connector for Business Applications