Jump to

• Request
• Response

Get metadata details of catalog item based on catalog ID.

get

/iam/governance/selfservice/api/v1/catalog/{catalogid}/metadata

Returns metadata details of catalog item based on the catalog ID. The metadata attributes returned gives information for each attribute of a Catalog item.

Request

Supported Media Types

• application/json

Path Parameters

• catalogid: string
  Unique Catalog ID of Catalog Item

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful

Headers

• ResponseTime: string
  Captures the time in milliseconds taken for processing the request.

Body ()

Root Schema : GetCatalogMetadataByCatalogId

Type: object

Show Source

• catalogMetadatas(optional): array catalogMetadatas
• links(optional): array links

{
    "properties":{
        "catalogMetadatas":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/GetCatalogMetadataByCatalogIdEntity"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        }
    }
}

Nested Schema : catalogMetadatas

Type: array

Show Source

• Array of: object GetCatalogMetadataByCatalogIdEntity

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/GetCatalogMetadataByCatalogIdEntity"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LinkDataInstances

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LinkDataInstances"
    }
}

Nested Schema : GetCatalogMetadataByCatalogIdEntity

Type: object

Show Source

• metadataDefinitionCertifiable(optional): boolean
• metadataDefinitionDBColumnName(optional): string
• metadataDefinitionDescription(optional): string
• metadataDefinitionDisplayName(optional): string
• metadataDefinitionId(optional): string
• metadataDefinitionSearchable(optional): boolean
• metadataDefinitionSortable(optional): boolean
• metadataDefinitionUdf(optional): boolean
• metadataValue(optional): string

{
    "properties":{
        "metadataValue":{
            "type":"string"
        },
        "metadataDefinitionId":{
            "type":"string"
        },
        "metadataDefinitionDBColumnName":{
            "type":"string"
        },
        "metadataDefinitionDisplayName":{
            "type":"string"
        },
        "metadataDefinitionDescription":{
            "type":"string"
        },
        "metadataDefinitionSearchable":{
            "type":"boolean"
        },
        "metadataDefinitionSortable":{
            "type":"boolean"
        },
        "metadataDefinitionUdf":{
            "type":"boolean"
        },
        "metadataDefinitionCertifiable":{
            "type":"boolean"
        }
    }
}

Nested Schema : LinkDataInstances

Type: object

Show Source

• href(optional): string
• rel(optional): string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

404 Response

Requested entity not found

500 Response

Internal Server Error

Back to Top