REST Console API

Is the REST Console API (https://developer.collibra.com/rest/rest-console-api/) available for DGC Cloud?

I would like to use the “Try it out” functionality in the API page but I don’t see how to connect to our environment. I specifically would like to use it to create and download diagnostic files.

tracywilliams

Posted 5 years ago · Edited 1 year ago·Last reply 5 years ago

4 comments

arthurburkhardt

·5 years ago · Edited

There’s no “Try it out” functionality on the console Swagger UI, unfortunately.
I really recommend to user jupyterlab as an interactive python environment, this will allow you to experiment with full flexibility, and easily prototype whatever you can imagine, using the REST apis. Here’s the example you are looking for.

from collibra import Console

c = Console(netloc=f'console-{env}.collibra.com', username=username)

#find latest diagnostic file
r = c.get("support")
modified, diagnostic_id = max([(x['modifiedDate'], x['id']) for x in r.json()])

#download
r = c.get(f"support/{diagnostic_id}")
with open(diagnostic_id + '.zip', 'wb+') as f:
    f.write(r.content)

tracywilliams

OP5 years ago · Edited

I see what you mean Arthur. Thanks.

pmahend3

·5 years ago · Edited

Hi Tracy,

Yes, you will find a list of REST operations for the Console. Just use the below URL pattern to get to the page - https://{your-collibra-console-url}/docs/rest/index.html

Thanks

tracywilliams

OP5 years ago · Edited

I got it - Thank you Pranay!