Get All Standard Comments

Gets the standard comments available in the system.

Resource Information

Scopesettings

Deprecated scope name:   get_settings_standard_comments

App TypeAgency
Authorization TypeAccess token
URI /v4/settings/comments?groups={groups}&lang={lang}&offset={offset}&limit={limit}
HTTP MethodGET
Automation Version(s)7.3.2

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
groupsstringNoThe group names of entities or records7.3.2
langStringNoIndicates the language applied.7.3.2
limitlongNoIndicates the number of items that are returned in each page.7.3.2
offsetlongNoIndicates the offset start of each page by the number specified.7.3.2

Response Information

FieldTypeDescriptionAutomation Version
result[]result{}7.3.2
result.commentsstringComments or notes about the current context.7.3.2
result.groupresult.group{}The name of the standard comments group.7.3.2
result.group.textstringThe localized display text.7.3.2
result.group.valuestringThe value for the specified parameter.7.3.2
result.textstringThe localized display text.7.3.2
result.typeresult.type{}The standard comment type.7.3.2
result.type.textstringThe localized display text.7.3.2
result.type.valuestringThe value for the specified parameter.7.3.2
result.valuestringThe value for the specified parameter.7.3.2
statusintegerThe record status.7.3.3