Sign in

v1

latestOpenAPI 3.1.02026-07-24188215268.7 KB
catalog relationships

Get resources that are related to a resource identified by IRI

If a resource A is related to resource B and C, this endpoint will return B and C. See request body for further filtering options.

post/metadata/relationships/{owner}/iri

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.

Query parameters

iristring required

Internationalized Resource Identifier (IRI) of the resource. You can find the IRI in the Technical Reference section under the Settings tab on the resource’s catalog page.

hydrationsboolean

Return additional information about the resource. For example, if the resource is in a collection, the collection IRI will be returned by default. If hydration is enabled, the collection's title and description will also be returned.

limitinteger

Number of results to return

nextstring

A token supplied by the previous response to retrieve the next page of results

Request body

byRelationTypesstring[]

Filter by these relation types. Relation types are identified by their IRI.

byResourceTypesstring[]

Filter by these resource types. Resource types are identified by their IRI.

Response

default response

consistentboolean
countinteger
nextstring