Request Information

URI Parameters

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
siteid globally unique identifier Required

Guid ID of the site.

Body Parameters


Response Information

Resource Description (Keyword)

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
ID integer Required

ID of the given keyword.

Phrase string Required

Custom phrase of the given keyword. (Max length 200 characters)

Plural string Required

Custom plural value of the given keyword. (Max length 200 characters)

Category byte ReadOnly

Category of the given keyword.

CategoryName string ReadOnly

Category name of the given keyword.

Type integer ReadOnly

Row type of the object for the given keyword.

DefaultPhrase string ReadOnly

Default phrase of the given keyword.

DefaultPlural string ReadOnly

Default plural value of the given keyword.

Description string ReadOnly

Description of the given keyword.

DefaultDisplay string ReadOnly

Default display of the given keyword.

Response Formats

application/xml, text/xml

<Keyword xmlns:i="" xmlns="">
  <Phrase>sample string 1</Phrase>
  <Plural>sample string 2</Plural>
  <CategoryName>sample string 3</CategoryName>
  <DefaultPhrase>sample string 4</DefaultPhrase>
  <DefaultPlural>sample string 5</DefaultPlural>
  <Description>sample string 6</Description>
  <DefaultDisplay>sample string 7</DefaultDisplay>

application/json, text/json

  "ID": 1,
  "Phrase": "sample string 1",
  "Plural": "sample string 2",
  "Category": 64,
  "CategoryName": "sample string 3",
  "Type": 1,
  "DefaultPhrase": "sample string 4",
  "DefaultPlural": "sample string 5",
  "Description": "sample string 6",
  "DefaultDisplay": "sample string 7"