The DataGalaxy API gives you access to CRUD actions on your metamodel, users and licenses.
Our API is organized around REST. It accepts and returns JSON-encoded data, and uses standard HTTP response codes, verbs and authentication with access tokens.
To get the full picture of DataGalaxy, please feel free to consult our online documentation.
Have a look at our step-by-step guide for a quick start on how to use our API.
Status Code | Description | Notes |
---|---|---|
200 | OK | The request was successful |
400 | Bad Request | Incoming request contains parameters that might not be valid |
401 | Unauthorized | The supplied credentials, if any, are not sufficient to access the resource |
404 | Not Found | The requested resource is not found |
429 | Too Many Requests | Too many requests have been (Rate limiting) |
500 | Server Error | The server could not return the representation due to an internal server error |
501 | Not Implemented | The requested operation is not supported (e.g. supports GET but not POST etc.) |
The DataGalaxy API has 2 kinds of limitations: rate limiting and throttling.
Pro tip: You can track your rate limiting status with the response header X-RateLimit-Remaining
.
It will display how many requests you can send until the next reset.
Method | Rate | Note |
---|---|---|
Rate limiting | 28800 requests / hour | When exceeded, your IP will be blocked for 15 minutes. |
Throttling | 8 requests / second | When exceeded, each request will be delayed by 500ms. |
Payload size | 100 MB | When exceeded, request will be rejected. |
All routes returning lists share the same pagination format. These routes take two optional parameters as query strings: limit
and page
.
QueryString | Definition |
---|---|
limit | Integer ranging from 1 to 5000. It sets the maximum amount of objects per page. Default value is 20. |
page | Integer starting at 1. It determines the page returned by the request. Default value is 1. |
The response payload contains 5 properties:
Property | Definition |
---|---|
pages | Total number of pages. |
total | Number of objects returned. |
total_sum | Sum of all existing objects. |
next_page | URL of the next page. Value will be null if there is none. |
results | List of objects. |
The DataGalaxy API uses Bearer authentication to authenticate requests.
Every request must contain an Authorization
header with either a PAT (Personal Access Token) or an integration token.
Here is a quick example on how to use a Bearer authentication using CURL:
curl -X GET "https://api.datagalaxy.com/v2/workspaces" -H "Authorization: Bearer token"
The first steps of our quick start guide will give you instructions to obtain an integration token.
/credentials
endpoint, you can also use it as a bearer token.
However, it is recommended to no longer generate an access token manually but to use your Personal Access Token or integration token directly.
Name | Description |
---|---|
pubapi |
URL of the DataGalaxy API. For instance: https://demo.api.datagalaxy.com/v2. 🗑 Deprecated: will be removed in the future. |
cid |
Client UUID |
uid |
User UUID |
given_name |
User given name |
family_name |
User family name |
email |
User email. |
sub |
Subject associated with the token (user email) |
x |
?? |
iat |
Timestamp that indicates the time at which the token was issued |
exp |
Timestamp that indicates the time at which the token will be expired |
Name | Description |
---|---|
api |
URL of the internal API without the /api path prefix.For instance: https://demo.datagalaxy.com/. 🗑 Deprecated will be removed in the future. |
cid |
Client UUID |
uid |
User UUID |
data |
?? |
x |
?? |
iat |
Timestamp that indicates the time at which the token was issued |
exp |
Timestamp that indicates the time at which the token will be expired |
Name | Description |
---|---|
api |
URL of the internal API without the /api path prefix.For instance: https://demo.datagalaxy.com/. 🗑 Deprecated will be removed in the future. |
pubapi |
URL of the DataGalaxy API. For instance: https://demo.api.datagalaxy.com/v2. 🗑 Deprecated will be removed in the future. |
sid |
Session UUID |
cid |
Client UUID |
cname |
Client name |
uid |
User UUID |
email |
User email |
iat |
Timestamp that indicates the time at which the token was issued |
exp |
Timestamp that indicates the time at which the token will be expired |
The DataGalaxy Developer API is updated frequently with new features, improvements and fixes.
All these changes will be documented in our .
We provide two API documentation layouts:
This call is unnecessary for users that use DataGalaxy authentication version 2 and up. If the calling user uses DataGalaxy authentication version 2 or greater, then this operation does not generate anything but returns the token used to authenticate the call.
Authorization header must contain a bearer token formatted as follows: Bearer <token>
.
This route must be called with a Personal Access Token or an integration token as bearer token.
The integration token can be generated from the "Integration" page of the "DataGalaxy Administration menu".
The access token returned by /credentials
shall be used as a bearer token in the authorization header of the requests you make to the API.
The access token expires after 2 hours and can be regenerated by making another request to /credentials
with your IntegrationToken as bearer token.
{- "accessToken": "string"
}
This call is unnecessary for users that use DataGalaxy authentication version 2 and up.
An integration token can be regenerated.
integrationToken required | string |
{- "integrationToken": "string"
}
Retrieve your workspaces or projects. If you need more detail, please consult our DataGalaxy's main concepts.
Provide a name to find a specific workspace.
If no query string is provided, then a list of all workspaces will be returned.
organizations
property in the response is deprecated. It returns an empty list and will be removed in a future release.
name | string |
{- "organizations": [
- {
- "name": "string",
- "id": "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
- "description": "string",
- "defaultVersionName": "string",
- "defaultVersionId": "c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
- "isVersioningEnabled": true,
- "defaultOwnerUser": {
- "firstname": "string",
- "lastname": "string",
- "fullname": "string",
- "email": "john.smith@email.com",
- "userId": "ade92d04-294e-4bff-9dfa-5ea2f5419426"
}, - "defaultStewardUser": {
- "firstname": "string",
- "lastname": "string",
- "fullname": "string",
- "email": "john.smith@email.com",
- "userId": "ade92d04-294e-4bff-9dfa-5ea2f5419426"
}, - "trigram": "string",
- "imageHash": "akrLmrLdEgjMrpULdrsgP0upBUxdbIhujQlKmotHlrQ=",
- "iconHash": "akrLmrLdEgjMrpULdrsgP0upBUxdbIhujQlKmotHlrQ="
}
], - "projects": [
- {
- "name": "string",
- "id": "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
- "description": "string",
- "defaultVersionName": "string",
- "defaultVersionId": "c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
- "isVersioningEnabled": true,
- "defaultOwnerUser": {
- "firstname": "string",
- "lastname": "string",
- "fullname": "string",
- "email": "john.smith@email.com",
- "userId": "ade92d04-294e-4bff-9dfa-5ea2f5419426"
}, - "defaultStewardUser": {
- "firstname": "string",
- "lastname": "string",
- "fullname": "string",
- "email": "john.smith@email.com",
- "userId": "ade92d04-294e-4bff-9dfa-5ea2f5419426"
}, - "trigram": "string",
- "imageHash": "akrLmrLdEgjMrpULdrsgP0upBUxdbIhujQlKmotHlrQ=",
- "iconHash": "akrLmrLdEgjMrpULdrsgP0upBUxdbIhujQlKmotHlrQ="
}
]
}
Return the list of versions available in the specified workspace.
workspaceId required | string (DoubleUuid) Example: 2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2 Composed of 2 colon-separated stringified UUIDv4. Represents a Workspace or an Entity in DataGalaxy's context. |
limit | number <double> Default: 20 |
page | number <double> Default: 1 |
{- "results": [
- {
- "workspaceName": "string",
- "versionName": "string",
- "originVersionId": "c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
- "originVersionName": "string",
- "isDefaultVersion": true,
- "versionId": "c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
- "status": 0
}
], - "total": null,
- "pages": 0.1,
- "total_sum": 0.1,
- "next_page": "string"
}
Manage relations between entities thanks to the entity links API. If you need more details on links, please consult our Entities Relationship documentation.
Create a link between the specified entity and its target.
Available link types can be found thanks to the GET /types
endpoint.
versionId required | string (VersionId) Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2 This id determines the scope of the request. |
fromId required | string (DoubleUuid) Example: 2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2 Composed of 2 colon-separated stringified UUIDv4. Represents a Workspace or an Entity in DataGalaxy's context. |
toId required | string (DoubleUuid) Composed of 2 colon-separated stringified UUIDv4. Represents a Workspace or an Entity in DataGalaxy's context. |
type required | string |
{- "toId": "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
- "type": "string"
}
{- "linkType": "string",
- "toId": "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
- "name": "string",
- "module": "string",
- "type": "string"
}
Return a list of all links owned by the specified entity.
versionId required | string (VersionId) Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2 This id determines the scope of the request. |
fromId required | string (DoubleUuid) Example: 2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2 Composed of 2 colon-separated stringified UUIDv4. Represents a Workspace or an Entity in DataGalaxy's context. |
[- {
- "linkType": "string",
- "toId": "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
- "name": "string",
- "module": "string",
- "type": "string"
}
]
This route creates multiple links between entities.
A link is defined by a source entity (fromId
), a target entity (toId
) and the type of link in between (type
).
versionId required | string (VersionId) Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2 This id determines the scope of the request. |
fromId required | string (DoubleUuid) Composed of 2 colon-separated stringified UUIDv4. Represents a Workspace or an Entity in DataGalaxy's context. |
toId required | string (DoubleUuid) Composed of 2 colon-separated stringified UUIDv4. Represents a Workspace or an Entity in DataGalaxy's context. |
type required | string |
[- {
- "fromId": "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
- "toId": "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
- "type": "string"
}
]
{- "total": 0,
- "created": 0,
- "updated": 0,
- "deleted": 0,
- "unchanged": 0
}
This route creates multiple links between entities.
A link is defined with the following type of object:
{
fromPath: "\\foo\\bar",
fromType: "\\NoSql\\Table",
linkType: "Implements",
toPath: "\\myLittleDimension",
toType: "\\Dimension"
}
versionId required | string (VersionId) Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2 This id determines the scope of the request. |
fromPath required | string |
fromType required | string |
linkType required | string |
toPath required | string |
toType required | string |
[- {
- "fromPath": "string",
- "fromType": "string",
- "linkType": "string",
- "toPath": "string",
- "toType": "string"
}
]
{- "total": 0.1,
- "created": 0.1,
- "updated": 0.1,
- "deleted": 0.1,
- "unchanged": 0.1
}
Deletes the specified link.
versionId required | string (VersionId) Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2 This id determines the scope of the request. |
fromId required | string (DoubleUuid) Example: 2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2 Composed of 2 colon-separated stringified UUIDv4. Represents a Workspace or an Entity in DataGalaxy's context. |
linkType required | string |
toId required | string (DoubleUuid) Example: 2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2 Composed of 2 colon-separated stringified UUIDv4. Represents a Workspace or an Entity in DataGalaxy's context. |
{- "error": {
- "message": "string",
- "status": 0.1
}
}
Use this endpoint in order to fetch Technologies, their associated modules, their description, images and metadatas related to creation, modification and usage.
Read our article on technologies for more informations.
{- "total": 0.1,
- "technologies": [
- {
- "displayName": "Amazon Athena",
- "technologyCode": "amazonathena",
- "modules": [
- "Catalog"
], - "description": "Amazon Athena is a cloud based querying service for Amazon S3 data storage",
- "imageHash": "d0lVskDXmqiczixAdKvHAmYvwoJsULxfqGty8oNihsw=",
- "thumbnailHash": "ssinU3x37+CrgvmHxUlrgh1WH12M1421sxnWlF/CfFM=",
- "svgImageHash": "yD/wnssKw4lylm3UtGN5F9pqj8zC/mlo6NnNRrR5VWI=",
- "creationTime": "2022-02-07T20:59:42.577+00:00",
- "creationUserId": "ade92d04-294e-4bff-9dfa-5ea2f5419426",
- "lastModificationTime": "2022-02-07T20:59:42.577+00:00",
- "lastModificationUserId": "ade92d04-294e-4bff-9dfa-5ea2f5419426",
- "lastUsageTime": "2022-02-07T20:59:42.577+00:00",
- "lastUsageUserId": "ade92d04-294e-4bff-9dfa-5ea2f5419426"
}
]
}
Add a custom technology to DataGalaxy using this endpoint.
Technologies can then be added to an object details using the technologyCode
property in a creation or update request payload.
Example:
POST /sources/bulktree/{versionId}
{
"name": "foo",
"type": "Relational",
"technologyCode": "azuresql",
"children": [ ... ]
}
Read our article on technologies for more informations.
technologyCode required | string The |
displayName required | string |
description required | string |
modules required | Array of strings (TechnologyModule) Items Enum: "Catalog" "Processing" "Usage" |
{- "technologyCode": "string",
- "displayName": "string",
- "description": "string",
- "modules": [
- "Catalog"
]
}
{- "displayName": "Amazon Athena",
- "technologyCode": "amazonathena",
- "modules": [
- "Catalog"
], - "description": "Amazon Athena is a cloud based querying service for Amazon S3 data storage",
- "imageHash": "d0lVskDXmqiczixAdKvHAmYvwoJsULxfqGty8oNihsw=",
- "thumbnailHash": "ssinU3x37+CrgvmHxUlrgh1WH12M1421sxnWlF/CfFM=",
- "svgImageHash": "yD/wnssKw4lylm3UtGN5F9pqj8zC/mlo6NnNRrR5VWI=",
- "creationTime": "2022-02-07T20:59:42.577+00:00",
- "creationUserId": "ade92d04-294e-4bff-9dfa-5ea2f5419426",
- "lastModificationTime": "2022-02-07T20:59:42.577+00:00",
- "lastModificationUserId": "ade92d04-294e-4bff-9dfa-5ea2f5419426",
- "lastUsageTime": "2022-02-07T20:59:42.577+00:00",
- "lastUsageUserId": "ade92d04-294e-4bff-9dfa-5ea2f5419426"
}
Update a technology's displayName
, description
and associated modules
using this endpoint.
Read our article on technologies for more informations.
technologyCode required | string |
displayName | string |
description | string |
modules | Array of strings (TechnologyModule) Items Enum: "Catalog" "Processing" "Usage" |
{- "displayName": "string",
- "description": "string",
- "modules": [
- "Catalog"
]
}
{- "displayName": "Amazon Athena",
- "technologyCode": "amazonathena",
- "modules": [
- "Catalog"
], - "description": "Amazon Athena is a cloud based querying service for Amazon S3 data storage",
- "imageHash": "d0lVskDXmqiczixAdKvHAmYvwoJsULxfqGty8oNihsw=",
- "thumbnailHash": "ssinU3x37+CrgvmHxUlrgh1WH12M1421sxnWlF/CfFM=",
- "svgImageHash": "yD/wnssKw4lylm3UtGN5F9pqj8zC/mlo6NnNRrR5VWI=",
- "creationTime": "2022-02-07T20:59:42.577+00:00",
- "creationUserId": "ade92d04-294e-4bff-9dfa-5ea2f5419426",
- "lastModificationTime": "2022-02-07T20:59:42.577+00:00",
- "lastModificationUserId": "ade92d04-294e-4bff-9dfa-5ea2f5419426",
- "lastUsageTime": "2022-02-07T20:59:42.577+00:00",
- "lastUsageUserId": "ade92d04-294e-4bff-9dfa-5ea2f5419426"
}
Delete a technology.
Read our article on technologies for more informations.
technologyCode required | string |
{- "error": {
- "message": "string",
- "status": 0.1
}
}
Search DataGalaxy objects with queries and filters
query
perfectly matches an object's text attribute value.isExactMatch
boolean (result.entities[n].isExactMatch
).Attribute type | Compatible filter operators |
---|---|
Text, FormattedText, MultiLineText, HtmlLink | contains , equals , startsWith , endsWith , isEmpty , isNotEmpty |
Boolean | equals |
Number, TimeSeriesLastEntry | equals , greaterThan , lowerThan , greaterOrEqualTo , lowerOrEqualTo , range , isEmpty , isNotEmpty |
Date, DateTime | range , pastHour , today , yesterday , currentWeek , pastWeek , beforeCurrentWeek , beforePastWeek , currentMonth , pastMonth , beforeCurrentMonth , beforePastMonth , beforeToday , currentYear , last365days , isEmpty , isNotEmpty |
ValueList | contains , excludes , equals |
Reference | contains , equals , isEmpty , isNotEmpty |
ReferenceList, ClientTag, MultiValueList, Hierarchy, PersonReference, UserReference, StewardUserReference, EntityReference, ObjectLink, AllLinkedData, UserGuid, ManagedTag | contains , isEmpty , isNotEmpty , matchAll , excludes |
Technology | contains , excludes |
query | string (SearchQuery) This term will be searched in the following attributes of an object: name, technicalName, description, summary and local synonym names |
versionId | string Version to search in. |
limit | any Default: 50 Maximum number of objects returned |
includedAttributes | Array of strings List of attributes, identified by their |
includeAccessData | boolean If set to |
Array of objects (SearchFilter) Use filters to refines your search result | |
saveSearchPayload | any Default: false If set to |
{- "query": "string",
- "versionId": "string",
- "limit": 50,
- "includedAttributes": [
- "CreationTime",
- "LastModificationTime",
- "DataOwners",
- "DataStewards",
- "ClientTags"
], - "includeAccessData": true,
- "filters": [
- {
- "attributeKey": "Type",
- "operator": "contains",
- "values": [
- "DataProcessing",
- "DataFlow",
- "DataProcessingItem"
]
}
], - "saveSearchPayload": false
}
{- "total": 0.1,
- "total_sum": 0.1,
- "result": {
- "filteredViews": [
- {
- "name": "string",
- "id": 0.1,
- "versionId": "c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
- "isPrivate": true
}
], - "entities": [
- {
- "versionId": "c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
- "accessData": {
- "hasOfficialRoleAttributesWriteAccess": true,
- "hasEntityStatusWriteAccess": true,
- "hasTaskWriteAccess": true,
- "hasReadAccess": true,
- "hasWriteAccess": true,
- "hasAdministratorAccess": true,
- "hasImportAccess": true,
- "hasExportAccess": true,
- "hasDeleteAccess": true,
- "hasCreateAccess": true,
- "hasManagementAccess": true
}, - "attributes": {
- "status": "Proposed",
- "tags": [
- "string"
], - "summary": "string",
- "description": "string",
- "owners": [
- "john.smith@email.com"
], - "stewards": [
- "john.smith@email.com"
], - "creationTime": "string",
- "lastModificationTime": "string",
- "property1": "string",
- "property2": "string"
}, - "childrenCount": 0.1,
- "path": "\\parentName\\entityName",
- "typePath": "\\parentType\\entityType",
- "functionalPath": "string",
- "location": "{dataType}/{versionId}/{objectId}",
- "objectUrl": "string",
- "parent": {
- "id": "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
- "name": "foo",
- "technicalName": "bar",
- "type": "string",
- "dataType": "string"
}, - "isWatched": true,
- "id": "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
- "name": "foo",
- "technicalName": "bar",
- "type": "string",
- "dataType": "string",
- "isExactMatch": true,
- "exactMatchAttributes": [
- {
- "attributeKey": "TechnicalName",
- "value": "Foo"
}
]
}
]
}, - "quickFilters": [
- {
- "filter": {
- "attributeKey": "Type",
- "operator": "contains",
- "values": [
- "DataProcessing",
- "DataFlow",
- "DataProcessingItem"
]
}, - "matches": 0.1
}
]
}
The queries history feature helps you retrieve search payloads you previously requested either with the POST /search
endpoint or via the DataGalaxy web application.
This history is saved manually. If you want to add an entry to it, set the saveSearchPayload
property to true
in your POST /search
request payload.
limit | number <double> Default: 20 |
{- "total": 0.1,
- "history": [
- {
- "accessCount": 0.1,
- "searchPayload": {
- "query": "string",
- "versionId": "string",
- "limit": 50,
- "filters": [
- {
- "attributeKey": "Type",
- "operator": "contains",
- "values": [
- "DataProcessing",
- "DataFlow",
- "DataProcessingItem"
]
}
], - "saveSearchPayload": false
}
}
]
}
The object history feature keeps a record of your recently accessed objects.
Each entry of the object history contains the object’s main information, including properties to help retrieve it such as location
(which is a prebuild API endpoint’s path to the object’s details).
New objects are automatically added to the history when you fetch an object's details using the GET /{dataType}/{versionId}/{objectId}
(e.g.: GET /properties/{versionId}/{objectId}).
limit | number <double> Default: 20 |
{- "total": 0.1,
- "history": [
- {
- "versionId": "c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
- "path": "\\parentName\\entityName",
- "typePath": "\\parentType\\entityType",
- "functionalPath": "string",
- "location": "{dataType}/{versionId}/{objectId}",
- "objectUrl": "string",
- "parent": {
- "id": "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
- "name": "foo",
- "technicalName": "bar",
- "type": "string",
- "dataType": "string"
}, - "isWatched": true,
- "id": "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
- "name": "foo",
- "technicalName": "bar",
- "type": "string",
- "dataType": "string"
}
]
}
Fetch the image associated to the hash
given in parameters.
The Content-Type
can be image/png
, image/jpeg
or image/svg
hash required | string Image hash to get. Must be URL-encoded. |
{- "error": {
- "message": "string",
- "status": 0.1
}
}
Upload an image to DataGalaxy and associate it to a resource using the category
property.
The maximum supported size of uploaded images is 1MB.
Supported resources are the following:
workspaceIcon
update a Workspace Icon. It can then be fetched using the GET /workspaces endpoint.technologyIcon
update a Technology Icon. It can then be fetched using the GET /technologies endpoint.image required | string <binary> Image's binary data. |
category required | string Enum: "clientSpaceImage" "workspaceImage" "workspaceIcon" "searchImage" "technologyIcon" Determines the ressource to associate the image to. |
workspaceId | string If |
technologyCode | string If |
{- "imageHash": "akrLmrLdEgjMrpULdrsgP0upBUxdbIhujQlKmotHlrQ="
}
Modifies one or more attributes of the specified object.
versionId required | string (VersionId) Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2 This id determines the scope of the request. |
objectId required | string (DoubleUuid) Example: 2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2 Composed of 2 colon-separated stringified UUIDv4. Represents a Workspace or an Entity in DataGalaxy's context. |
owners | Array of strings (Email) |
stewards | Array of strings (Email) |
tags | Array of strings |
description | string |
summary | string |
name | string |
technicalName | string |
status | string (EntityLifecycleStatusEnum) Enum: "Proposed" "InRevision" "Validated" "InValidation" "Obsolete" |
additional property | boolean or number or string or Array of strings or Array of Email (strings) or HyperLink (object) or DataTypePrecisionSize (object) or FormattedText (object) or TimeSeriesEntry (object) (CustomAttributeValue) Additional custom attribute. This property's type depends on the attribute's format. |
{- "owners": [
- "john.smith@email.com"
], - "stewards": [
- "john.smith@email.com"
], - "tags": [
- "string"
], - "description": "string",
- "summary": "string",
- "name": "string",
- "technicalName": "string",
- "status": "Proposed",
- "property1": true,
- "property2": true
}
{- "id": "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
- "location": "string"
}
Create an object with the specified attributes.
versionId required | string (VersionId) Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2 This id determines the scope of the request. |
parentId required | string (DoubleUuid) Example: 2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2 Composed of 2 colon-separated stringified UUIDv4. Represents a Workspace or an Entity in DataGalaxy's context. |
owners | Array of strings (Email) |
stewards | Array of strings (Email) |
tags | Array of strings |
description | string |
summary | string |
name | string |
technicalName | string |
status | string (EntityLifecycleStatusEnum) Enum: "Proposed" "InRevision" "Validated" "InValidation" "Obsolete" |
type required | string (EntityType) Enum: "None" "All" "BusinessTerm" "Concept" "IndicatorGroup" "Indicator" "ReferenceData" "DataFlow" "DataProcessing" "Use" "DataSet" "OpenDataSet" "Process" "Report" "Algorithm" "Application" "Screen" "Dashboard" "Feature" "Table" "Column" "NonRelationalModel" "RelationalModel" "Dimension" "DimensionGroup" "File" "Field" "NoSqlModel" "Document" "BusinessDomain" "BusinessDomainGroup" "Universe" "Model" "Directory" "Equipment" "SubStructure" "TagBase" "Tag" "View" "DataProcessingItem" "ReferenceDataValue" "UsageField" "PrimaryKey" "ForeignKey" "Diagram" "DiagramNode" "FilteredView" "Project" "Organization" "UsageComponent" "FreeDiagram" "PhysicalDiagram" |
{- "owners": [
- "john.smith@email.com"
], - "stewards": [
- "john.smith@email.com"
], - "tags": [
- "string"
], - "description": "string",
- "summary": "string",
- "name": "string",
- "technicalName": "string",
- "status": "Proposed",
- "type": "None"
}
{- "id": "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
- "location": "string"
}
Subscribe to notifications of the specified object.
versionId required | string (VersionId) Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2 This id determines the scope of the request. |
objectId required | string (DoubleUuid) Example: 2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2 Composed of 2 colon-separated stringified UUIDv4. Represents a Workspace or an Entity in DataGalaxy's context. |
{- "error": {
- "message": "string",
- "status": 0.1
}
}
Unsubscribe to notifications of the specified object.
versionId required | string (VersionId) Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2 This id determines the scope of the request. |
objectId required | string (DoubleUuid) Example: 2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2 Composed of 2 colon-separated stringified UUIDv4. Represents a Workspace or an Entity in DataGalaxy's context. |
{- "error": {
- "message": "string",
- "status": 0.1
}
}
Gets an object from its URN.
It returns a 404 if the object does not exist.
It returns a 400 if the URN is invalid.
versionId required | string <guid> |
urn required | string |
{- "object": {
- "id": { },
- "name": "string",
- "technicalName": "string",
- "urn": {
- "value": "string"
}, - "entityType": "None"
}
}
Updates an object from its URN.
It returns a 404 if the object does not exist.
It returns a 400 if the URN is invalid.
versionId required | string <guid> |
urn required | string |
name | string Object name |
technicalName | string Object technical name |
description | string Description |
summary | string Summary |
additional property | number or string or Array of arrays or object or boolean |
{- "name": "string",
- "technicalName": "string",
- "description": "string",
- "summary": "string",
- "property1": 0,
- "property2": 0
}
{- "object": {
- "id": { },
- "name": "string",
- "technicalName": "string",
- "urn": {
- "value": "string"
}
}
}
Deletes an object from its URN.
It returns a 404 if the object does not exist.
It returns a 400 if the URN is invalid.
versionId required | string <guid> |
urn required | string |
{- "object": {
- "id": { },
- "name": "string",
- "technicalName": "string",
- "urn": {
- "value": "string"
}
}
}
Creates an object from its URN.
It returns a 400 if the URN is invalid.
versionId required | string <guid> |
urn required | string Object URN (Uniform Resource Name) |
name | string Object name |
technicalName | string Object technical name |
description | string Description |
summary | string Summary |
additional property | number or string or Array of arrays or object or boolean |
Create a Snowflake view.
{- "urn": "urn:snowflake-1:myaccount.eu-central-1:mydb:myschema:myview@view",
- "query": "SELECT * FROM mytable",
- "summary": "This is an example of a view created with its URN"
}
Snowflake view successfully created.
{- "object": {
- "id": "56ca96b3-ec2d-4a27-af39-f2535ac05c36:75c8367c-8a91-4c03-b20b-5bec29841b59",
- "type": "view",
- "name": "myview",
- "technicalName": "myview",
- "urn": "urn:snowflake-1:myaccount.eu-central-1:mydb:myschema:myview@view"
}
}
Get links associated to an object from its URN.
It returns a 404 if the object does not exist.
It returns a 400 if the URN is invalid.
versionId required | string <guid> |
fromUrn required | string |
{- "links": [
- {
- "linkType": "Unknown",
- "toId": { },
- "name": "string",
- "module": "string",
- "type": "string"
}
]
}
Create a link to an object from its URN.
It returns a 404 if the object does not exist.
It returns a 400 if the URN is invalid.
versionId required | string <guid> |
fromUrn required | string |
toUrn | string |
type | string |
{- "toUrn": "string",
- "type": "string"
}
{- "link": {
- "linkType": "Unknown",
- "fromId": { },
- "toId": { }
}
}
Delete a link between two objects from their URNs.
It returns a 404 if the object does not exist.
It returns a 400 if the URN is invalid.
versionId required | string <guid> |
fromUrn required | string |
toUrn required | string |
linkType required | string |
{- "link": {
- "linkType": "Unknown",
- "fromId": { },
- "toId": { }
}
}
Creates objects and links from their URN.
versionId required | string <guid> |
Array of objects A list of objects | |
Array of objects A list of links between objects |
Import Azure Data Factory and Azure SQL objects with data processing items.
{- "objects": [
- {
- "urn": "urn:adf-1:factoryName:dataflow@dataflow"
}, - {
- "urn": "urn:azuresql-1:instance:database:schema:customers:first_name"
}, - {
- "urn": "urn:azuresql-1:instance:database:schema:customers:last_name"
}, - {
- "urn": "urn:azuresql-1:instance:database:schema:customers:name"
}, - {
- "urn": "urn:adf-1:factoryName:dataflow@dataflow",
- "dataProcessingItems": [
- {
- "name": "1",
- "type": "Undefined",
- "inputs:": [
- "urn:azuresql-1:instance:database:schema:customers:first_name",
- "urn:azuresql-1:instance:database:schema:customers:last_name"
], - "outputs": [
- "urn:azuresql-1:instance:database:schema:customers:name"
]
}
]
}
], - "links": [ ]
}
{- "property1": null,
- "property2": null
}
Gets the campaigns of the specified space
spaceGuid required | string <guid> |
versionId required | string |
{- "campaigns": [
- {
- "guid": "string",
- "name": "string",
- "attributePath": "string",
- "description": "string",
- "owner": {
- "referenceId": { },
- "fullName": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "userId": "string",
- "profileImageHash": "string",
- "profileThumbnailHash": "string",
- "licenseLevel": 0
}, - "creationUser": {
- "referenceId": { },
- "fullName": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "userId": "string",
- "profileImageHash": "string",
- "profileThumbnailHash": "string",
- "licenseLevel": 0
}, - "spaceGuid": "string",
- "versionId": "string",
- "ended": true,
- "currentPhase": {
- "guid": "string",
- "name": "string",
- "description": "string",
- "assignees": [
- {
- "referenceId": { },
- "fullName": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "userId": "string",
- "profileImageHash": "string",
- "profileThumbnailHash": "string",
- "licenseLevel": 0
}
], - "phaseType": 0,
- "transitions": [
- {
- "name": "string",
- "description": "string",
- "sourcePhase": {
- "guid": "string",
- "name": "string",
- "description": "string",
- "assignees": [
- {
- "referenceId": { },
- "fullName": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "userId": "string",
- "profileImageHash": "string",
- "profileThumbnailHash": "string",
- "licenseLevel": 0
}
]
}, - "targetPhase": {
- "guid": "string",
- "name": "string",
- "description": "string",
- "assignees": [
- {
- "referenceId": { },
- "fullName": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "userId": "string",
- "profileImageHash": "string",
- "profileThumbnailHash": "string",
- "licenseLevel": 0
}
]
}, - "direction": 0,
- "expectedAttributeValuesStrings": [
- "string"
], - "objectsStatusDictionary": {
- "property1": true,
- "property2": true
}, - "active": true
}
]
}, - "workflowName": "string",
- "creationTime": "2019-08-24T14:15:22Z"
}
]
}
Gets the campaigns using the specified object
required | object (ReferenceId) |
versionId required | string |
{- "campaigns": [
- {
- "guid": "string",
- "name": "string",
- "attributePath": "string",
- "description": "string",
- "owner": {
- "referenceId": { },
- "fullName": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "userId": "string",
- "profileImageHash": "string",
- "profileThumbnailHash": "string",
- "licenseLevel": 0
}, - "creationUser": {
- "referenceId": { },
- "fullName": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "userId": "string",
- "profileImageHash": "string",
- "profileThumbnailHash": "string",
- "licenseLevel": 0
}, - "spaceGuid": "string",
- "versionId": "string",
- "ended": true,
- "currentPhase": {
- "guid": "string",
- "name": "string",
- "description": "string",
- "assignees": [
- {
- "referenceId": { },
- "fullName": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "userId": "string",
- "profileImageHash": "string",
- "profileThumbnailHash": "string",
- "licenseLevel": 0
}
], - "phaseType": 0,
- "transitions": [
- {
- "name": "string",
- "description": "string",
- "sourcePhase": {
- "guid": "string",
- "name": "string",
- "description": "string",
- "assignees": [
- {
- "referenceId": { },
- "fullName": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "userId": "string",
- "profileImageHash": "string",
- "profileThumbnailHash": "string",
- "licenseLevel": 0
}
]
}, - "targetPhase": {
- "guid": "string",
- "name": "string",
- "description": "string",
- "assignees": [
- {
- "referenceId": { },
- "fullName": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "userId": "string",
- "profileImageHash": "string",
- "profileThumbnailHash": "string",
- "licenseLevel": 0
}
]
}, - "direction": 0,
- "expectedAttributeValuesStrings": [
- "string"
], - "objectsStatusDictionary": {
- "property1": true,
- "property2": true
}, - "active": true
}
]
}, - "workflowName": "string",
- "creationTime": "2019-08-24T14:15:22Z"
}
]
}
Creates a new campaign
workflowGuid | string <guid> |
name | string or null |
description | string or null |
ownerGuid | string <guid> |
spaceGuid | string <guid> |
referenceIds | Array of strings or null |
versionId | string or null |
{- "workflowGuid": "string",
- "name": "string",
- "description": "string",
- "ownerGuid": "string",
- "spaceGuid": "string",
- "referenceIds": [
- "string"
], - "versionId": "string"
}
{- "guid": "string"
}
{- "campaign": {
- "guid": "string",
- "name": "string",
- "attributePath": "string",
- "description": "string",
- "owner": {
- "referenceId": { },
- "fullName": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "userId": "string",
- "profileImageHash": "string",
- "profileThumbnailHash": "string",
- "licenseLevel": 0
}, - "creationUser": {
- "referenceId": { },
- "fullName": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "userId": "string",
- "profileImageHash": "string",
- "profileThumbnailHash": "string",
- "licenseLevel": 0
}, - "spaceGuid": "string",
- "versionId": "string",
- "ended": true,
- "currentPhase": {
- "guid": "string",
- "name": "string",
- "description": "string",
- "assignees": [
- {
- "referenceId": { },
- "fullName": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "userId": "string",
- "profileImageHash": "string",
- "profileThumbnailHash": "string",
- "licenseLevel": 0
}
], - "phaseType": 0,
- "transitions": [
- {
- "name": "string",
- "description": "string",
- "sourcePhase": {
- "guid": "string",
- "name": "string",
- "description": "string",
- "assignees": [
- {
- "referenceId": { },
- "fullName": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "userId": "string",
- "profileImageHash": "string",
- "profileThumbnailHash": "string",
- "licenseLevel": 0
}
]
}, - "targetPhase": {
- "guid": "string",
- "name": "string",
- "description": "string",
- "assignees": [
- {
- "referenceId": { },
- "fullName": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "userId": "string",
- "profileImageHash": "string",
- "profileThumbnailHash": "string",
- "licenseLevel": 0
}
]
}, - "direction": 0,
- "expectedAttributeValuesStrings": [
- "string"
], - "objectsStatusDictionary": {
- "property1": true,
- "property2": true
}, - "active": true
}
]
}, - "workflowName": "string",
- "creationTime": "2019-08-24T14:15:22Z",
- "referenceIds": [
- "string"
], - "supportedAttributeValues": [
- "string"
]
}
}
{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "instance": "string",
- "extensions": {
- "property1": null,
- "property2": null
}, - "property1": null,
- "property2": null
}
Updates the specified campaign
guid required | string <guid> |
guid | string <guid> |
name | string or null |
description | string or null |
ownerGuid | string <guid> |
{- "guid": "string",
- "name": "string",
- "description": "string",
- "ownerGuid": "string"
}
{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "instance": "string",
- "extensions": {
- "property1": null,
- "property2": null
}, - "property1": null,
- "property2": null
}
Adds one or multiple entities to the specified campaign
guid required | string <guid> |
versionId required | string |
guid | string <guid> |
versionId | string or null |
referenceIds | Array of strings or null |
{- "guid": "string",
- "versionId": "string",
- "referenceIds": [
- "string"
]
}
{- "campaign": {
- "guid": "string",
- "name": "string",
- "attributePath": "string",
- "description": "string",
- "owner": {
- "referenceId": { },
- "fullName": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "userId": "string",
- "profileImageHash": "string",
- "profileThumbnailHash": "string",
- "licenseLevel": 0
}, - "creationUser": {
- "referenceId": { },
- "fullName": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "userId": "string",
- "profileImageHash": "string",
- "profileThumbnailHash": "string",
- "licenseLevel": 0
}, - "spaceGuid": "string",
- "versionId": "string",
- "ended": true,
- "currentPhase": {
- "guid": "string",
- "name": "string",
- "description": "string",
- "assignees": [
- {
- "referenceId": { },
- "fullName": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "userId": "string",
- "profileImageHash": "string",
- "profileThumbnailHash": "string",
- "licenseLevel": 0
}
], - "phaseType": 0,
- "transitions": [
- {
- "name": "string",
- "description": "string",
- "sourcePhase": {
- "guid": "string",
- "name": "string",
- "description": "string",
- "assignees": [
- {
- "referenceId": { },
- "fullName": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "userId": "string",
- "profileImageHash": "string",
- "profileThumbnailHash": "string",
- "licenseLevel": 0
}
]
}, - "targetPhase": {
- "guid": "string",
- "name": "string",
- "description": "string",
- "assignees": [
- {
- "referenceId": { },
- "fullName": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "userId": "string",
- "profileImageHash": "string",
- "profileThumbnailHash": "string",
- "licenseLevel": 0
}
]
}, - "direction": 0,
- "expectedAttributeValuesStrings": [
- "string"
], - "objectsStatusDictionary": {
- "property1": true,
- "property2": true
}, - "active": true
}
]
}, - "workflowName": "string",
- "creationTime": "2019-08-24T14:15:22Z",
- "referenceIds": [
- "string"
], - "supportedAttributeValues": [
- "string"
]
}
}
Gets the events for the specified campaign
guid required | string <guid> |
{- "campaignEvents": [
- {
- "eventTypeName": "string",
- "clientGuid": "string",
- "userGuid": "string",
- "userFullName": "string",
- "creationTime": "2019-08-24T14:15:22Z"
}
]
}
Removes one or multiple entities from the specified compaign
guid required | string <guid> |
guid | string <guid> |
referenceIds | Array of strings or null |
{- "guid": "string",
- "referenceIds": [
- "string"
]
}
{- "campaign": {
- "guid": "string",
- "name": "string",
- "attributePath": "string",
- "description": "string",
- "owner": {
- "referenceId": { },
- "fullName": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "userId": "string",
- "profileImageHash": "string",
- "profileThumbnailHash": "string",
- "licenseLevel": 0
}, - "creationUser": {
- "referenceId": { },
- "fullName": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "userId": "string",
- "profileImageHash": "string",
- "profileThumbnailHash": "string",
- "licenseLevel": 0
}, - "spaceGuid": "string",
- "versionId": "string",
- "ended": true,
- "currentPhase": {
- "guid": "string",
- "name": "string",
- "description": "string",
- "assignees": [
- {
- "referenceId": { },
- "fullName": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "userId": "string",
- "profileImageHash": "string",
- "profileThumbnailHash": "string",
- "licenseLevel": 0
}
], - "phaseType": 0,
- "transitions": [
- {
- "name": "string",
- "description": "string",
- "sourcePhase": {
- "guid": "string",
- "name": "string",
- "description": "string",
- "assignees": [
- {
- "referenceId": { },
- "fullName": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "userId": "string",
- "profileImageHash": "string",
- "profileThumbnailHash": "string",
- "licenseLevel": 0
}
]
}, - "targetPhase": {
- "guid": "string",
- "name": "string",
- "description": "string",
- "assignees": [
- {
- "referenceId": { },
- "fullName": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "userId": "string",
- "profileImageHash": "string",
- "profileThumbnailHash": "string",
- "licenseLevel": 0
}
]
}, - "direction": 0,
- "expectedAttributeValuesStrings": [
- "string"
], - "objectsStatusDictionary": {
- "property1": true,
- "property2": true
}, - "active": true
}
]
}, - "workflowName": "string",
- "creationTime": "2019-08-24T14:15:22Z",
- "referenceIds": [
- "string"
], - "supportedAttributeValues": [
- "string"
]
}
}
Sets the current phase of the specified campaign
guid required | string <guid> |
phaseGuid required | string <guid> |
{- "campaign": {
- "guid": "string",
- "name": "string",
- "attributePath": "string",
- "description": "string",
- "owner": {
- "referenceId": { },
- "fullName": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "userId": "string",
- "profileImageHash": "string",
- "profileThumbnailHash": "string",
- "licenseLevel": 0
}, - "creationUser": {
- "referenceId": { },
- "fullName": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "userId": "string",
- "profileImageHash": "string",
- "profileThumbnailHash": "string",
- "licenseLevel": 0
}, - "spaceGuid": "string",
- "versionId": "string",
- "ended": true,
- "currentPhase": {
- "guid": "string",
- "name": "string",
- "description": "string",
- "assignees": [
- {
- "referenceId": { },
- "fullName": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "userId": "string",
- "profileImageHash": "string",
- "profileThumbnailHash": "string",
- "licenseLevel": 0
}
], - "phaseType": 0,
- "transitions": [
- {
- "name": "string",
- "description": "string",
- "sourcePhase": {
- "guid": "string",
- "name": "string",
- "description": "string",
- "assignees": [
- {
- "referenceId": { },
- "fullName": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "userId": "string",
- "profileImageHash": "string",
- "profileThumbnailHash": "string",
- "licenseLevel": 0
}
]
}, - "targetPhase": {
- "guid": "string",
- "name": "string",
- "description": "string",
- "assignees": [
- {
- "referenceId": { },
- "fullName": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "userId": "string",
- "profileImageHash": "string",
- "profileThumbnailHash": "string",
- "licenseLevel": 0
}
]
}, - "direction": 0,
- "expectedAttributeValuesStrings": [
- "string"
], - "objectsStatusDictionary": {
- "property1": true,
- "property2": true
}, - "active": true
}
]
}, - "workflowName": "string",
- "creationTime": "2019-08-24T14:15:22Z",
- "referenceIds": [
- "string"
], - "supportedAttributeValues": [
- "string"
]
}
}
Returns all Campaign objects that not accessible by current user
guid required | string <guid> |
versionId required | string |
{- "entities": [
- {
- "referenceId": { },
- "entityType": 0,
- "technologyCode": "string"
}
]
}
Creates a new workflow
name | string or null |
description | string or null |
attributePath | string or null |
Array of objects or null (WorkflowPhaseDto) | |
spaceGuid | string <guid> |
{- "name": "string",
- "description": "string",
- "attributePath": "string",
- "phases": [
- {
- "name": "string",
- "description": "string",
- "phaseType": 0,
- "transitions": [
- {
- "transitionName": "string",
- "targetPhaseName": "string",
- "description": "string",
- "direction": 0,
- "expectedAttributeValues": [
- "string"
]
}
], - "assignees": [
- {
- "userGuid": "string",
- "teamGuid": "string",
- "governanceRole": {
- "attributePath": "string"
}
}
]
}
], - "spaceGuid": "string"
}
{- "guid": "string"
}
Updates the spedified workflow
workflowGuid required | string <guid> |
name | string or null |
description | string or null |
attributePath | string or null |
Array of objects or null (WorkflowPhaseDto) |
{- "name": "string",
- "description": "string",
- "attributePath": "string",
- "phases": [
- {
- "name": "string",
- "description": "string",
- "phaseType": 0,
- "transitions": [
- {
- "transitionName": "string",
- "targetPhaseName": "string",
- "description": "string",
- "direction": 0,
- "expectedAttributeValues": [
- "string"
]
}
], - "assignees": [
- {
- "userGuid": "string",
- "teamGuid": "string",
- "governanceRole": {
- "attributePath": "string"
}
}
]
}
]
}
{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "instance": "string",
- "extensions": {
- "property1": null,
- "property2": null
}, - "property1": null,
- "property2": null
}
Deletes the specified workflow
workflowGuid required | string <guid> |
{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "instance": "string",
- "extensions": {
- "property1": null,
- "property2": null
}, - "property1": null,
- "property2": null
}
Allows to define business rules which characterize the data quality level. Depending on the uses and business constraints, these rules may cover several aspects of the data, such as its integrity, freshness, or completeness.
Checks can be created on these rules to frequently report the status of the data quality.
Gets a list of data quality rules using query parameters as filters.
Use cases:
?workspaceId={workspaceId}
?entityId={entityId}
.
You can also use the path and type path: ?entityPath={entityPath}&entityTypePath={entityTypePath}&versionId={versionId}
.
?code={code}&workspaceId={workspaceId}
entityId | string or null Entity unique identifier (composed of the workspace UUID and the object UUID separated by a colon). Example: bd95bbbf-16f8-4618-ab47-4ee835563304:52e35910-c3d0-45ce-b330-a9db28e5dc73 |
entityPath | string or null Entity path using backslash (\) as a separator. Example: \Zoho\CRM\Client. Please note that \ must be escaped in JSON string (i.e., "\\Zoho\\CRM\\Client") |
entityTypePath | string or null Entity type path using backslash (\) as a separator. Example: \Relational\Model\Table. Please note that \ must be escaped in JSON string (i.e., "\\Relational\\Model\\Table") |
versionId | string or null Workspace version unique identifier. Example: 22b5dc8c-8a19-48fa-99e3-a3da9bfe0068 |
workspaceId | string or null Workspace unique identifier. Example: 4765f58d-4cb0-4700-8fe3-d4ddee360391 |
code | string or null External identifier of the rule. Example: 123_client_code_unique |
{- "rules": [
- {
- "id": "ec64748c-059e-4a6a-a9db-5f9e634a2da8",
- "statement": "Invoice must include reference",
- "code": "invoice_missing_reference",
- "type": "completeness",
- "entityId": "bd95bbbf-16f8-4618-ab47-4ee835563304:52e35910-c3d0-45ce-b330-a9db28e5dc73",
- "clientId": "738b9d4d-3fa5-46dd-bc9f-1c76a45a6b60",
- "creationTime": "2024-02-13T10:11:12.13Z",
- "userId": "00776c0e-cd9e-439f-81dd-7f58e8105aaa",
- "fieldIds": [
- "bd95bbbf-16f8-4618-ab47-4ee835563304:6efa4837-641c-4cab-8362-96a486abd9dd",
- "bd95bbbf-16f8-4618-ab47-4ee835563304:96103b9f-bf36-40fc-80ae-f614a6153861"
], - "lastChecks": [
- {
- "id": "53768fce-c7c4-4216-bc5b-6d477abe2012",
- "ruleId": "ec64748c-059e-4a6a-a9db-5f9e634a2da8",
- "status": "passed",
- "message": "Everything looks good!",
- "userId": "00776c0e-cd9e-439f-81dd-7f58e8105aaa",
- "creationTime": "2024-01-02T03:04:05.678Z"
}, - {
- "id": "e8ffb3f6-55b4-46d9-b8c4-9e6483f870da",
- "ruleId": "ec64748c-059e-4a6a-a9db-5f9e634a2da8",
- "status": "failed",
- "message": "Oh oh... something bad happened!",
- "detail": "Processing foo...\nProcessing bar...\nError: something bad happened!\nStack trace: org.acme.DataQualityProcessor.main()",
- "userId": "00776c0e-cd9e-439f-81dd-7f58e8105aaa",
- "creationTime": "2024-01-02T04:05:06.789Z"
}
]
}
]
}
Creates a new data quality rule on a given entity.
You must either provide a versionId, entityPath and entityTypePath, or an entityId.
statement | string Statement of the rule in natural language. Example: Client code must be unique |
code | string or null External identifier of the rule (must be unique in a workspace). Example: 123_client_code_unique |
versionId | string or null <guid> Workspace version unique identifier. Example: 22b5dc8c-8a19-48fa-99e3-a3da9bfe0068 |
entityId | string or null Entity unique identifier (composed of the workspace UUID and the object UUID separated by a colon). Example: bd95bbbf-16f8-4618-ab47-4ee835563304:52e35910-c3d0-45ce-b330-a9db28e5dc73 |
(RuleTypeEnum (string or null)) Rule type. Must be one of the seven dimensions of data quality assessment: completeness, accuracy, consistency, validity, uniqueness, integrity or timeliness | |
entityPath | string or null Entity path using backslash (\) as a separator. Example: \Zoho\CRM\Client. Please note that \ must be escaped in JSON string (i.e., "\\Zoho\\CRM\\Client") |
entityTypePath | string or null Entity type path using backslash (\) as a separator. Example: \Relational\Model\Table. Please note that \ must be escaped in JSON string (i.e., "\\Relational\\Model\\Table") |
fieldIds | Array of strings or null |
(SeverityEnum (string or null)) | |
category | string or null |
description | string or null |
externalUrl | string or null |
{- "statement": "Client code must be unique",
- "code": "client_code_unique",
- "type": "uniqueness",
- "versionId": "4aeae8a9-0c0d-4fa9-a8af-cb529bb64fa2",
- "entityPath": "\\Zoho\\CRM\\Client",
- "entityTypePath": "\\Relational\\Model\\Table"
}
{- "ruleId": "string"
}
Gets the specified data quality rule.
It returns at most the latest 1000 checks for the data quality rule.
ruleId required | string <guid> Unique rule identifier. Example: ec64748c-059e-4a6a-a9db-5f9e634a2da8 |
{- "id": "ec64748c-059e-4a6a-a9db-5f9e634a2da8",
- "statement": "Invoice must include reference",
- "code": "invoice_missing_reference",
- "type": "completeness",
- "entityId": "bd95bbbf-16f8-4618-ab47-4ee835563304:52e35910-c3d0-45ce-b330-a9db28e5dc73",
- "clientId": "738b9d4d-3fa5-46dd-bc9f-1c76a45a6b60",
- "creationTime": "2024-02-13T10:11:12.13Z",
- "userId": "00776c0e-cd9e-439f-81dd-7f58e8105aaa",
- "fieldIds": [
- "bd95bbbf-16f8-4618-ab47-4ee835563304:6efa4837-641c-4cab-8362-96a486abd9dd",
- "bd95bbbf-16f8-4618-ab47-4ee835563304:96103b9f-bf36-40fc-80ae-f614a6153861"
], - "lastChecks": [
- {
- "id": "53768fce-c7c4-4216-bc5b-6d477abe2012",
- "ruleId": "ec64748c-059e-4a6a-a9db-5f9e634a2da8",
- "status": "passed",
- "message": "Everything looks good!",
- "userId": "00776c0e-cd9e-439f-81dd-7f58e8105aaa",
- "creationTime": "2024-01-02T03:04:05.678Z"
}, - {
- "id": "e8ffb3f6-55b4-46d9-b8c4-9e6483f870da",
- "ruleId": "ec64748c-059e-4a6a-a9db-5f9e634a2da8",
- "status": "failed",
- "message": "Oh oh... something bad happened!",
- "detail": "Processing foo...\nProcessing bar...\nError: something bad happened!\nStack trace: org.acme.DataQualityProcessor.main()",
- "userId": "00776c0e-cd9e-439f-81dd-7f58e8105aaa",
- "creationTime": "2024-01-02T04:05:06.789Z"
}
]
}
Updates the code
and/or statement
and/or the type
and/or the fieldIds
on the specified data quality rule.
Other fields cannot be updated.
If code
is:
- provided with an non null and non empty string value,
then the code of the rule will be updated to this value. Example: { "code": "newCode" }
- provided with a null or empty string value,
then the code of the rule will be reset to null. Example: { "code": null }
- not provided,
then the code of the rule will not be updated. Example: { }
ruleId required | string <guid> Unique rule identifier. Example: ec64748c-059e-4a6a-a9db-5f9e634a2da8 |
UpdateRuleParameter
(RuleTypeEnum (string or null)) | |
(SeverityEnum (string or null)) | |
code | string or null |
statement | string or null |
fieldIds | Array of strings or null |
category | string or null |
description | string or null |
externalUrl | string or null |
{- "type": "Completeness",
- "severity": "Low",
- "code": "string",
- "statement": "string",
- "fieldIds": [
- "string"
], - "category": "string",
- "description": "string",
- "externalUrl": "string"
}
{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "instance": "string",
- "extensions": {
- "property1": null,
- "property2": null
}, - "property1": null,
- "property2": null
}
Deletes the specified data quality rule.
ruleId required | string <guid> Unique rule identifier. Example: ec64748c-059e-4a6a-a9db-5f9e634a2da8 |
{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "instance": "string",
- "extensions": {
- "property1": null,
- "property2": null
}, - "property1": null,
- "property2": null
}
Gets the rule checks for the specified data quality rule.
It returns at most the latest 1000 checks.
ruleId required | string <guid> Unique rule identifier. Example: ec64748c-059e-4a6a-a9db-5f9e634a2da8 |
{- "checks": [
- {
- "id": "53768fce-c7c4-4216-bc5b-6d477abe2012",
- "ruleId": "ec64748c-059e-4a6a-a9db-5f9e634a2da8",
- "status": "passed",
- "message": "Everything looks good!",
- "userId": "00776c0e-cd9e-439f-81dd-7f58e8105aaa",
- "creationTime": "2024-01-02T03:04:05.678Z"
}
]
}
Creates a new rule check for the specified data quality rule.
ruleId required | string <guid> Unique rule identifier. Example: ec64748c-059e-4a6a-a9db-5f9e634a2da8 |
CreateRuleCheckParameter
status | string (DataQualityStatusEnum) Enum: "Unknown" "Passed" "Warning" "Failed" |
message | string or null |
detail | string or null |
creationTime | string or null |
{- "status": "passed",
- "message": "Everything looks good!",
- "detail": "noop",
- "creationTime": "2024-08-26T12:34:56.789Z"
}
{- "checkId": "53768fce-c7c4-4216-bc5b-6d477abe2012"
}
Deletes the specified data quality rule check.
ruleId required | string <guid> Unique rule identifier. Example: ec64748c-059e-4a6a-a9db-5f9e634a2da8 |
checkId required | string <guid> Unique rule check identifier. Example: 53768fce-c7c4-4216-bc5b-6d477abe2012 |
{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "instance": "string",
- "extensions": {
- "property1": null,
- "property2": null
}, - "property1": null,
- "property2": null
}
Modifies one or more attributes of the specified object.
versionId required | string (VersionId) Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2 This id determines the scope of the request. |
objectId required | string (DoubleUuid) Example: 2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2 Composed of 2 colon-separated stringified UUIDv4. Represents a Workspace or an Entity in DataGalaxy's context. |
owners | Array of strings (Email) |
stewards | Array of strings (Email) |
tags | Array of strings |
description | string |
summary | string |
name | string |
technicalName | string |
status | string (EntityLifecycleStatusEnum) Enum: "Proposed" "InRevision" "Validated" "InValidation" "Obsolete" |
additional property | boolean or number or string or Array of strings or Array of Email (strings) or HyperLink (object) or DataTypePrecisionSize (object) or FormattedText (object) or TimeSeriesEntry (object) (CustomAttributeValue) Additional custom attribute. This property's type depends on the attribute's format. |
{- "owners": [
- "john.smith@email.com"
], - "stewards": [
- "john.smith@email.com"
], - "tags": [
- "string"
], - "description": "string",
- "summary": "string",
- "name": "string",
- "technicalName": "string",
- "status": "Proposed",
- "property1": true,
- "property2": true
}
{- "id": "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
- "location": "string"
}
Create an object with the specified attributes.
versionId required | string (VersionId) Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2 This id determines the scope of the request. |
parentId required | string (DoubleUuid) Example: 2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2 Composed of 2 colon-separated stringified UUIDv4. Represents a Workspace or an Entity in DataGalaxy's context. |
owners | Array of strings (Email) |
stewards | Array of strings (Email) |
tags | Array of strings |
description | string |
summary | string |
name | string |
technicalName | string |
status | string (EntityLifecycleStatusEnum) Enum: "Proposed" "InRevision" "Validated" "InValidation" "Obsolete" |
type required | string (EntityType) Enum: "None" "All" "BusinessTerm" "Concept" "IndicatorGroup" "Indicator" "ReferenceData" "DataFlow" "DataProcessing" "Use" "DataSet" "OpenDataSet" "Process" "Report" "Algorithm" "Application" "Screen" "Dashboard" "Feature" "Table" "Column" "NonRelationalModel" "RelationalModel" "Dimension" "DimensionGroup" "File" "Field" "NoSqlModel" "Document" "BusinessDomain" "BusinessDomainGroup" "Universe" "Model" "Directory" "Equipment" "SubStructure" "TagBase" "Tag" "View" "DataProcessingItem" "ReferenceDataValue" "UsageField" "PrimaryKey" "ForeignKey" "Diagram" "DiagramNode" "FilteredView" "Project" "Organization" "UsageComponent" "FreeDiagram" "PhysicalDiagram" |
{- "owners": [
- "john.smith@email.com"
], - "stewards": [
- "john.smith@email.com"
], - "tags": [
- "string"
], - "description": "string",
- "summary": "string",
- "name": "string",
- "technicalName": "string",
- "status": "Proposed",
- "type": "None"
}
{- "id": "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
- "location": "string"
}
Subscribe to notifications of the specified object.
versionId required | string (VersionId) Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2 This id determines the scope of the request. |
objectId required | string (DoubleUuid) Example: 2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2 Composed of 2 colon-separated stringified UUIDv4. Represents a Workspace or an Entity in DataGalaxy's context. |
{- "error": {
- "message": "string",
- "status": 0.1
}
}
Unsubscribe to notifications of the specified object.
versionId required | string (VersionId) Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2 This id determines the scope of the request. |
objectId required | string (DoubleUuid) Example: 2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2 Composed of 2 colon-separated stringified UUIDv4. Represents a Workspace or an Entity in DataGalaxy's context. |
{- "error": {
- "message": "string",
- "status": 0.1
}
}
Gets an object from its URN.
It returns a 404 if the object does not exist.
It returns a 400 if the URN is invalid.
versionId required | string <guid> |
urn required | string |
{- "object": {
- "id": { },
- "name": "string",
- "technicalName": "string",
- "urn": {
- "value": "string"
}, - "entityType": "None"
}
}
Updates an object from its URN.
It returns a 404 if the object does not exist.
It returns a 400 if the URN is invalid.
versionId required | string <guid> |
urn required | string |
name | string Object name |
technicalName | string Object technical name |
description | string Description |
summary | string Summary |
additional property | number or string or Array of arrays or object or boolean |
{- "name": "string",
- "technicalName": "string",
- "description": "string",
- "summary": "string",
- "property1": 0,
- "property2": 0
}
{- "object": {
- "id": { },
- "name": "string",
- "technicalName": "string",
- "urn": {
- "value": "string"
}
}
}
Deletes an object from its URN.
It returns a 404 if the object does not exist.
It returns a 400 if the URN is invalid.
versionId required | string <guid> |
urn required | string |
{- "object": {
- "id": { },
- "name": "string",
- "technicalName": "string",
- "urn": {
- "value": "string"
}
}
}
Creates an object from its URN.
It returns a 400 if the URN is invalid.
versionId required | string <guid> |
urn required | string Object URN (Uniform Resource Name) |
name | string Object name |
technicalName | string Object technical name |
description | string Description |
summary | string Summary |
additional property | number or string or Array of arrays or object or boolean |
Create a Snowflake view.
{- "urn": "urn:snowflake-1:myaccount.eu-central-1:mydb:myschema:myview@view",
- "query": "SELECT * FROM mytable",
- "summary": "This is an example of a view created with its URN"
}
Snowflake view successfully created.
{- "object": {
- "id": "56ca96b3-ec2d-4a27-af39-f2535ac05c36:75c8367c-8a91-4c03-b20b-5bec29841b59",
- "type": "view",
- "name": "myview",
- "technicalName": "myview",
- "urn": "urn:snowflake-1:myaccount.eu-central-1:mydb:myschema:myview@view"
}
}
Get links associated to an object from its URN.
It returns a 404 if the object does not exist.
It returns a 400 if the URN is invalid.
versionId required | string <guid> |
fromUrn required | string |
{- "links": [
- {
- "linkType": "Unknown",
- "toId": { },
- "name": "string",
- "module": "string",
- "type": "string"
}
]
}
Create a link to an object from its URN.
It returns a 404 if the object does not exist.
It returns a 400 if the URN is invalid.
versionId required | string <guid> |
fromUrn required | string |
toUrn | string |
type | string |
{- "toUrn": "string",
- "type": "string"
}
{- "link": {
- "linkType": "Unknown",
- "fromId": { },
- "toId": { }
}
}
Delete a link between two objects from their URNs.
It returns a 404 if the object does not exist.
It returns a 400 if the URN is invalid.
versionId required | string <guid> |
fromUrn required | string |
toUrn required | string |
linkType required | string |
{- "link": {
- "linkType": "Unknown",
- "fromId": { },
- "toId": { }
}
}
Creates objects and links from their URN.
versionId required | string <guid> |
Array of objects A list of objects | |
Array of objects A list of links between objects |
Import Azure Data Factory and Azure SQL objects with data processing items.
{- "objects": [
- {
- "urn": "urn:adf-1:factoryName:dataflow@dataflow"
}, - {
- "urn": "urn:azuresql-1:instance:database:schema:customers:first_name"
}, - {
- "urn": "urn:azuresql-1:instance:database:schema:customers:last_name"
}, - {
- "urn": "urn:azuresql-1:instance:database:schema:customers:name"
}, - {
- "urn": "urn:adf-1:factoryName:dataflow@dataflow",
- "dataProcessingItems": [
- {
- "name": "1",
- "type": "Undefined",
- "inputs:": [
- "urn:azuresql-1:instance:database:schema:customers:first_name",
- "urn:azuresql-1:instance:database:schema:customers:last_name"
], - "outputs": [
- "urn:azuresql-1:instance:database:schema:customers:name"
]
}
]
}
], - "links": [ ]
}
{- "property1": null,
- "property2": null
}
Retrieve all of the attributes (custom or not) defined in your client space. If you need more detail, please consult our Attributes documentation.
Deprecation warning:
This route is no longer maintained and is replaced by GET /attributes
.
Return a list of attributes available for the specified dataType.
versionId required | string (VersionId) Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2 This id determines the scope of the request. |
moduleName | string |
limit | number <double> Default: 20 |
page | number <double> Default: 1 |
{- "results": [
- {
- "dataType": "string",
- "subType": "string",
- "attributes": [
- {
- "mandatory": true,
- "description": "string",
- "isCdp": true,
- "attributeType": "string",
- "attributeKey": "string",
- "name": "string"
}
]
}
], - "total": null,
- "pages": 0.1,
- "total_sum": 0.1,
- "next_page": "string"
}
This route fetches available values for attributes with format:
ValueList
,Hierarchy
,MultiValueList
,ManagedTag
,ClientTag
.Learn more about attributes with this article.
dataType required | string (AttributeDataTypeEnum) Enum: "Property" "Source" "Container" "Structure" "Field" "DataProcessing" "Usage" "Common" |
attributeKey required | string (AttributeKey) Unique attribute identifier. Can be found with GET /attributes or when creating attributes with POST /attributes |
[ ]
This route adds up to 100 values to attributes with format:
ValueList
,Hierarchy
,MultiValueList
,ManagedTag
,ClientTag
.Attributes with format ValueList
expect a list of string values.
Attributes with format Hierarchy
, MultiValueList
, ManagedTag
and ClientTag
expect a request body with TagsBody
schema.
Learn more about attributes with this article.
dataType required | string (AttributeDataTypeEnum) Enum: "Property" "Source" "Container" "Structure" "Field" "DataProcessing" "Usage" "Common" |
attributeKey required | string (AttributeKey) Unique attribute identifier. Can be found with GET /attributes or when creating attributes with POST /attributes |
label required | string |
description | string |
Color (string) or string | |
keywords | Array of strings |
isActive | boolean |
isUserSuggestionEnabled | boolean |
[ ]
[ ]
This route updates up to 100 attribute values for attributes with format:
ValueList
,Hierarchy
,MultiValueList
,ManagedTag
,ClientTag
.
Attributes with format ValueList
expect a request body with AttributeValue
schema.
Attributes with format Hierarchy
, MultiValueList
, ManagedTag
and ClientTag
expect a request body with TagsBody
schema.
Learn more about attributes with this article.
dataType required | string (AttributeDataTypeEnum) Enum: "Property" "Source" "Container" "Structure" "Field" "DataProcessing" "Usage" "Common" |
attributeKey required | string (AttributeKey) Unique attribute identifier. Can be found with GET /attributes or when creating attributes with POST /attributes |
label required | string |
description | string |
Color (string) or string | |
keywords | Array of strings |
isActive | boolean |
isUserSuggestionEnabled | boolean |
[ ]