Import

Import JSON entity

/api/v1/import

Import endpoint for any JSON objects that are previously exported from the application

Request parameters

Responses

Request example:

[
  {
    "entityType": "TEST_CASE",
    "entity": {
      "id": "fd523557-118e-4356-81e9-432ed462d50c",
      "connectionRef": "11d6f2ee-424b-4e64-abcb-f95902496b4a",
      "testsuiteRef": "d2f2d729-721c-4e6e-b5ab-4dad679cb561",
      "description": "public.addresses - Count of rows",
      "sql": "SELECT COUNT(*) FROM public.addresses",
      "expectedResult": ">0",
      "type": "Query",
      "owner": "David",
      "dynamicRuleRef": "eaf2f027-88fe-4258-9804-b50645ff5eb7",
      "autoUpdate": false,
      "disabled": true,
      "relations": {
        "columns": [],
        "schema": "public",
        "object": "addresses"
      },
      "labels": [
        "LIVE"
      ]
    }
  },
  {
    "entityType": "TEST_CASE",
    "entity": {
      "id": "1e5d783a-dd41-4712-b083-0d5e9a3dc9d8",
      "connectionRef": "11d6f2ee-424b-4e64-abcb-f95902496b4a",
      "testsuiteRef": "d2f2d729-721c-4e6e-b5ab-4dad679cb561",
      "description": "public.addresses - Duplicates",
      "sql": "SELECT COUNT(*) FROM (SELECT \"language\",\"suite\" FROM public.addresses GROUP BY \"language\",\"suite\" HAVING COUNT(*)>1) a",
      "expectedResult": "=0",
      "type": "Query",
      "owner": "David",
      "dynamicRuleRef": "86f004bc-757f-480e-bf20-19a1f161cd5f",
      "autoUpdate": false,
      "disabled": false,
      "relations": {
        "columns": [
          "language",
          "suite"
        ],
        "schema": "public",
        "object": "addresses"
      },
      "labels": []
    }
  }
]

Response example:

{
  "type": "TEST_CASE",
  "created": 2,
  "updated": 0,
  "failed": 0,
  "total": 2
}

Import CSV entity

/api/v1/import/csv

Import endpoint for any CSV objects that are previously exported from the application

Request parameters

Responses

{
  "type": "CONNECTION",
  "created": 96,
  "updated": 96,
  "failed": 96,
  "total": 96,
  "errors": [
    {
      "objectReference": "18ad0215-778d-352d-8f14-959901273e8d",
      "reason": "example"
    }
  ],
  "warnings": [
    {
      "objectReference": "18ad0215-778d-352d-8f14-959901273e8d",
      "reason": "example"
    }
  ]
}

Delete entities

/api/v1/delete

Delete any imported entity by the reference id(s)

Request parameters

Responses

Request example:

{
  "ids": [
    "3244945c-c777-4fc8-9b63-cf1501011bf3"
  ]
}

Response example:

{
  "deleted": 1,
  "failed": 0,
  "total": 1,
  "errors": []
}

Import lineage

/api/v1/import/lineage

Import column level lineage from SQL queries

Request parameters

Responses

Request example:

{
  "connectionName": "connection_name",
  "queries": [
    "SELECT COUNT(*) FROM sports.participants_events JOIN sports.latest_revisions ON id = event_id WHERE rank > 1"
  ]
}

Response example:

{
  "type": "QUERY",
  "created": 1,
  "updated": 0,
  "failed": 0,
  "total": 1
}

27 May 2025