Using REST API - Retrieve Catalog Links

The Catalog Links API ({your_er360_url}:<port>/MartER360/service/portal/repository/cataloglinks) returns the full catalog object tree for a given catalog. This REST API is identical to the existing Catalogs API; with one addition, every object in the response (models, entities/tables, columns, domains, relationships, key groups, and all other catalog objects) includes a link property that is a direct browser deep-link into the erwin ER360 Metadata Browser. You can call this API using an external tool, such as Postman.

To retrieve catalog links, ensure that you have:

• A valid API access token generated from the erwin ER360

• The browseMetadata / viewMetadata permission in erwin ER360

• The ID or path of the catalog you want to query

Endpoint Information

Property	Value
Method	GET
URL	/MartER360/service/portal/repository/cataloglinks
Authentication	Required (Bearer Token)

Retrieving Catalog Links

Step 1: Create a New Request

1. Open Postman and click New > HTTP Request.

2. Set the method to GET.

3. Enter the URL: {your_er360_url}:<port>/MartER360/service/portal/repository/cataloglinks.

   Example: https://myserver.example.com:8443/MartER360/service/portal/repository/cataloglinks

Step 2: Configure Authentication

1. Generate an API Access Token from erwin ER360:

   1. Navigate to Settings > API Access Tokens.

   2. Create a new token or copy an existing one.

2. Go to the Authorization tab.

3. Select Bearer Token as the type.

4. Paste the API Access Token into the Token field.

Step 3: Configure Query Parameters

1. Go to the Params tab.

2. Add one of the following:

   • Key: id, Value: your catalog ID (for example, 6555)

   • Key: path, Value: your catalog path (for example, ER360/Library/MyModel)

Query Parameters

Provide id or path. If both are provided, id takes precedence:

Parameter	Type	Required	Description
id	Integer	Conditional	The numeric catalog ID. ID must be a positive integer (for example, 6555).
path	String	Conditional	The path of the catalog (for example, ER360/Library/MyModel).

Step 4: Send the Request

Click Send. The response will be a JSON object with the same structure as the Catalogs API, with a link property added to every object.

Example request:

GET https://myserver.example.com:<port>/MartER360/service/portal/repository/cataloglinks?id=6555

Headers:

Authorization: Bearer <your_api_access_token>

Response Reference

Success Response (HTTP 200)

{

"Catalog Id": "6555",

"Catalogs": [

{

"ER360/Model_Conceptual_2": {

"Model Details": [

{

"File Name": "Model_Conceptual_2",

"Mart Path": "Mart/Model_Conceptual_2",

"ER360 Path": "ER360/Model_Conceptual_2",

"Created On": "07/01/2026 01:37 PM",

"Created By": "jsmith",

"Status": "",

"Latest Version": 1,

"link": "https://myserver.example.com:<port>/ER360/main/metadata-browser?browser_id=Y0lkPTY1NTU..."

}

],

"Entities": [

{

"contextType": "Entity",

"name": "Customer",

"Physical Name": "customer",

"link": "https://myserver.example.com:<port>/ER360/main/metadata-browser?browser_id=Y0lkPTY1NTU..."

}

],

"Columns": [

{

"contextType": "Column",

"name": "CustomerID",

"Physical Name": "customer_id",

"link": "https://myserver.example.com:<port>/ER360/main/metadata-browser?browser_id=Y0lkPTY1NTU..."

}

]

}

}

]

}

Points to note:

• The link value is a browser deep-link. Opening it takes you directly to that object in the ER360 Metadata Browser.

• When the request uses path instead of id, the top-level key in the response is "Path" instead of "Catalog Id".

• If the catalog is not found, or the id/path does not match any catalog, the API returns {} with a 200 status.

Error Responses

HTTP Code	Error Scenario	Example Response
400	The id parameter was provided but is not a positive integer (for example, a decimal, zero, negative number, or non-numeric string)	{"error": "Invalid catalog ID. Please provide a positive integer."}
401	No valid authentication token was provided	{"error": "User does not have required permissions to access this resource. Please contact the Mart Administrator for required permissions."}
403	The authenticated user does not have the browseMetadata / viewMetadata permission in ER360	{"error": "User does not have required permissions to access this resource. Please contact the Mart Administrator for required permissions."}
500	An unexpected error occurred on the server (for example, a database error)	{"error": "Error retrieving catalog links"}