Skip to main content
Solved

Accessing Data of Catalog Item via Rest API or GraphQL

K
Data Enthusiast

Hello everyone,

Iā€™m working on a project that integrates a data masking tool with Ataccama, and Iā€™m encountering some issues when trying to retrieve actual catalog item data (the row-level data) via the REST API. Iā€™ve been testing both GraphQL and REST approaches, and hereā€™s what Iā€™ve found so far:

GraphQL vs. REST for Data Retrieval:
The GraphQL API appears to focus on metadata ā€“ attributes, versioning, policies, etc. However, based on my understanding, the actual table data (the rows and cells) isnā€™t available through GraphQL; itā€™s only accessible via a REST endpoint. Based on available documentation for MDM and RDM REST APIs, the REST endpoints follow a pattern using a fixed base path (/api/rest) on the default port (8051) and use basic HTTP authentication.

Endpoint URL Confusion:
Initially, I attempted to use an endpoint like:
ā€ƒā€ƒhttps://teranet.test.ataccama.online/catalog/data/catalogItem/<gid>/data
which returned a 404 error. Later, based on the docs, I switched to the documented REST API base URL:
ā€ƒā€ƒhttps://teranet.test.ataccama.online:8051/api/rest/
But then my Python script timed out when connecting to that URL.

Has anyone faced similar issues when trying to access actual catalog item data via the REST API? How do you determine the correct endpoint URL for your environment? Any other suggestions on how I can fetch the actual data from the data tab of a catalog item?

 

Thanks,

Karine

Best answer by anna.spakova

Hello, 

ā€‹@may_kwok Thank you for responding. What you mention is from the web application access, I think the question was via API. I believe it might still be possible to call those actions via API too if needed, but it would have to be tested first. 

ā€‹@karine.davtyan You should be able to deploy the component on the orchestration server, that is provided as part of the installation. The component requires to be wrapped into a workflow. You seem to be in Ataccama cloud, so in your case you would deploy this workflow via your cloud git repository. Please note that depending on your deployment type (e.g. hybrid) this might require some adjustments in the workflow as your data might not be accessible by the orchestration server. In those cases you might need to use the Run DPM Job task in the workflow to have it triggered on the hybrid DPE. https://docs.ataccama.com/runtime-server/latest/workflow-and-scheduler-reference/run-dpm-job.html

As this might get complicated, I would consider contacting your Engagement manager or Customer Success Manager and consult with them if needed. Whoever is working on your account might advise better knowing your platform configuration.

Kind regards,

Anna

 

View original
Did this topic help you find an answer to your question?

7 replies

OGordon100
Ataccamer
Forum|alt.badge.img
  • OGordon100Ataccamer
  • Ataccamer
  • 17 replies
  • March 31, 2025

Hi Karine,

MDM (and RDM) are products in which Ataccama physically stores data, as they are designed to effectively be systems of record.

But by very deliberate design, DQ&C does not hold data; only metadata. (For many customers, this is part of Hybrid Processing, in which we process your data in your cloud, and then send only the results back to the central Ataccama platform). The only time in which data can be retrieved is during the Post-Processing phase of a Monitoring Project (or when Invalid result Samples are deliberately configured to be retained).

As such, because we do not hold data in ONE DQ&C, we therefore have no Rest API in DQ&C to access data in ONE DQ&C. 

(And as an aside - GraphQL is an API spec designed around parsing highly nested information - such as our Metadata Model - so it is not an appropriate tool for tabular data access in general!) 

But for Data Masking - Iā€™d suggest having a look at our Data Protection Classification feature.

Hope this clears things up!

Oliver

Cansu
K
2 people like this
  • Cansu
    Cansu
  • K
    karine.davtyan
anna.spakova
Ataccamer
Forum|alt.badge.img+3

Hi,

just to add to ā€‹@OGordon100 comment, there is a way through ONE Desktop to actually retrieve the data - there is a step called Catalog Item Reader that can access the actual data but it requires that the plan in the ONE Desktop is run remotely on the DPE that has access to the data source - that is achieved by changing the environment in the ONE Desktop tool. See more details: https://docs.ataccama.com/one-desktop/latest/work-with-ataccama-one/work-with-data.html#read-data-using-catalog-item-reader

Kind regards,

Anna

 

Cansu
K
2 people like this
  • Cansu
    Cansu
  • K
    karine.davtyan
Cansu
Community Manager
Forum|alt.badge.img+3
  • CansuCommunity Manager
  • Community Manager
  • 642 replies
  • April 1, 2025

Hi ā€‹@karine.davtyan, does any of the solutions shared above help you with your question? If yes, could you please mark it as a best answer šŸ™‹šŸ»ā€ā™€ļø

Check out our Quick Start Guide to get started on the community šŸ™‹ā€ā™€ļø
K
1 person likes this
  • K
    karine.davtyan
K
Data Enthusiast

Hi ā€‹@anna.spakova , 

Thank you for your answer. Just wondering if there is a way to host a plan that reads the data via that Catalog item reader and writes to a text file directly onto the Ataccama web app for users that donā€™t have access to ONE desktop. Maybe through the components section of desktop and the web app? 

 

Thanks, 

Karine

Cansu
1 person likes this
  • Cansu
    Cansu
may_kwok
Star Blazer L3
Forum|alt.badge.img+4
  • may_kwokStar Blazer L3
  • Star Blazer L3
  • 84 replies
  • April 3, 2025

ā€‹@karine.davtyan would the Data Export functionality serve your needs? https://docs.ataccama.com/one/latest/sources/data-export.html

Seems like this is available from v14 onwards? 

Cansu
K
2 people like this
  • Cansu
    Cansu
  • K
    karine.davtyan
anna.spakova
Ataccamer
Forum|alt.badge.img+3
  • anna.spakovaAtaccamer
  • Ataccamer
  • 151 replies
  • Answer
  • April 7, 2025

Hello, 

ā€‹@may_kwok Thank you for responding. What you mention is from the web application access, I think the question was via API. I believe it might still be possible to call those actions via API too if needed, but it would have to be tested first. 

ā€‹@karine.davtyan You should be able to deploy the component on the orchestration server, that is provided as part of the installation. The component requires to be wrapped into a workflow. You seem to be in Ataccama cloud, so in your case you would deploy this workflow via your cloud git repository. Please note that depending on your deployment type (e.g. hybrid) this might require some adjustments in the workflow as your data might not be accessible by the orchestration server. In those cases you might need to use the Run DPM Job task in the workflow to have it triggered on the hybrid DPE. https://docs.ataccama.com/runtime-server/latest/workflow-and-scheduler-reference/run-dpm-job.html

As this might get complicated, I would consider contacting your Engagement manager or Customer Success Manager and consult with them if needed. Whoever is working on your account might advise better knowing your platform configuration.

Kind regards,

Anna

 

Cansu
K
2 people like this
  • Cansu
    Cansu
  • K
    karine.davtyan
Cansu
Community Manager
Forum|alt.badge.img+3
  • CansuCommunity Manager
  • Community Manager
  • 642 replies
  • April 9, 2025

Hi ā€‹@karine.davtyan, I wanted to check if any of the suggestions helped with your use case here? Iā€™m closing this thread for now but if you have any further questions please feel free to share them in the comments or reach out to your CSM directly as Anna suggested above šŸ™‹šŸ»ā€ā™€ļø

Check out our Quick Start Guide to get started on the community šŸ™‹ā€ā™€ļø

Reply


Most Liked this week

Community Terms of Use & ConditionsCookie settings

Cookie policy

We use cookies to enhance and personalize your experience. If you accept you agree to our full cookie policy. Learn more about our cookies.

 
Cookie settings