API summary

The API includes topic service methods that retrieve information about topics or actions, or save to a topic or action.

All input is validated, including checks to verify that a user has permission to save to topic or action. Any data that is retrieved is based on the user's work team permissions and topic workflow configuration.

Table 3-1 summarizes the Topics service methods.

Operation Method Name Description
Get a list of topics getTopicContexts Retrieves topic names and IDs.

Get a list of actions

getActionContexts

Retrieves action names and IDs for a topic.

Get a list of work teams

getWorkteamContexts

Retrieves work team names and IDs.

Get a list of topic templates

getTopicTemplateContexts

Retrieves topic template names and IDs.

Attach to an existing topic

attachTopic

Creates an attachment to an existing topic.

Attach to a new topic

attachNewTopic

Creates an attachment to a new topic.

Attach to an action

attachAction

Creates an attachment to an existing action.

Get field metadata

getFieldMetadata

Retrieves field properties for topics, topic templates, or work teams.

Get field values

getFieldValues

Retrieves field values for topics, topic templates, or work teams.

Get filters

getFilters

Retrieves fields defined as filters and their values for topics, topic templates, or work teams.

Get a list of projects

getProjects

Retrieves projects used by the user's topics.

Get user info

getUserInfo

Retrieves topic permissions for the user such as, can the user save to a topic.

Get service properties

getTopicsServiceProperties

Retrieves the Oracle Empirica Topics service version and other service properties. This can be used to determine whether the Oracle Empirica Topics service is available and is (or has) a version compatible with your version of the API.