API summary

The API includes topic service tasks 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 permissions.

Table 3-1 summarizes the Topics service tasks.

Note:

All endpoints are POST tasks, except for getProperties, which is a GET.

Operation	Task Name	Description	Path (BaseURL +)	Input	Response
Get a list of topics	getTopicContexts	Retrieves topic names and IDs.	/topics @QueryParam: findTopicId	TopicsServiceContext	TopicContexts
Get a list of actions	getActionContexts	Retrieves action names and IDs for a topic, for which user can add an attachment.	/actions @QueryParam: topicId	TopicsServiceContext	ActionContexts
Get a list of work teams	getWorkteamContexts	Retrieves work team names and IDs.	/workteams	TopicsServiceContext	WorkteamContexts
Get a list of topic templates	getTopicTemplateContexts	Retrieves topic template names and IDs.	/topictemplates	TopicsServiceContext	TopicTemplateContexts
Attach to an existing topic	attachTopic	Creates an attachment to an existing topic.	/topic/attach	{TopicsServiceContext	Empty (status only)
Attach to a new topic	attachNewTopic	Creates an attachment to a new topic. Creates a topic without an attachment.	/topic/attachnew	{TopicsServiceContext, TopicInput, AttachmentInput}	TopicResult
Attach to an action	attachAction	Creates an attachment to an existing action.	/action/attach	{TopicsServiceContext, ActionContext, AttachmentInput}	Empty (status only)
Attach to a new action	attachNewAction	Create the action, and optional attachment, added to existing topic.	/action/attachnew	/file @QueryParam: guid	Empty
Stream a file	streamFileAttachment	Create a temporary file.	/file @QueryParam: guid	BINARY_INPUT_STREAM	Empty
Get field metadata	getFieldMetadata	Retrieves field properties for topics, topic templates, or work teams.	/{context}/field Where context is a Field Context value Where context is a Field Context value {topics, topicTemplates, workteams, actions}	TopicsServiceContext	FieldMetadata
Get field values	getFieldValues	Retrieves field values for topics, topic templates, or work teams.	/{context}/value Where context is a Field Context value {topics, topicTemplates, workteams, actions}	TopicsServiceContext	FieldValues
Get filters	getFilters	Retrieves fields defined as filters and their values for topics, topic templates, workteams or actions.	/{context}/filter Where context is a Field Context value {topics, TopicTemplates, Workteams, actions}	TopicsServiceContext	Filters
Get a list of projects	getProjects	Retrieves projects used by the user's topics.	/project	TopicsServiceContext	ProjectList
Get a list of action types	getActionTypes	Retrieves Active Action Types visible to the user.	/actionTypes	TopicsServiceContext	ActionTypeContexts
Get user info	getUserInfo	Retrieves topic permissions for the user; for example, can the user save to a topic.	/user	TopicsServiceContext	TopicsUserInfo
Get topics service properties	getTopicsServiceProperties	Retrieves the Oracle Empirica Topics service version and other service properties.	/props	[None]	TopicsServiceProperties
Get a list of topic workflow configurations (TWCs)	getTopicConfigs	Retrieves a list of TWCs available to the user.	/twc	TopicsServiceContext	TopicConfigContexts