Therefore Web API Programming Interface 1.0

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Printable Version
Save Permalink URL

Therefore Web API > Web API Reference > Operations

GetCategoryInfo

Scroll

REST URL (POST) https://tenant.thereforeonline.com/theservice/v0001/restun/GetCategoryInfo

SOAP Action (POST) http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetCategoryInfo

Returns the definition of Therefore™ category.

Input Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetCategoryInfo

Element Name	Element Type	Restrictions	Description
■ parameters
■ CategoryNo	xs:int	mandatory	Sets the number of the category to get information for.
■ IsAccessMaskNeeded	xs:boolean		Sets to true if the access mask for category and fields should be returned in response.
□ IsSearchFieldOrderNeeded	xs:boolean	nillable	Sets to true if the search usage order for fields should be returned in response.

Output Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetCategoryInfoResponse

Element Name	Element Type	Restrictions	Description
■ parameters
■ AutoAppendMode		restriction enum (xs:string) - DefaultMode (0) - Begin (1) - End (2) - Replace (3) - Disabled (4)	Gets the auto append mode for this category.
■ BelongsToCaseDefinition	xs:int		Gets the unique identifier of the case definition the category belongs to.
□ CategoryFields		nillable	Gets the list of Category fields.
≡ WSCategoryField		list nillable
■ BelongsTo	xs:int		Gets the field number of the TheCategoryField this field belongs to (set for dependent fields only).
■ BelongsToTable	xs:int		Gets the field number of the TheCategoryField this field belongs to (is set for fields which belong to table only).
□ Caption	xs:string	nillable	Gets the caption of the field.
■ CaseSensitive	xs:boolean		Gets information if the field is case sensitive.
□ ColName	xs:string	nillable	Gets the column name of the field in the database.
■ CounterMode		restriction enum (xs:string) - Undefined (0) - ClientCounter (1) - ServerCounter (2)	Gets the counter mode of the TheCategoryField if it is a counter field.
□ DefaultVal	xs:string	nillable	Gets the default value for this field.
■ DependencyMode		restriction enum (xs:string) - Referenced (0) - SynchronizedRedundant (1) - EditableRedundant (2)	Gets the dependency mode of this field.
■ DisplayOrderPos	xs:int		Returns the position of the field inside a table field or the position in the document title.
■ DontLoadValues	xs:boolean		Returns whether choices will be pre-loaded for display (only for keyword and dependent fields).
■ FieldNo	xs:int		Gets the field number of this field.
■ FieldType		restriction enum (xs:string) - StringField (1) - IntField (2) - DateField (3) - LabelField (4) - MoneyField (5) - LogicalField (6) - NumericCounter (8) - TextCounter (9) - TableField (10) - CustomField (99)	Gets the category field type. NOTE: if FieldType value is 'CustomField' check values of IsImageFieldType and IsTabControlFieldType properties to find out type of the field.
□ ForeignCol	xs:string	nillable	Gets the column name of the referenced column in a foreign table (set for dependent fields only).
■ Guid	xs:string	GUID string template: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}	Gets GUID of this field.
■ Height	xs:int		Gets the height of this field in the category dialog.
□ IndexDataFieldName	xs:string	nillable	Gets the name of the index data field.
■ IndexType	xs:int		Gets the index type of the field (no / normal / unique).
■ IsForeignDatatype	xs:boolean		Returns whether the field is a foreign data type.
■ IsMultipleKeyword	xs:boolean		Returns whether the field is a multiple keyword.
■ IsSingleKeyword	xs:boolean		Returns whether the field is a single keyword.
■ KeepRedundant	xs:boolean		Gets information if values from a foreign data type should be copied to the TWC table and kept there redundant.
■ Length	xs:int		Gets the length of the field.
■ Mandatory	xs:boolean		Returns whether or not the field is mandatory and must be filled out before archiving a document or changing the index data.
■ PosX	xs:int		Gets the horizontal position of this field in the category dialog in pixels.
■ PosY	xs:int		Gets the vertical position of this field in the category dialog in pixels.
□ RegularExpr	xs:string	nillable	Gets the regular expression if one has been defined in Solution Designer. Defining regular expressions via the API is not possible.
■ TabOrderPos	xs:int		Gets the tab order position of this field.
■ TypeGroup		restriction enum (xs:string) - StandardTypeGroup (1) - KeywordTypeGroup (2) - UserInt (3) - UserTextAnsi (4) - UserDate (5) - UserFloat (6) - UserTextUnicode (7) - CaseDefinitionTypeGroup (8)	Gets the type group of the field.
□ TypeIndexColumn	xs:string	nillable	Gets the type index column of the field. Additional information for user defined data type (TypeNo > 6).
□ TypeMultiInner	xs:string	nillable	Gets the type multi inner of the field. Additional information for user defined data type (TypeNo > 6).
□ TypeMultiJoin	xs:string	nillable	Gets the type multi join of the field. Additional information for user defined data type (TypeNo > 6).
□ TypeMultiOuter	xs:string	nillable	Gets the type multi outer of the field. Additional information for user defined data type (TypeNo > 6).
■ TypeNo	xs:int		Gets the type number of this field.
□ TypeTableName	xs:string	nillable	Gets the type table name of the field. Additional information for user defined data type (TypeNo > 6).
■ Visible	xs:boolean		Returns whether or not the field is visible in the category dialog.
■ Width	xs:int		Gets the width of this field in the category dialog.
□ WorkflowField	xs:string	nillable	Gets the name of the corresponding Microsoft® Exchange form field (if Microsoft® Exchange workflow is enabled for the category).
■ SelectFromDropDownBox	xs:boolean		Returns whether dropdown box should be used to select value.
□ DisplayProperties		nillable	Gets display properties of this field.
■ BackgroundColor	xs:int		Gets the background color of the field.
■ Bold	xs:boolean		True if the font is formatted as bold.
□ FaceName	xs:string	nillable	Gets the face name.
■ FontSize	xs:int		Gets the font size of the field.
■ HorizontalAlignment		restriction enum (xs:string) - Left (0) - CenterH (1) - Right (2)	Gets the horizontal alignment of the text.
■ Italic	xs:boolean		True if the font is formatted as italic.
■ Padding	xs:int		Gets a value that indicates the thickness of padding space.
■ TextColor	xs:int		Gets the text color of the field.
■ Underlined	xs:boolean		True if the font is formatted as underlined.
■ VerticalAlignment		restriction enum (xs:string) - Top (0) - CenterV (4) - Bottom (8)	Gets the vertical alignment of the text.
□ ImageDocNo	xs:int	nillable	Gets the number of the document image.
■ IsImageFieldType	xs:boolean		Returns whether the field is an image field.
■ IsTabControlFieldType	xs:boolean		Returns whether the field is a tab control field.
■ ParentFieldNo	xs:int		Gets number of parent field (tab control or table field).
■ ShowInTabNo	xs:int		Gets number of tab where current field is shown or 0 (zero).
□ Tabs		nillable	Gets list of tabs if current field is a tab control field.
≡ WSTabInfo		list nillable
■ BackgroundColor	xs:int		Gets background color.
□ Caption	xs:string	nillable	Gets the caption of the tab.
■ Position	xs:int		Gets the position of the tab in the tab control.
■ TabColor	xs:int		Gets the tab color of the tab.
■ TabNo	xs:int		Gets the number of this tab.
■ TextColor	xs:int		Gets the text color of the tab.
■ Visible	xs:boolean		Gets whether or not the tab is visible in the category dialog.
□ Condition	xs:string	nillable	Gets the condition for conditional visibility of the tab.
□ AccessMask		nillable	DEPRECATED: Use the RoleAccessMask property instead. Gets access mask for the field for connected user.
■ Value	xs:unsignedLong		Represents the access mask of the permissions. See also: operation GetPermissionConstants.
■ IsAutoAppendField	xs:boolean		Gets access mask for the field for connected user.
■ IsDateTimeFieldType	xs:boolean		Returns whether the field is a Therefore™ Timestamp (date/time) field.
■ Scale	xs:int		Returns scale for decimal field.
□ RegExSample	xs:string	nillable	Example of a valid data string for the field.
□ FieldID	xs:string	nillable	Gets the field ID of the field.
□ Condition	xs:string	nillable	Gets condition for conditional formating for the field.
□ ConditionalFormatting		nillable	Gets conditional formating specification. Returns null if the condition is empty.
□ BackgroundColorBGR	xs:int	nillable	Gets background color for the field (in BGR color space) or null.
□ BackgroundColorRGB	xs:int	nillable	Gets background color for the field (in RGB color space) or null.
■ FieldNo	xs:int		Gets number of the field.
□ TextColorBGR	xs:int	nillable	Gets text color for the field (in BGR color space) or null.
□ TextColorRGB	xs:int	nillable	Gets text color for the field (in RGB color space) or null.
□ Formula	xs:string	nillable	Gets formula for calculated field.
■ IsCalculationTrigger	xs:boolean		Returns true if data change on the field can trigger a calculation on the index data.
■ IsFormattingTrigger	xs:boolean		Returns true if data change on the field can trigger formatting update for the index data.
□ RoleAccessMask		nillable	Gets role access mask for the field for connected user.
■ Value	xs:unsignedLong		Represents the access mask of the permissions. See also: operation GetRolePermissionConstants.
■ SortDescending	xs:boolean		Gets sort order of the field.
□ Filter		nillable	Gets list of referenced table filters. It can only be set on a primary field. For any other field type the property will be null.
≡ WSFieldFilter		list nillable
□ Condition	xs:string	nillable	Gets or sets filter condition for given field. It contains either an index FieldID (not FieldNo) or a fixed value. Its value is treated as a fixed value when it contains only [0-9] characters or when it is between double quotation marks ("). This index field value or the fixed value will be compared to the value in the ReferencedTableColumn and the non-matching rows will be filtered out.
□ ReferencedTableColumn	xs:string	nillable	Gets or sets referenced table column(field) for the condition. It contains FieldID (not FieldNo) of the referenced index field.
■ ConditionMode		restriction enum (xs:string) - Formatting (0) - Disabled (1) - Mandatory (2)	Gets the condition mode for conditional formatting.
■ IsDependencyTrigger	xs:boolean		Returns true if data change in this field can trigger value change in other fields in the index data. (Due to prim-dep-group membership / calculated field / ref.tab. filtering field.)
■ CategoryNo	xs:int		Gets the number of the current category.
■ CheckInCommentsMode		restriction enum (xs:string) - CommentsDisabled (0) - CommentsAllowed (1) - CommentsMandatory (2)	Gets the Check-in Comments Mode for the current category.
□ Description	xs:string	nillable	Gets the description of the current category.
■ DocumentTitleLength	xs:int		Gets the length of the document title.
■ FieldCount	xs:int		Gets the number of category fields in the current category.
■ FolderNo	xs:int		Gets the number of the folder containing the current category.
■ Guid	xs:string	GUID string template: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}	Gets the GUID of the current category.
■ Height	xs:int		Gets the height of the category dialog.
■ IsFulltextEnabled	xs:boolean		Gets whether or not the full text search on this category is enabled.
□ Name	xs:string	nillable	Gets the name of the category.
■ NewVersionOnIndexDataChange	xs:boolean		Gets if changes on the index data in this category generates a new document version or not.
■ QueryTemplateNo	xs:int		Gets the number of the query template (if one is associated with the current category).
■ SubCtgryFieldIx	xs:int		Gets the sub category field index (if the current category has a sub category field).
□ TableName	xs:string	nillable	Gets the name of the date base table containing the definition for the current category.
□ Title	xs:string	nillable	Gets the title of the current category.
■ Version	xs:int		Gets the version number of the current category.
■ WatermarkDocNo	xs:int		Gets the document number of the watermark image.
■ WatermarkHPos	xs:int		Gets the horizontal position of the watermark image.
■ WatermarkMode	xs:int		Gets the watermark mode.
■ WatermarkResolution	xs:int		Gets the resolution of the watermark image in dots per inch (dpi).
■ WatermarkVPos	xs:int		Gets the vertical position of the watermark image.
■ Width	xs:int		Gets the width of the category dialog.
□ WorkflowFolder	xs:string	nillable	Gets the full path of the Microsoft® Exchange public folder (if Microsoft® Exchange workflow is enabled for the current category).
□ WorkflowForm	xs:string	nillable	Gets the name of the Microsoft® Exchange form (if Microsoft® Exchange workflow is enabled for the current category).
■ WorkflowProcessNo	xs:int		Gets the process number of the associated workflow process (only for Therefore™ integrated workflow). A new workflow instance will be started when a new document has been archived.
■ WorkflowProcessNoUpdate	xs:int		Gets the process number of the associated workflow process (only for Therefore™ integrated workflow). A new workflow instance will be started when a document has been changed.
■ BackgroundColor	xs:int		Gets the background color.
■ CoverMode		restriction enum (xs:string) - NeverShown (0) - OnlyForEmptyDocument (1) - AlwaysShown (2)	Gets the mode of showing a cover sheet for documents for given category.
■ DocumentPreview	xs:boolean		Gets document previews status in the Therefore™ Navigator. True - activated, False - deactivated.
■ EmptyDocMode		restriction enum (xs:string) - EmptyNotAllowed (0) - EmptyAllowed (1) - MustBeEmpty (2)	Determines whether Therefore™ document must containt files, can contain files or may not contain files.
■ FullTextDate	xs:dateTime		Gets the "Exclude Earlier Than" date. Documents saved before this date are excluded from full-text search indexing.
■ FullTextMode		restriction enum (xs:string) - FTModeOff (0) - FTModeAll (1) - FTModeExcludeByDate (2)	Gets the full-text search indexing behavior.
□ AccessMask		nillable	DEPRECATED: Use the RoleAccessMask parameter instead. Gets access mask for given category for connected user.
■ Value	xs:unsignedLong		Represents the access mask of the permissions. See also: operation GetPermissionConstants.
□ FieldNoSearchOrder		nillable	Gets the order of fields used when searching the category
≡ int	xs:int	list
□ RoleAccessMask		nillable	Gets the role access mask for connected user.
■ Value	xs:unsignedLong		Represents the access mask of the permissions. See also: operation GetRolePermissionConstants.
□ AvailableLCIDs		nillable	Gets list of LCIDs of all the translations available for the category.
≡ LCID	xs:int	list
■ CurrentLCID	xs:int		Gets current LCID.
■ SharedLinkDefaultExpiryPeriod	xs:int		Gets the default expiry period for shared links for this category. If it is -1, the global setting is used instead. If it is 0, it means 'No expiry'. This setting is in days.
■ SharedLinkEditRole	xs:int		Gets the shared link edit role for this category. If the role is 0, the global setting is used instead.
■ SharedLinkMandatoryPassword		restriction enum (xs:string) - Default (0) - Enabled (1) - Disabled (2)	Gets the shared link mandatory password option for this category.
■ SharedLinkReadOnlyRole	xs:int		Gets the shared link read only role for this category. If the role is 0, the global setting is used instead.
■ SharedLinkShareOption		restriction enum (xs:string) - Default (0) - Disabled (1) - OrganizationWithoutRights (2) - OrganizationWithRights (3) - Public (4)	Gets the shared link share type option for this category, which sets what share types can be created.
□ DocTitleConfig		nillable	Title configurations for the different use cases.
≡ WSDocTitleConfigEntry		list nillable
□ FieldNos		nillable	Fields included in the title, ordered.
≡ int	xs:int	list
■ HideCtgryName	xs:boolean		True means that category name doesn't appear in the title.
■ MaxLength	xs:int		When the title length exceeds this length then it will be cut off to this length.
■ ShowFieldName	xs:boolean		True means that field names appears in the title.
■ TitleType		restriction enum (xs:string) - Undef (0) - Default (1) - TitleBar (2) - DocumentName (3) - Mobile (4) - Teams (5) - Export (6) - Send (7) - TreeView (8) - RecycleBin (9) - Logs (10)	The use case of the title.

Legend:

■	Not nillable element.
□	Nillable element.
≡	List of elements.
Bold	Mandatory element.