Communities
A collaborative platform to connect and grow with like-minded Informaticans across the globe
Product Communities
Connect and collaborate with Informatica experts and champions
Discussions
Have a question? Start a Discussion and get immediate answers you are looking for
User Groups
Customer-organized groups that meet online and in-person. Join today to network, share ideas, and get tips on how to get the most out of Informatica
Get Started
Community Guidelines
Knowledge Center
Troubleshooting documents, product guides, how to videos, best practices, and more
Knowledge Base
One-stop self-service portal for solutions, FAQs, Whitepapers, How Tos, Videos, and more
Support TV
Video channel for step-by-step instructions to use our products, best practices, troubleshooting tips, and much more
Documentation
Information library of the latest product documents
Velocity (Best Practices)
Best practices and use cases from the Implementation team
Learn
Rich resources to help you leverage full capabilities of our products
Trainings
Role-based training programs for the best ROI
Certifications
Get certified on Informatica products. Free, Foundation, or Professional
Product Learning Paths
Free and unlimited modules based on your expertise level and journey
Resources
Library of content to help you leverage the best of Informatica products
Tech Tuesdays Webinars
Most popular webinars on product architecture, best practices, and more
Product Availability Matrix
Product Availability Matrix statements of Informatica products
SupportFlash
Monthly support newsletter
Support Documents
Informatica Support Guide and Statements, Quick Start Guides, and Cloud Product Description Schedule
Product Lifecycle
End of Life statements of Informatica products
Ideas
Events
Change Request Tracking
Marketplace
English
  • Informatica Data Quality 10.4.0
  • All Products

Table of Contents

Search

  1. Preface
  2. Introduction to Business Glossary API
  3. HTTP Methods
  4. API Reference

API Guide

API Guide

Back Next

GET /glossary/api/v4/term

GET /glossary/api/v4/term

Use this URI to retrieve details such as attributes, related categories, and related terms for a business term. Requires a valid JSESSIONID cookie as part of this request.

Parameters

The following table describes the query parameters for the GET /glossary/api/v4/term URI request:
Parameter
Description
id
Required. A unique string identifier for a business term.
attributes
Optional. String attributes for a business term.
Returns a comma separated list of attribute identifiers.
The order of the attributes in the list is not the order of the attributes in the return list.
By default, returns all attributes marked by an administrator for API access.

Return Values

The following table describes the return values for the GET /glossary/api/v4/term API request:
Field
Description
id
Unique identifier for a business term.
attributes
Attribute details.
label
Returns attribute names as localized display names.
id
Unique identifier for an attribute.
value
Attribute value.
categories
List of related categories for this business term. This is an array of category definitions.
category
Structure of the category.
id
Unique identifier of the category.
path
Path to this category. This is a string array that begins as a top level element to the category in the business glossary.
description
Description of the category. Appears as an array with one description for each level of the category
mmUrl
The url of the term in MM. The URL will be an absolute URL already encoded into the correct URL syntax for MM.

Term Markup Syntax

Some fields contain references to other terms in the business glossary. These fields must be of the String datatype. The markup has the following format: 
[term bg_element_uid="id" infa_description="some description text" relationshipName="name of  relationship that links these two terms" glossaryName="name of glossary which has this term"]name of term[/term]
You can use the term command and pass the value of the
bg_element_uid
 field to query the business glossary for additional term details.

Responses

The following responses can occur for the GET /glossary/api/v4/term API request:
HTTP Return Code: 200 
Example: GET http://localhost:port/analyst/glossary/api/v4/term?id=1

Returns

{
  "processingTime": 963,
  "term": {
    "id": "1",
    "attributes": [
      {
        "id": "name",
        "label": "Name",
        "value": "customer"
      },
      {
        "id": "description",
        "label": "Description",
        "value": "This is a great customer"
      },
      {
        "id": "glossaryName",
        "label": "Glossary Name",
        "value": "BG_Test"
      },
      {
        "id": "glossaryId",
        "label": "Glossary Id",
        "value": "843067937963648"
      },
      {
        "id": "steward",
        "label": "Data Steward",
        "value": ""
      },
      {
        "id": "owner",
        "label": "Owner",
        "value": ""
      },
      {
        "id": "phase",
        "label": "Phase",
        "value": "PUBLISHED"
      },
      {
        "id": "status",
        "label": "Status",
        "value": "ACTIVE"
      },
      {
        "id": "stakeHolders",
        "label": "Stakeholders",
        "value": []
      },
      {
        "id": "usageContext",
        "label": "Usage Context",
        "value": ""
      },
      {
        "id": "example",
        "label": "Example",
        "value": ""
      },
      {
        "id": "referenceTableURL",
        "label": "Reference Table URL",
        "value": ""
      }
    ],
    "categories": [
      {
        "id": "843067937963648",
        "path": [
          "BG_Test"
        ],
        "description": [
          "Glossary description"
        ]
      },
      {
        "id": "222678635555534",
        "path": [
          "BG_Test",
          "Category1"
        ],
        "description": [
          "Glossary description",
          "Category description"
        ]
      }
    ],
    "relatedTerms": []
  },
  "mmUrl": "http://irw28dqd03.informatica.com:8085/analyst/bg.user/bgurlapi?objectid=1&objecttype=com.informatica.bg.core.models.BGTermInfo"
}
HTTP Return Code: 400
Response to a missing parameter: 
{
  "errorCode": "BG1003",
  "message": "Invalid request, missing either parameter {0} or its value."
}
HTTP Return Code: 401
Session is expired.
HTTP Return Code: 404
Response for a business term that a user does not have read permission on. For example: 
{
  "errorCode": "BGREST_1007",
  "message": "Invalid request, termId {0} does not exist."
}
HTTP Return Code: 500
Response for an internal error that occurs when accessing a business term: 
{
  "errorCode": "BG1004",
  "message": "Internal error."
}
0 COMMENTS
We’d like to hear from you!