2.2.4.20 Keyword

  • Article

Namespace: http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration

The Keyword complex type contains information about a keyword.

 <xs:complexType name="Keyword">
   <xs:sequence>
     <xs:element minOccurs="0" name="contact" nillable="true" type="xs:string"/>
     <xs:element minOccurs="0" name="definition" nillable="true" type="xs:string"/>
     <xs:element minOccurs="0" name="endDate" type="xs:dateTime"/>
     <xs:element minOccurs="0" name="id" type="xs:int"/>
     <xs:element minOccurs="0" name="reviewDate" type="xs:dateTime"/>
     <xs:element minOccurs="0" name="startDate" type="xs:dateTime"/>
     <xs:element minOccurs="0" name="term" nillable="true" type="xs:string"/>
   </xs:sequence>
 </xs:complexType>

contact: Specifies the contact user name for the keyword. This value MUST be a string with length not more than 50 characters or it MUST be NULL.

definition: The definition of the keyword, which is shown in search results. This value MAY not be present, otherwise it MUST be a string with length not more than 500 characters.

endDate:  Specifies the date and time, in UTC format, as defined in [RFC3339], when the keyword stops appearing in search results. This value MAY not be present, in which case the keyword never stops appearing on search results.

id:  Specifies the unique identifier of the keyword. When the Keyword object represents a keyword defined in the protocol server, this value MUST be present and MUST be non-negative.

reviewDate: The date and time, in UTC format, as defined in [RFC3339], when the keyword is expected to be reviewed. This value MAY be not be present, in which case there’s no expected review date for the keyword.

startDate: The date and time, in UTC format, as defined in [RFC3339], when the keyword begins to appear in search results. This value MUST be present.

term: The search term for this keyword. This value MUST be present and MUST be a string with length greater than 0 and not more than 100 characters.