Sign in

v1

latestOpenAPI 3.1.02026-07-24188215268.7 KB
catalog resources

Update a resource

Update a resource of any type in the organization. Properties that are not defined in the request are not updated. When updating properties that have a single value, the old value is replaced by the new value in the request. When updating properties that have a list of values, see "updateListBy" query parameter for more granular controls. To delete properties, use "Delete properties from a resource". To update multiple resources at once, use "Bulk: update multiple resources at once".

patch/metadata/resources/{owner}

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.

updateListBy'ADD' | 'REMOVE' | 'REPLACE' required

Set this option when updating properties that supports having a list of values. Given a list of values in the request body, should this request add to the existing list, remove the specified values, or replace the existing list with the specified values?

Request body

collectionsstring[]

Collections, identified by IRI, that this resource is added into. Required when creating a resource. Available collections can be discovered using "Search for resources" endpoint.

propertiesobject

Create/update any property that is associated with a metadata presentation. Key is the IRI of the property. Value is the intended value of the property.

titlestring

Title of the resource. Required when creating a resource.

Response

default response

collectionsstring[]

Collections that the resource is a part of

iristring uri

IRI of the resource

propertiesobject

All properties of the resource that are associated with a metadata presentation. Key is the IRI of the property. Value is the value of the property.

sourceIdstring

Database of the resource (applies only to tables and columns)

tableIdstring

Table id of the resource (applies only to columns)

tableIristring

Table IRI of the resource (applies only to columns)

titlestring

Title of the resource

typesstring[]

Type of the resource

urlstring uri

A URL that redirects to the resource's page on data.world