Save a dataset description as a private draft.

Store a dataset description in your own base. The server does not fetch the source or import its data. Saving creates a managed dataset.md version for base search, collections and OKF export. Existing publication stays unchanged until publish_base. The normal base and document limits apply; extra base capacity uses the existing subscription. Metadata and public discovery have no separate fee. Returns: { base{id,name,visibility,dataset,created_at,updated_at,documents,bytes,api,export_url,okf_url,public_url,embed_url,publication} }

put/api/bases/{base_id}/dataset

Request

  • Base URL: https://okfindex.com
  • URL: https://okfindex.com/api/bases/{base_id}/dataset
  • Auth: none declared

Path parameters

base_idstring required

Base ID returned by the API.

Request body

descriptionstring required

Dataset description, 1–2000 characters.

coveragestring required

Geographic, temporal or subject coverage, 1–300 characters.

formatstring required

Source format, for example CSV or JSON, 1–40 characters.

update_frequencystring required

Declared update schedule, 1–200 characters. No automatic check is performed.

licensestring required

Declared license or access terms, 1–300 characters. Not independently verified.

source_urlstring required

HTTPS origin URL, at most 1000 characters, without credentials.

Response

{ base{id,name,visibility,dataset,created_at,updated_at,documents,bytes,api,export_url,okf_url,public_url,embed_url,publication} }

Changes

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