dataset

Ingest a new dataset

Changed on

Create a dataset element in SciCat and send the data to SciCat.

post/dataset

Request

  • The document declares no server URL.
  • Auth
    API key in cookie user

Request body

metaDatastring required

The metadata of the dataset.

userTokenstring required

the scicat token for acting on behalf of the user

autoArchiveboolean

whether to autoarchive the dataset. Default is TRUE

Response

Dataset ingestion successful

datasetIdstring required

The created dataset's id

transferIdstring

The unique transfer id of the dataset transfer job.

statusstring

The status of the transfer. Can be used to send a message back to the ui.

Changes

  • effe6597c391Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 714c2732319dRevision changes
    • breaking

      the response property became optional for the status

    • info

      added the required property to the response with the status