Application Calls

This section describes the Application Web service calls that are available in SBM. These calls represent the Web service operations that are invoked from a client and performed on the SBM Application Engine Web Server. The calls receive one or more arguments from the client, perform an operation on the server, and return an XML response to the client when applicable.

The following table lists all supported calls in alphabetical order, followed by a brief description of each operation. Select a call to view detailed information including:

List of Application Calls

Call

Description

CreateAuxItem

This service creates a single auxiliary item within the same table.

CreateAuxItems

This service creates multiple auxiliary items within the same table.

CreateFileAttachment

This service creates a new file attachment associated with an item.

CreateNoteAttachment

This service creates a new note on an existing item.

CreatePrimaryItem

This service submits a single primary item within the specified project.

CreatePrimaryItems

This service submits multiple primary items within the same project using the data supplied.

DeleteAttachment

This service deletes an existing attachment, which can be a note, item link, URL attachment, or file attachment.

DeleteItems

This service uses the delete transition to delete multiple items.

DeleteItemsByQuery

This service deletes all the items that match the specified where clause.

GetApplications

This service returns a list of available applications.

GetAvailableSubmitTransitions

This service returns all submit transitions for the specified project.

GetAvailableTransitions

This service returns a list of available transitions for the specified item.

GetFieldSelections

This service returns the full list of available selections for Single Selection, Multi-Selection, and Binary/Trinary fields.

GetFileAttachment

This service gets an existing file attachment.

GetFileField

This service returns a list of files from a specified File field on an item.

GetGroupMembers

This services returns a list of users who are members of one or more specified groups.

GetItem

This service returns a single item, given the table ID and internal item ID.

GetItems

This service returns one or more items, given the table ID and internal item ID for each item.

GetItemsByQuery

This service returns multiple items found using a where clause and an order by clause to determine the set of items returned.

GetItemsChangeHistory

This service returns a range of change history for a primary or auxiliary item.

GetNoteLoggerInfo

This service returns the e-mail address of the E-mail Recorder feature.

GetReports

This service returns a list of reports within a specified range, limited by one or more optional filters.

GetSolutions

This service returns a list of solutions that can be accessed by the user.

GetStateChangeHistory

This service returns a specified range of state change history for an item.

GetSubmitProjects

This service returns a list of projects into which the user can submit items.

GetTables

This service returns a list of tables optionally filtered by solution or table type.

GetURLField

his service returns a list of URLs from a specified URL field on an item.

GetUsers

This service returns one or more user records.

GetVersion

This service returns the SBM version number.

GetWorkflows

This service returns data about the graphical workflow diagram.

IsUserValid

This service determines whether a specified user is valid or not.

LinkSubtask

This service links one item to another to create a subtask relationship.

Logout

This service releases any licenses and resources associated with the session.

RunModScript

This service executes a specified ModScript.

RunReport

This service runs a specified Listing report, given the proper privileges.

RunReportXml

This service runs a specified report, given the proper privileges.

UpdateFileAttachment

This service updates an existing file attachment for a specified item.

UpdateFileField

This service updates a specified File field on an item using a specified transition.

UpdateURLField

This service updates a specified URL field on an item using a specified transition.

TransitionItem

This service transitions an existing item using a specified transition.

TransitionItems

This service transitions one or more existing items using a specified transition.