dataset.record.get

サイテーションを指定して、データセットのレコードを取得します。

パラメータ

• citation_label: string -- サイテーション名。
• columns: string array -- 取得するカラム名。
• condition: condition -- 取得条件。
• offset: integer -- 取得開始位置。
• limit: integer -- 取得件数。
• order: string -- 結果の並び替えの基準にするカラム名。

戻り値

取得結果が戻されます。

実行例

リクエストデータ

{
    "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"
    }
}

リクエスト実行

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

レスポンス

{
  "result": [
    {
      "id": 3,
      "name": "玉井 真帆"
    },
    {
      "id": 1,
      "name": "石塚 洋次"
    }
  ],
  "id": 1,
  "jsonrpc": "2.0"
}