dataset.record.get

Note

This document has been machine translated.

Retrieves a record in a dataset by specifying a citation.

Parameters

• citation_label: string -- Citation name.
• columns: string array -- Column names to retrieve.
• condition: condition -- condition to retrieve.
• offset: integer -- The starting position to retrieve.
• limit: integer -- The number of results to retrieve.
• order: string -- column name to sort the results by.

Return Values

The results of the retrieval are returned.

Execution example

Request Data

{
    "id": 1,
    "jsonrpc": "2.0",
    "method": "dataset.record.get",
    "params": {
      "citation_label": "my_citation",
      "columns": [
        "id",
        "name"
      ],
      "condition": {
        "<>": ["id", 2]
      },
      "offset": 0,
      "limit": 2,
      "order": "-id"
    }
}

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": 3,
      "name": "玉井 真帆"
    },
    {
      "id": 1,
      "name": "石塚 洋次"
    }
  ],
  "id": 1,
  "jsonrpc": "2.0"
}