DAdata
legacy catalog - analysis

Update an existing analysis.

Please refer to the updated IRI-based resource endpoints.

patch/metadata/analysis/{owner}/{id}

Request

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

Path parameters

ownerstring required
idstring required

Request body

assetStatusIristring
collectionsstring[]

Catalog Collection to which this metadata resource is added. Required for POST and PUT.Available catalog collection can be discovered via appropriate discovery endpoints.

descriptionstring

A short, but descriptive statement about the metadata resource.

propertiesobject

Custom properties for the metadata resource mapped to API Bindings. Can be simple name-value string pairs or nested values for a string name. See examples for details.

summarystring
tagsstring[]

A collection of tags to identify the relevance of metadata resource. Tags with no spaces is defacto standard

titlestring

Title of the metadata resource. Required for POST and PUT.

typeLabelstring

Indicates the type of metadata resource. Some examples of valid values are Report, Tableau dashboard, Glossary, Table, Database view etc. Default values will be assumed if not provided. Defaults to Report for analysis resources, Glossary for Glossary resources, Table for Table resources and Column for Column resources. Once specified during creation, this cannot be changed via PATCH. Only a PUT can change the type

Example request

{
  "collections": [
    "Aid Option"
  ],
  "description": "Aid given to charity is an option that can be exercised by individuals and corporations",
  "tags": [
    "HumanitarianAid"
  ],
  "title": "crypto.snowflake",
  "typeLabel": "Tableau dashboard"
}

Response

default response

messagestring

Changes

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