/site/group/history | Documentation

API call to get history of site group changes.

The user must be authenticated and have read permissions to the site group.

Request

The request object has the following fields:

Name	Type	Required	Description
siteGroupId	String	Yes	Identifier for the site group.

Response

The response object for a successful query has the following fields:

Name	Type	Description
`time`	Long	The site group modification time in format of unix timestamp
`username`	String	Name of user who did site group modification
`changes`	Array of Object	List of specified site group modification

Change object has the following fields:

Name	Type	Description
`type`	String	Type of change (`NAME`, `DESCRIPTION`, `PREFIX`, `ANNOTATIONS`, `COMPOSER_SEGMENTS_LIMIT`, `COMPOSER_CONTEXTUAL_SEGMENTS_LIMIT`, `USE_STANDARD_TAXONOMY`, `COMPOSER_APPLICATION_ID`, `UNSTRUCTURED_DICTIONARY_IDS`, `PARSING_SCRIPT_IDS`, `QUERY_DICTIONARY_IDS`, `SEARCH_SYNONYM_DICTIONARY_IDS`, `TYPE`)
`oldValue`	String	The value of site group field before change
`newValue`	String	The value of site group field after change

Examples

Bash

$ python cx.py /site/group/history '{"siteGroupId":"9222300742653756873"}'
{
 "changes": [
 {
 "time": 1635926573835, 
 "username": "exampleUser@example.com", 
 "changes": [
 {
 "type": "NAME", 
 "oldValue": "Old name", 
 "newValue": "New name"
 }
 ]
 }, 
 {
 "time": 1636026573264, 
 "username": "anotherExampleUser@example.com", 
 "changes": [
 {
 "type": "DESCRIPTION", 
 "oldValue": "Old description", 
 "newValue": "New description"
 }
 ]
 }
 ]
}

Last updated: March 12, 2024