Share via


FullTextSearchKnowledgeArticleRequest.StateCode Property

Definition

Gets or sets the state of the knowledge articles to filter the search results. Required.

public:
 property int StateCode { int get(); void set(int value); };
public int StateCode { get; set; }
member this.StateCode : int with get, set
Public Property StateCode As Integer

Property Value

The state code of the knowledge articles to be searched.

Remarks

Use this parameter to restrict the knowledge article search by state. If you do not want to filter on any state value, specify a negative value for this parameter, say -1.

You can use the following state code values to filter your results:

  • 0: Draft

  • 1: Approved

  • 2: Scheduled

  • 3: Published

  • 4: Expired

  • 5: Archived

  • 6: Discarded

Notes for the caller

Some of the filtering is done post-search from the full-text index, which depends on the values specified for the StateCode and RemoveDuplicates parameters. The rules based on StateCode and RemoveDuplicate parameters are:

StateCode

RemoveDuplicates

Search result

Applies to