Test Cases

Get Test Case By ID

Get Test Case details by ID

GET

/api/v2/test-cases/{test_case_id}

Get Test Case By ID

curl --request GET \
  --url "https://test-manager-api.lambdatest.com//api/v2/test-cases/{test_case_id}" \
  --header "Authorization: Basic <encoded-value>"

{
  "data": {
    "project_id": "sample_project_id",
    "folder_id": "sample_folder_id",
    "test_case_id": "sample_test_case_id",
    "title": "Sample Test Case Title",
    "description": "<p>Sample test case description</p>",
    "priority": "Normal",
    "type": "",
    "estimated_time": 10,
    "preconditions": "Sample preconditions for the test case",
    "path": [
      {
        "id": "sample_root_folder_id",
        "name": "Root Folder"
      },
      {
        "id": "sample_parent_folder_id",
        "name": "Parent Folder"
      },
      {
        "id": "sample_folder_id",
        "name": "Current Folder"
      }
    ],
    "created_by": 1234567,
    "updated_by": 1234567,
    "created_at": "2024-07-26T08:37:16Z",
    "updated_at": "2024-07-26T09:15:00Z",
    "status": "",
    "tags": [
      {
        "tag_id": 100001,
        "name": "regression"
      },
      {
        "tag_id": 100002,
        "name": "smoke"
      }
    ],
    "test_steps": [
      {
        "id": "sample_step_id_1",
        "serial_no": 1,
        "description": "Open the application",
        "action": null,
        "outcome": "Application opens successfully",
        "attachments": null,
        "entity_type": "step",
        "entity_id": ""
      },
      {
        "id": "sample_step_id_2",
        "serial_no": 2,
        "description": "Navigate to the target page",
        "action": null,
        "outcome": "Target page is displayed",
        "attachments": null,
        "entity_type": "step",
        "entity_id": ""
      }
    ],
    "internal_id": "TC-1",
    "external_id": "12345",
    "jira_details": [
      {
        "jira_id": "PROJ-123",
        "jira_link": "https://example.atlassian.net/browse/PROJ-123",
        "platform_name": "jira"
      }
    ],
    "dynamic_field_details": [
      {
        "field_id": "sample_field_id_1",
        "field_name": "User",
        "type": "user",
        "placeholder": "1",
        "is_required": false,
        "value": "",
        "test_case_id": "sample_test_case_id",
        "options": null
      },
      {
        "field_id": "sample_field_id_2",
        "field_name": "Automation Candidate",
        "type": "single_select",
        "placeholder": "",
        "is_required": false,
        "value": "Yes",
        "test_case_id": "sample_test_case_id",
        "options": [
          "Yes",
          "No",
          "Not applicable",
          "Automated"
        ]
      }
    ],
    "automation_status": "Not Automated",
    "bdd_scenarios": [],
    "is_auteur_generated": false,
    "code_generation_status": "",
    "test_type": "",
    "dataset_id": null,
    "params_used": false,
    "app_id": "",
    "is_mobile": false,
    "os": "",
    "live_mode": false,
    "commit_id": 100001,
    "commit_message": "Sample commit message",
    "total_steps": 2,
    "version": 1,
    "snapshot_id": "sample_snapshot_id",
    "execution_allowed": false,
    "execution_code_request_id": 0,
    "latest_commit_id": 100001,
    "revert_allowed": false,
    "session_status": "",
    "session_started_by": 0,
    "bulk_automation_status": "inactive",
    "automation_in_progress": false,
    "kaneai_version": 0,
    "revert_disabled": false,
    "auteur_commit_id": "",
    "is_test_validated": true
  },
  "metadata": null,
  "columnMetadata": {
    "auteur_test_id": {
      "display_name": "Auteur Test ID",
      "default": false,
      "can_be_hidden": true,
      "sortable": false
    },
    "automation_status": {
      "display_name": "Automation Status",
      "default": false,
      "can_be_hidden": true,
      "sortable": false
    },
    "created_at": {
      "display_name": "Created At",
      "default": true,
      "can_be_hidden": true,
      "sortable": true
    },
    "created_by": {
      "display_name": "Created By",
      "default": true,
      "can_be_hidden": true,
      "sortable": false
    },
    "dataset_id": {
      "display_name": "Dataset ID",
      "default": false,
      "can_be_hidden": true,
      "sortable": false
    },
    "deleted_at": {
      "display_name": "Deleted By",
      "default": false,
      "can_be_hidden": true,
      "sortable": false
    },
    "description": {
      "display_name": "Description",
      "default": true,
      "can_be_hidden": true,
      "sortable": false
    },
    "estimated_time": {
      "display_name": "Estimated Time",
      "default": false,
      "can_be_hidden": true,
      "sortable": false
    },
    "external_id": {
      "display_name": "external_id",
      "default": false,
      "can_be_hidden": true,
      "sortable": false
    },
    "folder_id": {
      "display_name": "Folder ID",
      "default": false,
      "can_be_hidden": true,
      "sortable": false
    },
    "internal_id": {
      "display_name": "internal_id",
      "default": true,
      "can_be_hidden": true,
      "sortable": true
    },
    "is_auteur_generated": {
      "display_name": "KaneAI Generated",
      "default": false,
      "can_be_hidden": true,
      "sortable": false
    },
    "latest_test_commit_id": {
      "display_name": "Latest Test Commit ID",
      "default": false,
      "can_be_hidden": true,
      "sortable": false
    },
    "organization_id": {
      "display_name": "Organization ID",
      "default": false,
      "can_be_hidden": true,
      "sortable": false
    },
    "preconditions": {
      "display_name": "Preconditions",
      "default": false,
      "can_be_hidden": true,
      "sortable": false
    },
    "priority": {
      "display_name": "Priority",
      "default": true,
      "can_be_hidden": false,
      "sortable": true
    },
    "project_id": {
      "display_name": "Project ID",
      "default": false,
      "can_be_hidden": true,
      "sortable": false
    },
    "status": {
      "display_name": "Status",
      "default": true,
      "can_be_hidden": false,
      "sortable": false
    },
    "title": {
      "display_name": "Title",
      "default": true,
      "can_be_hidden": false,
      "sortable": true
    },
    "type": {
      "display_name": "Type",
      "default": true,
      "can_be_hidden": false,
      "sortable": false
    },
    "updated_at": {
      "display_name": "Updated At",
      "default": false,
      "can_be_hidden": true,
      "sortable": false
    },
    "updated_by": {
      "display_name": "Updated By",
      "default": false,
      "can_be_hidden": true,
      "sortable": false
    }
  },
  "filterMetadata": {
    "automation_status": {
      "display_name": "Automation Status",
      "options": [
        "Automated",
        "Not Automated",
        "To Be Automated"
      ],
      "type": "select",
      "custom_filters": false
    },
    "created_at": {
      "display_name": "Created At",
      "scopes": [
        "created_at_condition_before",
        "created_at_condition_after",
        "created_at_condition_on",
        "created_at_condition_between"
      ],
      "type": "time.Time",
      "custom_filters": false
    },
    "created_by": {
      "display_name": "Created By",
      "type": "int",
      "custom_filters": false
    },
    "id": {
      "display_name": "",
      "type": "string",
      "custom_filters": false
    },
    "internal_id": {
      "display_name": "internal_id",
      "type": "int",
      "custom_filters": false
    },
    "is_auteur_generated": {
      "display_name": "KaneAI Generated",
      "type": "bool",
      "custom_filters": false
    },
    "jira_issues": {
      "display_name": "Issues",
      "options": [
        "PROJ-123"
      ],
      "type": "select",
      "custom_filters": false
    },
    "organization_id": {
      "display_name": "Organization ID",
      "type": "int",
      "custom_filters": false
    },
    "priority": {
      "display_name": "Priority",
      "options": [
        "Lowest",
        "Low",
        "Medium",
        "High",
        "Highest",
        "Normal"
      ],
      "type": "select",
      "custom_filters": false
    },
    "status": {
      "display_name": "Status",
      "options": [
        "Unverified",
        "Faulty",
        "Ready",
        "Live",
        "Archived"
      ],
      "type": "select",
      "custom_filters": false
    },
    "title": {
      "display_name": "Title",
      "type": "string",
      "custom_filters": false
    },
    "type": {
      "display_name": "Type",
      "options": [
        "Accessibility",
        "Acceptance",
        "Compatibility",
        "Destructive",
        "Performance",
        "Integration",
        "Functional",
        "Regression",
        "Smoke & Sanity",
        "Security",
        "User Interface",
        "Usability",
        "Other"
      ],
      "type": "select",
      "custom_filters": false
    }
  },
  "rbac_metadata": {
    "can_create_entity": true,
    "can_execute_entity": false,
    "can_edit_entity": true,
    "can_delete_entity": true,
    "can_list_entity": true,
    "can_read_entity": true,
    "can_update_entity": true
  }
}

Authorizations

Authorizationstringheaderrequired

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

test_case_idstringrequired

Response

application/json

dataobject

data.project_idstring

Example: "sample_project_id"

data.folder_idstring

Example: "sample_folder_id"

data.test_case_idstring

Example: "sample_test_case_id"

data.titlestring

Example: "Sample Test Case Title"

data.descriptionstring

Example: "<p>Sample test case description</p>"

data.prioritystring

Example: "Normal"

data.typestring

Example: ""

data.estimated_timenumber

Example: 10

data.preconditionsstring

Example: "Sample preconditions for the test case"

data.pathobject[]

data.created_bynumber

Example: 1234567

data.updated_bynumber

Example: 1234567

data.created_atstring

Example: "2024-07-26T08:37:16Z"

data.updated_atstring

Example: "2024-07-26T09:15:00Z"

data.statusstring

Example: ""

data.tagsobject[]

data.test_stepsobject[]

data.internal_idstring

Example: "TC-1"

data.external_idstring

Example: "12345"

data.jira_detailsobject[]

data.dynamic_field_detailsobject[]

data.automation_statusstring

Example: "Not Automated"

data.bdd_scenariosarray

data.is_auteur_generatedboolean

Example: false

data.code_generation_statusstring

Example: ""

data.test_typestring

Example: ""

data.dataset_idnull

data.params_usedboolean

Example: false

data.app_idstring

Example: ""

data.is_mobileboolean

Example: false

data.osstring

Example: ""

data.live_modeboolean

Example: false

data.commit_idnumber

Example: 100001

data.commit_messagestring

Example: "Sample commit message"

data.total_stepsnumber

Example: 2

data.versionnumber

Example: 1

data.snapshot_idstring

Example: "sample_snapshot_id"

data.execution_allowedboolean

Example: false

data.execution_code_request_idnumber

Example: 0

data.latest_commit_idnumber

Example: 100001

data.revert_allowedboolean

Example: false

data.session_statusstring

Example: ""

data.session_started_bynumber

Example: 0

data.bulk_automation_statusstring

Example: "inactive"

data.automation_in_progressboolean

Example: false

data.kaneai_versionnumber

Example: 0

data.revert_disabledboolean

Example: false

data.auteur_commit_idstring

Example: ""

data.is_test_validatedboolean

Example: true

metadatanull

columnMetadataobject

columnMetadata.auteur_test_idobject

columnMetadata.automation_statusobject

columnMetadata.created_atobject

columnMetadata.created_byobject

columnMetadata.dataset_idobject

columnMetadata.deleted_atobject

columnMetadata.descriptionobject

columnMetadata.estimated_timeobject

columnMetadata.external_idobject

columnMetadata.folder_idobject

columnMetadata.internal_idobject

columnMetadata.is_auteur_generatedobject

columnMetadata.latest_test_commit_idobject

columnMetadata.organization_idobject

columnMetadata.preconditionsobject

columnMetadata.priorityobject

columnMetadata.project_idobject

columnMetadata.statusobject

columnMetadata.titleobject

columnMetadata.typeobject

columnMetadata.updated_atobject

columnMetadata.updated_byobject

filterMetadataobject

filterMetadata.automation_statusobject

filterMetadata.created_atobject

filterMetadata.created_byobject

filterMetadata.idobject

filterMetadata.internal_idobject

filterMetadata.is_auteur_generatedobject

filterMetadata.jira_issuesobject

filterMetadata.organization_idobject

filterMetadata.priorityobject

filterMetadata.statusobject

filterMetadata.titleobject

filterMetadata.typeobject

rbac_metadataobject

rbac_metadata.can_create_entityboolean

Example: true

rbac_metadata.can_execute_entityboolean

Example: false

rbac_metadata.can_edit_entityboolean

Example: true

rbac_metadata.can_delete_entityboolean

Example: true

rbac_metadata.can_list_entityboolean

Example: true

rbac_metadata.can_read_entityboolean

Example: true

rbac_metadata.can_update_entityboolean

Example: true

Selenium Automation API

Automated Screenshots API

App Automation API (Real Devices)

Smart UI

Cypress Automation

User Management

Test Manager

HyperExecute

Accessibility Testing

Analytics

Performance Testing

Audit logs

Selenium Automation API

Automated Screenshots API

App Automation API (Real Devices)

Smart UI

Cypress Automation

User Management

Test Manager

HyperExecute

Accessibility Testing

Analytics

Performance Testing

Audit logs

Get Test Case By ID

Authorizations

Path Parameters

Response