Changelog
The DataGalaxy Developer API is updated frequently with new features, improvements and fixes.
All these changes will be documented in this changelog.
If you have any questions or need more information about these changes or our API in general,
please feel free to open a support ticket.
Fixes
- Add support for the
AppliesTo, Consumes, DiagramHasSource, Executes, HasForOutputPort, HasForUseCase, Impacts, IsConsumedBy, IsExecutedBy, IsImpactedBy, IsMonitoredBy, IsOutputPortFor, IsSourceForDiagram, IsSubjectTo, IsUseCaseFor, and Monitors link relationships to search and object operations.
- Correct the documentation for whether the
name and technicalName fields are required in the POST /v2/fields/bulk/{versionId}/{parentId} and PUT /v2/structures/bulk/{versionId}/{parentId} operations.
Improvements
- Internal: Dependency updates
Fixes
- Add importID to Data Processing Item objects when importing via the
POST /v2/dataProcessing/bulktree/{versionId} operation
Fixes
- Correctly populate object links in the
POST /v2/search operation result
Improvements
- Internal: Dependency updates
Fixes
- Improve search results for the object types "MonitorGroup", "PolicyGroup", "RuleGroup", and "UseCase" in the
GET /v2/objects operation
- Support more types in the
/v2/attributes/screens and /v2/tasks operations
Improvements
- Internal: Dependency updates
Improvements
- Internal: Dependency updates
General
- Documentation page logos and favicons are updated to reflect DataGalaxy's current branding
Features
- Add a
GET /v2/objects/types operation to retrieve an object type's related and link-compatible types.
- Add support for "Processing", "Diagram", "Initiative", "Objective", "DataProduct", "AiProduct", "Rule", "Policy", and "Monitor"
dataTypeName values in /v2/attributes operations
Fixes
- Correctly translate the "Diagram", "DataProduct", "AiProduct", "Initiative", "Objective", "Policy" and "RuleAndMonitor" module types in
/v2/users/authorizations operations
- Clarify the error message when the
POST /v2/objects operation fails due to an invalid parent ID
Improvements
- Internal: Dependency updates
Improvements
- Error response bodies from
/v2/scim/Users operations are now formatted to the urn:ietf:params:scim:api:messages:2.0:Error schema as defined in RFC7644 ยง 3.12
- Error messages for the
POST /v2/scim/Users operation are more specific when the input does not contain an emails field or a valid work email address
Features
- Add
GET /v2/objects, GET /v2/objects/{objectId}, and DELETE /v2/objects/{objectId} operations to retrieve lists of objects, retrieve individual objects, and delete individual objects regardless of the object's type.
- Add support for managing "Initiative", "Objective", "DataProduct", "AiProduct", "Rule", "Policy", and "Monitor" object types. Some of these types are available as product options. Please reach out to your account manager to activate them.
Improvements
- Internal: Dependency updates
Fixes
- Correctly handle the
parentId field in the request bodies of the PUT /v2/properties/{versionId}/{propertyId} and PUT /v2/usages/{versionId}/{usageId} operations
- Clarify the use of the
includedAttributes input field in the POST /v2/search operation's documentation
Improvements
- Internal: Dependency updates
Fixes
- The
technicalName input field of the PUT /v2/fields/bulk operation is now marked as required in the API's specification and documentation. The operation's name input field is now marked as optional. This reflects the system's behavior.
Improvements
- Internal: Dependency updates
Improvements
- URN-related operations now belong to a dedicated section in the documentation.
Fixes
- The operations that create entities
POST /v2/containers, POST /v2/dataProcessing, POST /v2/fields, POST /v2/properties,POST /v2/sources,POST /v2/structures, and POST /v2/usages now return the correct object ID when creating an object with the same name as an existing object in the workspace
Improvements
- Internal: Dependency updates
Improvements
- Internal: Dependency updates
Fixes
- Creating or modifying rich text formatted attributes now saves their raw text equivalents in the DataGalaxy backend
Improvements
- Internal: Dependency updates
Fixes
- The
externalTags and qualityStatus entity attributes are now properly managed in get and set endpoints
Features
- New DataQuality endpoints:
POST /data-quality/rules/bulk: Create Data Quality rules in bulkPOST /data-quality/checks/bulk: Create Data Quality rule checks in bulk
Fixes
- Revert the validation check for bulktree operations introduced on 6 February 2025 in version 2.31.5
Improvements
- Internal: Dependency updates
Fixes
- Corrected the
GET /v2/users/authorizations operation's results.authorizations.modules.authorization fields' values
Improvements
- Internal: Dependency updates
Fixes
- Bulk and bulktree operations now return a 400 response when input
name, technicalName, or displayName contains a backslash.
- When updating a user via SCIM integration, a reader license is now automatically assigned to users who have no licesne if a reader license is available.
Improvements
- Internal: Logging enhancements
- Internal: Dependency updates
Fixes
- Operations that retrieve objects with an optional
maxDepth parameter such as GET /v2/usages and GET /v2/dataProcessing retrieve more accurate results. If defined, then the maxDepth parameter must equal "0", otherwise the operation returns an HTTP 400 response.
Improvements
- Data quality improvements:
- Added new rule attributes
- Added a new rule type
- Internal: Dependency updates
- Internal: Security patches
Fixes
- Removed the POST
POST /v2/imports/{versionId}/{importGuid}/reconcile endpoint from the documentation as it was not destined for public use
Improvements
- Internal: Dependency updates
Fixes
- Prevent 500 responses when calling
GET /v2/users/authorizations and the requested user does not have access to the requested workspace version
Improvements
- Internal: Dependency updates
- Internal: Security patches
Fixes
- Resolve potential 500 responses when querying very large sets of objects
Improvements
- Search operation filters are updated to match the filters available in the web-based platform search form
- Updated incorrect search filter documentation
- Invalid search filter errors now include the failed search operation and the attribute type's available search operations
General
- Added an
allTeams query string parameter to the GET /v2/teams operation
- Clarified documentation for the
GET /v2/credentials and GET /v2/credentials/regenerate operations. These calls are unnecessary for users who use DataGalaxy authentication version 2 and up.
- Internal: Dependency updates
Improvements
- Internal: Logging improvements
- Internal: Security patches
Fixes
- Return a 400 response instead of 500 when calling
POST /v2/search with invalid filter schema
General
- Deprecated workspace organizations
- The
organizations property in the GET /v2/workspaces call response now contains an empty list and will be removed in a future release
Improvements
- Internal: Updated logging logic
Fixes
- The
inputs and outputs properties of the POST /v2/dataProcessing/bulktree/{versionId} operation's input are now required
Improvements
- Added the
DataQualityReview task type
- The rate limit has increased from 14400 to 28800 requests per hour
- Internal: Security patches
Improvements
- Performance improvements to the
POST /v2/links/bulktree operation
- Internal: Security patches
Fixes
- Corrected the
type input enum values in /v2/dataprocessing operations
Improvements
- Added
firstConnectionDate and lastConnectionDate fields to user objects in the GET /v2/users?scope=admin
operation result
- Internal: Security patches
Improvements
- Added a new route
GET /v2/campaigns/{guid}/entities/version/{versionId}/no-access-data
- Added an optional
creationTime body attribute to the POST /v2/data-quality/rules/{ruleId}/checks route
- Updated URNs documentation
- Internal: process and documentation updates
Improvements
- Added an optional
importId attribute to the POST /v2/usages/dataProcessing/{versionId} route
- Updated SCIM documentation
- Internal: security patches
Improvements
- Added an optional
importId attribute to the POST /v2/usages/bulktree/{versionId} route
- Internal: security patches
Fixes
- Fixed unexpected
HTTP 400 Bad Request responses when updating user authorizations
Improvements
- Performance improvements to the
GET /v2/users/authorizations operation
Fixes
- Fixed SCIM error management (wrong 500 status code instead of 4xx)
Fixes
- Fixed unexpected SCIM error on update (POST/PUT/PATCH) due to session management issue
Improvements
- Internal: security patches
Fixes
- Fix unexpected
HTTP 401 Unauthorized responses when working with data processing, user, and user licenses entities
- Ignore case on email addresses when synchronizing users using SCIM
Improvements
- The rate limit has increased from 7200 requests per hour to 14400 requests per hour
- Backpressure now triggers after four requests per second instead of two requests per second
- Internal: security patches
Improvements
- Data Quality:
- Make the
code attribute optional and editable on rules
- Add an optional
fieldIds attribute to identify which fields affected by a rule
- URN "private preview":
- Add new APIs to manage objects and links using their URNs
- Support more attribute update features on PUT routes
Fixes
- Ignore case on email addresses when synchronizing users using SCIM
Internal improvements
- Updated the documentation
Improvements
- Added an optional query param called importId to the POST /sources/bulk/{versionId}
- Internal: security patches
Improvements
- Internal: security patches
Improvements
- Remove personal access and integration token contents from HTTP 401 response bodies
Fixes
- Internal: Remove the
X-Powered-By response header
Improvements
- Internal: security patches
Documentation
- Fix the path in the Edit a field operation's documentation
- Clarify upsert actions in the Bulk upsert data processing tree, Bulk upsert a property tree, Bulk upsert a dictionary entities tree, and Bulk upsert a usage tree operations' documentation
Improvements
- Internal: security patches
Documentation
- Fix the path in the Get Primary Keys list operation's documentation
Fixes
- Fix
/search route clientId logic with updated authentication
Improvements
- Internal: updated session logic
- Internal: updated changelog generation
- Documentation : update API documentation on Workflow and Data Quality
Documentation
- Remove extra /v2 prefix in the API documentation of Campaigns, Workflows and Data Quality modules.
Documentation
- Add Data Quality API documentation (preview)
Improvements
- Remove userSessionId from internal calls
Fixes
- Fix
frontendUrl computation logic.
Improvements
- Remove internal paging logic and cache.
Deprecations
- Fields
profileImageUrl and profileThumbnailUrl on GET /users are now deprecated. Please use the Hypermedia link _links[@rel="profileImage"].href (whose value is GET /users/{userId}/profileImage)
- Field
objectUrl is now deprecated. You should build the web URL from the versionId, dataType and id.
Improvements
- Improve API documentation by using TSOA 5.1.1
- Improve authentication section in the API documentation
- Document
parentId parameter on GET /dataProcessingItem
- Export usage metrics as Prometheus format (internal)
Fixes
- Fix an error on
/attributes/screens/structure/substructure and /attributes/screens/usage/usagecomponent routes
Fixes
- fixed outdated changelog
- fixed typo on changelog
Features
- Users: new
/users/{userId}/profileImage route to get the profile image for a given user
Fixes
- Glossary: support technicalName on GET /properties
Improvements
- Documentation: improvement on the documentation overview regarding query parameters
- Internal: security patches
Features
- Internal: added linkedObjectCount attribute on
GET /{dataType}
Fixes
- DataProcessingItem: type of dataProcessingItem was always null in some case
Improvements
- Internal: updated dependencies
- Internal: internal improvements & optimisation
Fixes
- Attributes: some custom attributes could be hidden on entities requests
Fixes
- Bulktree: fixed an incorrect result when bulktree resulted without changing anything
Improvements
- Internal: improvement on security regarding bearer token
- Documentation: improvement regarding the date format on attributes
Fixes
- Documentation: fixed broken picture link for icon and picture
- Documentation: updated changelog including missing versions
- Fixed pagination
Features
- New api route to create object:
POST /objects/{versionId}/{workspaceId}:{workspaceId}
- Encoding: Special characters are supported
Fixes
Authorization ability to give the authorization of a private workspace to a user
Improvements
- Internal - Internal authentication improvements
Features
- Adding Watch endpoints to subscribe or unsubscribe to notifications of an object:
Improvements
- POST
/search documentation update to explain how to use attributePath for custom attributes
Fixes
- Formatted text mention and type were undefined.
Fixes
- Bulktree source import was case-sensitive
- roles attribute were missing from
GET /{dataType} with includedAttributes parameter
Features
- Values of
ValueList have now isActive field
- The
technologyCode is now available in history and link objects
General
- Format of
TimeSeries value is now <date>::<value> for bulktree creation routes
Fixes
- bug fix where
childrenCount was always equal to 0.
Features
PUT /objects - unique route for update objects attributes
Improvements
/scim/users now affects a reader license on creation (if there is any license available in license pool)
Fixes
- Fixed a bug where we could end with an empty property in a bulk import
- Fixed vulnerability issues