Get List of Tag History

Retrieves a list of tags assigned to an entity based on the TagEntityTypeId and a list of one or more TagEntityIds. The output includes each tag's details.

Query String Parameters

Name	Type	Description	Required
Action	String	TagHistory	Required
TagEntityTypeId	Int	The ID representing the type of entity whose tag history is being requested.	Optional
TagEntityIds	Int	A comma-separated list of entity IDs whose tag history you want to retrieve.	Optional
ChangeReturn	Bool	When set to 1 (true), returns an empty list if no tags are found instead of an error message. The default is 0 (false).	Optional

Response Codes

Code	Message	Information
0	Response Data	See 'Response' example tab
2	Missing Parameter or Invalid Format - TagEntityTypeId	Integer value is invalid or was not specified (when required)
2	Invalid TagEntityTypeId	Integer value is invalid or was not specified (when required)
2	Missing Parameter - TagEntityIds	Integer value is invalid or was not specified (when required)
2	Invalid Format - TagEntityIds	Integer value is invalid or was not specified (when required)
2	No Tag History Found	No data returned or set-up in BigChange when using `ChangeReturn=0`

Example

Request

Request URL

https://webservice.bigchange.com/v01/services.ashx?action=taghistory

Response

Response Data

{
  "Code": 0,
  "Result": [
    {
      "TagColor": "Red",
      "TagHistoryComment": "Initial setup",
      "TagHistoryDate": "2024-08-30 10:15:32",
      "TagHistoryEntityId": 123456789,
      "TagHistoryOwnerId": 25100,
      "TagHistoryId": 62260001,
      "TagName": "Monthly inspection"
    },
    {
      "TagColor": "Blue",
      "TagHistoryComment": "Updated color",
      "TagHistoryDate": "2024-09-01 14:22:11",
      "TagHistoryEntityId": 987654321,
      "TagHistoryOwnerId": 25145,
      "TagHistoryId": 62260002,
      "TagName": "Annual audit"
    },
    {
      "TagColor": "Green",
      "TagHistoryComment": "",
      "TagHistoryDate": "2024-09-02 09:30:45",
      "TagHistoryEntityId": 192837465,
      "TagHistoryOwnerId": 25193,
      "TagHistoryId": 62260003,
      "TagName": "Quarterly review"
    },
    {
      "TagColor": "Yellow",
      "TagHistoryComment": "Reassigned to new owner",
      "TagHistoryDate": "2024-09-02 16:55:55",
      "TagHistoryEntityId": 127596563,
      "TagHistoryOwnerId": 25250,
      "TagHistoryId": 62260004,
      "TagName": "6 weekly window clean"
    },
    {
      "TagColor": "Purple",
      "TagHistoryComment": "Tag removed and re-added",
      "TagHistoryDate": "2024-09-03 12:45:30",
      "TagHistoryEntityId": 246813579,
      "TagHistoryOwnerId": 25267,
      "TagHistoryId": 62260005,
      "TagName": "Equipment maintenance"
    }
  ]
}