Data Asset Attributes
Get Data Asset Attribute
Use this API to retrieve the details for the specified data asset attribute.
get/api/metadata-catalog/v1/metadata/attribute-details/{name}
Path parameters
namestring required
The name to get the related attribute information. For example, including the value for the name FileType, matching Attribute Information will be retrieved.
Response
OK Attribute Information retrieved successfully.
Example response
{
"data": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Type of the Record",
"nameKey": "IM.Name",
"description": "Gather Type for the record - provide some value related to nature of record",
"descriptionKey": "IM.Name.Description",
"fieldName": "nameOfRecord",
"mappedFieldName": "name",
"enabled": true,
"responseType": "Text",
"formula": "Default:Field4 + Default:Field3 + 100 + avg(CrossSchema:Field4 + Default:Field3)",
"optionType": "None",
"schemaId": "550e8400-e29b-41d4-a716-446655440000",
"schemaName": "vendors",
"options": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"option": "TypeA",
"optionKey": "IM.TypeA",
"colorCode": "#FF5733",
"sequence": 1,
"enabled": true
}
],
"referenceCategories": [
{
"name": "Financial Category",
"nameKey": "IM.FinancialCategoryName"
}
],
"responseMaxLength": 4000,
"responseSubType": "STANDARD",
"associatedAttributeInformation": [
{
"name": "Count of members",
"nameKey": "IM.CountOfMembersName",
"description": "Provide details about count associated with this attribute",
"descriptionKey": "IM.CountOfMembersDesc",
"schemaName": "risk",
"fieldName": "countOfMembers",
"mappedFieldName": "count",
"formula": "sum(1, 3)",
"options": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"option": "TypeA",
"optionKey": "IM.TypeA",
"colorCode": "#FF5733",
"sequence": 1,
"enabled": true
}
]
}
],
"multiSelectMaxOptionValues": 10,
"optionUrl": "/api/risk-v2/risk-categories",
"deleteMarker": "MARKED_FOR_DELETE",
"optionMetadata": {
"entityTypeName": "Location",
"basicServiceContextPath": "/api/location",
"optionUrl": "/api/ontology/ui/v1/entity-types/names/purpose/entities/basic-details/pages",
"optionListUrl": "/api/ontology/ui/v1/entity-types/names/purpose/entities/basic-details",
"optionType": "BusinessLocations",
"applicationUrl": "/settings/location-management/location/Location"
},
"validationRuleId": "email",
"abacBasicAssignmentInfo": [
{
"assignmentId": "550e8400-e29b-41d4-a716-446655440000",
"assignmentName": "Assignment1"
}
]
}
]
}