Skip to content
developers
Open TestCollab

Get latest test case revision

GET/testcaserevisions/getLatest

Gets the latest revision for a specific test case

Example

Section titled “Example”

Use resource IDs from your own project. Keep the API token in your server or CI environment.

example.ts
import { createConfiguration, TestCaseRevisionsApi } from '@testcollab/sdk';


const config = createConfiguration(process.env.TESTCOLLAB_TOKEN!);
const api = new TestCaseRevisionsApi(config);


const result = await api.getTestCaseLatestRevision({
  "project": 123,
  "testcase": 123
});
console.log(result);

Parameters

Section titled “Parameters”
Name Location Type Required Description
project query number Yes Project ID
testcase query integer Yes Test Case ID
_filter query string No Stringified JSON object for filter

Response

Section titled “Response”

200 — Get test case revision latest

Field Type Required Description
id number Yes —
revision number Yes —
modified_fields Test Case Revision Modified Fields Yes —
modified_fields.copy_of number No provide information about the testcase which is copied
modified_fields.title string No Test case title at the time of copy
modified_fields.revert_to number No Test case reverted to which revision number
modified_fields.fields Array of string No —
modified_fields.last_changed Test Case Revision Review Info No —
modified_fields.last_changed.fields Array of string No —
modified_fields.last_changed.values Test Case Revision Review Data Collection No —
testcase number Yes —
is_head boolean No Will be true only for latest version else false
created_at string No Date-time when test case revision created
updated_at string No Date-time when test case revision updated
updated_by number No —
action_type string No —
title string No —
suite Suite No —
suite.id number Yes —
suite.title string Yes —
suite.description string No —
suite.parent_id number No —
suite.order number No —
suite.created_by number No —
suite.is_bdd_managed boolean No True when the suite is managed by BDD sync from a feature file in Git.
suite.is_reference boolean No Will be true only for links
suite.source_id number No Only for links - source entity ID
suite.source_project number No Only for links - source Project ID
suite.is_main_link boolean No Will be true only for top level link suite
description string No Test case description (generated by rich text editor)
steps Step Collection No —
steps[].step string Yes (can contain HTML)
steps[].expected_result string Yes (can contain HTML)
steps[].reusable_step_id number Yes Reusable Step ID
steps_parsed Step Parsed Collection No —
steps_parsed[].step string Yes (can contain HTML)
steps_parsed[].step_id number No —
steps_parsed[].expected_result string Yes (can contain HTML)
steps_parsed[].step_index number No —
steps_parsed[].parsed_reusable_step_id number No —
priority number No Priority, 0 - Low, 1- Normal, 2 - High Values: 0, 1, 2.
tags Tag Collection No —
tags[].id number Yes —
tags[].name string Yes —
tags[].test_case_count number No —
requirements Requirement Collection No —
requirements[].id number No —
requirements[].title string Yes —
requirements[].requirementManager string No —
requirements[].requirement_id string Yes —
requirements[].requirement_key string No —
requirements[].requirement_url string No —
requirements[].project number Yes —
requirements[].status number No —
requirements[].req_info string No Stringified JSON object
requirements[].testcase_count number No —
requirements[].link_sync Requirement Link Sync No Azure DevOps reciprocal-link state for the requested test-case relation.
requirements[].link_sync.id number Yes —
requirements[].link_sync.desired_state string Yes Values: linked, unlinked.
requirements[].link_sync.sync_status string Yes Values: pending, synced, failed.
requirements[].link_sync.attempts number Yes —
requirements[].link_sync.last_error string No —
requirements[].link_sync.last_synced_at string No —
requirements[].link_sync.next_retry_at string No —
requirements[].custom_fields Array of Custom Field Collection Output No Array of custom fields - applicable only for inbuilt
requirements[].requirement_folder Generic Folder No Requirement folder - applicable only for inbuilt
requirements[].requirement_folder.id number Yes —
requirements[].requirement_folder.project number Yes —
requirements[].requirement_folder.title string Yes —
requirements[].requirement_folder.parent_id number Yes —
requirements[].requirement_folder.sort_order number No —
requirements[].requirement_folder.folderitemcount number No —
requirements[].requirement_folder.created_by number No —
requirements[].requirement_folder.description string No —
requirements[].requirement_folder.created_at string Yes —
requirements[].requirement_folder.updated_at string Yes —
requirements[].attachments Upload Collection No Requirement attachments - applicable only for inbuilt
requirements[].attachments[].id number Yes —
requirements[].attachments[].name string Yes —
requirements[].attachments[].hash string Yes —
requirements[].attachments[].ext string Yes —
requirements[].attachments[].mime string Yes —
requirements[].attachments[].size string Yes —
requirements[].attachments[].url string Yes —
requirements[].attachments[].created_by number No —
requirements[].attachments[].created_at string Yes —
requirements[].attachments[].updated_at string Yes —
requirements[].description string No Requirement description - applicable only for inbuilt
requirements[].created_at string No —
requirements[].updated_at string No —
requirements[].created_by User Minified No —
requirements[].created_by.id number Yes —
requirements[].created_by.username string No —
requirements[].created_by.name string Yes —
requirements[].created_by.avatar Upload No —
requirements[].created_by.is_guest number No —
Illustrative response
{
  "id": 123,
  "revision": 123,
  "modified_fields": {
    "copy_of": 123,
    "title": "example",
    "revert_to": 123,
    "fields": [],
    "last_changed": {
      "fields": [],
      "values": []
    }
  },
  "testcase": 123,
  "is_head": true,
  "created_at": "example",
  "updated_at": "example",
  "updated_by": 123,
  "action_type": "example"
}

Errors

Section titled “Errors”
Status Meaning
401 Unauthorized
403 Forbidden
404 Not found
500 Internal server error

Next steps

Section titled “Next steps”