TopicsServiceContext value object

Most tasks have a TopicsServiceContext value object passed as a parameter.

This value object contains context information to process a request. The username field is required. For any task that is specific to a topic workflow configuration, the twcId field is required. You can also set optional parameters.

Table 3–1 TopicsServiceContext optional parameters

Field name		Parameter type	Description
applicationName		Input	Name of your proprietary application. This field is appended to the source metadata for an attachment. For example, if the AttachmentInput.source field is specified as Results, the source is modified to be Results - My Application Name. When viewing attachments in Oracle Empirica Topics, this field enables a user to distinguish attachments from a variety of applications.
applicationInstance		Input	Reserved for future use.
version		Input	Version of the Oracle Empirica Topics API that you are using. Oracle Empirica Signal Release 2025.4.01 contains version 5 of the Oracle Empirica Topics API, as described in this document. If your Oracle Empirica Topics API version is greater than the Oracle Empirica Topics server version, a TopicsServiceException is thrown.
sortOrder		Input	List of columns on which to sort data and the sort order for each column. This field applies to only the getFieldValues task and is ignored for any other tasks. If this field is not specified, a default sort order is used. fieldType is one of: STRING, DATE, INTEGER, LONG, FLOAT, PROJECT, STATE, ACTION_TYPE order is one of: SORT_ASC, SORT_DESC
filter		Input	List of columns on which to filter data and the filter value to match on. This field applies to only the getFieldValues task and is ignored for any other tasks. If this field is not specified, the data is returned without any filtering. Numbers and dates should be converted to strings. Dates use mm/dd/yyyy format.
startRow		Input	Start row from which to begin retrieving data. If this field is not specified, the default value is 1.
chunkSize		Input	Maximum number of rows returned by the service on any applicable calls. Use this field to page large amounts of data rather than returning everything in one call. If this field is not specified, the default value is 500 rows. The fields chunkSize and startRow apply to the getTopicContexts, getActionContexts , getFieldValues, getWorkteamContexts, and getProjects tasks. These fields are ignored for other tasks.
nameContainsFilter		Input	Case-insensitive wildcard filter for topic names. This field applies only to the getTopicContexts task and is ignored for any other tasks. If specified, this field filters the results to topic names that contain this text.
version		Output	Version of the Oracle Empirica Topics server.
maxRows		Output	Maximum number of rows for a table attachment when attaching a TABLE attachment type. This value is determined by a site option, Max number of rows per table allowed in topic attachments, defined on the Oracle Empirica Topics server. You can also get this property from the getTopicsServiceProperties task.
numRows		Output	Number of rows that were retrieved by the task. This field is less than or equal to the chunk size.
totalRows		Output	Total number of rows available for the task. You can use this value to display the total number of pages of the result based on the chunk size. This field applies to the getTopicContexts, getActionContexts, getTopicTemplateContexts, getWorkteamContexts, getFieldMetadata, and getFieldValues tasks.

TopicServiceContext JSON :

{
  "applicationName": "string",
  "applicationInstance": "string",
  "version": "integer",
  "username": "string",
  “twcId”: “number”,
  "maxRows": "integer",
  "startRow": "integer",
  "chunkSize": "integer",
  "numRows": "integer",
  "totalRows": "integer",
  "sortOrder": [
    {
       TopicsSortOrder object 
    }
  ],
  "filter": [
    { 
       TopicsFilter object 
    }
  ],
  "nameContainsFilter": "string"
}