legacy catalog - relationships

Legacy - Creates a relationship between two catalog resources

Please refer to the updated IRI-based relationship endpoints.

post/metadata/relationships/{owner}

Request

  • Base URL
    https://api.data.world/v0
  • URL
    https://api.data.world/v0/metadata/relationships/{owner}
  • Auth
    HTTP bearer

Path parameters

ownerstring required

User name and unique identifier of the user or organization a resource belongs to. For example, in the URL: https://acme.data.world/jonloyens/an-intro-to-dataworld-dataset, jonloyens is the unique identifier of the owner.

Request body

relationshipTypestring uri required

IRI of the relationship type

sourceDatasetIdstring

If source is a table or column, populate with database ID that contains table.

sourceIdstring required
sourceTableIdstring

If source is a column, populate with table ID that contains column.

sourceType'CATALOG' | 'ANALYSIS' | 'BUSINESS_TERM' | 'COLUMN' | 'DATA_TYPE' | 'DATABASE' | 'DATASET' | 'PROJECT' | 'TABLE' | 'CONCEPT' | 'UNKNOWN_CATALOG_ENTRY' required
sourceTypeIristring uri

IRI of specified sourceType, this is required when sourceType is generic.

targetDatasetIdstring

If target is a table or column, populate with database ID that contains table.

targetIdstring required
targetTableIdstring

If target is a column, populate with table ID that contains column.

targetType'CATALOG' | 'ANALYSIS' | 'BUSINESS_TERM' | 'COLUMN' | 'DATA_TYPE' | 'DATABASE' | 'DATASET' | 'PROJECT' | 'TABLE' | 'CONCEPT' | 'UNKNOWN_CATALOG_ENTRY' required

Type of targetId.

Response

default response

messagestring

Changes

No recorded changes to this operation across all 2 revisions of this API.