New Endpoint: Manipulating Tracked Changes in Documents
ReportingCloud adds API endpoints for manipulating tracked changes in documents. The trackedchanges endpoint retrieves metadata including change type, timestamp, and highlight color. A companion endpoint accepts or rejects individual changes by their identifier in the document.
We just rolled out a new set of endpoints to retrieve and manipulate MS Word compatible tracked changes in a document. Track changes is very helpful when working on the same document with multiple authors specifically with legal or healthcare documents where changes need to be tracked and safely logged.
The following endpoint processing/review/trackedchanges returns all tracked changes in a document that will be uploaded with the POST request:
https://api.reporting.cloud/v1/processing/review/trackedchanges
The following return object contains information about the tracked changes:
TrackedChange
| Key | Value Type | Description |
|---|---|---|
| changeKind | ChangeKind | Gets the kind of the tracked change. Possible values: 4096 (InsertedText), 8192 (DeletedText). |
| changeTime | DateTime | Gets the time stamp of the tracked change. |
| defaultHighlightColor | String | Gets the default highlight color of tracked changes. |
| highlightColor | String | Gets the highlight color of the tracked change. |
| highlightMode | HighlightMode | Gets the highlight mode of the tracked change. Possible values: 1 (Never), 2 (Activated), 3 (Always). |
| length | int | Gets the length of the change. |
| start | int | Gets the start index of the change in the document. |
| id | int | Gets the unique id of the tracked change that can be used to remove the tracked change. |
| text | String | Gets the text of the tracked change. |
| userName | String | Gets the user name of the author for that tracked change. |
We introduced the complete new namespace Processing. This namespace will host all endpoints to manipulate a document in future versions of ReportingCloud. The first addition is the namespace Review. The second new endpoint method is processing/review/removetrackedchange in this namespace:
https://api.reporting.cloud/v1/processing/review/removetrackedchange
By passing the id of the TrackedChange return object, you can accept or reject a tracked change in the document. The return value of this endpoint is the manipulated document with the removed tracked change.
The ReportingCloud .NET SDK and the NuGet package has been updated.
You can read the full API documentation of the new namespace here:
https://docs.reporting.cloud/docs/endpoint/processing
Happy coding!
Reporting
The Text Control Reporting Framework combines powerful reporting features with an easy-to-use, MS Word compatible word processor. Users can create documents and templates using ordinary Microsoft Word skills. The Reporting Framework is included in all .NET based TX Text Control products including ASP.NET, Windows Forms and WPF.
Related Posts
ReportingConferenceReportingCloud
Impressions from Developer Days Magdeburg 2019
Text Control sponsored the sold-out Developer Days Magdeburg 2019, presenting the latest product versions and technologies at its booth. The team raffled off an Xbox One during the closing session…
ReportingConferenceReportingCloud
See Text Control at DEVintersection, Orlando
Text Control exhibits at DEVintersection Spring 2019 in Orlando from June 11 to 13, presenting the upcoming TX Text Control X17 with high DPI support and Visual Studio 2019 compatibility. The…
ReportingConferenceReportingCloud
Impressions from dotnet Cologne 2019
Text Control sponsored the community-driven dotnet Cologne 2019, presenting products across all platforms with branded frisbees and stickers. The sold-out event attracted enthusiastic developers…
ReportingCloud: New MergeSettings property to remove empty lines
The ReportingCloud Web API adds a removeEmptyLines property to MergeSettings that removes blank lines from merged documents when all merge fields on a line are empty. This prevents unwanted gaps…
Creating Templates: Typical Invoice Elements
Building an invoice template with TX Text Control uses JSON data, merge fields, repeating blocks, and Excel-compatible formulas. Line totals, tax, and discounts compute directly in the template…