Get test cases for a pipeline or dataset

At least one of datasetId, pipelineId, or pipelineSlug must be provided

Query Parameters

datasetId uuid

The ID of the Dataset to retrieve test cases for

pipelineId uuid

The ID of the Pipeline to retrieve test cases for

pipelineSlug string

The slug of the Pipeline to retrieve test cases for

Responses

• 200
• 400
• 500

---

Test cases retrieved successfully

application/json

application/json; charset=utf-8

Schema

Example (from schema)

---

Schema

testCases object[]
Array [
id uuid required
The ID of the test case
createdAt date-time required
The date and time when the test case was created
archivedAt date-time nullable deprecated
The date and time when the test case was archived, can be null if the test case has not been archived
deletedAt date-time nullable required
The date and time when the test case was deleted, can be null if the test case has not been deleted
updatedAt date-time required
The date and time when the test case was last updated
expectedOutputs object nullable
The expected outputs for the test case
inputs object required
The input data for the test case as a JSON object
property name* any
The input data for the test case as a JSON object
name string required
The name of the test case
pipelineId uuid required
The ID of the pipeline that the test case belongs to
datasetId uuid required
The ID of the dataset that the test case belongs to
]

{
  "testCases": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "createdAt": "2024-10-30T23:25:45.326Z",
      "deletedAt": "2024-10-30T23:25:45.326Z",
      "updatedAt": "2024-10-30T23:25:45.326Z",
      "expectedOutputs": {},
      "inputs": {},
      "name": "string",
      "pipelineId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "datasetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ]
}

Schema

Example (from schema)

---

Schema

testCases object[]
Array [
id uuid required
The ID of the test case
createdAt date-time required
The date and time when the test case was created
archivedAt date-time nullable deprecated
The date and time when the test case was archived, can be null if the test case has not been archived
deletedAt date-time nullable required
The date and time when the test case was deleted, can be null if the test case has not been deleted
updatedAt date-time required
The date and time when the test case was last updated
expectedOutputs object nullable
The expected outputs for the test case
inputs object required
The input data for the test case as a JSON object
property name* any
The input data for the test case as a JSON object
name string required
The name of the test case
pipelineId uuid required
The ID of the pipeline that the test case belongs to
datasetId uuid required
The ID of the dataset that the test case belongs to
]

{
  "testCases": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "createdAt": "2024-10-30T23:25:45.326Z",
      "deletedAt": "2024-10-30T23:25:45.326Z",
      "updatedAt": "2024-10-30T23:25:45.326Z",
      "expectedOutputs": {},
      "inputs": {},
      "name": "string",
      "pipelineId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "datasetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ]
}

Invalid pipeline ID

Server error

Loading...