Informatica Data Quality
- Informatica Data Quality 10.5.1
- All Products
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.
|
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 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]
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" }
{ "errorCode": "BG1003", "message": "Invalid request, missing either parameter {0} or its value." }
{ "errorCode": "BGREST_1007", "message": "Invalid request, termId {0} does not exist." }
{ "errorCode": "BG1004", "message": "Internal error." }