Data Governance made
easier with APIs
DataGalaxy's web API lets you automate repetitive tasks
and efficiently build integrations between DataGalaxy and your tools.
- Import
- Export
Integrate fast
Use the DataGalaxy API to import and update up to 250,000 objects per request in your metamodel.
Here, the following JSON data is sent to the import endpoint to create a database representation in DataGalaxy web app:
- Request
- Response
JSON encoded payload
{
"name": "My DataBase",
"type": "Relational",
"summary": "Database summary",
"technology": "mysql",
"description": "Database description",
"owners": [
"john.smith@datagalaxy.com"
],
"stewards": [
"john.smith@datagalaxy.com"
],
"tags": [
"GDPR"
],
"children": [
{
"name": "My Container",
"type": "Model",
"summary": "Container summary",
"children": [
{
"name": "table_0",
"type": "Table",
"children": [
{
"name": "column_0",
"type": "Column"
},
{
"name": "column_1",
"type": "Column"
}
]
},
{
"name": "view_0",
"type": "View",
"children": [
{
"name": "column_0",
"type": "Column"
},
{
"name": "column_1",
"type": "Column"
}
]
}
]
}
]
}
JSON encoded payload
{
"total": 8,
"created": 8,
"updated": 0,
"deleted": 0,
"unchanged": 0
}
DataGalaxy web app
Easily fetch your objects
Retrieve up to 5000 objects per request with their attributes and relations to your metamodel.
- Request
- Response
cURL
curl 'https://yourapi.datagalaxy.com/v2/fields?versionId=913f3fbb-6d87-49b8-9428-1cea07e25351&includeAttributes=true&page=1&limit=5000'
-H 'Authorization: Bearer {accessToken}'
JSON encoded payload
{
"total": 4,
"pages": 1,
"total_sum": 4,
"next_page": null,
"results": [
{
"id": "0596ec5a-6e36-4476-8875-e76bf1f538b0:429c2dd0-9bd0-4a90-9221-2298994d9793",
"name": "column_0",
"technicalName": "column_0",
"type": "Column",
"dataType": "Field",
"versionId": "913f3fbb-6d87-49b8-9428-1cea07e25351",
"path": "\\My DataBase\\My Container\\table_0\\column_0",
"typePath": "\\Relational\\Model\\Table\\Column",
"objectUrl": "https://datagalaxy.com/#/client/4bdbc99e-f9c7-42f7-93e8-a946a5c937e1/space/0596ec5a-6e36-4476-8875-e76bf1f538b0/913f3fbb-6d87-49b8-9428-1cea07e25351/catalog/all/list/tree/browse/429c2dd0-9bd0-4a90-9221-2298994d9793",
"location": "fields/913f3fbb-6d87-49b8-9428-1cea07e25351/0596ec5a-6e36-4476-8875-e76bf1f538b0:429c2dd0-9bd0-4a90-9221-2298994d9793",
"attributes": {
"owners": [
"john.smith@datagalaxy.com"
],
"stewards": [
"john.smith@datagalaxy.com"
],
"status": "Proposed",
"tableTechnicalName": "table_0",
"tableDisplayName": "table_0",
"tags": [],
"summary": "",
"description": "",
"technicalComments": "",
"dataTypePrecisionSize": null,
"isMandatory": false,
"isPrimaryKey": false,
"isForeignKey": false,
"isTechnicalData": false,
"size": 50,
"columnDataType": "VariableString",
"creationTime": "2022-12-12T14:21:17.912+00:00",
"lastModificationTime": "2022-12-12T14:21:17.912+00:00",
"order": 1
},
"childrenCount": 0,
"parent": {
"id": "0596ec5a-6e36-4476-8875-e76bf1f538b0:4d7f4d78-c87a-44bd-9461-97182cc4f794",
"name": "table_0",
"technicalName": "table_0",
"type": "Table",
"dataType": "Structure"
}
},
{
"id": "0596ec5a-6e36-4476-8875-e76bf1f538b0:62f7a096-58d4-4a7f-bdf0-ce5181f65e6f",
"name": "column_0",
"technicalName": "column_0",
"type": "Column",
"dataType": "Field",
"versionId": "913f3fbb-6d87-49b8-9428-1cea07e25351",
"path": "\\My DataBase\\My Container\\view_0\\column_0",
"typePath": "\\Relational\\Model\\View\\Column",
"objectUrl": "https://datagalaxy.com/#/client/4bdbc99e-f9c7-42f7-93e8-a946a5c937e1/space/0596ec5a-6e36-4476-8875-e76bf1f538b0/913f3fbb-6d87-49b8-9428-1cea07e25351/catalog/all/list/tree/browse/62f7a096-58d4-4a7f-bdf0-ce5181f65e6f",
"location": "fields/913f3fbb-6d87-49b8-9428-1cea07e25351/0596ec5a-6e36-4476-8875-e76bf1f538b0:62f7a096-58d4-4a7f-bdf0-ce5181f65e6f",
"attributes": {
"owners": [
"john.smith@datagalaxy.com"
],
"stewards": [
"john.smith@datagalaxy.com"
],
"status": "Proposed",
"tableTechnicalName": "view_0",
"tableDisplayName": "view_0",
"tags": [],
"summary": "",
"description": "",
"technicalComments": "",
"dataTypePrecisionSize": null,
"isMandatory": false,
"isPrimaryKey": false,
"isForeignKey": false,
"isTechnicalData": false,
"size": 50,
"columnDataType": "VariableString",
"creationTime": "2022-12-12T14:21:17.912+00:00",
"lastModificationTime": "2022-12-12T14:21:17.912+00:00",
"order": 1
},
"childrenCount": 0,
"parent": {
"id": "0596ec5a-6e36-4476-8875-e76bf1f538b0:5412aa87-9057-467e-b968-ac75405614b4",
"name": "view_0",
"technicalName": "view_0",
"type": "View",
"dataType": "Structure"
}
},
{
"id": "0596ec5a-6e36-4476-8875-e76bf1f538b0:88fd42e5-81e4-4b85-a21e-a696218ccbe6",
"name": "column_1",
"technicalName": "column_1",
"type": "Column",
"dataType": "Field",
"versionId": "913f3fbb-6d87-49b8-9428-1cea07e25351",
"path": "\\My DataBase\\My Container\\view_0\\column_1",
"typePath": "\\Relational\\Model\\View\\Column",
"objectUrl": "https://datagalaxy.com/#/client/4bdbc99e-f9c7-42f7-93e8-a946a5c937e1/space/0596ec5a-6e36-4476-8875-e76bf1f538b0/913f3fbb-6d87-49b8-9428-1cea07e25351/catalog/all/list/tree/browse/88fd42e5-81e4-4b85-a21e-a696218ccbe6",
"location": "fields/913f3fbb-6d87-49b8-9428-1cea07e25351/0596ec5a-6e36-4476-8875-e76bf1f538b0:88fd42e5-81e4-4b85-a21e-a696218ccbe6",
"attributes": {
"owners": [
"john.smith@datagalaxy.com"
],
"stewards": [
"john.smith@datagalaxy.com"
],
"status": "Proposed",
"tableTechnicalName": "view_0",
"tableDisplayName": "view_0",
"tags": [],
"summary": "",
"description": "",
"technicalComments": "",
"dataTypePrecisionSize": null,
"isMandatory": false,
"isPrimaryKey": false,
"isForeignKey": false,
"isTechnicalData": false,
"size": 50,
"columnDataType": "VariableString",
"creationTime": "2022-12-12T14:21:17.912+00:00",
"lastModificationTime": "2022-12-12T14:21:17.912+00:00",
"order": 2
},
"childrenCount": 0,
"parent": {
"id": "0596ec5a-6e36-4476-8875-e76bf1f538b0:5412aa87-9057-467e-b968-ac75405614b4",
"name": "view_0",
"technicalName": "view_0",
"type": "View",
"dataType": "Structure"
}
},
{
"id": "0596ec5a-6e36-4476-8875-e76bf1f538b0:b773d7a1-f5a4-4912-b65d-63d9b5e50364",
"name": "column_1",
"technicalName": "column_1",
"type": "Column",
"dataType": "Field",
"versionId": "913f3fbb-6d87-49b8-9428-1cea07e25351",
"path": "\\My DataBase\\My Container\\table_0\\column_1",
"typePath": "\\Relational\\Model\\Table\\Column",
"objectUrl": "https://datagalaxy.com/#/client/4bdbc99e-f9c7-42f7-93e8-a946a5c937e1/space/0596ec5a-6e36-4476-8875-e76bf1f538b0/913f3fbb-6d87-49b8-9428-1cea07e25351/catalog/all/list/tree/browse/b773d7a1-f5a4-4912-b65d-63d9b5e50364",
"location": "fields/913f3fbb-6d87-49b8-9428-1cea07e25351/0596ec5a-6e36-4476-8875-e76bf1f538b0:b773d7a1-f5a4-4912-b65d-63d9b5e50364",
"attributes": {
"owners": [
"john.smith@datagalaxy.com"
],
"stewards": [
"john.smith@datagalaxy.com"
],
"status": "Proposed",
"tableTechnicalName": "table_0",
"tableDisplayName": "table_0",
"tags": [],
"summary": "",
"description": "",
"technicalComments": "",
"dataTypePrecisionSize": null,
"isMandatory": false,
"isPrimaryKey": false,
"isForeignKey": false,
"isTechnicalData": false,
"size": 50,
"columnDataType": "VariableString",
"creationTime": "2022-12-12T14:21:17.912+00:00",
"lastModificationTime": "2022-12-12T14:21:17.912+00:00",
"order": 2
},
"childrenCount": 0,
"parent": {
"id": "0596ec5a-6e36-4476-8875-e76bf1f538b0:4d7f4d78-c87a-44bd-9461-97182cc4f794",
"name": "table_0",
"technicalName": "table_0",
"type": "Table",
"dataType": "Structure"
}
}
]
}
DataGalaxy web app
- Search
Search through your metamodel with precision
DataGalaxy API’s search endpoint allows you to find objects accurately, thanks to advanced filters.
- Request
- Response
JSON encoded payload
{
"versionId": "913f3fbb-6d87-49b8-9428-1cea07e25351",
"query": "My",
"filters": [
{
"attributeKey": "TechnologyCode",
"operator": "contains",
"values": [
"mysql"
]
},
{
"attributeKey": "DataOwners",
"operator": "contains",
"values": [
"4e944307-4cb2-45bf-99a5-2c8056bfe0e5"
]
},
{
"attributeKey": "LastModificationTime",
"operator": "currentWeek",
"values": []
}
]
}
JSON encoded payload
{
"total": 2,
"total_sum": 2,
"result": {
"entities": [
{
"id": "0596ec5a-6e36-4476-8875-e76bf1f538b0:575e3901-0673-43eb-944b-2f5e0a853957",
"versionId": "913f3fbb-6d87-49b8-9428-1cea07e25351",
"name": "My Container",
"technicalName": "My Container",
"type": "Model",
"dataType": "Container",
"path": "\\My DataBase\\My Container",
"typePath": "\\Relational\\Model",
"objectUrl": "https://yourapi.datagalaxy.com/#/client/4bdbc99e-f9c7-42f7-93e8-a946a5c937e1/space/0596ec5a-6e36-4476-8875-e76bf1f538b0/913f3fbb-6d87-49b8-9428-1cea07e25351/catalog/all/list/tree/browse/575e3901-0673-43eb-944b-2f5e0a853957",
"location": "containers/913f3fbb-6d87-49b8-9428-1cea07e25351/0596ec5a-6e36-4476-8875-e76bf1f538b0:575e3901-0673-43eb-944b-2f5e0a853957",
"isExactMatch": false
},
{
"id": "0596ec5a-6e36-4476-8875-e76bf1f538b0:feda4333-e85a-492a-8c3b-39c7e257e0a2",
"versionId": "913f3fbb-6d87-49b8-9428-1cea07e25351",
"name": "My DataBase",
"technicalName": "My DataBase",
"type": "Relational",
"dataType": "Source",
"path": "\\My DataBase",
"typePath": "\\Relational",
"objectUrl": "https://yourapi.datagalaxy.com/#/client/4bdbc99e-f9c7-42f7-93e8-a946a5c937e1/space/0596ec5a-6e36-4476-8875-e76bf1f538b0/913f3fbb-6d87-49b8-9428-1cea07e25351/catalog/all/list/tree/browse/feda4333-e85a-492a-8c3b-39c7e257e0a2",
"location": "sources/913f3fbb-6d87-49b8-9428-1cea07e25351/0596ec5a-6e36-4476-8875-e76bf1f538b0:feda4333-e85a-492a-8c3b-39c7e257e0a2",
"isExactMatch": false
}
],
"filteredViews": []
},
"quickFilters": [
{
"filter": {
"attributeKey": "EntityStatus",
"operator": "contains",
"values": [
"Proposed"
]
},
"matches": 2
},
{
"filter": {
"attributeKey": "DataOwners",
"operator": "contains",
"values": []
},
"matches": 2
},
{
"filter": {
"attributeKey": "DataStewards",
"operator": "contains",
"values": []
},
"matches": 2
},
{
"filter": {
"attributeKey": "Domains",
"operator": "contains",
"values": []
},
"matches": 1
},
{
"filter": {
"attributeKey": "CreationTime",
"operator": "currentWeek",
"values": []
},
"matches": 2
}
]
}
DataGalaxy web app