Scribd
Upload
230 views

CDGC Public API Postman Collection

This document provides information about using a Postman collection for the CDGC Public REST API, including downloading the Postman collection and environment files, setting up the environment, and listing the available API endpoints. The Postman collection contains examples for the Search, Bulk Import/Export, and Job Monitoring APIs. The document also provides notes on API improvements between releases and regions for different API base URLs.

Uploaded by

chetan sharma
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
230 views

CDGC Public API Postman Collection

This document provides information about using a Postman collection for the CDGC Public REST API, including downloading the Postman collection and environment files, setting up the environment, and listing the available API endpoints. The Postman collection contains examples for the Search, Bulk Import/Export, and Job Monitoring APIs. The document also provides notes on API improvements between releases and regions for different API base URLs.

Uploaded by

chetan sharma
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 6

CDGC Public REST API - Postman Collection Sample

Solution
Attached is the sample postman collection to use CDGC Public REST API.

To use the postman collection, use the environment file attached.

Note
There can be improvements added in API from one release to another and some details in this article
may be outdated. Thus, some calls in the collection may not work as expected. Refer to the official
CDGC documentation for CDGC Public REST API details.

Postman Collection
This includes the following API examples:

Search API
Asset List API (POST)
/data360/search/v1/assets
Asset Details API (GET)
/data360/search/v1/assets/{id}
Multiple Assets Detail API (POST)
/data360/search/v1/assets/details
Bulk Import / Export API
Bulk Import API
/data360/content/import/v1/assets (POST)
Bulk Export API (Search and Export)
/data360/search/export/v1/assets (POST)
Bulk Export API (Specific Assets)
/data360/search/export/v1/assets/details (POST)
Job Monitoring API
/data360/observable/v1/jobs (GET)
Download Exported file, Success file or Error file

Import the Collection and Environment


1. Download the Postman collection and environment files.
2. Open Postman.
3. Click on "Import" to upload the collection and environment files.
1. Select the collection file (e.g., CDGC_Public_API.postman_collection.json) and
import it.
2. Select the environment file (e.g., CDGC_API_Env.postman_environment.json) and
import it.
Set Up the Environment

1. Once you have imported the environment file, click on the environment quicklook icon in the top
right corner to manage environments.
2. Select CDGC ENV API - Shared from the dropdown.
3. Fill in the necessary environment variables such as IDMC URL, CDGC API URL, username,
password, or any other configurations required for your CDGC API setup.

Env sample :
URL: https://dm-us.informaticacloud.com
api.url: https://idmc-api.dm-us.informaticacloud.com
username: IDMC username
password: IDMC password

Note
To generate jwt token using SAML check IDMC official documentation (SAML Login API):

{{url}}/ma/api/v2/user/loginSaml

CDGC API usage URL


API base URL to use for different pods:

Region API base URL

EMEA https://idmc-api.dm-em.informaticacloud.com/
UK https://idmc-api.dm-uk.informaticacloud.com/
APJ https://idmc-api.dm-ap.informaticacloud.com/
NA https://idmc-api.dm-us.informaticacloud.com/
Canada https://idmc-api.dm-na.informaticacloud.com/

List of API Endpoints


Note: Some details in this article may be outdated. Please refer to the official CDGC documentation
for CDGC Public REST API details.

Type API Call Endpoints Description


Provides list of Assets
based on search
Asset List
POST /data360/search/v1/assets query or body
API
parameters
Search
API Asset Provides details of an
GET /data360/search/v1/assets/{id}
Details API Asset.

Multiple Provides details of


Assets POST /data360/search/v1/assets/details multiple Asset passed
Details API in body parameter.

/data360/search/export/v1/assets Search and export


assets in a file based
on query.
Bulk Bulk
POST
Import / Export API
Export specific assets
Export
in a file based on list
API /data360/search/export/v1/assets/details
of assets in body
parameters.
Bulk Import assets from a
POST /data360/content/import/v1/assets
Import API file.

Monitor a CDGC Job.


Job
e.g. bulk export, bulk
Monitoring GET /data360/observable/v1/jobs/{{id}}
import jobs, catalog
API
source jobs.

Job API Download exported


file, success file or
Download /data360/observable error file.
Exported GET /v1/jobs/{{id}}/outputProperties/files/<outputfile
file properties Key : Name> Key examples:
Export_File,
Success_File

Overall process
To consume CDGC Public APIs, you need to generate a session ID and JWT token.
Problem Type
Standard release

User Type
Administrator; Developer

Project Phases
Configure; Implement

Primary Product
Cloud Data Governance and Catalog
Product Component
API

Product Version
Latest

Last Modified Date


9/4/2023 9:30 AM

URL Name
CDGC-Public-API-Postman-Collection

Language
English

You might also like