Retrieve a data object

Retrieve details for the data object.

Request Method Service URL

GET

/api-metadata/v1/{access-key}/metadata/tables/{tableId}

Request Headers

Content-Type=application/json

Request URL Example

http://{AccountURL}/api-metadata/v1/e2a7a0df2410470d85ef69c8dad2bdb8/metadata/tables/Address

Response Body Example

[
   {
      "tenantId": 100,
      "name": "Address Table",
      "versionTS": 1528488842722,
      "active": true,
      "createdTS": 1528488842722,
      "bucketingStrategy": {
         "fieldName": "ID",
         "numberOfBuckets": 8
       },
       "foreignKeys": [
          {
              "tenantId": 100,
              "name": "FK_Address_Organization_OrganizationID_ID",
              "versionTS": 1528488842655,
              "active": true,
              "createdTS": 1528488842655,
              "type": "PARENT",
              "sourceAttribute": "SourceOrganizationID",
              "sourceColumn": "OrganizationID",
              "destinationColumn": "ID",
              "destinationTable": "Organization",
              "sourceTableId": "Address",
              "foreignKeyId": "Organization.ID.OrganizationID"
           },
          {
              .....
          }
        "tablePrimaryKey": "ID",
        "sourceAttribute": "SourceAddressID",
        "insertOnly": false,
        "tableId": "Address",
        "resourceName": "addresses",
        "columns": [
            {
                "tenantId": 100,
                "name": "Column - ID",
                "versionTS": 1528488841703,
                "description": "Unique identifier for the object ",
                "active": true,
                "createdTS": 1528488841703,
                "type": {
                    "columntype": ".ColumnPrimitiveType",
                    "dataType": "STRING"
                },
                "tableId": "Address",
                "fieldId": "ID",
                "required": true
            },
            {
                .....
            }
         ]
     }
 
 
]

Learn more

Sitemap