Skip to content

Latest commit

 

History

History
864 lines (545 loc) · 33.9 KB

changelog.md

File metadata and controls

864 lines (545 loc) · 33.9 KB

Any known issues detected on that version are listed in the known issues section.

Release notes

Preview features are treated as a separate branch and will not be included in the official release until the feature is ready. Each preview release lists all the additional features that are enabled.

The format is based on Keep a changelog, and this project does not adheres to Semantic versioning. It will be upgraded when the Agravity Backend is upgraded and will have the same version.

AgravityAPI 8.4.2 (2025-02-02)

  • Just version upgrade to match backend

AgravityAPI 8.4.1 (2025-01-26)

  • Just version upgrade to match backend

AgravityAPI 8.4.0 (2025-01-12)

  • Add new /portalssaveuserattributes endpoint to save the portal user attributes
  • Change from CustomClaimsProviderResponseContent to CustomClaimsProviderResponseContentTokenIssuanceStart
  • Add more description to public configuration (404 and 401)
  • Change year in description to 2025

AgravityAPI 8.3.1 (2024-12-12)

  • Just version upgrade to match backend

AgravityAPI 8.3.0 (2024-12-11)

  • Create portals users management to own service
    • POST /portalsusers - This endpoint upserts a portals user.
    • GET /portalsusers - This endpoint lists all portals user.
    • DELETE /portalsusers/{id} - This endpoint deletes a portals user.
  • Adjustments for portals   - Change properties in_details to detail_order   - Change properties in_facets to facet_order   - Add options to user context for limiting the options   - Add translations and acceptLanguage to parameters on portal configurations
  • Do adjustments for User Context in Portal:
    • Add properties fieldsand authentication to Portal (and PortalConfiguration)
    • Add endpoint POST /portalsenhancetoken - for Entra External ID authentication token extension (add user context to token)
    • Add models of Entra External ID Claims
    • 1253 FC Portal: Add user context and apply filter in local API
      • Add List of PortalFields to add user context and change the way metadata, facets and user context is stored on Portals
    • Add Scopefilter to search query to just add another filter which can come from another source (like user-context)
  • Adjust Portal Model   - add property theme.fav_icon, allowed_origins,   - remove properties metadata and facettes (replaced by fields)   - restructure/reorder properties in Portal (and PortalConfiguration)
  • Add Role to ProviderResponseClaims

AgravityAPI 8.2.1 (2024-11-22)

  • Add language to asset download object (to respect the requested language)

AgravityAPI 8.2.0 (2024-11-13)

  • Add history property to SearchAdmingIndexerStatus which contains the history of the last runs of indexer
  • Add endpoint to patch the UDL cache on demand (with admin API key)
  • Add GET /auth/containerwrite/{container} - This endpoint creates and returns a SAS-Token with write

AgravityAPI 8.1.2 (2024-10-11)

  • Just version upgrade to match backend

AgravityAPI 8.1.1 (2024-10-10)

  • Change collectionid to be lowercase (now it is working with SDK again)
  • Change the share_id to be separated by underscore

AgravityAPI 8.1.0 (2024-10-08)

  • Add property asset_icon_rules to the Portal (and PortalConfiguration) - to allow to store rules to show icons in the portal
  • Add accepted-language header parameter to the HttpSharedCollections endpoints.

AgravityAPI 8.0.0 (2024-09-30)

  • Target now net8.0
  • Add Accepted-Languages as HTTP header parameter
  • Portal now have simple languages property (comma separated strings)
  • #1023 Download formats - Permissions on download formats
  • Correcting the return parameter of GeneralManagement Version to AgravityInfoResponse and remove badResult
  • #1114 Upgrade .NET 6 to .NET 8 (incl. switch to isolated model)

AgravityAPI 8.0.0-preview.1 (2024-09-03)

  • Target now net8.0
  • Add Accepted-Languages as HTTP header parameter

AgravityAPI 7.3.1 (2024-08-18)

  • 1196 Download Format: Add optional parameter for fallback to thumbnails
  • Correct status of search status (from "201 Created" to "200 OK")

AgravityAPI 7.3.0 (2024-08-02)

  • Add public API: GET /searchadmin/status - This endpoint gives the status about the index and indexer.
  • Add endpoint DELETE /collection/{id} to public - This endpoint deletes the collection with the given ID (and their siblings).
  • Update some of the descriptions.
  • 1167 Remove obsolete marked fields and queues
    • removed metadata from asset Blob
    • shared collections from users
    • text_content from asset
  • 1100 Created/Change date saved on asset (create/update/modified)
  • 1176 Add 'created_by' to published asset

AgravityAPI 7.2.2 (2024-06-10)

  • Just version upgrade to match backend

AgravityAPI 7.2.1 (2024-06-03)

  • Just version upgrade to match backend

AgravityAPI 7.2.0 (2024-05-31)

  • Add endpoint GET {{url_public}}/api/assets/{assetId}/view?portal_id={portalId}&format={downloadFormatId} - This endpoint returns the content of an asset which is available in a specific portal (portal_id is "key") and returns the blob directly.
    • Add optional download boolean parameter to indicate that I want to download the file
  • Add property zipname to DownloadZipRequest - which is used for downloading zip; Add new endpoint GET /deleted - This endpoint checks all deleted entities in the database until a specific date and returns the elements which are deleted.
    • allows to filter for since, until, entity_type and portal_id
  • Add new endpoint GET /portals/{id}/assetids - This endpoint gets all Asset IDs in portal scope.

AgravityAPI 7.1.0 (2024-05-08)

Change to restsharp and add targetFramework net6.0

  • Add param collectiontypeid to GET /assets endpoint to query all assets from collection type
  • Add GET search/facettes (facette name is query parameter) with nearly same attributes than search - This endpoint returns one facette based on the search parameters.

AgravityAPI 7.0.1 (2024-04-07)

Portal:

  • Add links to portal model for impressum, privacy and conditions;
  • Add optional icon_empty and icon_active to theme
  • Add portalZipRequest class and add zip_type to SharedCollectionZipRequest
  • Add endpoint POST /portals/{id}/zip - Which initiates the ZIP creation of a portal id. (public)
  • Add endpoint GET /portals/{id}/zip/{zipId} - This endpoint gets the progress/status of the ZIP creation of a portal. (public)

AgravityAPI 7.0.0 (2024-03-23)

General:

  • Order start with 999 as default
  • Add /assets/{id}/tocollection endpoint to allow assigning / moving / removing an asset to/from a collection (public)

Add AgravityAPI for Portal Management (private):

  • Add GET /portals/{id} endpoint (public) - This endpoint returns a portal with specific id.
  • Add GET /portals/{id}/config endpoint (public) - This endpoint returns a full configuration of the portal. Incl. download formats, SDLs, UDLs and coll type items
    • Add the way how to fetch UDLs, SDLs (limit by ID and with language)

Enhance download endpoint(s):

  • Add fand portal_id parameter to /assets/{id}/download (public)
  • Add key (asset MD5) parameter to /assets/{id}/download when coming via portal identification (public only)
  • extend original blob metadata and add download format behaviour to download

AgravityAPI 6.1.6 (2024-02-01)

  • Just version upgrade to match backend

AgravityAPI 6.1.5 (2024-01-28)

  • Just version upgrade to match backend

AgravityAPI 6.1.4 (2024-01-17)

  • Just version upgrade to match backend

AgravityAPI 6.1.3 (2024-01-14)

  • Just update year to 2024 in description

AgravityAPI 6.1.2 (2023-12-18)

  • Just version upgrade to match backend

AgravityAPI 6.1.1 (2023-12-15)

  • Just version upgrade to match backend

AgravityAPI 6.1.0 (2023-12-14)

Extend Share to have passwords, allowed_formats and be a separate entity:

  • add GET /assets/{id}/blob - This endpoint checks, if an asset exists, is an image, has original blob, is status active, is part of the shared collection and returns the requested asset blob.
  • add GET /downloadformats-shared - This endpoint lists all download formats for a specific shared collections in database. Needs a valid shared collection ID to be authenticated.
  • add GET /shared/{id}/zip/{zipId} - This endpoint gets the progress/status of the ZIP creation of a shared collection.
  • add POST /shared/{id}/zip - Initiates the ZIP creation of a shared collection.
  • add param ay-password to get share
  • fix add_data in AssetBlob to be not an array of metadata
  • add model SharedAllowedFormat
  • add model SharedCollectionZipRequest
  • refactor collectionSharingService to collectionShareManagementService
  • Add ay-password header to shared collection (and zip request) endpoints
  • Add password to shared collection model

Other changes:

  • GET /assets/{id}/textcontent - This endpoint returns all textual content of an asset (i.e. text of PDF)
  • Add Removed and DirtyMarked as history entry types. DirtyMarked is only used backend internally.
  • Added error(AgravityErrorResponse) to sharedCollectionZipRequest class if zip caused an error.
  • Removed unused opened field from sharedCollection model.

AgravityAPI 6.0.4 (2023-11-06)

  • Just version upgrade to match backend

AgravityAPI 6.0.3 (2023-11-04)

  • Just version upgrade to match backend

AgravityAPI 6.0.2 (2023-10-23)

  • Just version upgrade to match backend

AgravityAPI 6.0.1 (2023-10-19)

  • Just version upgrade to match backend

AgravityAPI 6.0.0 (2023-10-02)

  • #70 Alternative thumbnails for assets

    • Add new optional param previewofto /assetupload endpoint
    • Respect versionendpoint as well for preview

  • #784 Add Roles to Permission System

    • Add role property to Asset, Collection and CollectionType which can be NONE, VIEWER, EDITOR
    • Change permissions property from workspace and collection to to be an array of PermissionEntity (role and id)

  • #974 Add custom configs for frontends

    • Update endpoint GET /config/frontend - add param customonly - This returns only the custom created configurations.

  • #930 Allow versioning of assets (not dependent on the type), if not published

    • Add mime_type to version to be optionally checked in backend

AgravityAPI 5.3.6 (2023-09-18)

  • Just version upgrade to match backend

AgravityAPI 5.3.5 (2023-09-18)

  • Just version upgrade to match backend

AgravityAPI 5.3.4 (2023-09-10)

  • Return list of collection type items now contains ALL items (regardless of permissions)

AgravityAPI 5.3.3 (2023-08-27)

  • Add optional filename as property for httpAssetUploadFile

AgravityAPI 5.3.2 (2023-08-17)

  • Just version upgrade to match backend

AgravityAPI 5.3.1 (2023-08-01)

  • Allow managing SDLs (add, remove, replace) in Public API

AgravityAPI 5.3.0 (2023-07-21)

  • Just version upgrade to match backend

AgravityAPI 5.2.2 (2023-07-06)

  • Just version upgrade to match backend

AgravityAPI 5.2.1 (2023-07-04)

  • Refactor AssetIdContainer to AssetIdFormat
  • Add zip_url to quickshare (and full)

AgravityAPI 5.2.0 (2023-06-06)

  • Add GET /quickshares/{id} to get a full QuickShares (incl. asset paging)
  • Add PUT /assets/{id}/availability to set the availability of an asset

AgravityAPI 5.1.6 (2023-05-23)

  • Remove techdata from all assets get endpoint and moved to GetAssetById:
    • add query parameter techdata to public GetAssetById endpoint
  • Refactor public SignalR management class to have the prefix "public"

AgravityAPI 5.1.5 (2023-05-03)

(no changes - was not published on nuget - just update according to backend version)

AgravityAPI 5.1.4 (2023-04-27)

(no changes - was not published on nuget - just update according to backend version)

AgravityAPI 5.1.3 (2023-04-23)

(no changes - was not published on nuget - just update according to backend version)

AgravityAPI 5.1.2 (2023-03-23)

  • Change all AddProperties from Dictionary<string, Object> to Dictionary<string, object>
  • Add property Profile which could have the ICC-Profile name for the original blob
  • Add Format property to CollTypeItem model to get and store additional information about the format of the item_type
  • Add ClientId property to VersionInfo

AgravityAPI 5.1.1 (2023-03-16)

(no changes - was not published on nuget - just update according to backend version)

AgravityAPI 5.1.0 (2023-02-19)

(no changes - just update according to backend version)

AgravityAPI 5.0.2 (2023-02-06)

(no changes - just update according to backend version)

AgravityAPI 5.0.1 (2023-01-27)

  • Add / modifiy multipart/formdata endpoint POST /assets/{id}/versionsupload: This endpoint allows to upload one asset which replaces the asset with given id and creates a version which is returned.
  • modified /assets/{id}/versions to now only take json as input (VersionedAsset)
  • add missing filter parameter to HttpAssetsGet and made collectionId not mandatory.
  • add expires property to SasToken for easy access;
  • Add upload to storage use case;
  • Add notPrefixto WhereParam (only used in backend);

AgravityAPI 5.0.0 (2023-01-07)

  • Add new permission endpoints:
    • CollectionType Management: POST /collectiontypes/{id}/permissions
    • Workspace Management: POST /workspaces/{id}/permissions
    • (new) PermissionManagement:
      • POST /permissions/settings/identities update all allowed permissions (ADD, REPLACE, REMOVE);
      • GET /permissions/settings - Get the permission settings
      • PUT /permissions/settings - Fully replace the settings;
  • Changed POST /signalr/messages/{id} to GET /signalr/info/{id}
  • Add permissionless property on collection type;
  • Add permission_enabled property on Agravity version;
  • Corrected properties of infoEntitySkillEnhanced to be alligned to other objects;
  • Removed enabled property in Permission Settings (Permissions are now globally set in Environment Variables);
  • Removed uncomplete flag in get assets by id;
  • Allow viewer to edit images
  • Change and add admin asset operations:
    • PATCH /assets/{id}/repair (was GET)
    • PATCH /assets/{id}/renew (was GET)
    • PATCH /assets/renew!! (was GET)
    • Add PATCH /assets/{id}/reindex
  • Add new Asset Versioning methods to public function:
    • POST /assets/{id}/versions - This endpoint allows to create empty version or upload one asset which replaces the asset with given id and creates version.
    • DELETE /assets/[id}/versions/{vNr} - This endpoint deletes a version of an asset.
    • GET /assets/{id}/versions/{vNr}/blobs - This endpoint checks if assets and version exists and returns the url for the requested blob.
    • POST /assets/{id}}/versions/{vNr}/restore - This endpoint restores a version nr to be the current version and saves the current asset as version.
    • GET /assets/{id}/versions - This endpoint lists all the versioned assets which are stored in the database if asset is still valid.
  • Remove some endpoints:
    • AssetOperations: GET /assets/{id}/similar- Perhash removed because it is not working as expected;
    • CollectionManagement: POST & GET: /collections/{id}/permissions- Currently not used (will have a comeback soon)
    • HelperTools: GET /helpers/allqueryrus not in use anymore - show RUs in portal;
    • Remove deprecated Search result entries (reason_result, max_sum_results, search_query, search_filter, search_order_by, search_mode and origin)
  • Update asset version to create empty versions of assets (removes orig blob) - additional PUT blob on azure storage inbox is neccessary:
  • Add SearchAdmin status endpoint: GET /searchadmin/status;
  • Changed SearchAdmin endpoints:
    • Recreate index: PATCH /searchadmin/recreate
    • Delete index (and search resources): PATCH /searchadmin/delete
  • Add translationsparameter to GET StaticDefinedLists and StaticDefinedListById endpoints (private & public)

AgravityAPI 4.9.3 (2022-12-15)

Add parameter:

  • Paging with param skip in GET /api/search

Copy more endpoints from private to public:

  • Create Asset (without data) POST {{url}}/api/assets?collectionid={{collectionId}}
  • Get Inbox Token GET {{url}}/api/auth/inbox (for upload)
  • Create Published AssetImage POST {{url}}/api/assets/{{assetId}}/publish
  • Get All Published of Asset GET {{url}}/api/assets/asset_id/publish
  • SignalR GET /api/signalr/negotiate?negotiateVersion=1

Repaired some annotations

  • x-functions-key header was missing (saved search)
  • API Key instead of Bearer 401 message
  • Comma instead of colon separation in search param ids

AgravityAPI 4.9.2 (2022-12-05)

  • Add to Public the Download Format Management and Custom Image Manipulation (with DownloadID):
    • Add POST assets/{id}/imageedit to Public Asset Operation Management
    • Add GET assets/{id}/imageedit/{download_format_id} to Public Asset Operation Management
    • Fix missing OpenAPI parameter change the param use_internal_image to original in GET assets/{id}/imageedit in Public Asset Operation Management
    • Remove POST assets/{id}/rotate from Public Asset Operation Management

AgravityAPI 4.9.1 (2022-12-01)

  • Add ids param to search endpoint (private and public) to limit the results to given ids (comma separated);
  • introduce new options property to searchResult which reflect all filter params given
  • deprecation properties announced (all are included in options):
    • max_sum_results => options.limit
    • search_query => options.searchstring
    • search_filter => options.filter
    • search_order_by => options.orderby
    • search_mode => options.mode

AgravityAPI 4.9.0 (2022-11-28)

Add translations param in nearly all endpoints which receives translateable objects Add missing items as param PublicAssetManagement Add missing fields as param PublicAssetOperations and PublicCollectionManagement Add Saved Search Management:

  • POST /savedsearches (editor + admin) This endpoint creates one saved search entry in the database.
  • GET /savedsearches (all + public) This endpoint lists all saved searchs in database.
  • DELETE /savedsearches/{id} (editor + admin) This endpoint deletes a single saved search.

AgravityAPI 4.8.1 (2022-11-14)

  • Change GET /assetsenhancer/{id} to GET /helper/skillenhancer/{id} - Show the result of the SkillEnhancer for assets and collections

AgravityAPI 4.8.0 (2022-11-13)

  • Add methods to public functions:
    • Update GET /assets/{id} - Add "uncomplete" flag return uncomplete
    • Add POST /assets/{id} - Update asset via API key
    • Add POST /collections/{id} - Update collection via API
    • Fix return value from HttpStaticDefinedListsGetById

AgravityAPI 4.7.3 (2022-10-31)

Just version upgrade to match backend

AgravityAPI 4.7.2 (2022-11-02)

Just version upgrade to match backend

AgravityAPI 4.7.1 (2022-10-31)

Just version upgrade to match backend

AgravityAPI 4.7.0 (2022-10-30)

New Features (in public):

  • Add helper methods to public functions:
    • Add POST /assetsupload - Upload asset via API key
    • Add POST /collections - Create collection via API key

Improvements:

  • Changed publish asset - removed "original" and replaced with "format";
  • Add origin to downloadFormat (where this format is based on);

AgravityAPI 4.6.0 (2022-10-18)

New Features (in public):

  • Repair /collections endpoint (level and parentid are now optional);
  • Add GET /collectiontypeitems - This method returns a list of collection types items.
  • Add helper methods to public functions:
    • Add GET /helper/userdefinedlists - Returns all user defined lists of all collection types
    • Add GET /helper/filterableitems - Returns all filterable items directly from the search index
    • Add GET /helper/searchableitemnames - Returns all searchable items directly from the search index
    • Add GET /helper/searchableitems - Returns all searchable items directly from the search index
  • Add Translations Management to public functions;
    • Add GET /translations/{id} - Get all the translations of a whole entity (Asset, Collection, Collection Type, Download Format)
    • Add GET /translations/{id]}/custom/{customProperty} - Get the translation of custom field on the entity (Asset, Collection)
    • Add GET /translations/{id}/{property} - Get the translations of a specific field on the entity (Asset, Collection, Collection Type, Download Format)

AgravityAPI 4.5.5 (2022-10-14)

Just version upgrade to match backend

AgravityAPI 4.5.4 (2022-09-28)

Improvements:

  • PublishAsset body now allows
    • "usecases" (string list) (also to be updated)
    • "original" (boolean) to publish original asset (with new name)

AgravityAPI 4.5.3 (2022-09-21)

Just version upgrade to match backend

AgravityAPI 4.5.2 (2022-09-12)

Just version upgrade to match backend

AgravityAPI 4.5.1 (2022-09-11)

New Features:

  • Add new endpoint POST /translations which takes a list of string (assetIds) to return all translations of these assets;
    • Has optional property query param where it can be filtered down to a specific property;

###Improvements:

  • Make includeblueprint in /collectiontypeitems as query parameter (not path param);

Others: Just reordering of properties (no changes on content) - because C# source based on new base classes

AgravityAPI 4.5.0 (2022-09-04)

New Features:

  • Add endpoint PUT /assets/{id}/availability to set the availibility of the asset (asset operation);
    • Add availability properties to asset (only set, when asset is locked or availability is timed);
    • Add assetAvailability as separate model;
  • Add Ordering of entities in Workspace/CollectionType and Items of CollectionTypes and CollTypeItemBlueprints
  • Add AssetIconRuleManagement CRUD /asseticonrules to have asset icon rules which are displayed on assets;
  • Add includeBlueprint parameter at GET /collectiontypeitems (to get even the items of blueprints)

Not possible to update the asset availability asset update (asset mangement) endpoint;

###Improvements:

  • Add param for body POST /colltypeitemgroup (was missing)
  • Add security annotation to GET /collectiontypeitems (was missing in openAPI)

AgravityAPI 4.4.2 (2022-08-29)

New Features:

  • Add ICC Profile Management:
    • GET /iccprofiles This endpoint lists all icc profiles in blob container.
  • POST /colltypeitemgroups/{{collTypeItemGroupId}} (editor, admin) This endpoint updates a single collection type item group. (Roles: Editor, Admin)
  • Add new endpoint GET /searchableitems which now returns full items with lots of new information;

###Improvements:

  • Change items of translationManagement.agravity.ts to optional and type bool
  • Changed endpoint /searchableitems to /searchableitemnames

AgravityAPI 4.4.1 (2022-08-11)

###Improvements:

  • Add missing OpenApiHeader at sdl update
  • Extend WhereParam
  • Update the agravityuser to save name/email/roles/groups
    • add tutorial list (without any function yet)

AgravityAPI 4.4.0 (2022-07-22)

Add Static Defined List Management:

  • POST /staticdefinedlists (admin) This endpoint creates one static defined list entry in the database.
  • GET /staticdefinedlists (all) This endpoint lists all static defined lists in database.
  • GET /staticdefinedlists/{id} (all) This endpoint gets a static defined list from database.
  • UPDATE /staticdefinedlists/{id} (admin) Updates a static defined list in database.
  • DELETE /staticdefinedlists/{id} (admin) This endpoint deletes a single static defined list.

Add AssetOperations with new endpoints:

  • PATCH assets/{id}/runqueue/{queue} (editor/admin) This endpoint execute a specific queue of the asset. E.g. Recreation of previews, AI recognition, hash values, ...
  • PATCH assets/{id}/purgecdn (editor/admin) This endpoint purges all published assets of this asset when CDN is enabled

Add AssetPublishing with new endpoint:

  • POST assets/{id}/publish/{pid} (editor/admin) This endpoint currently updates only the description of the published asset with the given ID.

Add HelperTools with new endpoint:

  • POST helper/excel/export (admin) This endpoint creates an excel export of the db

AgravityAPI 4.3.0 (2022-06-27)

Add GeneralManagement with new endpoint:

  • POST /cleanup (admin) to check all original blobs if all elements are set correctly in database
    • will be removed if not found in database
    • will be moved to archive if found in database but set as deleted (status "D")

Add AssetOperations with new endpoint:

  • GET assets/{id}/repair (editor/admin) which refills (or corrects) the collection type items based on collections

Improvements:

  • Remove the assets on collections
  • Replaced PublishEntity with PublishedAssets
  • Add param workspaceid to create collection type;
  • Add param sftpenabled to create secure upload for user;
  • Add name and email to user info;
  • Add region to version, versionEntity, publishEntity, asset;

AgravityAPI 4.2.0 (2022-06-15)

Add CollTypeItemGroups Management with new endpoints:

  • POST /colltypeitemgroups (editor/admin) : This endpoint creates a item collection type group with a subset of items as preparation
  • GET /colltypeitemgroups (editor/admin) : This endpoint delivers a list all item collection type groups.
  • DELETE /colltypeitemgroups/{id} (editor/admin) : This endpoint deletes a specific item collection type group.

A CollTypeItemGroup is a collection of prepared items which could be assigned to collection types. These items don't have any relation to collection types, collections or assets.

Improvements:

  • Add items parameter to assets and collection to expand all items (with corresponding language);
  • CollTypeItem boolean fields are now nullable (mandatory, searchable, onlyasset,multi)
  • Add group (translateable label of grouping items within a collection type) and order (bring the items in order) properties to CollTypeItem which can be filled.

AgravityAPI 4.1.1 (2022-05-26)

  • Add publicCollectionTypeManagement and updated routes in publicWorkspaceManagement;

AgravityAPI 4.1.0 (2022-05-15)

  • #441
    • POST /workspaces (editor/admin) : This endpoint creates a unique workspace ID and adds the information to the database.
    • GET /workspaces (all - private & public) : This endpoint lists all available workspaces, which are stored in the database and not deleted (status "A"). It will never be empty. If no workspace is stored in the database, one is constructed (id: "w0000") with all available collection types.
    • GET /workspaces/{id} (all - private & public) : This endpoint returns one single workspace (from ID).
    • POST /workspaces/{id} (editor/admin) : This endpoint updates the workspace with name, description and collection_types
    • DELETE /workspaces/{id} (editor/admin) : This endpoint deletes the workspace with the given ID.
    • DELETE /workspaces (admin) : This endpoint deletes all workspaces

AgravityAPI 4.0.1 (2022-05-05)

  • Add filter query param to GET /assets endpoint;
    • extended assetPageResult with filter criterion;
    • new "WhereParam" model

AgravityAPI 4.0.0 V4 .NET6 UPGRADE (2022-04-27)

  • Add new private ConfigurationManagementService with new endpoints:
    • GET /config (only admin) : Lists all config values stored in config table
    • GET /config/frontend (all) : Lists config value only for frontend stored in config table
    • POST /config (only admin) : This initializes all configurations and write them into appconfig table.
    • POST / config/key (only admin) : Update an existing config value with the given key. (Only value, content-type and description)
  • Add new public ConfigurationManagementService with new endpoint:
    • GET /config/frontend (all) : Lists config value only for frontend stored in config table
  • Add optional addconfigqueues query param to setup (if custom queues have to be initialized)
  • SasToken now contains full token incl. URL
  • Add upgrade v3tov4 endpoint /upgrade/V3toV4

##AgravityAPI 3.4.5: Just version update

##AgravityAPI 3.4.4: Translations Custom Fields ###API:

  • /translations/{id}/custom/{customField} GET Get the translation of custom field on the entity (Asset, Collection)
  • /collections/{id}/repair PATCH This endpoint checks if collection and assets from collection are the same. If not, the collection is corrected.

##AgravityAPI 3.4.3: Just version update

##AgravityAPI 3.4.2: Translation Management (Bulk) ###API:

  • /translations/{id} GET all the translations of a whole entity (Asset, Collection, Collection Type, Download Format)
  • /translations/{id}/{property} GET the translations of a specific field on the entity (Asset, Collection, Collection Type, Download Format)
  • /translations/{id} POST Updates the translations of a whole entity (Asset, Collection, Collection Type, Download Format)

##AgravityAPI 3.4.0: Translations / Download Formats / Search Improvement ###Model:

  • pageResultAsset was refactored to assetPageResult
  • downloadFormat has now operations and asset_type instead of image_operations to be more flexible
  • shareCollectionFull has page instead of assets and page_size in return model;
  • Translations added to asset, collection, collectionType, collTypeItem and downloadFormat ###API:
  • /assets POST has now collection id as mandatory parameter
  • /assets GET has now new assetPageResult return value
  • /shared GET has now continuous token + limit + order by parameter
  • /deletesearchresources [admin] can now delete the index, indexer, data-sources and skills - have to be recreated after that.

Known issues

Below is a list of any know issues affecting the recommended minimum version:

Issue Impact Mitigation Tracking link