KEkeboola
Metadata

Create or update table metadata

Sets multiple metadata for table and columns with one call. If the given key and provider combination already exist for the table, the data will be updated with the new value and timestamp. All metadata associated with the table and columns are returned to the response.

At least one of the metadata or columnsMetadata object is required. Using columnName as index for columnsMetadata is deprecated and not recommended, rather index it by int. Please add columnName to metadata object as described in example.

When the request is not sent as JSON (application/x-www-form-urlencoded, deprecated), only the table-level metadata list is returned.

post/v2/storage/branch/{branchId}/tables/{id}/metadata

Request

Path parameters

idstring required

Id of the table.

branchIdstring required

Request body

providerstring required

Id of the creating component

columnsMetadataobject

Object of column metadata grouped by column, indexed by int (indexing by columnName is deprecated). Each metadata object should carry columnName.

Example request

{
  "provider": "test-component",
  "metadata": [
    {
      "key": "some-key",
      "value": "Some value"
    }
  ]
}

Response

All metadata associated with the table and its columns.

OR

Example response

{
  "metadata": [
    {
      "id": "19509",
      "key": "some-key",
      "value": "Some value",
      "provider": "test-component",
      "timestamp": "2017-02-13T23:36:10+0100"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.