Retrieve a foreign key for a data object

Returns the foreign key definition in the data object.

Request Method	Service URL
GET	`/api-metadata/{access-key}/metadata/tables/{tableId}/foreignkeys/{foreignKeyId}`
Request Headers	`Content-Type=application/json`

Request URL Example

http://{AccountURL}/api-metadata/e2a7a0df2410470d85ef69c8dad2bdb8/metadata/tables/{tableId}/foreignkeys/{foreignKeyId}

Response Body Example

[
    {
        "tenantId": 0,
        "name": "mastercustomer",
        "versionTS": 1541803248262,
        "active": true,
        "createdTS": 1541803248262,
        "tableId": "mastercustomer",
        "dedupeTargetId": "Customer_MasterCustomer",
        "mainIdentifier": "masterid",
        "foreignKeyIds": {
            "customer_mastercustomer": [
                "Customer.ID.CustomerID"
            ]
        }
    }
]

Foreign keys entity metadata

tenantId
name
versionTS
active (true/false)
createdTS
type
sourceAttribute
sourceColumn
destinationColumn
destinationTable
sourceTableId
foreignKeyId

Learn more

Sitemap