[IMPLEMENTED] Query Content previous version by API

Jay_Miao · December 8, 2021, 2:07pm

I went through the discussion on Squidex Content versioning. How to query content history data via API. We want to show user the changes between old and new on our web site, but not want to expose Squidex to the users.

Sebastian · December 8, 2021, 2:15pm

In general you can make the same API calls as the Squidex frontend.

So you can use the history endpoint to retrieve a history of all changes, e.g.

GET https://cloud.squidex.io/api/apps/<APP_NAME>/history?channel=schemas.<SCHEMA_NAME>.contents.<CONTENT_ID>

and then use the content id and the version you want to get the content:

https://cloud.squidex.io/api/content/<APP_NAME>/<SCHEMA_NAME>/<CONTENT_ID>/<CONTENT_VERSION>

Jay_Miao · December 8, 2021, 2:55pm

Thanks very much for your quick response. I will test them.

Jay_Miao · December 8, 2021, 8:31pm

I am still not successful yet to use your syntax in ClientLibrary. Can you recommend a way on how to hook this up in C#, or do you have any sample? I don’t see a version option in ClientOptions. Thanks

Sebastian · December 9, 2021, 6:53am

You are right. It is missing there. Going to add it.

Sebastian · December 9, 2021, 1:56pm

I have added it to Squidex.ClientLibrary 7.6.0, it is not tested yet, because I have to add it to the API tests now.

Jay_Miao · December 9, 2021, 2:11pm

Sebastian, Thanks very much. This is great and very responsive. Just confirm the spec for enhancement: a new ClientOption property call Version is to be added. The value is int.

if this option is empty, then the latest version is returned
if this option is value version, then that version’s content is returned
if the version value is not existing, then nothing will be return.

Sebastian · December 9, 2021, 2:12pm

It is just a new method:

github.com

Squidex/squidex-samples/blob/master/csharp/Squidex.ClientLibrary/Squidex.ClientLibrary/IContentsClient.cs#L327


/// </summary>
/// <param name="id">The ID of the content item. Cannot be null or empty.</param>
/// <param name="version">The version of the content.</param>
/// <param name="context">The context object to add additonal headers to the request and change the behavior of the API when querying content items.</param>
/// <param name="ct">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
/// <returns>
/// The content item or null if not found.
/// </returns>
/// <exception cref="ArgumentNullException"><paramref name="id"/> is null.</exception>
/// <exception cref="ArgumentException"><paramref name="id"/> is empty.</exception>
Task<TEntity> GetAsync(string id, int version, QueryContext context = null, CancellationToken ct = default);

/// <summary>
/// Query content items by an optional query.
/// </summary>
/// <param name="query">The optional query.</param>
/// <param name="context">The context object to add additonal headers to the request and change the behavior of the API when querying content items.</param>
/// <param name="ct">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
/// <returns>
/// The matching content items.
/// </returns>

Sebastian · December 9, 2021, 2:38pm

I have seen a problem there because the endpoint only returns the data of the content. I will update the client library.

Jay_Miao · December 9, 2021, 2:53pm

Is it version param optional? Is my understanding correct if the version param is not set, then the latest version of content is returned?

Sebastian · December 9, 2021, 3:07pm

No, it is not optional. But you get the version from the normal content endpoint.

For example I just added a test: https://github.com/Squidex/squidex/pull/807/files#diff-54e5fe47060062c76fd2d03f6a0718f6f7b8fa3465b7ef4e0822489ae881cde4

Jay_Miao · December 9, 2021, 4:19pm

Good design. Looking forward to the release date of 7.6.0

Sebastian · December 9, 2021, 4:26pm

It is released since a while

Jay_Miao · December 9, 2021, 8:13pm

Hi Sebastian, I got version 7.7.0 and works exactly as I expected per your code sample
You are super. Many thanks for your lightning speed release!!

Jay

system · December 11, 2021, 4:11pm

This topic was automatically closed after 2 days. New replies are no longer allowed.