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.5
  • 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/admin/attributelist

GET /glossary/api/v4/admin/attributelist

Use this URI to enable the client to query the list of ordered attributes that are available to look up as details for a business term. Requires a valid JSESSIONID cookie as part of this request.
These attributes are configured and enabled for API access by an administrator in the Analyst Service.

Returns

A list of attributes available for return through the Business Glossary API.
The returned list is random. The returned order number starts from 0.

Return Values

The following table describes the list of return values for the GET /glossary/api/v4/admin/attributelist URI request:
Field
Description
attributes
The details of an attribute.
id
Unique identifier such as name or description.
label
Returns attribute names as the localized display names.
order
Random order.
dataType
Datatype of the attribute. Datatype can be STRING, INTEGER, BOOLEAN, DATE.
default
The number of users.

Responses

The following responses can occur for the GET /glossary/api/v4/admin/attributelist URI request:
HTTP Return Code: 200
Response for an attribute list request. For example: 
{
  "processingTime": 341,
  "attributes": [
    {
      "id": "infa_description",
      "label": "Description",
      "order": 0,
      "description": "Description of the Glossary asset.",
      "dataType": "STRING",
      "default": false
    },
    {
      "id": "related_term",
      "label": "Related Terms",
      "order": 1,
      "description": "Other business terms that are related to this business term.",
      "dataType": "STRING",
      "default": false
    },
    {
      "id": "usageContext",
      "label": "Usage Context",
      "order": 2,
      "description": "Contextual description to show how a business term can be used.",
      "dataType": "STRING",
      "default": false
    },
    {
      "id": "steward",
      "label": "Data Steward",
      "order": 3,
      "description": "User who manages a Glossary asset.",
      "dataType": "STRING",
      "default": false
    },
    {
      "id": "referenceTableURL",
      "label": "Reference Table URL",
      "order": 4,
      "description": "URL of the reference table.",
      "dataType": "STRING",
      "default": false
    },
    {
      "id": "phase",
      "label": "Phase",
      "order": 5,
      "description": "Current phase in the lifecycle of the Glossary asset.",
      "dataType": "STRING",
      "default": false
    },
    {
      "id": "example",
      "label": "Example",
      "order": 6,
      "description": "Example showing the business term in use.",
      "dataType": "STRING",
      "default": false
    },
    {
      "id": "owner",
      "label": "Owner",
      "order": 7,
      "description": "Business owner of the Glossary asset.",
      "dataType": "STRING",
      "default": false
    },
    {
      "id": "name",
      "label": "Name",
      "order": 8,
      "description": "Name of the Glossary asset.",
      "dataType": "STRING",
      "default": false
    },
    {
      "id": "status",
      "label": "Status",
      "order": 9,
      "description": "Current status in the lifecycle of the Glossary asset.",
      "dataType": "STRING",
      "default": false
    }
  ]
}
HTTP Return Code: 401
Session is expired. For example: 


{
  "errorCode": "BG1002",
  "message": "The token has expired. 
Authenticate again."
}


{
  "errorCode": "BG1006",
  "message": "The request is not valid, or the authToken is not valid."
}
HTTP Return Code: 403
This API method will not return an error.
HTTP Return Code: 404
This API method will not return an error.
HTTP Return Code: 500
Response for an internal error that occurs when accessing a business term. For example: 
{
  "errorCode": "BG1004",
  "message": "Internal error."
}
0 COMMENTS
We’d like to hear from you!