v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB
Reference Tables

Batch rows query

Batch query reference table rows by their primary key values. Returns only found rows in the included array.

post/api/v2/reference-tables/queries/batch-rows

Request body

Example request

{
  "data": {
    "attributes": {
      "row_ids": [
        "row_id_1",
        "row_id_2"
      ],
      "table_id": "00000000-0000-0000-0000-000000000000"
    },
    "type": "reference-tables-batch-rows-query"
  }
}

Response

Successfully retrieved rows. Some or all requested rows were found. Response includes found rows in the included section.

Example response

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "relationships": {
      "rows": {
        "data": [
          {
            "id": "row_id_1",
            "type": "row"
          },
          {
            "id": "row_id_2",
            "type": "row"
          }
        ]
      }
    },
    "type": "reference-tables-batch-rows-query"
  },
  "included": [
    {
      "attributes": {
        "values": {
          "ip_address": "102.130.113.9"
        }
      },
      "id": "row_id_1",
      "type": "row"
    },
    {
      "attributes": {
        "values": {
          "ip_address": "102.130.113.10"
        }
      },
      "id": "row_id_2",
      "type": "row"
    }
  ]
}