Sign in

v1

latestOpenAPI 3.0.02026-07-1717466209.0 KB
Publish projects

Publish project metadata

Publishes project metadata to a NADA catalog. The server loads the exported project JSON (generated for the project), then merges each property from the request body into that object as top-level keys. The combined JSON is sent to the catalog as POST {catalog_url}/index.php/api/datasets/create/{type} with header x-api-key, where {type} is derived from the project (e.g. survey, timeseries, timeseries-db). Typical merge fields from the Metadata Editor UI are overwrite, published, access_policy, data_remote_url, and repositoryid (see schema). Omit the body or send {} to publish without overriding those fields.

post/publish/{sid}/{catalog_connection_id}

Path parameters

sidstring required

Project ID or IDNO

catalog_connection_idinteger required

Catalog connection ID

Request body

overwrite'yes' | 'no'

If yes, allows replacing an existing study in the catalog with the same IDNO. Merged as top-level overwrite on the dataset JSON sent to NADA.

published0 | 1

Catalog visibility — 0 draft, 1 published (merged as published).

access_policy'data_na' | 'direct' | 'public' | 'licensed' | 'remote' | 'enclave' | 'open' | ''

Data access / access policy code merged as access_policy on the payload. Allowed values match the Metadata Editor publish form; NADA may validate against codes returned by GET .../index.php/api/catalog/data_access_codes on the catalog.

data_remote_urlstring

URL for remote / external data access; merged as data_remote_url. Used when access_policy is remote or enclave (per catalog configuration).

repositoryidstring

Target collection (repository) code in NADA; merged as repositoryid. Options are typically populated from GET .../index.php/api/collections on the catalog (see /publish/catalog_info/...).

Example request

{
  "overwrite": "yes",
  "published": 1,
  "access_policy": "licensed",
  "data_remote_url": "",
  "repositoryid": "MY_COLLECTION"
}

Response

Project metadata published successfully (response shape follows NADA API)