Skip to content

dataset.citation.delete

Note

This document has been machine translated.

Deletes a citation.

Parameters

  • citation_label (string): The citation name. All citations with the same name will be deleted. To delete only one, specify the long-form citation name.

Return Value

The citation information of the deleted citation is returned as a JSON Array. For details, refer to citation_info.

Example

Request Data

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

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": 5,
      "short_form": "my_citation",
      "long_form": "my_citation_1752069016.910675",
      "dataset_name": "my_dataset",
      "dataset_realname": "provenance.prov_66a165b2bf2f4d2aae5b24c726943181",
      "transaction_time": {
        "_type": "datetime",
        "val": "2025-07-09T13:50:16.907991+09:00"
      },
      "created_at": {
        "_type": "datetime",
        "val": "2025-07-09T13:50:16.910675+09:00"
      }
    },
    {
      "id": 7,
      "short_form": "my_citation",
      "long_form": "my_citation_1752069018.735731",
      "dataset_name": "my_dataset",
      "dataset_realname": "provenance.prov_66a165b2bf2f4d2aae5b24c726943181",
      "transaction_time": {
        "_type": "datetime",
        "val": "2025-07-09T13:50:18.732239+09:00"
      },
      "created_at": {
        "_type": "datetime",
        "val": "2025-07-09T13:50:18.735731+09:00"
      }
    }
  ],
  "id": 1,
  "jsonrpc": "2.0"
}