Skip to content

dataset.citation.create

Note

This document has been machine translated.

Issues a citation for the current state of the dataset.

Parameters

  • citation_label (string): The name of the citation.
  • source (string): The name of the dataset from which the citation is issued.

Return Value

The citation information of the issued citation is returned. For details, refer to citation_info.

Example

Request Data

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "dataset.citation.create",
  "params": {
    "citation_label": "my_citation",
    "source": "my_dataset"
  }
}

Request Execution

curl -H "Content-type: application/json" \
     -H "APIKey: 9c6f4574-89d1-4e3c-8af7-2549dc217fcf" \
     -H "Secret: aef8caingiej1ieNieJ3Phool4maeGohcies" \
     -X POST -d "@request.json" \
     https://localhost/api/v2/dataset/jsonrpc

Response

{
  "result": {
    "id": 4,
    "short_form": "my_citation",
    "long_form": "my_citation_1752068695.412697",
    "dataset_name": "my_dataset",
    "dataset_realname": "provenance.prov_66a165b2bf2f4d2aae5b24c726943181",
    "transaction_time": {
      "_type": "datetime",
      "val": "2025-07-09T13:44:55.408319+09:00"
    },
    "created_at": {
      "_type": "datetime",
      "val": "2025-07-09T13:44:55.412697+09:00"
    }
  },
  "id": 1,
  "jsonrpc": "2.0"
}