API Docs for:
Show:

TestLinkApi Class

Defined in: H:\testlink-api-client\lib\testlinkapi.js:22

TestLink API Client brings you a pure JavaScript Node-Module for TestLink tool

Methods

getBuildsForTestPlan

(
  • testPlanId
  • callback
)
Json Object

Defined in H:\testlink-api-client\lib\testlinkapi.js:33

Retrieves Builds Created for TestPlan.

Parameters:

  • testPlanId Object
  • callback Function

Returns:

Json Object:

JSON Object for Builds

getExecCountersByBuild

(
  • testPlanId
  • callback
)
Json Object

Defined in H:\testlink-api-client\lib\testlinkapi.js:613

Retrieves Execution Counters for Build

Parameters:

  • testPlanId Object
  • callback Function

Returns:

Json Object:

JSON Object for Execution Counters

getFirstLevelTestSuitesForTestProject

(
  • testProjectId
  • callback
)
Json Object

Defined in H:\testlink-api-client\lib\testlinkapi.js:641

Retrieves First Level of TestSuites in a Project

Parameters:

  • testProjectId Object
  • callback Function

Returns:

Json Object:

JSON Object for TestSuite

getFullPath

(
  • nodeId
  • callback
)
Json Object

Defined in H:\testlink-api-client\lib\testlinkapi.js:668

Retrieves Full Path for a Node

Parameters:

  • nodeId Object
  • callback Function

Returns:

Json Object:

JSON Object for FullPath

getLastExecutionResult

(
  • testPlanId
  • testCaseExternalId
  • callback
)
Json Object

Defined in H:\testlink-api-client\lib\testlinkapi.js:696

Retrieves Last Execution Result for a TestCase

Parameters:

  • testPlanId Object
  • testCaseExternalId Object
  • callback Function

Returns:

Json Object:

JSON Object for Last Execution Result

getProjectPlatforms

(
  • testProjectId
  • callback
)
Json Object

Defined in H:\testlink-api-client\lib\testlinkapi.js:61

Retrieves Platforms Assigned for Project.

Parameters:

  • testProjectId Object
  • callback Function

Returns:

Json Object:

JSON Object for Project Platforms

getProjects

(
  • callback
)
Json Object

Defined in H:\testlink-api-client\lib\testlinkapi.js:117

Retrieves Created Test Projects.

Parameters:

  • callback Function

Returns:

Json Object:

JSON Object for Project(s)

getProjectTestPlans

(
  • testProjectId
  • callback
)
Json Object

Defined in H:\testlink-api-client\lib\testlinkapi.js:89

Retrieves TestPlans Created for Project.

Parameters:

  • testProjectId Object
  • callback Function

Returns:

Json Object:

JSON Object for Project TestPlan(s)

getTestCase

(
  • callback
  • testCaseExternalId
)
Json Object

Defined in H:\testlink-api-client\lib\testlinkapi.js:140

Retrieves Created TestCase based on External Id.

Parameters:

  • callback Function
  • testCaseExternalId Object

Returns:

Json Object:

JSON Object for TestCase

getTestCaseAttachments

(
  • testCaseExternalId
  • downloadPath
  • callback
)

Defined in H:\testlink-api-client\lib\testlinkapi.js:168

Get attached files for a TestCase.

Parameters:

  • testCaseExternalId Object
  • downloadPath Object
  • callback Function

getTestCaseCustomFieldDesignValue

(
  • testProjectId
  • testCaseExternalId
  • customFieldName
  • details
  • version
  • callback
)
Json Object

Defined in H:\testlink-api-client\lib\testlinkapi.js:206

Retrieves Custom Field Design Value Created for TestCase.

Parameters:

  • testProjectId Object
  • testCaseExternalId Object
  • customFieldName Object
  • details Object
  • version Object
  • callback Function

Returns:

Json Object:

JSON Object for TestCase Custom field Value

getTestCaseIDByName

(
  • testCaseName
  • callback
)
Json Object

Defined in H:\testlink-api-client\lib\testlinkapi.js:323

Retrieves Created TestCase based on Id

Parameters:

  • testCaseName Object
  • callback Function

Returns:

Json Object:

JSON Object for TestCase

getTestCasesForTestPlan

(
  • testPlanId
  • callback
)
Json object

Defined in H:\testlink-api-client\lib\testlinkapi.js:250

Retrieves Created TestCase(s) for a TestPlan

Parameters:

  • testPlanId Object
  • callback Function

Returns:

Json object:

JSON Object for TestCases(s)

getTestCasesForTestSuite

(
  • testProjectId
  • testSuiteId
  • callback
)
Json Object

Defined in H:\testlink-api-client\lib\testlinkapi.js:278

Retrieves Created TestCase(s) for a TestSuite

Parameters:

  • testProjectId Object
  • testSuiteId Object
  • callback Function

Returns:

Json Object:

JSON Object for TestCases(s)

getTestLinkVersion

(
  • callback
)
Json Object

Defined in H:\testlink-api-client\lib\testlinkapi.js:928

Retrieves TestList Version.

Parameters:

  • callback Function

Returns:

Json Object:

JSON Object for version

getTestPlanByName

(
  • testProjectName
  • testPlanName
  • callback
)
Json Object

Defined in H:\testlink-api-client\lib\testlinkapi.js:351

Retrieves TestPlan and its Properties

Parameters:

  • testProjectName Object
  • testPlanName Object
  • callback Function

Returns:

Json Object:

JSON Object for TestPlan

getTestPlanPlatforms

(
  • testPlanId
  • callback
)
Json Object

Defined in H:\testlink-api-client\lib\testlinkapi.js:384

Retrieves Platforms Assigned for TestPlan

Parameters:

  • testPlanId Object
  • callback Function

Returns:

Json Object:

JSON Object for Platform

getTestProjectByName

(
  • testProjectName
  • callback
)
Json Object

Defined in H:\testlink-api-client\lib\testlinkapi.js:412

Retrieves TestProject and its Properties

Parameters:

  • testProjectName Object
  • callback Function

Returns:

Json Object:

JSON Object for Project

getTestSuitesForTestPlan

(
  • testPlanId
  • callback
)
Json Object

Defined in H:\testlink-api-client\lib\testlinkapi.js:440

Retrieves TestSuites created for TestPlan(s)

Parameters:

  • testPlanId Object
  • callback Function

Returns:

Json Object:

JSON Object for TestSuite

getTestSuitesForTestSuite

(
  • testSuiteId
  • callback
)
Json Object

Defined in H:\testlink-api-client\lib\testlinkapi.js:468

Retrieves Child TestSuite(s) created under a TestSuite(s)

Parameters:

  • testSuiteId Object
  • callback Function

Returns:

Json Object:

JSON Object for TestSuite

getUserByID

(
  • userId
  • callback
)
Json Object

Defined in H:\testlink-api-client\lib\testlinkapi.js:496

Retrieves User and user properties

Parameters:

  • userId Object
  • callback Function

Returns:

Json Object:

JSON Object for User

getUserByLogin

(
  • user
  • callback
)
Json Object

Defined in H:\testlink-api-client\lib\testlinkapi.js:524

Retrieves LoggedIn User and properties

Parameters:

  • user Object
  • callback Function

Returns:

Json Object:

JSON Object for User

removePlatformFromTestPlan

(
  • testPlanId
  • platformName
  • callback
)
Json Object

Defined in H:\testlink-api-client\lib\testlinkapi.js:729

Un-Assign a Platform for a given TestPlan

Parameters:

  • testPlanId Object
  • platformName Object
  • callback Function

Returns:

Json Object:

JSON Object for a PlatformTestPlan

reportTCResult

(
  • testPlanId
  • testCaseExternalId
  • buildId
  • notes
  • status
  • platformName
  • user
  • bugId
  • callback
)
Json object

Defined in H:\testlink-api-client\lib\testlinkapi.js:762

Update Result for a given TestCase.

Parameters:

  • testPlanId Object
  • testCaseExternalId Object
  • buildId Object
  • notes Object
  • status Object
  • platformName Object
  • user Object
  • bugId Object
  • callback Function

Returns:

Json object:

JSON Object for TestCase Result

reportTCResultOverwrite

(
  • testPlanId
  • testCaseExternalId
  • buildId
  • notes
  • status
  • platformName
  • overwrite
  • user
  • bugId
  • callback
)
Json object

Defined in H:\testlink-api-client\lib\testlinkapi.js:821

Overwrite Result for a given TestCase.

Parameters:

  • testPlanId Object
  • testCaseExternalId Object
  • buildId Object
  • notes Object
  • status Object
  • platformName Object
  • overwrite Object
  • user Object
  • bugId Object
  • callback Function

Returns:

Json object:

JSON Object for TestCase Result

setTestCaseExecutionType

(
  • testProjectId
  • testCaseExternalId
  • executionType
  • callback
)
Json object

Defined in H:\testlink-api-client\lib\testlinkapi.js:886

Set the Execution Type for a given TestCase.

Parameters:

  • testProjectId Object
  • testCaseExternalId Object
  • executionType Object
  • callback Function

Returns:

Json object:

JSON Object for TestCase Execution Type

updateTestCase

(
  • testCaseExternalId
  • version
  • summary
  • callback
)
Json object

Defined in H:\testlink-api-client\lib\testlinkapi.js:951

Update TestCase Version and Summary.

Parameters:

  • testCaseExternalId Object
  • version Object
  • summary Object
  • callback Function

Returns:

Json object:

JSON Object for TestCase

updateTestCaseCustomFieldDesignValue

(
  • testProjectId
  • testCaseExternalId
  • version
  • customFieldName
  • customFieldValue
  • callback
)
Json object

Defined in H:\testlink-api-client\lib\testlinkapi.js:989

Update TestCase Custom Field Design Values.

Parameters:

  • testProjectId Object
  • testCaseExternalId Object
  • version Object
  • customFieldName Object
  • customFieldValue Object
  • callback Function

Returns:

Json object:

JSON Object for TestCase

uploadTestCaseAttachment

(
  • testCaseId
  • fileName
  • uploadPath
  • callback
)

Defined in H:\testlink-api-client\lib\testlinkapi.js:552

Uploads a Given file to TestCase

Parameters:

  • testCaseId Object
  • fileName Object
  • uploadPath Object
  • callback Function