DataGalaxy logo
API docs by Redocly

Developer API - DataGalaxy (2.31.0)

Download OpenAPI specification:Download

License: DataGalaxy©

Overview

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.

Response Status Codes

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.)

Rate Limits

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.

Query parameters

Boolean query parameters only accept the values true and false.

Pagination

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.

Authentication

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.

💡 Tip A Personal Access Token (PAT) can be generated from the "Security" tab on your user profile. Similarly, an integration token can be generated from the "Integration" page on the DataGalaxy Administration space.

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.

ℹ️ Note The DataGalaxy API will transparently generate an access token from your Personal Access Token (PAT) or your integration token. If you have obtained an access token by manually calling the deprecated /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.

Personal Access Token claims reference

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

Integration token claims reference

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

Access token claims reference

ℹ️ Note You should not manipulate access tokens directly but use personal access tokens or integration tokens instead.
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

Changelog

The DataGalaxy Developer API is updated frequently with new features, improvements and fixes.

All these changes will be documented in our .

Documentation layout

We provide two API documentation layouts:

  • Default layout
    This layout displays information in a modern way and contains more information about requests parameters
  • Swagger layout
    This is our legacy layout. It's main perk is the "Try it" feature which lets you send requests directly from the documentation.

Authentication

Generate your access token.

Generate an access token. Deprecated

🗑 Deprecated It's recommended to use your PAT (Personal Access Token) or integration token directly.

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.

Authorizations:
Integration tokenPersonal Access Token

Responses

Response samples

Content type
application/json
{
  • "accessToken": "string"
}

Renew an integration token. Deprecated

🗑 Deprecated It's recommended to use your PAT (Personal Access Token) or integration token directly.

This call is unnecessary for users that use DataGalaxy authentication version 2 and up.

An integration token can be regenerated.

Authorizations:
Integration tokenPersonal Access Token
query Parameters
integrationToken
required
string

Responses

Response samples

Content type
application/json
{
  • "integrationToken": "string"
}

Workspaces

Retrieve your workspaces or projects. If you need more detail, please consult our DataGalaxy's main concepts.

List all workspaces.

Provide a name to find a specific workspace.
If no query string is provided, then a list of all workspaces will be returned.

🗑 Deprecated The organizations property in the response is deprecated. It returns an empty list and will be removed in a future release.
Authorizations:
Personal Access TokenIntegration token
query Parameters
name
string

Responses

Response samples

Content type
application/json
{
  • "organizations": [
    ],
  • "projects": [
    ]
}

Lists the versions of a workspace.

Return the list of versions available in the specified workspace.

Authorizations:
Personal Access TokenIntegration token
path Parameters
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.

query Parameters
limit
number <double>
Default: 20
page
number <double>
Default: 1

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "total": null,
  • "pages": 0.1,
  • "total_sum": 0.1,
  • "next_page": "string"
}

Bulk create links using Paths

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"
}
Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

Request Body schema: application/json
required
Array
fromPath
required
string
fromType
required
string
linkType
required
string
toPath
required
string
toType
required
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "total": 0.1,
  • "created": 0.1,
  • "updated": 0.1,
  • "deleted": 0.1,
  • "unchanged": 0.1
}

Technologies

GetTechnologies

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.

Authorizations:
Personal Access TokenIntegration token

Responses

Response samples

Content type
application/json
{
  • "total": 0.1,
  • "technologies": [
    ]
}

CreateTechonogy

Add a custom technology to DataGalaxy using this endpoint.

Adding technologies to DataGalaxy objects

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.

Authorizations:
Personal Access TokenIntegration token
Request Body schema: application/json
required
technologyCode
required
string

The technologyCode is the technology's identifier

displayName
required
string
description
required
string
modules
required
Array of strings (TechnologyModule)
Items Enum: "Catalog" "Processing" "Usage"

Responses

Request samples

Content type
application/json
{
  • "technologyCode": "string",
  • "displayName": "string",
  • "description": "string",
  • "modules": [
    ]
}

Response samples

Content type
application/json
{
  • "displayName": "Amazon Athena",
  • "technologyCode": "amazonathena",
  • "modules": [
    ],
  • "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"
}

UpdateTechnology

Update a technology's displayName, description and associated modules using this endpoint.
Read our article on technologies for more informations.

Authorizations:
Personal Access TokenIntegration token
path Parameters
technologyCode
required
string
Request Body schema: application/json
required
displayName
string
description
string
modules
Array of strings (TechnologyModule)
Items Enum: "Catalog" "Processing" "Usage"

Responses

Request samples

Content type
application/json
{
  • "displayName": "string",
  • "description": "string",
  • "modules": [
    ]
}

Response samples

Content type
application/json
{
  • "displayName": "Amazon Athena",
  • "technologyCode": "amazonathena",
  • "modules": [
    ],
  • "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"
}

DeleteTechnology

Delete a technology.
Read our article on technologies for more informations.

Authorizations:
Personal Access TokenIntegration token
path Parameters
technologyCode
required
string

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Search

Search DataGalaxy objects

Search DataGalaxy objects with queries and filters

Exact Matches

An exact match occure when your query perfectly matches an object's text attribute value.

Exact match requirements

Attributes have to be indexed for exact match.

Finding exact matches in the search result

Exact matches can be determined using the isExactMatch boolean (result.entities[n].isExactMatch).
Each search result returned carries this flag.

Filters

Filters help you refine your search. They are applied to objects attributes' values.

Different attribute types support different search operators:
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
Authorizations:
Personal Access TokenIntegration token
Request Body schema: application/json
required
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.
If versionId is not provided, the search scope will be extended to all the workspaces you have access to.

limit
any
Default: 50

Maximum number of objects returned

includedAttributes
Array of strings

List of attributes, identified by their attributeKey or attributePath, to be returned in the search result In case of an attribute linked to a dataType or is custom, attributePath should be used

includeAccessData
boolean

If set to true, returns access rights the current token has on each item

Array of objects (SearchFilter)

Use filters to refines your search result

saveSearchPayload
any
Default: false

If set to true, the search payload will be saved in the queries history.
Request the GET /history/search/queries to retrieve it.

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "versionId": "string",
  • "limit": 50,
  • "includedAttributes": [
    ],
  • "includeAccessData": true,
  • "filters": [
    ],
  • "saveSearchPayload": false
}

Response samples

Content type
application/json
{
  • "total": 0.1,
  • "total_sum": 0.1,
  • "result": {
    },
  • "quickFilters": [
    ]
}

History

Return saved search queries

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.

Authorizations:
Personal Access TokenIntegration token
query Parameters
limit
number <double>
Default: 20

Responses

Response samples

Content type
application/json
{
  • "total": 0.1,
  • "history": [
    ]
}

Return recently accessed objects

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}).

ℹ️ Note It's recommended to use your PAT (Personal Access Token) in order to get objects that you've recently accessed.
If you are using an Integration token, you will get objects recently accessed by the user associated with that integration token.
Authorizations:
Personal Access TokenIntegration token
query Parameters
limit
number <double>
Default: 20

Responses

Response samples

Content type
application/json
{
  • "total": 0.1,
  • "history": [
    ]
}

Image

Fetch an image

Fetch the image associated to the hash given in parameters.
The Content-Type can be image/png, image/jpeg or image/svg

query Parameters
hash
required
string

Image hash to get. Must be URL-encoded.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Upload an image

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.
Request Body schema: multipart/form-data
required
image
required
string <binary>

Image's binary data.
Supported MIME types: image/png, image/jpeg, image/jpg

category
required
string
Enum: "clientSpaceImage" "workspaceImage" "workspaceIcon" "searchImage" "technologyIcon"

Determines the ressource to associate the image to.

workspaceId
string

If category is set to workspaceImage or workspaceIcon, this parameter is mandatory and will bind the image to the target workspace

technologyCode
string

If category is set to technologyIcon, this parameter is mandatory and will bind the image to the target technology

Responses

Response samples

Content type
application/json
{
  • "imageHash": "akrLmrLdEgjMrpULdrsgP0upBUxdbIhujQlKmotHlrQ="
}

Objects

Update attributes of any object type

Edit an object.

Modifies one or more attributes of the specified object.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

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.

Request Body schema: application/json
required
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.

Responses

Request samples

Content type
application/json
{
  • "owners": [
    ],
  • "stewards": [
    ],
  • "tags": [
    ],
  • "description": "string",
  • "summary": "string",
  • "name": "string",
  • "technicalName": "string",
  • "status": "Proposed",
  • "property1": true,
  • "property2": true
}

Response samples

Content type
application/json
{
  • "id": "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
  • "location": "string"
}

Create an object.

Create an object with the specified attributes.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

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.

Request Body schema: application/json
required
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"

Responses

Request samples

Content type
application/json
{
  • "owners": [
    ],
  • "stewards": [
    ],
  • "tags": [
    ],
  • "description": "string",
  • "summary": "string",
  • "name": "string",
  • "technicalName": "string",
  • "status": "Proposed",
  • "type": "None"
}

Response samples

Content type
application/json
{
  • "id": "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
  • "location": "string"
}

Subscribe to notifications of an object.

Subscribe to notifications of the specified object.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

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.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Unsubscribe to notifications of an object.

Unsubscribe to notifications of the specified object.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

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.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Campaigns

Get Campaigns

Gets the campaigns of the specified space

path Parameters
spaceGuid
required
string <guid>
versionId
required
string

Responses

Response samples

Content type
application/json
{
  • "campaigns": [
    ]
}

Get Object Campaigns

Gets the campaigns using the specified object

path Parameters
required
object (ReferenceId)
versionId
required
string

Responses

Response samples

Content type
application/json
{
  • "campaigns": [
    ]
}

Create Campaign

Creates a new campaign

Request Body schema: application/json
required
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

Responses

Request samples

Content type
application/json
{
  • "workflowGuid": "string",
  • "name": "string",
  • "description": "string",
  • "ownerGuid": "string",
  • "spaceGuid": "string",
  • "referenceIds": [
    ],
  • "versionId": "string"
}

Response samples

Content type
application/json
{
  • "guid": "string"
}

Check Campaign Name Usage

Checks if the campaign name is available

path Parameters
spaceGuid
required
string <guid>
name
required
string

Responses

Response samples

Content type
application/json
{
  • "isCampaignNameUsed": true
}

Get Campaign

Gets the specified campaign

path Parameters
guid
required
string <guid>

Responses

Response samples

Content type
application/json
{
  • "campaign": {
    }
}

Delete Campaign

Deletes the specified campaign

path Parameters
guid
required
string <guid>

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "extensions": {
    },
  • "property1": null,
  • "property2": null
}

Update Campaign

Updates the specified campaign

path Parameters
guid
required
string <guid>
Request Body schema: application/json
required
guid
string <guid>
name
string or null
description
string or null
ownerGuid
string <guid>

Responses

Request samples

Content type
application/json
{
  • "guid": "string",
  • "name": "string",
  • "description": "string",
  • "ownerGuid": "string"
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "extensions": {
    },
  • "property1": null,
  • "property2": null
}

Add Campaign Entities

Adds one or multiple entities to the specified campaign

path Parameters
guid
required
string <guid>
versionId
required
string
Request Body schema: application/json
required
guid
string <guid>
versionId
string or null
referenceIds
Array of strings or null

Responses

Request samples

Content type
application/json
{
  • "guid": "string",
  • "versionId": "string",
  • "referenceIds": [
    ]
}

Response samples

Content type
application/json
{
  • "campaign": {
    }
}

Get Campaign Events

Gets the events for the specified campaign

path Parameters
guid
required
string <guid>

Responses

Response samples

Content type
application/json
{
  • "campaignEvents": [
    ]
}

Remove Campaign Entities

Removes one or multiple entities from the specified compaign

path Parameters
guid
required
string <guid>
Request Body schema: application/json
required
guid
string <guid>
referenceIds
Array of strings or null

Responses

Request samples

Content type
application/json
{
  • "guid": "string",
  • "referenceIds": [
    ]
}

Response samples

Content type
application/json
{
  • "campaign": {
    }
}

Set Phase

Sets the current phase of the specified campaign

path Parameters
guid
required
string <guid>
phaseGuid
required
string <guid>

Responses

Response samples

Content type
application/json
{
  • "campaign": {
    }
}

Get Campaign NoAccess Objects

Returns all Campaign objects that not accessible by current user

path Parameters
guid
required
string <guid>
versionId
required
string

Responses

Response samples

Content type
application/json
{
  • "entities": [
    ]
}

Workflows

Get Workflows

Gets the workflows of the specified space

path Parameters
spaceGuid
required
string <guid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Workflow

Creates a new workflow

Request Body schema: application/json
required
name
string or null
description
string or null
attributePath
string or null
Array of objects or null (WorkflowPhaseDto)
spaceGuid
string <guid>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "attributePath": "string",
  • "phases": [
    ],
  • "spaceGuid": "string"
}

Response samples

Content type
application/json
{
  • "guid": "string"
}

Update Workflow

Updates the spedified workflow

path Parameters
workflowGuid
required
string <guid>
Request Body schema: application/json
required
name
string or null
description
string or null
attributePath
string or null
Array of objects or null (WorkflowPhaseDto)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "attributePath": "string",
  • "phases": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "extensions": {
    },
  • "property1": null,
  • "property2": null
}

Delete Workflow

Deletes the specified workflow

path Parameters
workflowGuid
required
string <guid>

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "extensions": {
    },
  • "property1": null,
  • "property2": null
}

Data Quality

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.

Get Rules

Gets a list of data quality rules using query parameters as filters.
Use cases:

  • List all data quality rules for a given workspace: ?workspaceId={workspaceId}
  • List all data quality rules for a given entity: ?entityId={entityId}. You can also use the path and type path: ?entityPath={entityPath}&entityTypePath={entityTypePath}&versionId={versionId}.
  • Get the data quality rule for a given code (unique for a given workspace): ?code={code}&workspaceId={workspaceId}

It returns at most 1000 results.
query Parameters
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

Responses

Response samples

Content type
application/json
{
  • "rules": [
    ]
}

Create Rule

Creates a new data quality rule on a given entity.
You must either provide a versionId, entityPath and entityTypePath, or an entityId.

Request Body schema: application/json
required
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 six dimensions of data quality assessment: completeness, accuracy, consistency, validity, uniqueness or integrity

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

Responses

Request samples

Content type
application/json
{
  • "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"
}

Response samples

Content type
application/json
{
  • "ruleId": "string"
}

Get Rule

Gets the specified data quality rule.
It returns at most the latest 1000 checks for the data quality rule.

path Parameters
ruleId
required
string <guid>

Unique rule identifier. Example: ec64748c-059e-4a6a-a9db-5f9e634a2da8

Responses

Response samples

Content type
application/json
{
  • "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": [
    ],
  • "lastChecks": [
    ]
}

Updates a rule.

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: { }

path Parameters
ruleId
required
string <guid>

Unique rule identifier. Example: ec64748c-059e-4a6a-a9db-5f9e634a2da8

Request Body schema: application/json
required

UpdateRuleParameter

(RuleTypeEnum (string or null))
code
string or null
statement
string or null
fieldIds
Array of strings or null

Responses

Request samples

Content type
application/json
{
  • "type": "Completeness",
  • "code": "string",
  • "statement": "string",
  • "fieldIds": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "extensions": {
    },
  • "property1": null,
  • "property2": null
}

Delete Rule

Deletes the specified data quality rule.

path Parameters
ruleId
required
string <guid>

Unique rule identifier. Example: ec64748c-059e-4a6a-a9db-5f9e634a2da8

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "extensions": {
    },
  • "property1": null,
  • "property2": null
}

Get Rule Checks

Gets the rule checks for the specified data quality rule.
It returns at most the latest 1000 checks.

path Parameters
ruleId
required
string <guid>

Unique rule identifier. Example: ec64748c-059e-4a6a-a9db-5f9e634a2da8

Responses

Response samples

Content type
application/json
{
  • "checks": [
    ]
}

Create Rule Checks

Creates a new rule check for the specified data quality rule.

path Parameters
ruleId
required
string <guid>

Unique rule identifier. Example: ec64748c-059e-4a6a-a9db-5f9e634a2da8

Request Body schema: application/json
required

CreateRuleCheckParameter

status
string (DataQualityStatusEnum)
Enum: "Unknown" "Passed" "Warning" "Failed"
message
string or null
detail
string or null
creationTime
string or null

Responses

Request samples

Content type
application/json
{
  • "status": "passed",
  • "message": "Everything looks good!",
  • "detail": "noop",
  • "creationTime": "2024-08-26T12:34:56.789Z"
}

Response samples

Content type
application/json
{
  • "checkId": "53768fce-c7c4-4216-bc5b-6d477abe2012"
}

Delete Rule Check

Deletes the specified data quality rule check.

path Parameters
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

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "extensions": {
    },
  • "property1": null,
  • "property2": null
}

Imports

Process the actions decided by the user regarding a given source based on a importGuid

Process action on objects without given importGuid

Process the actions decided by the user regarding a given source based on a importGuid.
It returns a 400 if the importGuid is invalid.

path Parameters
versionId
required
string <guid>
importGuid
required
string
Request Body schema: application/json
required
any

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
"string"

URNs

ℹ️ Note This feature is currently in private preview.
Manage objects using a Uniform Resource Name (URN).

Get an object from its URN

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.

path Parameters
versionId
required
string <guid>
urn
required
string

Responses

Response samples

Content type
application/json
{
  • "object": {
    }
}

Update an object from its URN

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.

path Parameters
versionId
required
string <guid>
urn
required
string
Request Body schema: application/json
required
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

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "technicalName": "string",
  • "description": "string",
  • "summary": "string",
  • "property1": 0,
  • "property2": 0
}

Response samples

Content type
application/json
{
  • "object": {
    }
}

Delete an object from its URN

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.

path Parameters
versionId
required
string <guid>
urn
required
string

Responses

Response samples

Content type
application/json
{
  • "object": {
    }
}

Create an object from its URN

Creates an object from its URN.
It returns a 400 if the URN is invalid.

path Parameters
versionId
required
string <guid>
Request Body schema: application/json
required
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

Responses

Request samples

Content type
application/json

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"
}

Response samples

Content type
application/json

Snowflake view successfully created.

{
  • "object": {
    }
}

Attributes

Retrieve all of the attributes (custom or not) defined in your client space. If you need more detail, please consult our Attributes documentation.

List of available attributes Deprecated

Deprecation warning:
This route is no longer maintained and is replaced by GET /attributes.

Return a list of attributes available for the specified dataType.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

query Parameters
moduleName
string
limit
number <double>
Default: 20
page
number <double>
Default: 1

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "total": null,
  • "pages": 0.1,
  • "total_sum": 0.1,
  • "next_page": "string"
}

List attribute values

This route fetches available values for attributes with format:

  • ValueList,
  • Hierarchy,
  • MultiValueList,
  • ManagedTag,
  • or ClientTag.

Learn more about attributes with this article.

Authorizations:
Personal Access TokenIntegration token
query Parameters
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

Responses

Response samples

Content type
application/json
Example
[ ]

Add attribute values

This route adds up to 100 values to attributes with format:

  • ValueList,
  • Hierarchy,
  • MultiValueList,
  • ManagedTag,
  • or 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.

Authorizations:
Personal Access TokenIntegration token
query Parameters
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

Request Body schema: application/json
required
Any of
Array
label
required
string
description
string
Color (string) or string
keywords
Array of strings
isActive
boolean
isUserSuggestionEnabled
boolean

Responses

Request samples

Content type
application/json
Example
[ ]

Response samples

Content type
application/json
Example
[ ]

Update attribute values

This route updates up to 100 attribute values for attributes with format:

  • ValueList,
  • Hierarchy,
  • MultiValueList,
  • ManagedTag,
  • or 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.

Authorizations:
Personal Access TokenIntegration token
query Parameters
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

Request Body schema: application/json
required
Any of
Array
label
required
string
description
string
Color (string) or string
keywords
Array of strings
isActive
boolean
isUserSuggestionEnabled
boolean

Responses

Request samples

Content type
application/json
Example
[ ]

Response samples

Content type
application/json
Example
[ ]

Return a list of attributes

Return a list of attributes available for a given dataType.
Note: Common attributes are not bound to one dataType and can therefore be used on any dataType.

Learn more about attributes with this article.

Authorizations:
Personal Access TokenIntegration token
query Parameters
dataType
required
string (AttributeDataTypeEnum)
Enum: "Property" "Source" "Container" "Structure" "Field" "DataProcessing" "Usage" "Common"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a custom attribute

Learn more about attributes with this article.

To create value for a ValueList format attribute, you must use POST /CreateAttributeValues then update the attribute with PUT /UpdateAttribute

Authorizations:
Personal Access TokenIntegration token
path Parameters
dataType
required
string (AttributeDataTypeEnum)
Enum: "Property" "Source" "Container" "Structure" "Field" "DataProcessing" "Usage" "Common"

Specifies the dataType this attribute will be associated with

Request Body schema: application/json
required
name
required
string
format
required
string (AttributeFormats)
Enum: "FormattedText" "Boolean" "Date" "HtmlLink" "Number" "ValueList" "Text" "ManagedTag" "MultiValueList" "UserReference" "PersonReference" "Hierarchy" "TimeSeriesObject"

The Date format need type attribute Date

description
string
string or boolean or number

When the type and format of the attribute is Date the defaultValue must be: dd/mm/yyyy

enforceUniqueness
boolean
Default: false

When set to true, duplicate creations will throw an error

timeSeriesFrequency
string (TimeSeriesFrequency)
Enum: "daily" "weekly" "monthly"

Only for TimeSeriesObject attributes

timeSeriesColorRule
string (TimeSeriesColorRule)
Enum: "none" "shouldIncrease" "shouldDecrease"

Only for TimeSeriesObject attributes

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "format": "FormattedText",
  • "description": "string",
  • "defaultValue": "string",
  • "enforceUniqueness": false,
  • "timeSeriesFrequency": "daily",
  • "timeSeriesColorRule": "none"
}

Response samples

Content type
application/json
{
  • "name": "tags",
  • "attributeKey": "string",
  • "format": "Text",
  • "dataType": "Property",
  • "description": "string",
  • "defaultValue": true,
  • "isCustom": true,
  • "isMandatory": true,
  • "isEditable": true,
  • "values": [
    ],
  • "timeSeriesColorRule": "none",
  • "timeSeriesFrequency": "daily"
}

Bulk create attributes

Learn more about attributes with this article.

Create up to 50 attributes.

Authorizations:
Personal Access TokenIntegration token
Request Body schema: application/json
required
Array
name
required
string
format
required
string (AttributeFormats)
Enum: "FormattedText" "Boolean" "Date" "HtmlLink" "Number" "ValueList" "Text" "ManagedTag" "MultiValueList" "UserReference" "PersonReference" "Hierarchy" "TimeSeriesObject"

The Date format need type attribute Date

description
string
string or boolean or number

When the type and format of the attribute is Date the defaultValue must be: dd/mm/yyyy

enforceUniqueness
boolean
Default: false

When set to true, duplicate creations will throw an error

timeSeriesFrequency
string (TimeSeriesFrequency)
Enum: "daily" "weekly" "monthly"

Only for TimeSeriesObject attributes

timeSeriesColorRule
string (TimeSeriesColorRule)
Enum: "none" "shouldIncrease" "shouldDecrease"

Only for TimeSeriesObject attributes

dataType
required
string (ModuleNames)
Enum: "Property" "Common" "Source" "Container" "Structure" "Field" "DataProcessing" "Usage"

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Bulk edit attributes

Learn more about attributes with this article.

Update up to 50 attributes.

Authorizations:
Personal Access TokenIntegration token
Request Body schema: application/json
required
Array
name
string
description
string
string or boolean or number

This field type depends on the attribute format.

timeSeriesFrequency
string (TimeSeriesFrequency)
Enum: "daily" "weekly" "monthly"

Only for TimeSeriesObject attributes

timeSeriesColorRule
string (TimeSeriesColorRule)
Enum: "none" "shouldIncrease" "shouldDecrease"

Only for TimeSeriesObject attributes

dataType
required
string (ModuleNames)
Enum: "Property" "Common" "Source" "Container" "Structure" "Field" "DataProcessing" "Usage"
attributeKey
required
string (AttributeKey)

Unique attribute identifier. Can be found with GET /attributes or when creating attributes with POST /attributes

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Update an attribute

Learn more about attributes with this article.

Authorizations:
Personal Access TokenIntegration token
path Parameters
dataType
required
string (AttributeDataTypeEnum)
Enum: "Property" "Source" "Container" "Structure" "Field" "DataProcessing" "Usage" "Common"

Specifies the dataType associated with an attribute

attributeKey
required
string

Unique attribute identifier. Can be found with GET /attributes or when creating attributes with POST /attributes

Request Body schema: application/json
required
name
string
description
string
string or boolean or number

This field type depends on the attribute format.

timeSeriesFrequency
string (TimeSeriesFrequency)
Enum: "daily" "weekly" "monthly"

Only for TimeSeriesObject attributes

timeSeriesColorRule
string (TimeSeriesColorRule)
Enum: "none" "shouldIncrease" "shouldDecrease"

Only for TimeSeriesObject attributes

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "defaultValue": "string",
  • "timeSeriesFrequency": "daily",
  • "timeSeriesColorRule": "none"
}

Response samples

Content type
application/json
{
  • "name": "tags",
  • "attributeKey": "string",
  • "format": "Text",
  • "dataType": "Property",
  • "description": "string",
  • "defaultValue": true,
  • "isCustom": true,
  • "isMandatory": true,
  • "isEditable": true,
  • "values": [
    ],
  • "timeSeriesColorRule": "none",
  • "timeSeriesFrequency": "daily"
}

Delete a custom attribute

Learn more about attributes with this article.

Authorizations:
Personal Access TokenIntegration token
path Parameters
dataType
required
string (AttributeDataTypeEnum)
Enum: "Property" "Source" "Container" "Structure" "Field" "DataProcessing" "Usage" "Common"

Specifies the dataType associated with an attribute

attributeKey
required
string (AttributeKey)

Unique attribute identifier. Can be found with GET /attributes or when creating attributes with POST /attributes

Responses

Response samples

Content type
application/json
{
  • "name": "tags",
  • "attributeKey": "string",
  • "format": "Text",
  • "dataType": "Property",
  • "description": "string",
  • "defaultValue": true,
  • "isCustom": true,
  • "isMandatory": true,
  • "isEditable": true,
  • "values": [
    ],
  • "timeSeriesColorRule": "none",
  • "timeSeriesFrequency": "daily"
}

List available tags Deprecated

Deprecation warning:
This route is no longer maintained and is replaced by GET /attributes/values.
In order to reproduce this route's behavior, request GET /attributes/values?dataType=common&attributeKey=Domains.

Return the list of all tags available.
Tags can be added to the tag field of an object.

Authorizations:
Personal Access TokenIntegration token
query Parameters
limit
number <double>
Default: 20
page
number <double>
Default: 1
color
string
isNative
boolean
isActive
boolean
isUserSuggestionEnabled
boolean

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "total": null,
  • "pages": 0.1,
  • "total_sum": 0.1,
  • "next_page": "string"
}

Create tag Deprecated

Deprecation warning:
This route is no longer maintained and is replaced by POST /attributes/values.
In order to reproduce this route's behavior, request POST /attributes/values?dataType=common&attributeKey=Domains and send the same request body.

This route can create up to 5 000 tags. color can be one of the values enumerated below, or an hexadecimal value.

Authorizations:
Personal Access TokenIntegration token
Request Body schema: application/json
required
Array
label
required
string
description
string
Color (string) or string
keywords
Array of strings
isActive
boolean
isUserSuggestionEnabled
boolean

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "details": [
    ],
  • "unchanged": 0.1,
  • "deleted": 0.1,
  • "updated": 0.1,
  • "created": 0.1,
  • "total": 0.1
}

Screens

Return a list of attribute screen layouts

Return a list of attribute screen layouts.
An attribute screen layout displays which attributes exists on each entity type, ordered by entity type and categories.

Note: there is 2 level of attribute screens: ClientSpace level and Workspace level.

Learn more about attribute screen basics with this this article. Learn more about attributes with this article.

Tip: attribute screen layouts returned by this route are basically a JSON-stringified version of the Screen section
found on DataGalaxy Platform.

Authorizations:
Personal Access TokenIntegration token
query Parameters
versionId
string (Uuid)
Example: versionId=ade92d04-294e-4bff-9dfa-5ea2f5419426

By default, this request will return clientspace level screen layouts.
If versionId is specified, this request will return workspace level screen layouts.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Return a list of attribute screen layouts filtered by dataType

Return a list of attribute screen layouts.
An attribute screen layout displays which attributes exists on each entity type, ordered by entity type and categories.

Note: there is 2 level of attribute screens: ClientSpace level and Workspace level.

Learn more about attribute screen basics with this this article. Learn more about attributes with this article.

Tip: attribute screen layouts returned by this route are basically a JSON-stringified version of the Screen section
found on DataGalaxy Platform.

Authorizations:
Personal Access TokenIntegration token
path Parameters
dataType
required
string (ScreenDataTypes)
Enum: "property" "source" "container" "structure" "field" "dataprocessing" "usage" "dataprocessingitem"
query Parameters
versionId
string (Uuid)
Example: versionId=ade92d04-294e-4bff-9dfa-5ea2f5419426

By default, this request will return clientspace level screen layouts.
If versionId is specified, this request will return workspace level screen layouts.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Return a list of attribute screen layouts filtered by dataType and entity type

Return a list of attribute screen layouts.
An attribute screen layout displays which attributes exists on each entity type, ordered by entity type and categories.

Note: there is 2 level of attribute screens: ClientSpace level and Workspace level.

Learn more about attribute screen basics with this this article. Learn more about attributes with this article.

Tip: attribute screen layouts returned by this route are basically a JSON-stringified version of the Screen section
found on DataGalaxy Platform.

Authorizations:
Personal Access TokenIntegration token
path Parameters
dataType
required
string (ScreenDataTypes)
Enum: "property" "source" "container" "structure" "field" "dataprocessing" "usage" "dataprocessingitem"
type
required
string (LowerCaseAllTypes)
Enum: "businessterm" "indicator" "concept" "dataprocessing" "application" "dashboard" "screen" "table" "column" "relational" "nonrelational" "usage" "referencedata" "dimension" "file" "field" "nosql" "document" "businessdomain" "universe" "dataflow" "dataset" "process" "report" "algorithm" "model" "directory" "equipment" "tag" "view" "tagbase" "indicatorgroup" "dimensiongroup" "businessdomaingroup" "feature" "referencedatavalue" "usagefield" "usagecomponent" "substructure"
query Parameters
versionId
string (Uuid)
Example: versionId=ade92d04-294e-4bff-9dfa-5ea2f5419426

By default, this request will return clientspace level screen layouts.
If versionId is specified, this request will return workspace level screen layouts.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update an attribute screen layout

Update an entire attribute screen layout.

Here are some tips for your updates:

  • create a new category: add a new element to your body with just a name and attributes
  • update an existing category: specify its id and change any other property (name, isHidden, attributes)
  • remove a category: if your body does not contain it, it will be removed
  • remove an attribute: if attributes does not contain it, it will be removed
  • change a category or attribute position/order: categories and attributes order in your body will be applied

Find existing categories id and layout with GET /attributes/screens routes.
Find attribute names with GET /attributes.

Learn more about attribute screen basics with this this article. Learn more about attributes with this article.

Authorizations:
Personal Access TokenIntegration token
path Parameters
dataType
required
string (ScreenDataTypes)
Enum: "property" "source" "container" "structure" "field" "dataprocessing" "usage" "dataprocessingitem"

Target dataType

type
required
string (LowerCaseAllTypes)
Enum: "businessterm" "indicator" "concept" "dataprocessing" "application" "dashboard" "screen" "table" "column" "relational" "nonrelational" "usage" "referencedata" "dimension" "file" "field" "nosql" "document" "businessdomain" "universe" "dataflow" "dataset" "process" "report" "algorithm" "model" "directory" "equipment" "tag" "view" "tagbase" "indicatorgroup" "dimensiongroup" "businessdomaingroup" "feature" "referencedatavalue" "usagefield" "usagecomponent" "substructure"

Target entity type

query Parameters
versionId
string (Uuid)
Example: versionId=ade92d04-294e-4bff-9dfa-5ea2f5419426

By default, this request will update clientspace level screen layouts.
If versionId is specified, this request will update workspace level screen layouts.

Request Body schema: application/json
required

This represents your screen layout. Categories and attributes order matters

Array
name
required
string
Uuid (string) or string
isHidden
boolean
Array of ReversedSystemAttribute (string) or CustomAttributeName (string) (AttributeName)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "type": "BusinessTerm",
  • "dataType": "Property",
  • "isClientLevel": true,
  • "categories": [
    ]
}

Reset an Attribute Screen

Reset an attribute screen to its default layout.

Learn more about attributes with this article.

Authorizations:
Personal Access TokenIntegration token
path Parameters
dataType
required
string (ScreenDataTypes)
Enum: "property" "source" "container" "structure" "field" "dataprocessing" "usage" "dataprocessingitem"

Target dataType

type
required
string (LowerCaseAllTypes)
Enum: "businessterm" "indicator" "concept" "dataprocessing" "application" "dashboard" "screen" "table" "column" "relational" "nonrelational" "usage" "referencedata" "dimension" "file" "field" "nosql" "document" "businessdomain" "universe" "dataflow" "dataset" "process" "report" "algorithm" "model" "directory" "equipment" "tag" "view" "tagbase" "indicatorgroup" "dimensiongroup" "businessdomaingroup" "feature" "referencedatavalue" "usagefield" "usagecomponent" "substructure"

Target entity type

query Parameters
versionId
string (Uuid)
Example: versionId=ade92d04-294e-4bff-9dfa-5ea2f5419426

By default, this request will reset clientspace level screen layouts.
If versionId is specified, this request will reset workspace level screen layouts.

Responses

Response samples

Content type
application/json
{
  • "type": "BusinessTerm",
  • "dataType": "Property",
  • "isClientLevel": true,
  • "categories": [
    ]
}

Glossary

Manage all of your functionnal entities from your business glossary. If you need more detail, please consult our Glossary module documentation.

Return a list of properties.

Return a list of all properties contained in the specified workspace.

Authorizations:
Personal Access TokenIntegration token
query Parameters
versionId
required
string (VersionId)
Example: versionId=c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

parentId
string (Uuid)
Example: parentId=ade92d04-294e-4bff-9dfa-5ea2f5419426

Stringified UUIDv4. See RFC 4112

name
string
technicalName
string
type
string (PropertyTypeEnum)
Enum: "Universe" "BusinessDomain" "BusinessDomainGroup" "ReferenceData" "Dimension" "DimensionGroup" "Concept" "IndicatorGroup" "Indicator" "BusinessTerm" "ReferenceDataValue"
includeAccessData
boolean (IncludeAccessData)

If this is true, every objects returned will contain an accessData property.
accessData contains the access level the current token has on the object.
Default: false

includeAttributes
boolean (IncludeAttributes)

If this is true, every objects returned will contain an attributes property.
attributes contains the value of every attributes the object has.
Default: false

includeLinks
boolean (IncludeLinks)

If this is true, every objects returned will contain a links property.
links contains the list of every other objects linked to it.
Default: false

Array of ReversedSystemAttribute (string) or CustomAttributeName (string) (AttributeName)
limit
number <double>
Default: 20
page
number <double>
Default: 1
maxDepth
number <double> (MaxDepth)

Determines the maximum depth at which objects will be fetched, relative to the parentId.
A maximum depth of 0 will fetch direct objects only, while maximum depth n will fetch objects from depth 0 to depth n.
By default, no maximum depth is applied; objects of all depths will be fetched.

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "total": null,
  • "pages": 0.1,
  • "total_sum": 0.1,
  • "next_page": "string"
}

Return a property.

Return the details of the specified property.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

propertyId
required
string (Uuid)
Example: ade92d04-294e-4bff-9dfa-5ea2f5419426

Stringified UUIDv4. See RFC 4112

query Parameters
Array of ReversedSystemAttribute (string) or CustomAttributeName (string) (AttributeName)
includeAccessData
boolean (IncludeAccessData)

If this is true, every objects returned will contain an accessData property.
accessData contains the access level the current token has on the object.
Default: false

Responses

Response samples

Content type
application/json
{
  • "name": "foo",
  • "technicalName": "bar",
  • "type": "string",
  • "id": "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
  • "versionId": "c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
  • "path": "string",
  • "functionalPath": "string",
  • "typePath": "string",
  • "objectUrl": "string",
  • "childrenCount": 0.1,
  • "accessData": {
    },
  • "attributes": {
    },
  • "isWatched": true,
  • "richTextAttributes": {
    }
}

Edit a property.

Modifies one or more attributes of the specified property.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

propertyId
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.

Request Body schema: application/json
required
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"
parentId
string (DoubleUuid)

Composed of 2 colon-separated stringified UUIDv4. Represents a Workspace or an Entity in DataGalaxy's context.

Responses

Request samples

Content type
application/json
{
  • "owners": [
    ],
  • "stewards": [
    ],
  • "tags": [
    ],
  • "description": "string",
  • "summary": "string",
  • "name": "string",
  • "technicalName": "string",
  • "status": "Proposed",
  • "parentId": "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2"
}

Response samples

Content type
application/json
{
  • "id": "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
  • "location": "string"
}

Delete a property.

Deletes the specified property.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

propertyId
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.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

List the property types.

Return the list of properties types and their compatible entity types.

Authorizations:
Personal Access TokenIntegration token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get local synonyms

Fetches the list of synonyms on a property.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

propertyId
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.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a property.

Create a property in the specified parent (workspace or compatible property).
Available property types can be found thanks to the GET /types endpoint.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

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.

Request Body schema: application/json
required
name
required
string

Entity name

type
required
string (PropertyTypeEnum)
Enum: "Universe" "BusinessDomain" "BusinessDomainGroup" "ReferenceData" "Dimension" "DimensionGroup" "Concept" "IndicatorGroup" "Indicator" "BusinessTerm" "ReferenceDataValue"
status
string (EntityLifecycleStatusEnum)
Enum: "Proposed" "InRevision" "Validated" "InValidation" "Obsolete"
owners
Array of strings (Email)

Email list of users defined as Owners of this entity

stewards
Array of strings (Email)

Email list of users defined as Stewards of this entity

tags
Array of strings

List of tags

description
string
summary
string
upsert
boolean

If true, this request will try to UPSERT instead of create the entity

additional property
string or number or boolean or Array of strings or Array of Email (strings) or HyperLink (object) or string or any or Array of TimeSeriesEntry (objects) (AdditionalCustomAttribute)

Additional attribute. This property's type depends on the attribute's format.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "Universe",
  • "status": "Proposed",
  • "owners": [
    ],
  • "stewards": [
    ],
  • "tags": [
    ],
  • "description": "string",
  • "summary": "string",
  • "upsert": true,
  • "property1": "string",
  • "property2": "string"
}

Response samples

Content type
application/json
{
  • "id": "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
  • "location": "string"
}

Bulk upsert a property tree

This route creates or update multiple properties and all their children up to a total of 250 000 entities.
This route uses the Upsert method. Existing entities are updated and non-existing ones are created. Existing entities are not deleted.
Read our article on bulktree for more informations.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

Request Body schema: application/json
required
Array
type
required
string (PropertyTypeEnum)
Enum: "Universe" "BusinessDomain" "BusinessDomainGroup" "ReferenceData" "Dimension" "DimensionGroup" "Concept" "IndicatorGroup" "Indicator" "BusinessTerm" "ReferenceDataValue"
status
string (EntityLifecycleStatusEnum)
Enum: "Proposed" "InRevision" "Validated" "InValidation" "Obsolete"
owners
Array of strings (Email)
stewards
Array of strings (Email)
tags
Array of strings
description
string
summary
string
code
string
name
required
string
children
Array of objects (PropertiesBulkTreeCreationRequest)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "total": 0.1,
  • "created": 0.1,
  • "updated": 0.1,
  • "deleted": 0.1,
  • "unchanged": 0.1
}

Create a local synonym

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

localSynonymId
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.

Request Body schema: application/json
required

Contains the name and description of your local synonym

name
required
string
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "id": "string",
  • "description": "string"
}

Update a local synonym

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

localSynonymId
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.

Request Body schema: application/json
required
name
string
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "id": "string",
  • "description": "string"
}

Delete a local synonym

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

localSynonymId
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.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "id": "string",
  • "description": "string"
}

Bulk delete properties

Deletes a list of properties referenced by their id.

Warning: deleting a property will delete its children objects in the process
Deleted children objects will be included in the total count.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

Request Body schema: application/json
required

List of ids referencing properties

Array
string (DoubleUuid)

Composed of 2 colon-separated stringified UUIDv4. Represents a Workspace or an Entity in DataGalaxy's context.

Responses

Request samples

Content type
application/json
[
  • "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2"
]

Response samples

Content type
application/json
{
  • "totalDeleted": 0.1
}

Sources

Manage all of your entities from your technical dictionary. If you need more detail, please consult our Dictionary module documentation.

Return a list of sources.

Return a list of all sources contained in the specified workspace.

Authorizations:
Personal Access TokenIntegration token
query Parameters
versionId
required
string (VersionId)
Example: versionId=c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

name
string
technicalName
string
type
string (ModelTypeEnum)
Enum: "Relational" "NonRelational" "NoSql" "TagBase"
includeAccessData
boolean (IncludeAccessData)

If this is true, every objects returned will contain an accessData property.
accessData contains the access level the current token has on the object.
Default: false

includeAttributes
boolean (IncludeAttributes)

If this is true, every objects returned will contain an attributes property.
attributes contains the value of every attributes the object has.
Default: false

includeLinks
boolean (IncludeLinks)

If this is true, every objects returned will contain a links property.
links contains the list of every other objects linked to it.
Default: false

Array of ReversedSystemAttribute (string) or CustomAttributeName (string) (AttributeName)
limit
number <double>
Default: 20
page
number <double>
Default: 1
maxDepth
number <double> (MaxDepth)

Determines the maximum depth at which objects will be fetched, relative to the parentId.
A maximum depth of 0 will fetch direct objects only, while maximum depth n will fetch objects from depth 0 to depth n.
By default, no maximum depth is applied; objects of all depths will be fetched.

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "total": null,
  • "pages": 0.1,
  • "total_sum": 0.1,
  • "next_page": "string"
}

Return a source.

Return the details of the specified source.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

sourceId
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.

query Parameters
Array of ReversedSystemAttribute (string) or CustomAttributeName (string) (AttributeName)
includeAccessData
boolean (IncludeAccessData)

If this is true, every objects returned will contain an accessData property.
accessData contains the access level the current token has on the object.
Default: false

Responses

Response samples

Content type
application/json
{
  • "name": "foo",
  • "technicalName": "bar",
  • "type": "string",
  • "id": "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
  • "versionId": "c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
  • "path": "string",
  • "functionalPath": "string",
  • "typePath": "string",
  • "objectUrl": "string",
  • "childrenCount": 0.1,
  • "accessData": {
    },
  • "attributes": {
    },
  • "isWatched": true,
  • "richTextAttributes": {
    }
}

Edit a source (Deprecated).

Modifies one or more attributes of the specified source (for string, number and boolean values).

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

sourceId
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.

Request Body schema: application/json
required
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
string or number or boolean or Array of strings or Array of Email (strings) or HyperLink (object) or string or any or Array of TimeSeriesEntry (objects) (AdditionalCustomAttribute)

Additional attribute. This property's type depends on the attribute's format.

Responses

Request samples

Content type
application/json
{
  • "owners": [
    ],
  • "stewards": [
    ],
  • "tags": [
    ],
  • "description": "string",
  • "summary": "string",
  • "name": "string",
  • "technicalName": "string",
  • "status": "Proposed",
  • "property1": "string",
  • "property2": "string"
}

Response samples

Content type
application/json
{
  • "id": "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
  • "location": "string"
}

Delete a source.

Deletes the specified source.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

sourceId
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.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get Primary Keys list.

Return the list of Primary Keys in the specified source.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

sourceId
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.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update/create the primary keys of a relational source.

Update or create the primary keys of a relational source.
tablePath has the following format: tablePath: "\\containerName\\tableName"

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

sourceId
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.

Request Body schema: application/json
required
Array
tablePath
required
string
columnName
required
string
pkName
required
string
pkOrder
required
number <double>

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "total": 0.1,
  • "created": 0.1,
  • "updated": 0.1,
  • "deleted": 0.1,
  • "unchanged": 0.1
}

Get Foreign Keys list.

Return the list of Primary Keys in the specified source.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

sourceId
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.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update/create the foreign keys of a relational source.

Update or create the primary keys of a relational source.
Path properties have the following format: pkTablePath: "\\containerName\\tableName"

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

sourceId
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.

Request Body schema: application/json
required
Array
fkTechnicalName
required
string
pkTechnicalName
required
string
pkTablePath
required
string
pkColumnName
required
string
fkTablePath
required
string
fkColumnName
required
string
fkDisplayName
required
string
summary
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "total": 0.1,
  • "created": 0.1,
  • "updated": 0.1,
  • "deleted": 0.1,
  • "unchanged": 0.1
}

Create a source.

Create a source in the specified workspace.

Available source types can be found thanks to the GET /types endpoint.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

Request Body schema: application/json
required
name
required
string

Entity name

type
required
string (ModelTypeEnum)
Enum: "Relational" "NonRelational" "NoSql" "TagBase"
status
string (EntityLifecycleStatusEnum)
Enum: "Proposed" "InRevision" "Validated" "InValidation" "Obsolete"
owners
Array of strings (Email)

Email list of users defined as Owners of this entity

stewards
Array of strings (Email)

Email list of users defined as Stewards of this entity

tags
Array of strings

List of tags

description
string
summary
string
upsert
boolean

If true, this request will try to UPSERT instead of create the entity

technicalName
string
additional property
string or number or boolean or Array of strings or Array of Email (strings) or HyperLink (object) or string or any or Array of TimeSeriesEntry (objects) (AdditionalCustomAttribute)

Additional attribute. This property's type depends on the attribute's format.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "Relational",
  • "status": "Proposed",
  • "owners": [
    ],
  • "stewards": [
    ],
  • "tags": [
    ],
  • "description": "string",
  • "summary": "string",
  • "upsert": true,
  • "technicalName": "string",
  • "property1": "string",
  • "property2": "string"
}

Response samples

Content type
application/json
{
  • "id": "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
  • "location": "string"
}

Bulk create sources.

Create sources in bulk mode (max 100) in the specified workspace.

Available structure types can be found thanks to the GET /types endpoint.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

Request Body schema: application/json
required
Array
type
required
string (ModelTypeEnum)
Enum: "Relational" "NonRelational" "NoSql" "TagBase"
status
string (EntityLifecycleStatusEnum)
Enum: "Proposed" "InRevision" "Validated" "InValidation" "Obsolete"
owners
Array of strings (Email)
stewards
Array of strings (Email)
tags
Array of strings
description
string
summary
string
name
required
string
technicalName
string
additional property
string or number or boolean or Array of strings or Array of Email (strings) or HyperLink (object) or string or TimeSerieValue (string) or any (AdditionalCustomAttributeBulk)

Additional attribute. This property's type depends on the attribute's format.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "total": 0.1,
  • "created": 0.1,
  • "updated": 0.1,
  • "deleted": 0.1,
  • "unchanged": 0.1
}

Bulk edit sources.

Edit sources in bulk mode (max 100) in the specified workspace.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

Request Body schema: application/json
required
Array
type
required
string (ModelTypeEnum)
Enum: "Relational" "NonRelational" "NoSql" "TagBase"
status
string (EntityLifecycleStatusEnum)
Enum: "Proposed" "InRevision" "Validated" "InValidation" "Obsolete"
owners
Array of strings (Email)
stewards
Array of strings (Email)
tags
Array of strings
description
string
summary
string
name
string
technicalName
required
string
additional property
string or number or boolean or Array of strings or Array of Email (strings) or HyperLink (object) or string or TimeSerieValue (string) or any (AdditionalCustomAttributeBulk)

Additional attribute. This property's type depends on the attribute's format.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "total": 0.1,
  • "created": 0.1,
  • "updated": 0.1,
  • "deleted": 0.1,
  • "unchanged": 0.1
}

Bulk delete sources

Deletes a list of sources referenced by their id.

Warning: deleting a source will delete its children objects in the process
Deleted children objects will be included in the total count.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

Request Body schema: application/json
required

List of ids referencing sources

Array
string (DoubleUuid)

Composed of 2 colon-separated stringified UUIDv4. Represents a Workspace or an Entity in DataGalaxy's context.

Responses

Request samples

Content type
application/json
[
  • "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2"
]

Response samples

Content type
application/json
{
  • "totalDeleted": 0.1
}

Bulk upsert a dictionary entities tree

This route upserts a Source and all it's children up to a total of 250 000 entities.
This route uses the Upsert method. Existing entities are updated and non-existing ones are created. Existing entities are not deleted.
Read our article on bulktree for more informations.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

query Parameters
importId
string (Uuid)
Example: importId=ade92d04-294e-4bff-9dfa-5ea2f5419426

Stringified UUIDv4. See RFC 4112

Request Body schema: application/json
required
type
required
string (ModelTypeEnum)
Enum: "Relational" "NonRelational" "NoSql" "TagBase"
status
string (EntityLifecycleStatusEnum)
Enum: "Proposed" "InRevision" "Validated" "InValidation" "Obsolete"
owners
Array of strings (Email)
stewards
Array of strings (Email)
tags
Array of strings
description
string
summary
string
name
required
string
technicalName
string
Array of ChildStructure (objects) or Array of ChildContainer (objects)
additional property
string or number or boolean or Array of strings or Array of Email (strings) or HyperLink (object) or string or TimeSerieValue (string) or any (AdditionalCustomAttributeBulk)

Additional attribute. This property's type depends on the attribute's format.

Responses

Request samples

Content type
application/json
{
  • "type": "Relational",
  • "status": "Proposed",
  • "owners": [
    ],
  • "stewards": [
    ],
  • "tags": [
    ],
  • "description": "string",
  • "summary": "string",
  • "name": "string",
  • "technicalName": "string",
  • "children": [
    ],
  • "property1": "string",
  • "property2": "string"
}

Response samples

Content type
application/json
{
  • "total": 0.1,
  • "created": 0.1,
  • "updated": 0.1,
  • "deleted": 0.1,
  • "unchanged": 0.1
}

Delete a foreignKey.

Deletes the specified foreignKey.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

sourceId
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.

foreignKeyId
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.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Remove column from privateKey.

Remove the specified column from its attributed privateKey.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

sourceId
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.

columnId
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.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

List the source types.

Return the list of source types and their compatible children types.

Authorizations:
Personal Access TokenIntegration token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Containers

Manage all of your entities from your technical dictionary. If you need more detail, please consult our Dictionary module documentation.

Return the details of a container.

Return the details of a container.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

containerId
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.

query Parameters
Array of ReversedSystemAttribute (string) or CustomAttributeName (string) (AttributeName)
includeAccessData
boolean (IncludeAccessData)

If this is true, every objects returned will contain an accessData property.
accessData contains the access level the current token has on the object.
Default: false

Responses

Response samples

Content type
application/json
{
  • "name": "foo",
  • "technicalName": "bar",
  • "type": "string",
  • "id": "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
  • "versionId": "c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
  • "path": "string",
  • "functionalPath": "string",
  • "typePath": "string",
  • "objectUrl": "string",
  • "childrenCount": 0.1,
  • "accessData": {
    },
  • "attributes": {
    },
  • "isWatched": true,
  • "richTextAttributes": {
    }
}

Edit a container (for string, number and boolean values).

Modifies one or more attributes of the specified container.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

containerId
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.

Request Body schema: application/json
required
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.

Responses

Request samples

Content type
application/json
{
  • "owners": [
    ],
  • "stewards": [
    ],
  • "tags": [
    ],
  • "description": "string",
  • "summary": "string",
  • "name": "string",
  • "technicalName": "string",
  • "status": "Proposed",
  • "property1": true,
  • "property2": true
}

Response samples

Content type
application/json
{
  • "id": "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
  • "location": "string"
}

Delete a container.

Deletes the specified container.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

containerId
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.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Return a list of containers.

Return a list of all containers contained in the specified source / container.

Authorizations:
Personal Access TokenIntegration token
query Parameters
versionId
required
string (VersionId)
Example: versionId=c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

parentId
string (DoubleUuid)
Example: parentId=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.

name
string
technicalName
string
type
string (ContainerTypeEnum)
Enum: "Model" "Directory" "Equipment"
includeAccessData
boolean (IncludeAccessData)

If this is true, every objects returned will contain an accessData property.
accessData contains the access level the current token has on the object.
Default: false

includeAttributes
boolean (IncludeAttributes)

If this is true, every objects returned will contain an attributes property.
attributes contains the value of every attributes the object has.
Default: false

includeLinks
boolean (IncludeLinks)

If this is true, every objects returned will contain a links property.
links contains the list of every other objects linked to it.
Default: false

Array of ReversedSystemAttribute (string) or CustomAttributeName (string) (AttributeName)
limit
number <double>
Default: 20
page
number <double>
Default: 1
maxDepth
number <double> (MaxDepth)

Determines the maximum depth at which objects will be fetched, relative to the parentId.
A maximum depth of 0 will fetch direct objects only, while maximum depth n will fetch objects from depth 0 to depth n.
By default, no maximum depth is applied; objects of all depths will be fetched.

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "total": null,
  • "pages": 0.1,
  • "total_sum": 0.1,
  • "next_page": "string"
}

Create a container.

Create a container in the specified parent.

Available container types can be found thanks to the GET /types endpoint.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

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.

Request Body schema: application/json
required
name
required
string

Entity name

type
required
string (ContainerTypeEnum)
Enum: "Model" "Directory" "Equipment"
status
string (EntityLifecycleStatusEnum)
Enum: "Proposed" "InRevision" "Validated" "InValidation" "Obsolete"
owners
Array of strings (Email)

Email list of users defined as Owners of this entity

stewards
Array of strings (Email)

Email list of users defined as Stewards of this entity

tags
Array of strings

List of tags

description
string
summary
string
upsert
boolean

If true, this request will try to UPSERT instead of create the entity

technicalName
string
additional property
string or number or boolean or Array of strings or Array of Email (strings) or HyperLink (object) or string or any or Array of TimeSeriesEntry (objects) (AdditionalCustomAttribute)

Additional attribute. This property's type depends on the attribute's format.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "Model",
  • "status": "Proposed",
  • "owners": [
    ],
  • "stewards": [
    ],
  • "tags": [
    ],
  • "description": "string",
  • "summary": "string",
  • "upsert": true,
  • "technicalName": "string",
  • "property1": "string",
  • "property2": "string"
}

Response samples

Content type
application/json
{
  • "id": "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
  • "location": "string"
}

Bulk create containers.

Massively create containers in the specified parent. (max 250 000)

Available container types can be found thanks to the GET /types endpoint.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

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.

Request Body schema: application/json
required
Array
type
required
string (ContainerTypeEnum)
Enum: "Model" "Directory" "Equipment"
status
string (EntityLifecycleStatusEnum)
Enum: "Proposed" "InRevision" "Validated" "InValidation" "Obsolete"
owners
Array of strings (Email)
stewards
Array of strings (Email)
tags
Array of strings
description
string
summary
string
name
required
string
technicalName
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "total": 0.1,
  • "created": 0.1,
  • "updated": 0.1,
  • "deleted": 0.1,
  • "unchanged": 0.1
}

Bulk edit containers.

Massively edit containers in the specified parent. (max 250 000)

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

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.

Request Body schema: application/json
required
Array
type
required
string (ContainerTypeEnum)
Enum: "Model" "Directory" "Equipment"
status
string (EntityLifecycleStatusEnum)
Enum: "Proposed" "InRevision" "Validated" "InValidation" "Obsolete"
owners
Array of strings (Email)
stewards
Array of strings (Email)
tags
Array of strings
description
string
summary
string
name
string
technicalName
required
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "total": 0.1,
  • "created": 0.1,
  • "updated": 0.1,
  • "deleted": 0.1,
  • "unchanged": 0.1
}

Bulk delete containers

Deletes a list of container referenced by their id.

Warning: deleting a container will delete its children objects in the process
Deleted children objects will be included in the total count.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

Request Body schema: application/json
required

List of ids referencing containers

Array
string (DoubleUuid)

Composed of 2 colon-separated stringified UUIDv4. Represents a Workspace or an Entity in DataGalaxy's context.

Responses

Request samples

Content type
application/json
[
  • "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2"
]

Response samples

Content type
application/json
{
  • "totalDeleted": 0.1
}

List the container types.

Return the list of containers types and their compatible children types,.

Authorizations:
Personal Access TokenIntegration token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Structures

Manage all of your entities from your technical dictionary. If you need more detail, please consult our Dictionary module documentation.

Return a list of structures.

Return a list of all existing structures contained in the specified source. If parentId belongs to a workspace, a list of structures contained by all the sources of this workspace will be returned.

Authorizations:
Personal Access TokenIntegration token
query Parameters
versionId
required
string (VersionId)
Example: versionId=c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

parentId
string (DoubleUuid)
Example: parentId=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.

name
string
technicalName
string
type
string (StructureTypeEnum)
Enum: "Table" "Document" "File" "SubStructure" "Tag" "View"
includeAccessData
boolean (IncludeAccessData)

If this is true, every objects returned will contain an accessData property.
accessData contains the access level the current token has on the object.
Default: false

includeAttributes
boolean (IncludeAttributes)

If this is true, every objects returned will contain an attributes property.
attributes contains the value of every attributes the object has.
Default: false

includeLinks
boolean (IncludeLinks)

If this is true, every objects returned will contain a links property.
links contains the list of every other objects linked to it.
Default: false

Array of ReversedSystemAttribute (string) or CustomAttributeName (string) (AttributeName)
limit
number <double>
Default: 20
page
number <double>
Default: 1
maxDepth
number <double> (MaxDepth)

Determines the maximum depth at which objects will be fetched, relative to the parentId.
A maximum depth of 0 will fetch direct objects only, while maximum depth n will fetch objects from depth 0 to depth n.
By default, no maximum depth is applied; objects of all depths will be fetched.

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "total": null,
  • "pages": 0.1,
  • "total_sum": 0.1,
  • "next_page": "string"
}

Return a structure.

Return the details of the specified structure.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

structureId
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.

query Parameters
Array of ReversedSystemAttribute (string) or CustomAttributeName (string) (AttributeName)
includeAccessData
boolean (IncludeAccessData)

If this is true, every objects returned will contain an accessData property.
accessData contains the access level the current token has on the object.
Default: false

Responses

Response samples

Content type
application/json
{
  • "name": "foo",
  • "technicalName": "bar",
  • "type": "string",
  • "id": "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
  • "versionId": "c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
  • "path": "string",
  • "functionalPath": "string",
  • "typePath": "string",
  • "objectUrl": "string",
  • "childrenCount": 0.1,
  • "accessData": {
    },
  • "attributes": {
    },
  • "isWatched": true,
  • "richTextAttributes": {
    }
}

Delete a structure.

Deletes the specified structure.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

structureId
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.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Edit a structure.

Modifies one or more attributes of the specified structure.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

structureId
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.

Request Body schema: application/json
required
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.

Responses

Request samples

Content type
application/json
{
  • "owners": [
    ],
  • "stewards": [
    ],
  • "tags": [
    ],
  • "description": "string",
  • "summary": "string",
  • "name": "string",
  • "technicalName": "string",
  • "status": "Proposed",
  • "property1": true,
  • "property2": true
}

Response samples

Content type
application/json
{
  • "id": "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
  • "location": "string"
}

Create a structure.

Create a structure inside the specified parent entity.

Available structure types can be found thanks to the GET /types endpoint.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

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.

Request Body schema: application/json
required
name
required
string
technicalName
string
type
required
string (StructureTypeEnum)
Enum: "Table" "Document" "File" "SubStructure" "Tag" "View"
owners
Array of strings (Email)
stewards
Array of strings (Email)
tags
Array of strings
description
string
summary
string
upsert
boolean
status
string (EntityLifecycleStatusEnum)
Enum: "Proposed" "InRevision" "Validated" "InValidation" "Obsolete"
additional property
string or number or boolean or Array of strings or Array of Email (strings) or HyperLink (object) or string or any or Array of TimeSeriesEntry (objects) (AdditionalCustomAttribute)

Additional attribute. This property's type depends on the attribute's format.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "technicalName": "string",
  • "type": "Table",
  • "owners": [
    ],
  • "stewards": [
    ],
  • "tags": [
    ],
  • "description": "string",
  • "summary": "string",
  • "upsert": true,
  • "status": "Proposed",
  • "property1": "string",
  • "property2": "string"
}

Response samples

Content type
application/json
{
  • "id": "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
  • "location": "string"
}

Bulk delete structures

Deletes a list of structures referenced by their id.

Warning: deleting a structure will delete its children objects in the process
Deleted children objects will be included in the total count.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

Request Body schema: application/json
required

List of ids referencing structures

Array
string (DoubleUuid)

Composed of 2 colon-separated stringified UUIDv4. Represents a Workspace or an Entity in DataGalaxy's context.

Responses

Request samples

Content type
application/json
[
  • "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2"
]

Response samples

Content type
application/json
{
  • "totalDeleted": 0.1
}

Bulk create structures

Massively create structures in the specified parent. (max 250 000)

Available structure types can be found thanks to the GET /types endpoint.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

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.

Request Body schema: application/json
required
Array
type
required
string (StructureTypeEnum)
Enum: "Table" "Document" "File" "SubStructure" "Tag" "View"
status
string (EntityLifecycleStatusEnum)
Enum: "Proposed" "InRevision" "Validated" "InValidation" "Obsolete"
owners
Array of strings (Email)
stewards
Array of strings (Email)
tags
Array of strings
description
string
summary
string
name
required
string
technicalName
string
additional property
string or number or boolean or Array of strings or Array of Email (strings) or HyperLink (object) or string or any or Array of TimeSeriesEntry (objects) (AdditionalCustomAttribute)

Additional attribute. This property's type depends on the attribute's format.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "total": 0.1,
  • "created": 0.1,
  • "updated": 0.1,
  • "deleted": 0.1,
  • "unchanged": 0.1
}

Bulk edit structures

Massively edit structures in the specified parent. (max 250 000)

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

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.

Request Body schema: application/json
required
Array
type
required
string (StructureTypeEnum)
Enum: "Table" "Document" "File" "SubStructure" "Tag" "View"
status
string (EntityLifecycleStatusEnum)
Enum: "Proposed" "InRevision" "Validated" "InValidation" "Obsolete"
owners
Array of strings (Email)
stewards
Array of strings (Email)
tags
Array of strings
description
string
summary
string
name
required
string
technicalName
string
additional property
string or number or boolean or Array of strings or Array of Email (strings) or HyperLink (object) or string or any or Array of TimeSeriesEntry (objects) (AdditionalCustomAttribute)

Additional attribute. This property's type depends on the attribute's format.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "total": 0.1,
  • "created": 0.1,
  • "updated": 0.1,
  • "deleted": 0.1,
  • "unchanged": 0.1
}

List the structure types.

Return the list of structure types and their compatible field types,.

Authorizations:
Personal Access TokenIntegration token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Fields

Manage all of your entities from your technical dictionary. If you need more detail, please consult our Dictionary module documentation.

Return a list of fields.

Return a list of fields contained by a structure. If parentId belongs to a source or workspace, a list of fields contained by all the structures of this source or workspace will be returned.

Authorizations:
Personal Access TokenIntegration token
query Parameters
versionId
required
string (VersionId)
Example: versionId=c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

parentId
string (DoubleUuid)
Example: parentId=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.

name
string
technicalName
string
type
string (FieldTypeEnum)
Enum: "Column" "Field"
includeAccessData
boolean (IncludeAccessData)

If this is true, every objects returned will contain an accessData property.
accessData contains the access level the current token has on the object.
Default: false

includeAttributes
boolean (IncludeAttributes)

If this is true, every objects returned will contain an attributes property.
attributes contains the value of every attributes the object has.
Default: false

includeLinks
boolean (IncludeLinks)

If this is true, every objects returned will contain a links property.
links contains the list of every other objects linked to it.
Default: false

Array of ReversedSystemAttribute (string) or CustomAttributeName (string) (AttributeName)
limit
number <double>
Default: 20
page
number <double>
Default: 1
maxDepth
number <double> (MaxDepth)

Determines the maximum depth at which objects will be fetched, relative to the parentId.
A maximum depth of 0 will fetch direct objects only, while maximum depth n will fetch objects from depth 0 to depth n.
By default, no maximum depth is applied; objects of all depths will be fetched.

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "total": null,
  • "pages": 0.1,
  • "total_sum": 0.1,
  • "next_page": "string"
}

Return a field.

Return the details of the specified field.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

fieldId
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.

query Parameters
Array of ReversedSystemAttribute (string) or CustomAttributeName (string) (AttributeName)
includeAccessData
boolean (IncludeAccessData)

If this is true, every objects returned will contain an accessData property.
accessData contains the access level the current token has on the object.
Default: false

Responses

Response samples

Content type
application/json
{
  • "name": "foo",
  • "technicalName": "bar",
  • "type": "string",
  • "id": "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
  • "versionId": "c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
  • "path": "string",
  • "functionalPath": "string",
  • "typePath": "string",
  • "objectUrl": "string",
  • "childrenCount": 0.1,
  • "accessData": {
    },
  • "attributes": {
    },
  • "isWatched": true,
  • "richTextAttributes": {
    }
}

Edit a field.

Modifies one or more attributes of the specified field.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

fieldId
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.

Request Body schema: application/json
required
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"
columnDataType
required
string (ColumnDataTypeEnum)
Enum: "VariableString" "FixedString" "Integer" "DateTime" "Decimal" "Boolean" "Binary" "Numeric" "Date" "TimeStamp" "LongText" "String"
size
required
number <double>

Responses

Request samples

Content type
application/json
{
  • "owners": [
    ],
  • "stewards": [
    ],
  • "tags": [
    ],
  • "description": "string",
  • "summary": "string",
  • "name": "string",
  • "technicalName": "string",
  • "status": "Proposed",
  • "columnDataType": "VariableString",
  • "size": 0.1
}

Response samples

Content type
application/json
{
  • "id": "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
  • "location": "string"
}

Delete a field.

Deletes the specified field.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

fieldId
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.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Create a field.

Create a field inside the specified structure.

Available field types can be found thanks to the GET /types endpoint.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

structureId
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.

Request Body schema: application/json
required
name
required
string

Entity name

type
required
string (FieldTypeEnum)
Enum: "Column" "Field"
status
string (EntityLifecycleStatusEnum)
Enum: "Proposed" "InRevision" "Validated" "InValidation" "Obsolete"
owners
Array of strings (Email)

Email list of users defined as Owners of this entity

stewards
Array of strings (Email)

Email list of users defined as Stewards of this entity

tags
Array of strings

List of tags

description
string
summary
string
upsert
boolean

If true, this request will try to UPSERT instead of create the entity

technicalName
string
columnDataType
string (ColumnDataTypeEnum)
Enum: "VariableString" "FixedString" "Integer" "DateTime" "Decimal" "Boolean" "Binary" "Numeric" "Date" "TimeStamp" "LongText" "String"
size
number <double>
additional property
string or number or boolean or Array of strings or Array of Email (strings) or HyperLink (object) or string or any or Array of TimeSeriesEntry (objects) (AdditionalCustomAttribute)

Additional attribute. This property's type depends on the attribute's format.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "Column",
  • "status": "Proposed",
  • "owners": [
    ],
  • "stewards": [
    ],
  • "tags": [
    ],
  • "description": "string",
  • "summary": "string",
  • "upsert": true,
  • "technicalName": "string",
  • "columnDataType": "VariableString",
  • "size": 0.1,
  • "property1": "string",
  • "property2": "string"
}

Response samples

Content type
application/json
{
  • "id": "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
  • "location": "string"
}

Bulk delete fields

Deletes a list of fields referenced by their id.

Warning: deleting a field will delete its children objects in the process
Deleted children objects will be included in the total count.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

Request Body schema: application/json
required

List of ids referencing fields

Array
string (DoubleUuid)

Composed of 2 colon-separated stringified UUIDv4. Represents a Workspace or an Entity in DataGalaxy's context.

Responses

Request samples

Content type
application/json
[
  • "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2"
]

Response samples

Content type
application/json
{
  • "totalDeleted": 0.1
}

Bulk create fields.

Massively create fields in the specified parent. (max 250 000)

Available field types can be found thanks to the GET /types endpoint.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

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.

Request Body schema: application/json
required
Array
type
required
string (FieldTypeEnum)
Enum: "Column" "Field"
status
string (EntityLifecycleStatusEnum)
Enum: "Proposed" "InRevision" "Validated" "InValidation" "Obsolete"
owners
Array of strings (Email)
stewards
Array of strings (Email)
tags
Array of strings
description
string
summary
string
name
required
string
technicalName
required
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "total": 0.1,
  • "created": 0.1,
  • "updated": 0.1,
  • "deleted": 0.1,
  • "unchanged": 0.1
}

Bulk edit fields.

Massively edit fields in the specified parent. (max 250 000)

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

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.

Request Body schema: application/json
required
Array
type
required
string (FieldTypeEnum)
Enum: "Column" "Field"
status
string (EntityLifecycleStatusEnum)
Enum: "Proposed" "InRevision" "Validated" "InValidation" "Obsolete"
owners
Array of strings (Email)
stewards
Array of strings (Email)
tags
Array of strings
description
string
summary
string
name
required
string
technicalName
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "total": 0.1,
  • "created": 0.1,
  • "updated": 0.1,
  • "deleted": 0.1,
  • "unchanged": 0.1
}

List the field types.

Return the list of field types and their compatible parent types.

Authorizations:
Personal Access TokenIntegration token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

DataProcessing

Manage all of your functionnal entities from your processes. If you need more detail, please consult our Data Processing module documentation.

Return a list of data processing.

Return the list of data processing contained in the specified workspace

Authorizations:
Personal Access TokenIntegration token
query Parameters
versionId
required
string (VersionId)
Example: versionId=c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

parentId
string (DoubleUuid)
Example: parentId=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.

name
string
technicalName
string
type
string (DataProcessingTypeEnum)
Enum: "DataProcessing" "DataFlow"
includeAccessData
boolean (IncludeAccessData)

If this is true, every objects returned will contain an accessData property.
accessData contains the access level the current token has on the object.
Default: false

includeAttributes
boolean (IncludeAttributes)

If this is true, every objects returned will contain an attributes property.
attributes contains the value of every attributes the object has.
Default: false

includeLinks
boolean (IncludeLinks)

If this is true, every objects returned will contain a links property.
links contains the list of every other objects linked to it.
Default: false

Array of ReversedSystemAttribute (string) or CustomAttributeName (string) (AttributeName)
limit
number <double>
Default: 20
page
number <double>
Default: 1
maxDepth
number <double> (MaxDepth)

Determines the maximum depth at which objects will be fetched, relative to the parentId.
A maximum depth of 0 will fetch direct objects only, while maximum depth n will fetch objects from depth 0 to depth n.
By default, no maximum depth is applied; objects of all depths will be fetched.

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "total": null,
  • "pages": 0.1,
  • "total_sum": 0.1,
  • "next_page": "string"
}

Return a data processing.

Return the details of the specified data processing.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

dataProcessingId
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.

query Parameters
Array of ReversedSystemAttribute (string) or CustomAttributeName (string) (AttributeName)
includeAccessData
boolean (IncludeAccessData)

If this is true, every objects returned will contain an accessData property.
accessData contains the access level the current token has on the object.
Default: false

Responses

Response samples

Content type
application/json
{
  • "name": "foo",
  • "technicalName": "bar",
  • "type": "string",
  • "id": "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
  • "versionId": "c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
  • "path": "string",
  • "functionalPath": "string",
  • "typePath": "string",
  • "objectUrl": "string",
  • "childrenCount": 0.1,
  • "accessData": {
    },
  • "attributes": {
    },
  • "isWatched": true,
  • "richTextAttributes": {
    },
  • "dpItems": [
    ]
}

Update a data processing.

Modifies one or more attributes of the specified data processing and its inputs and outputs.
An input/output shall be a sourceId/structureId/fieldId.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

dataProcessingId
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.

Request Body schema: application/json
required
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"
addInputs
Array of strings (Uuid)
addOutputs
Array of strings (Uuid)
removeInputs
Array of strings (Uuid)
removeOutputs
Array of strings (Uuid)

Responses

Request samples

Content type
application/json
{
  • "owners": [
    ],
  • "stewards": [
    ],
  • "tags": [
    ],
  • "description": "string",
  • "summary": "string",
  • "name": "string",
  • "technicalName": "string",
  • "status": "Proposed",
  • "addInputs": [
    ],
  • "addOutputs": [
    ],
  • "removeInputs": [
    ],
  • "removeOutputs": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
  • "location": "string"
}

Delete a data processing.

Deletes the specified data processing.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

dataProcessingId
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.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

List the data processing types.

Return the list of source types and their compatible structure types.

Authorizations:
Personal Access TokenIntegration token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a data processing.

Create a data processing in the specified parent with its inputs and outputs.
An input/output shall be a sourceId/structureId/fieldId.
Available data processing types can be found thanks to the GET /types endpoint.

Authorizations:
Personal Access TokenIntegration token
path Parameters
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.

versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

Request Body schema: application/json
required
name
required
string

Entity name

type
required
string (DataProcessingTypeEnum)
Enum: "DataProcessing" "DataFlow"
status
string (EntityLifecycleStatusEnum)
Enum: "Proposed" "InRevision" "Validated" "InValidation" "Obsolete"
owners
Array of strings (Email)

Email list of users defined as Owners of this entity

stewards
Array of strings (Email)

Email list of users defined as Stewards of this entity

tags
Array of strings

List of tags

description
string
summary
string
upsert
boolean

If true, this request will try to UPSERT instead of create the entity

technicalName
string
inputs
Array of strings
outputs
Array of strings
additional property
string or number or boolean or Array of strings or Array of Email (strings) or HyperLink (object) or string or any or Array of TimeSeriesEntry (objects) (AdditionalCustomAttribute)

Additional attribute. This property's type depends on the attribute's format.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "DataProcessing",
  • "status": "Proposed",
  • "owners": [
    ],
  • "stewards": [
    ],
  • "tags": [
    ],
  • "description": "string",
  • "summary": "string",
  • "upsert": true,
  • "technicalName": "string",
  • "inputs": [
    ],
  • "outputs": [
    ],
  • "property1": "string",
  • "property2": "string"
}

Response samples

Content type
application/json
{
  • "id": "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
  • "location": "string"
}

Bulk delete data processings

Deletes a list of data processing referenced by their id.

Warning: deleting a data processing will delete its children objects in the process
Deleted children objects will be included in the total count.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

Request Body schema: application/json
required

List of ids referencing data processings

Array
string (DoubleUuid)

Composed of 2 colon-separated stringified UUIDv4. Represents a Workspace or an Entity in DataGalaxy's context.

Responses

Request samples

Content type
application/json
[
  • "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2"
]

Response samples

Content type
application/json
{
  • "totalDeleted": 0.1
}

Bulk upsert data processing tree

This route massively creates dataProcessings with their inputs/outputs and their dataProcessingItems.
This route uses the Upsert method. Existing entities are updated and non-existing ones are created. Existing entities are not deleted.
Read our article on bulktree for more information.

Inputs and outputs paths must be in the following format:


{
  entityPath: "\\foo\\bar",
  typePath: "\\NoSql\\Table"
}
Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

query Parameters
importId
string (Uuid)
Example: importId=ade92d04-294e-4bff-9dfa-5ea2f5419426

Stringified UUIDv4. See RFC 4112

Request Body schema: application/json
required
Array
name
required
string
technicalName
string
owners
Array of strings (Email)
stewards
Array of strings (Email)
tags
Array of strings
status
string (EntityLifecycleStatusEnum)
Enum: "Proposed" "InRevision" "Validated" "InValidation" "Obsolete"
description
string
summary
string
type
required
string (DataProcessingTypeEnum)
Enum: "DataProcessing" "DataFlow"
required
Array of objects (BulkInput)
required
Array of objects (BulkInput)
children
Array of objects (DataProcessingBulkCreation)
Array of objects (DpiBulkModel)
additional property
string or number or boolean or Array of strings or Array of Email (strings) or HyperLink (object) or string or TimeSerieValue (string) or any (AdditionalCustomAttributeBulk)

Additional attribute. This property's type depends on the attribute's format.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "total": 0.1,
  • "created": 0.1,
  • "updated": 0.1,
  • "deleted": 0.1,
  • "unchanged": 0.1,
  • "details": {
    }
}

DataProcessingItem

Manage the mapping of your data processings via the data processing items.

Return the list of data processing items contained in the specified parent

Return the list of data processing items contained in the specified parent

Authorizations:
Personal Access TokenIntegration token
query Parameters
versionId
required
string (VersionId)
Example: versionId=c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

parentId
required
string (DoubleUuid)
Example: parentId=2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

A data processing id (format: {workspaceId}:{dataProcessingId}

name
string
technicalName
string
type
string (DataProcessingItemTypeEnum)
Enum: "Undefined" "Copy" "Concatenate" "Substring" "Formula" "Agregate" "Convert" "Search" "InnerJoin" "ConstantVariable" "Custom" "OuterJoin" "Filter" "Calculation"

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "total": null
}

List the data processing items types.

Return the list of data processing item types and their compatible inputs/outputs types.

Authorizations:
Personal Access TokenIntegration token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a data processing item.

Create a data processing item and its inputs and outputs in the specified data processing.
An input/output shall be a sourceId/structureId/fieldId.
Available data processing item types can be found thanks to the GET /types endpoint.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

dataProcessingId
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.

Request Body schema: application/json
required
name
required
string
technicalName
string
type
required
string (DataProcessingItemTypeEnum)
Enum: "Undefined" "Copy" "Concatenate" "Substring" "Formula" "Agregate" "Convert" "Search" "InnerJoin" "ConstantVariable" "Custom" "OuterJoin" "Filter" "Calculation"
summary
string
description
string
inputs
Array of strings
outputs
Array of strings

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "technicalName": "string",
  • "type": "Undefined",
  • "summary": "string",
  • "description": "string",
  • "inputs": [
    ],
  • "outputs": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "ade92d04-294e-4bff-9dfa-5ea2f5419426"
}

Bulk upsert data processing items.

Create multiple data processing items and their inputs and outputs in the specified data processing.
Inputs and outputs paths must have the following format:


{
  entityPath: "\\foo\\bar",
  typePath: "\\NoSql\\Table"
}


Available data processing item types can be found thanks to the GET /types endpoint.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

dataProcessingId
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.

Request Body schema: application/json
required
Array
name
required
string
technicalName
string
type
required
string (DataProcessingItemTypeEnum)
Enum: "Undefined" "Copy" "Concatenate" "Substring" "Formula" "Agregate" "Convert" "Search" "InnerJoin" "ConstantVariable" "Custom" "OuterJoin" "Filter" "Calculation"
summary
string
description
string
required
Array of objects (MappingPath)
required
Array of objects (MappingPath)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "total": 0.1,
  • "created": 0.1,
  • "updated": 0.1,
  • "deleted": 0.1,
  • "unchanged": 0.1
}

Update a data processing item.

Update a data processing item and its inputs and outputs in the specified data processing.
An input/output shall be a sourceId/structureId/fieldId.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

dataProcessingId
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.

dataProcessingItemId
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.

Request Body schema: application/json
required
name
string
technicalName
string
type
string (DataProcessingItemTypeEnum)
Enum: "Undefined" "Copy" "Concatenate" "Substring" "Formula" "Agregate" "Convert" "Search" "InnerJoin" "ConstantVariable" "Custom" "OuterJoin" "Filter" "Calculation"
summary
string
description
string
addInputs
Array of strings
addOutputs
Array of strings
removeOutputs
Array of strings
removeInputs
Array of strings

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "technicalName": "string",
  • "type": "Undefined",
  • "summary": "string",
  • "description": "string",
  • "addInputs": [
    ],
  • "addOutputs": [
    ],
  • "removeOutputs": [
    ],
  • "removeInputs": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "ade92d04-294e-4bff-9dfa-5ea2f5419426"
}

Delete a data processing item.

Delete a data processing item.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

dataProcessingId
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.

dataProcessingItemId
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.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Usage

Manage all of your functionnal entities from your usage module. If you need more detail, please consult our Usage module documentation.

Return a list of usages.

Return a list of all usage contained in the specified parent. A parent can be a workspace or another usage.

Authorizations:
Personal Access TokenIntegration token
query Parameters
versionId
required
string (VersionId)
Example: versionId=c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

parentId
string (DoubleUuid)
Example: parentId=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.

name
string
technicalName
string
includeAccessData
boolean (IncludeAccessData)

If this is true, every objects returned will contain an accessData property.
accessData contains the access level the current token has on the object.
Default: false

includeAttributes
boolean (IncludeAttributes)

If this is true, every objects returned will contain an attributes property.
attributes contains the value of every attributes the object has.
Default: false

includeLinks
boolean (IncludeLinks)

If this is true, every objects returned will contain a links property.
links contains the list of every other objects linked to it.
Default: false

Array of ReversedSystemAttribute (string) or CustomAttributeName (string) (AttributeName)
type
string (UsageTypeEnum)
Enum: "Application" "Algorithm" "Dashboard" "Feature" "DataSet" "OpenDataSet" "Screen" "Process" "Report" "Usage" "UsageField" "UsageComponent"
limit
number <double>
Default: 20
page
number <double>
Default: 1
maxDepth
number <double> (MaxDepth)

Determines the maximum depth at which objects will be fetched, relative to the parentId.
A maximum depth of 0 will fetch direct objects only, while maximum depth n will fetch objects from depth 0 to depth n.
By default, no maximum depth is applied; objects of all depths will be fetched.

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "total": null,
  • "pages": 0.1,
  • "total_sum": 0.1,
  • "next_page": "string"
}

Return a usage.

Return the details of the specified usage.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

usageId
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.

query Parameters
Array of ReversedSystemAttribute (string) or CustomAttributeName (string) (AttributeName)
includeAccessData
boolean (IncludeAccessData)

If this is true, every objects returned will contain an accessData property.
accessData contains the access level the current token has on the object.
Default: false

Responses

Response samples

Content type
application/json
{
  • "name": "foo",
  • "technicalName": "bar",
  • "type": "string",
  • "id": "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
  • "versionId": "c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
  • "path": "string",
  • "functionalPath": "string",
  • "typePath": "string",
  • "objectUrl": "string",
  • "childrenCount": 0.1,
  • "accessData": {
    },
  • "attributes": {
    },
  • "isWatched": true,
  • "richTextAttributes": {
    }
}

Edit a usage.

Modifies one or more attributes of the specified usage.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

usageId
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.

Request Body schema: application/json
required
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"
parentId
string (DoubleUuid)

Composed of 2 colon-separated stringified UUIDv4. Represents a Workspace or an Entity in DataGalaxy's context.

Responses

Request samples

Content type
application/json
{
  • "owners": [
    ],
  • "stewards": [
    ],
  • "tags": [
    ],
  • "description": "string",
  • "summary": "string",
  • "name": "string",
  • "technicalName": "string",
  • "status": "Proposed",
  • "parentId": "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2"
}

Response samples

Content type
application/json
{
  • "id": "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
  • "location": "string"
}

Delete a usage.

Deletes the specified usage.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

usageId
required
string (Uuid)
Example: ade92d04-294e-4bff-9dfa-5ea2f5419426

Stringified UUIDv4. See RFC 4112

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

List the usage types.

Return the list of Usage types and their compatible children types.

Authorizations:
Personal Access TokenIntegration token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a usage.

Create a usage in the specified parent (workspace or compatible usage).
Available usage types can be found thanks to the GET /types endpoint.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

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.

Request Body schema: application/json
required
name
required
string

Entity name

type
required
string (UsageTypeEnum)
Enum: "Application" "Algorithm" "Dashboard" "Feature" "DataSet" "OpenDataSet" "Screen" "Process" "Report" "Usage" "UsageField" "UsageComponent"
status
string (EntityLifecycleStatusEnum)
Enum: "Proposed" "InRevision" "Validated" "InValidation" "Obsolete"
owners
Array of strings (Email)

Email list of users defined as Owners of this entity

stewards
Array of strings (Email)

Email list of users defined as Stewards of this entity

tags
Array of strings

List of tags

description
string
summary
string
upsert
boolean

If true, this request will try to UPSERT instead of create the entity

technicalName
string
additional property
string or number or boolean or Array of strings or Array of Email (strings) or HyperLink (object) or string or any or Array of TimeSeriesEntry (objects) (AdditionalCustomAttribute)

Additional attribute. This property's type depends on the attribute's format.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "Application",
  • "status": "Proposed",
  • "owners": [
    ],
  • "stewards": [
    ],
  • "tags": [
    ],
  • "description": "string",
  • "summary": "string",
  • "upsert": true,
  • "technicalName": "string",
  • "property1": "string",
  • "property2": "string"
}

Response samples

Content type
application/json
{
  • "id": "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
  • "location": "string"
}

Bulk upsert a usage tree

This route creates or update multiple usages and all their children up to a total of 250 000 entities.
This route uses the Upsert method. Existing entities are updated and non-existing ones are created. Existing entities are not deleted.
Read our article on bulktree for more informations.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

query Parameters
importId
string (Uuid)
Example: importId=ade92d04-294e-4bff-9dfa-5ea2f5419426

Stringified UUIDv4. See RFC 4112

Request Body schema: application/json
required
Array
type
required
string (UsageTypeEnum)
Enum: "Application" "Algorithm" "Dashboard" "Feature" "DataSet" "OpenDataSet" "Screen" "Process" "Report" "Usage" "UsageField" "UsageComponent"
status
string (EntityLifecycleStatusEnum)
Enum: "Proposed" "InRevision" "Validated" "InValidation" "Obsolete"
owners
Array of strings (Email)
stewards
Array of strings (Email)
tags
Array of strings
description
string
summary
string
name
required
string
technicalName
string
children
Array of objects (UsageBulktreeCreation)
additional property
string or number or boolean or Array of strings or Array of Email (strings) or HyperLink (object) or string or TimeSerieValue (string) or any (AdditionalCustomAttributeBulk)

Additional attribute. This property's type depends on the attribute's format.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "total": 0.1,
  • "created": 0.1,
  • "updated": 0.1,
  • "deleted": 0.1,
  • "unchanged": 0.1
}

Bulk delete usages

Deletes a list of usages referenced by their id.

Warning: deleting a usage will delete its children objects in the process
Deleted children objects will be included in the total count.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

Version ID

Request Body schema: application/json
required

List of ids referencing usages

Array
string (DoubleUuid)

Composed of 2 colon-separated stringified UUIDv4. Represents a Workspace or an Entity in DataGalaxy's context.

Responses

Request samples

Content type
application/json
[
  • "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2"
]

Response samples

Content type
application/json
{
  • "totalDeleted": 0.1
}

Tasks

Tasks can be assigned to team members and linked to DataGalaxy objects.

Rich text format

Simple text or rich text descriptions can be added in order to give your tasks some context.

DataGalaxy API handles rich text as one or more stringified HTML paragraphs.
This HTML string may contain standard text formatting tags (e.g.: <b>, <i>, <s>, <pre>, <a>, and more...), but also a custom tag <rich-text-mention> which will mention and notify a member of your team in the task description.

The <rich-text-mention> tag contains an attribute mention-id refering to the userId of the user your are mentionning.
Request the GET /users or GET /users/roles endpoints to find userIds of your team members.

Examples

Rich text and user mention example are provided in /tasks endpoints documentation.

List entity tasks

Return a list of all tasks associated with an entity.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

entityId
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.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a task.

Create a task in the specified entity.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

entityId
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.

Request Body schema: application/json
required
assignee
required
string (Email)

DataGalaxy user email.

text
required
string (RichText)
title
required
string
type
string (TaskType)
Enum: "AddObject" "UpdateAttribute" "UpdateContact" "MoveObject" "GrantAccess" "ValidateChange" "UpdateDescription" "Duplicate" "Question" "DataQualityReview"
dueTime
string (IDate)

Format: YYYY-MM-DD

status
string (TaskStatus)
Enum: "Requested" "InProgress" "Executed" "Refused"

Responses

Request samples

Content type
application/json
{
  • "assignee": "john.smith@email.com",
  • "text": "<p>Normal <strong>bold </strong><em>italic </em><u>underlined </u><s>strikethrough </s> <rich-text-mention mention-id=\"85b44c58-3d83-4892-8117-9793ad0bdc64\" target-type=\"User\"></rich-text-mention> <rich-text-mention mention-id=\"8dc9f078-e43e-11ed-b5ea-0242ac120002\" target-type=\"Team\"></rich-text-mention></p>",
  • "title": "string",
  • "type": "AddObject",
  • "dueTime": "string",
  • "status": "Requested"
}

Response samples

Content type
application/json
{
  • "assignee": "john.smith@email.com",
  • "text": "<p>Normal <strong>bold </strong><em>italic </em><u>underlined </u><s>strikethrough </s> <rich-text-mention mention-id=\"85b44c58-3d83-4892-8117-9793ad0bdc64\" target-type=\"User\"></rich-text-mention> <rich-text-mention mention-id=\"8dc9f078-e43e-11ed-b5ea-0242ac120002\" target-type=\"Team\"></rich-text-mention></p>",
  • "title": "string",
  • "type": "AddObject",
  • "dueTime": "string",
  • "status": "Requested",
  • "taskId": "string",
  • "creator": "john.smith@email.com",
  • "creationTime": "string",
  • "entity": {
    }
}

List user tasks

Return the list of tasks of which the user associated to the integrationToken is the creator or the assigned manager.

assignee and creator parameters support query string arrays and will be logically joined with OR operator

Authorizations:
Personal Access TokenIntegration token
query Parameters
q
string (SearchQuery)

This term will be searched in the following attributes of an object: name, technicalName, description, summary and local synonym names

creator
Array of strings (Email)
Example: creator=john.smith@email.com
assignee
Array of strings (Email)
Example: assignee=john.smith@email.com
status
string (TaskStatus)
Enum: "Requested" "InProgress" "Executed" "Refused"
type
string (TaskType)
Enum: "AddObject" "UpdateAttribute" "UpdateContact" "MoveObject" "GrantAccess" "ValidateChange" "UpdateDescription" "Duplicate" "Question" "DataQualityReview"
versionId
string (Uuid)
Example: versionId=ade92d04-294e-4bff-9dfa-5ea2f5419426

Stringified UUIDv4. See RFC 4112

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update a task.

Update a task in the specified entity.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

entityId
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.

taskId
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.

Request Body schema: application/json
required
assignee
string (Email)

DataGalaxy user email.

text
string (RichText)
title
string
type
string (TaskType)
Enum: "AddObject" "UpdateAttribute" "UpdateContact" "MoveObject" "GrantAccess" "ValidateChange" "UpdateDescription" "Duplicate" "Question" "DataQualityReview"
dueTime
string (IDate)

Format: YYYY-MM-DD

status
string (TaskStatus)
Enum: "Requested" "InProgress" "Executed" "Refused"
response
string (RichText)

Responses

Request samples

Content type
application/json
{
  • "assignee": "john.smith@email.com",
  • "text": "<p>Normal <strong>bold </strong><em>italic </em><u>underlined </u><s>strikethrough </s> <rich-text-mention mention-id=\"85b44c58-3d83-4892-8117-9793ad0bdc64\" target-type=\"User\"></rich-text-mention> <rich-text-mention mention-id=\"8dc9f078-e43e-11ed-b5ea-0242ac120002\" target-type=\"Team\"></rich-text-mention></p>",
  • "title": "string",
  • "type": "AddObject",
  • "dueTime": "string",
  • "status": "Requested",
  • "response": "<p>Normal <strong>bold </strong><em>italic </em><u>underlined </u><s>strikethrough </s> <rich-text-mention mention-id=\"85b44c58-3d83-4892-8117-9793ad0bdc64\" target-type=\"User\"></rich-text-mention> <rich-text-mention mention-id=\"8dc9f078-e43e-11ed-b5ea-0242ac120002\" target-type=\"Team\"></rich-text-mention></p>"
}

Response samples

Content type
application/json
{
  • "assignee": "john.smith@email.com",
  • "text": "<p>Normal <strong>bold </strong><em>italic </em><u>underlined </u><s>strikethrough </s> <rich-text-mention mention-id=\"85b44c58-3d83-4892-8117-9793ad0bdc64\" target-type=\"User\"></rich-text-mention> <rich-text-mention mention-id=\"8dc9f078-e43e-11ed-b5ea-0242ac120002\" target-type=\"Team\"></rich-text-mention></p>",
  • "title": "string",
  • "type": "AddObject",
  • "dueTime": "string",
  • "status": "Requested",
  • "taskId": "string",
  • "creator": "john.smith@email.com",
  • "creationTime": "string",
  • "entity": {
    }
}

Delete a task.

Delete a task from the specified entity.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

entityId
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.

taskId
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.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Comments

A comment is a piece of simple text or rich text adding context or remarks to an object.
Comments are visible by other users and members of your team can be mentionned in it.

Rich text format

DataGalaxy API handles rich text as one or more stringified HTML paragraphs.
This HTML string may contain standard text formatting tags (e.g.: <b>, <i>, <s>, <pre>, <a>, and more...), but also a custom tag <rich-text-mention> which will mention and notify a member of your team in the comment.

The <rich-text-mention> tag contains an attribute mention-id refering to the userId of the user your are mentionning.
Request the GET /users or GET /users/roles endpoints to find userIds of your team members.

Examples

Rich text and user mention example are provided in /comments endpoints documentation.

Return a list of comments.

Return a list of all comments details in the specified entity.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

entityId
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.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a comment.

Create a comment in the specified entity.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

entityId
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.

Request Body schema: application/json
required
message
required
string (RichText)

Responses

Request samples

Content type
application/json
{
  • "message": "<p>Normal <strong>bold </strong><em>italic </em><u>underlined </u><s>strikethrough </s> <rich-text-mention mention-id=\"85b44c58-3d83-4892-8117-9793ad0bdc64\" target-type=\"User\"></rich-text-mention> <rich-text-mention mention-id=\"8dc9f078-e43e-11ed-b5ea-0242ac120002\" target-type=\"Team\"></rich-text-mention></p>"
}

Response samples

Content type
application/json
{
  • "message": "<p>Normal <strong>bold </strong><em>italic </em><u>underlined </u><s>strikethrough </s> <rich-text-mention mention-id=\"85b44c58-3d83-4892-8117-9793ad0bdc64\" target-type=\"User\"></rich-text-mention> <rich-text-mention mention-id=\"8dc9f078-e43e-11ed-b5ea-0242ac120002\" target-type=\"Team\"></rich-text-mention></p>",
  • "commentId": "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
  • "creationTime": "string",
  • "creationUser": "john.smith@email.com",
  • "lastModificationTime": "string",
  • "lastModificationUser": "john.smith@email.com"
}

Update a comment

Update a comment in the specified entity.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

entityId
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.

commentId
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.

Request Body schema: application/json
required
message
required
string (RichText)

Responses

Request samples

Content type
application/json
{
  • "message": "<p>Normal <strong>bold </strong><em>italic </em><u>underlined </u><s>strikethrough </s> <rich-text-mention mention-id=\"85b44c58-3d83-4892-8117-9793ad0bdc64\" target-type=\"User\"></rich-text-mention> <rich-text-mention mention-id=\"8dc9f078-e43e-11ed-b5ea-0242ac120002\" target-type=\"Team\"></rich-text-mention></p>"
}

Response samples

Content type
application/json
{
  • "message": "<p>Normal <strong>bold </strong><em>italic </em><u>underlined </u><s>strikethrough </s> <rich-text-mention mention-id=\"85b44c58-3d83-4892-8117-9793ad0bdc64\" target-type=\"User\"></rich-text-mention> <rich-text-mention mention-id=\"8dc9f078-e43e-11ed-b5ea-0242ac120002\" target-type=\"Team\"></rich-text-mention></p>",
  • "commentId": "2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
  • "creationTime": "string",
  • "creationUser": "john.smith@email.com",
  • "lastModificationTime": "string",
  • "lastModificationUser": "john.smith@email.com"
}

Delete a comment

Delete a comment associated with the specified entity.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

entityId
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.

commentId
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.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Users

Return a list of users eligible to be stewards or owners. Deprecated

Return a list of users eligible to be stewards or owners in the specified version of your workspace.

Authorizations:
Personal Access TokenIntegration token
path Parameters
versionId
required
string (VersionId)
Example: c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

query Parameters
role
required
string (Roles)
Enum: "owner" "steward" "dpo" "cdo" "ciso" "expert"
userId
string (Uuid)
Example: userId=ade92d04-294e-4bff-9dfa-5ea2f5419426

Stringified UUIDv4. See RFC 4112

email
string (Email)
Example: email=john.smith@email.com

DataGalaxy user email.

limit
number <double>
Default: 20
page
number <double>
Default: 1

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "total": 0.1,
  • "pages": 0.1,
  • "total_sum": 0.1,
  • "next_page": "string"
}

Fetch governance users

Return list of users assigned to each of the 6 governance roles: Owner, Steward, CDO, DPO, CISO, Expert.

Query string arrays are supported and will be logically joined with OR operator

Authorizations:
Personal Access TokenIntegration token
query Parameters
role
Array of strings (Roles)
Items Enum: "owner" "steward" "dpo" "cdo" "ciso" "expert"
versionId
string (Uuid)
Example: versionId=ade92d04-294e-4bff-9dfa-5ea2f5419426

Stringified UUIDv4. See RFC 4112

userId
Array of strings (Uuid)
Example: userId=ade92d04-294e-4bff-9dfa-5ea2f5419426
email
Array of strings (Email)
Example: email=john.smith@email.com

Responses

Response samples

Content type
application/json
{
  • "owners": [
    ],
  • "stewards": [
    ],
  • "cdos": [
    ],
  • "cisos": [
    ],
  • "dpos": [
    ],
  • "experts": [
    ]
}

Return a list of users with their authorizations.

Return the list of all users owned by your account with the authorizations they have in your workspace and its modules.

Note:
Your integrationToken must have an admin access on the target workspace.

Deprecation:
In order to avoid a breaking change with previous versions, requesting this route without pagination parameters will result in a non-paginated response payload.
Pagination is standard as of version 2.5.0.

Authorizations:
Personal Access TokenIntegration token
query Parameters
versionId
required
string (VersionId)
Example: versionId=c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

userId
string (Uuid)
Example: userId=ade92d04-294e-4bff-9dfa-5ea2f5419426

Stringified UUIDv4. See RFC 4112

email
string (Email)
Example: email=john.smith@email.com

DataGalaxy user email.

limit
number <double>
Default: 20
page
number <double>
Default: 1

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "total": null,
  • "pages": 0.1,
  • "total_sum": 0.1,
  • "next_page": "string"
}

Update the authorizations of a list of users

Update the authorizations of a list of users on a workspace and its modules.
An authorization update to the glossary, dataProcessings or uses is applied at the module level, i.e., to all the entities they contain.
An authorization update to the catalog is applied to the specified sourceId.

Check the Request body Schema bellow for more informations on the expected structure and available values.

Authorizations:
Personal Access TokenIntegration token
Request Body schema: application/json
required
versionId
required
string (VersionId)

This id determines the scope of the request.
versionId relates to a workspace's version.
It can be found in the GET /workspaces and GET /workspaces/{workspaceId}/versions endpoint's response.

required
Array of objects (UserUpdateAuthorizations)

Responses

Request samples

Content type
application/json
{
  • "versionId": "c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2",
  • "users": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Return a list of users.

Return a list of users from the workspaces that the token currently has access to.

Note:
To retrieve all users in the client space, you need to have a token with administrator rights at the client space level and add the parameter scope=admin.

Authorizations:
Personal Access TokenIntegration token
query Parameters
userId
string (Uuid)
Example: userId=ade92d04-294e-4bff-9dfa-5ea2f5419426

An optional user id to filter the list

email
string (Email)
Example: email=john.smith@email.com

An optional user email to filter the list

limit
number <double>
Default: 20

Maximum number of results per page (by default: 20)

page
number <double>
Default: 1

Page number (by default: 1)

scope
string

An optional scope.

  • If you are using a token with administrator rights at the client space level, you can set the value to "admin" in order to retrieve all users in the client space including additional data about users such as activity and license information.
  • If you set the value to "admin" but your access token does not have administrative rights at the client space level, it will return a 401!

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "total": null,
  • "pages": 0.1,
  • "total_sum": 0.1,
  • "next_page": "string"
}

Create a user.

Create a user and add it to your account.
A user can be created with no license. You can add it later using PUT /user/{userId}.
Available licenses can be found thanks to the GET /licenses endpoint.

Authorizations:
Personal Access TokenIntegration token
Request Body schema: application/json
required
email
required
string (Email)

DataGalaxy user email.

firstname
required
string
lastname
required
string
licenseId
number <double>
title
string
service
string
role
string

Responses

Request samples

Content type
application/json
{
  • "email": "john.smith@email.com",
  • "firstname": "string",
  • "lastname": "string",
  • "licenseId": 0.1,
  • "title": "string",
  • "service": "string",
  • "role": "string"
}

Response samples

Content type
application/json
{
  • "userId": "ade92d04-294e-4bff-9dfa-5ea2f5419426",
  • "licenseLevel": "Reader",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "john.smith@email.com",
  • "profileImageUrl": "string",
  • "profileThumbnailUrl": "string",
  • "externalId": "string",
  • "service": "string",
  • "role": "string",
  • "title": "string",
  • "_links": [
    ]
}

Return a profile image

Return the profile image for a given user.

Authorizations:
Personal Access TokenIntegration token
path Parameters
userId
required
string (Uuid)
Example: ade92d04-294e-4bff-9dfa-5ea2f5419426

User unique identifier

query Parameters
dimension
required
string (ImageDimension)
Enum: "thumbnail" "default"

Optional dimension for the profile image (the "default" dimension is 300x300 and the "thumbnail" dimension is 60x60)

Responses

Response samples

Content type
application/json
{
  • "data": "string",
  • "contentType": "string"
}

Update the properties of a user.

Update the properties of a user. Set licenseId to null to remove its license.

Authorizations:
Personal Access TokenIntegration token
path Parameters
userId
required
string (Uuid)
Example: ade92d04-294e-4bff-9dfa-5ea2f5419426

Stringified UUIDv4. See RFC 4112

Request Body schema: application/json
required
firstname
string
lastname
string
email
string (Email)

DataGalaxy user email.

licenseId
number <double>
title
string
service
string
role
string
externalId
string

Responses

Request samples

Content type
application/json
{
  • "firstname": "string",
  • "lastname": "string",
  • "email": "john.smith@email.com",
  • "licenseId": 0.1,
  • "title": "string",
  • "service": "string",
  • "role": "string",
  • "externalId": "string"
}

Response samples

Content type
application/json
{
  • "userId": "ade92d04-294e-4bff-9dfa-5ea2f5419426",
  • "licenseLevel": "Reader",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "john.smith@email.com",
  • "profileImageUrl": "string",
  • "profileThumbnailUrl": "string",
  • "externalId": "string",
  • "service": "string",
  • "role": "string",
  • "title": "string",
  • "_links": [
    ]
}

Delete a user

Permanently deletes a user.

When deleting a user that had an owner or steward role on an object, the workspace's default owner / steward will automatically be assigned to the object.
Users that are default owners or stewards at workspace level cannot be deleted, an error will be thrown if you try to.

Authorizations:
Personal Access TokenIntegration token
path Parameters
userId
required
string (Uuid)
Example: ade92d04-294e-4bff-9dfa-5ea2f5419426

Stringified UUIDv4. See RFC 4112

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Teams

Teams are group of users with a common role or goal. They can be mentioned in comments or tasks descriptions.

Teams have three access level :

  • limited : All users are allowed to view the team profile and can request to join the team
  • private Only members of the team can view its profile
  • open All users can join the team and view its profile

List teams

This endpoint fetches each team existing in your client space.
Each team is represented by a JSON Object containing basic informations and a list of the members.
Make sure you read the Teams short introduction to get a grasp of the main concepts.

This endpoint supports multivalue filters passed as Querystrings, such as id, name and access.
If a filter contains multiple values the OR operator is applied.
So for example, filtering your result to match private teams named DreamTeam or ATeam can be done as follow :

/v2/teams?name=DreamTeam&name=ATeam&access=private

Authorizations:
Personal Access TokenIntegration token
query Parameters
id
Array of strings (DoubleUuid)
Example: id=2e21697d-e630-4459-b56a-4f4bcb996e4a:c9b33d6a-3f51-4aa7-9ff3-e64aad2d56c2

Filters result to match team id

name
Array of strings

Filters result to match team name

access
Array of strings (AccessType)
Items Enum: "limited" "private" "open"

Filters result to match team access

includeMembers
boolean
Default: false

When true, adds a members property to each teams in the response payload. This property will contain a list of users composing the team.

allTeams
boolean
Default: true

When true, retrieve all client teams if the calling user is a client admin. Otherwise, if false then retrieve the teams the calling user has access to via membership.

Responses

Response samples

Content type
application/json
{
  • "total": 1,
  • "results": [
    ]
}

Create team

This endpoint create a team.
You can optionally add a list of members, a description and a team email.

Authorizations:
Personal Access TokenIntegration token
Request Body schema: application/json
required
name
required
string

Team name

description
string

A short description of the team motivations

email
string

The team email will be used to notify all members

access
required
string (AccessType)
Enum: "limited" "private" "open"

Team access level. Read the Team's Introduction to learn more.

owners
required
Array of strings (Email)

Team owner's email

Array of objects (TeamMember)

List of users that are part of the team

Responses

Request samples

Content type
application/json
{
  • "name": "Dream Team",
  • "description": "This team is composed of the best of the best.",
  • "email": "contact@dreamteam.com",
  • "access": "limited",
  • "owners": [
    ],
  • "members": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "Dream Team",
  • "description": "This team is composed of the best of the best.",
  • "email": "contact@dreamteam.com",
  • "access": "limited",
  • "id": "7fb1a0c7-cd31-48ee-a2e6-c1e756329d8d:fb5ce285-4dc5-42e1-9bee-6446024d9864",
  • "iconHash": "L+FMgcYua9iw71ZcVXwmqewbJhi2dMdvxgSLSG+hGYA=",
  • "owners": [
    ],
  • "membersCount": 1,
  • "members": [
    ]
}

Update team

This endpoint updates the team associated to the id given in the request params.

owners and members properties will be updated with the exact value you provide in your request payload.
This means you can remove users from these lists by simply omitting them from your request.
On the other hand, if you wish to add users, you need to send the whole existing users list with the additional users.

Authorizations:
Personal Access TokenIntegration token
path Parameters
id
required
string (TeamId)
Example: 7fb1a0c7-cd31-48ee-a2e6-c1e756329d8d:fb5ce285-4dc5-42e1-9bee-6446024d9864

Team Id. Required in order to target a team.

Request Body schema: application/json
required
name
string

Team name

description
string

A short description of the team motivations

email
string

The team email will be used to notify all members

access
string (AccessType)
Enum: "limited" "private" "open"

Team access level. Read the Team's Introduction to learn more.

owners
Array of strings (Email)

Team owner's email

Array of objects (TeamMember)

List of users that are part of the team

Responses

Request samples

Content type
application/json
{
  • "name": "Dream Team",
  • "description": "This team is composed of the best of the best.",
  • "email": "contact@dreamteam.com",
  • "access": "limited",
  • "owners": [
    ],
  • "members": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "Dream Team",
  • "description": "This team is composed of the best of the best.",
  • "email": "contact@dreamteam.com",
  • "access": "limited",
  • "id": "7fb1a0c7-cd31-48ee-a2e6-c1e756329d8d:fb5ce285-4dc5-42e1-9bee-6446024d9864",
  • "iconHash": "L+FMgcYua9iw71ZcVXwmqewbJhi2dMdvxgSLSG+hGYA=",
  • "owners": [
    ],
  • "membersCount": 1,
  • "members": [
    ]
}

Delete a team

This endpoint deletes the team associated to the id given in the request params.

Authorizations:
Personal Access TokenIntegration token
path Parameters
id
required
string (TeamId)
Example: 7fb1a0c7-cd31-48ee-a2e6-c1e756329d8d:fb5ce285-4dc5-42e1-9bee-6446024d9864

Team Id. Required in order to target a team.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete multiple teams

This endpoint deletes a list of teams, specified by their id given in the request payload.

Authorizations:
Personal Access TokenIntegration token
Request Body schema: application/json
required
Array
string (TeamId)

Team Id. Required in order to target a team.

Responses

Request samples

Content type
application/json
[
  • "7fb1a0c7-cd31-48ee-a2e6-c1e756329d8d:fb5ce285-4dc5-42e1-9bee-6446024d9864"
]

Response samples

Content type
application/json
{
  • "error": {
    }
}

Licenses

Return the list of licences owned by your account.

Return the list of licenses owned by your account.
Licenses are grouped by license pools.

This route's response payload has a licenses field which contains an array of objects.
By default, objects found in this array can represent 2 things:

  • assigned licenses. These objects have an associateUser field, it displays which user is associated to which license pool.
  • license pools. These objects have a boolean field isLicensePool: true and a number field availableLicenses: n.

In order to assign a license to a user and link them to a license pool, request PUT /users/{userId} and update their licenseId field with one of your license pools licenseId.

Authorizations:
Personal Access TokenIntegration token
query Parameters
assigned
boolean
licenseLevel
string (DataGalaxyLicenseLevel)
Enum: "reader" "explorer" "steward"

Responses

Response samples

Content type
application/json
{
  • "total": 0.1,
  • "readers": {
    },
  • "explorers": {
    },
  • "stewards": {
    },
  • "licenses": [
    ]
}

SCIM/Users

Return a list of users.

Return a list of all the users owned by your account in SCIM format as detailed in RFC 7643 and RFC 7644.

Authorizations:
Personal Access TokenIntegration token
query Parameters
filter
string
excludedAttributes
string
attributes
string
sortBy
string
sortOrder
string
startIndex
number <double>
count
number <double>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a user.

Create a user and add it to your account. The user wll receive a reader license if the reader license pool has some available

Authorizations:
Personal Access TokenIntegration token
Request Body schema: application/json
required
schemas
required
string
Value: "urn:ietf:params:scim:schemas:core:2.0:User"
id
string (Uuid)

Stringified UUIDv4. See RFC 4112

externalId
string
title
string
service
string
role
string
licenseId
number <double>
active
boolean
required
Array of objects
required
object

Responses

Request samples

Content type
application/json
{
  • "schemas": "urn:ietf:params:scim:schemas:core:2.0:User",
  • "id": "ade92d04-294e-4bff-9dfa-5ea2f5419426",
  • "externalId": "string",
  • "title": "string",
  • "service": "string",
  • "role": "string",
  • "licenseId": 0.1,
  • "active": true,
  • "emails": [
    ],
  • "name": {
    }
}

Response samples

Content type
application/json
{
  • "schemas": "urn:ietf:params:scim:schemas:core:2.0:User",
  • "id": "ade92d04-294e-4bff-9dfa-5ea2f5419426",
  • "externalId": "string",
  • "meta": {
    },
  • "title": "string",
  • "service": "string",
  • "role": "string",
  • "licenseId": 0.1,
  • "name": {
    },
  • "active": true,
  • "emails": [
    ],
  • "photos": []
}

Return a user.

Return the corresponding users owned by your account in SCIM format as detailed in RFC 7643 and RFC 7644.

Authorizations:
Personal Access TokenIntegration token
path Parameters
userId
required
string (Uuid)
Example: ade92d04-294e-4bff-9dfa-5ea2f5419426

Stringified UUIDv4. See RFC 4112

query Parameters
filter
string
excludedAttributes
string
attributes
string
sortBy
string
sortOrder
string
startIndex
number <double>
count
number <double>

Responses

Response samples

Content type
application/json
{
  • "schemas": "urn:ietf:params:scim:schemas:core:2.0:User",
  • "id": "ade92d04-294e-4bff-9dfa-5ea2f5419426",
  • "externalId": "string",
  • "meta": {
    },
  • "title": "string",
  • "service": "string",
  • "role": "string",
  • "licenseId": 0.1,
  • "name": {
    },
  • "active": true,
  • "emails": [
    ],
  • "photos": []
}

Patch a user.

Patch a user. If the user is set to inactive, it will lose his license. If the user is then set to active, the license should be attached to the user manually in DataGalaxy.

Authorizations:
Personal Access TokenIntegration token
path Parameters
userId
required
string (Uuid)
Example: ade92d04-294e-4bff-9dfa-5ea2f5419426

Stringified UUIDv4. See RFC 4112

Request Body schema: application/json
required
schemas
required
string
Value: "urn:ietf:params:scim:api:messages:2.0:PatchOp"
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "schemas": "urn:ietf:params:scim:api:messages:2.0:PatchOp",
  • "Operations": [
    ]
}

Response samples

Content type
application/json
{
  • "schemas": "urn:ietf:params:scim:schemas:core:2.0:User",
  • "id": "ade92d04-294e-4bff-9dfa-5ea2f5419426",
  • "externalId": "string",
  • "meta": {
    },
  • "title": "string",
  • "service": "string",
  • "role": "string",
  • "licenseId": 0.1,
  • "name": {
    },
  • "active": true,
  • "emails": [
    ],
  • "photos": []
}

Delete a user

Permanently deletes an user.

When deleting an user that had an owner or steward role on an object, the workspace's default owner / steward will automatically be assigned to the object.
Users that are default owners or stewards at workspace level cannot be deleted, an error will be thrown if you try to.

Authorizations:
Personal Access TokenIntegration token
path Parameters
userId
required
string (Uuid)
Example: ade92d04-294e-4bff-9dfa-5ea2f5419426

Stringified UUIDv4. See RFC 4112

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "message": "string",
  • "stack": "string",
  • "status": 0.1,
  • "scimType": "string"
}

Update a user.

Update a user.

Authorizations:
Personal Access TokenIntegration token
path Parameters
userId
required
string (Uuid)
Example: ade92d04-294e-4bff-9dfa-5ea2f5419426

Stringified UUIDv4. See RFC 4112

Request Body schema: application/json
required
schemas
required
string
Value: "urn:ietf:params:scim:schemas:core:2.0:User"
id
string (Uuid)

Stringified UUIDv4. See RFC 4112

externalId
string
title
string
service
string
role
string
licenseId
number <double>
active
boolean
required
Array of objects
required
object

Responses

Request samples

Content type
application/json
{
  • "schemas": "urn:ietf:params:scim:schemas:core:2.0:User",
  • "id": "ade92d04-294e-4bff-9dfa-5ea2f5419426",
  • "externalId": "string",
  • "title": "string",
  • "service": "string",
  • "role": "string",
  • "licenseId": 0.1,
  • "active": true,
  • "emails": [
    ],
  • "name": {
    }
}

Response samples

Content type
application/json
{
  • "schemas": "urn:ietf:params:scim:schemas:core:2.0:User",
  • "id": "ade92d04-294e-4bff-9dfa-5ea2f5419426",
  • "externalId": "string",
  • "meta": {
    },
  • "title": "string",
  • "service": "string",
  • "role": "string",
  • "licenseId": 0.1,
  • "name": {
    },
  • "active": true,
  • "emails": [
    ],
  • "photos": []
}