TestLinkAPI (TestLink Java API 1.9.20-1 API)

java.lang.Object
- br.eti.kinoshita.testlinkjavaapi.TestLinkAPI

```
public class TestLinkAPI
extends Object
```
TestLink API class.

Since:

1.9.0-1

Author:

Bruno P. Kinoshita - http://www.kinoshita.eti.br

Constructor Summary

Constructors
Constructor and Description
`TestLinkAPI(URL url, String devKey)` Constructor with parameters.
`TestLinkAPI(URL url, String devKey, String proxyHost, int proxyPort)` Constructor with parameters.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`about()` Displays information about TL.
`Map<String,Object>`	`addPlatformToTestPlan(Integer testProjectId, Integer testPlanId, String platformName)` Adds a platform to a test plan.
`Map<String,Object>`	`addTestCaseKeywords(Map<String,List<String>> testCaseKeywordsMap)` Add keywords to existing test cases.
`Integer`	`addTestCaseToTestPlan(Integer testProjectId, Integer testPlanId, Integer testCaseId, Integer version, Integer platformId, Integer order, Integer urgency)` Adds a Test Case to a Test Plan.
`void`	`assignRequirements(Integer testCaseId, Integer testProjectId, List<Requirement> requirements)` Assign a requirements to a Test Case.
`void`	`assignTestCaseExecutionTask(Integer testPlanId, String testCaseExternalId, String user, String buildName)` Assign user to execute Test Case in Test Plan
`Boolean`	`checkDevKey(String devKey)` Checks developer key.
`Build`	`createBuild(Integer testPlanId, String buildName, String buildNotes)` Creates a Build.
`TestCase`	`createTestCase(String testCaseName, Integer testSuiteId, Integer testProjectId, String authorLogin, String summary, List<TestCaseStep> steps, String preconditions, TestCaseStatus status, TestImportance importance, ExecutionType execution, Integer order, Integer internalId, Boolean checkDuplicatedName, ActionOnDuplicate actionOnDuplicatedName)` Creates a Test Case.
`Map<String,Object>`	`createTestCaseSteps(Integer testCaseId, String testCaseExternalId, Integer version, TestCaseStepAction action, List<TestCaseStep> testCaseSteps)` Create, Update or Push a list of TestCaseSteps in a Test Case.
`TestPlan`	`createTestPlan(String planName, String projectName, String notes, Boolean isActive, Boolean isPublic)` Creates a Test Plan.
`TestProject`	`createTestProject(String testProjectName, String testProjectPrefix, String notes, Boolean enableRequirements, Boolean enableTestPriority, Boolean enableAutomation, Boolean enableInventory, Boolean isActive, Boolean isPublic)` Creates a Test Project.
`TestSuite`	`createTestSuite(Integer testProjectId, String name, String details, Integer parentId, Integer order, Boolean checkDuplicatedName, ActionOnDuplicate actionOnDuplicatedName)` Create a test suite.
`void`	`deleteExecution(Integer executionId)` Deletes an execution.
`Map<String,Object>`	`deleteTestCaseSteps(String testCaseExternalId, Integer version, List<TestCaseStep> testCaseSteps)` Delete a list if TestCaseSteps from a Test Case.
`Boolean`	`doesUserExist(String user)` Checks if the given user exists.
`Object`	`executeXmlRpcCall(String methodName, Map<String,Object> executionData)` Executes a XML-RPC call.
`Build[]`	`getBuildsForTestPlan(Integer testPlanId)` Retrieves an Array of Builds for a given Test Plan.
`String`	`getDevKey()`
`Map<String,Object>`	`getExecCountersByBuild(Integer testPlanId)` Gets the exec counters by build.
`TestSuite[]`	`getFirstLevelTestSuitesForTestProject(Integer testProjectId)` Get set of test suites AT TOP LEVEL of tree on a Test Project
`String[]`	`getFullPath(Integer nodeId)` Retrieves the full path of a node.
`Execution`	`getLastExecutionResult(Integer testPlanId, Integer testCaseId, String testCaseExternalId, Integer platformId, String platformName, Integer buildId, String buildName, Integer options)` Retrieves last execution result of a Test Case.
`Build`	`getLatestBuildForTestPlan(Integer testPlanId)` Retrieves the latest Build for a given Test Plan.
`Platform[]`	`getProjectPlatforms(Integer projectId)` Retrieves the platforms of a test project.
`TestProject[]`	`getProjects()` Retrieves all Test Projects from TestLink.
`TestPlan[]`	`getProjectTestPlans(Integer projectId)` Retrieves an array of Test Plans associated to a Test Project.
`TestCase`	`getTestCase(Integer testCaseId, Integer testCaseExternalId, Integer version)` Get a test case
`Attachment[]`	`getTestCaseAttachments(Integer testCaseId, Integer testCaseVersion, Integer testCaseExternalId)` Return an array of attachments of a Test Case.
`List<Integer>`	`getTestCaseBugs(Integer testPlanId, Integer testCaseId, Integer testCaseExternalId, Integer platformId, String platformName, Integer buildId, String buildName)` Get bugs related to a test case.
`TestCase`	`getTestCaseByExternalId(String fullTestCaseExternalId, Integer version)` Get a Test Case using the full external id, composed by the prefix and the external id: prefix-externalId
`CustomField`	`getTestCaseCustomFieldDesignValue(Integer testCaseId, Integer testCaseExternalId, Integer versionNumber, Integer testProjectId, String customFieldName, ResponseDetails details)` Retrieves list of Custom Fields for a Test Case.
`CustomField`	`getTestCaseCustomFieldExecutionValue(Integer testCaseId, Integer testCaseExternalId, Integer versionNumber, Integer executionId, Integer testPlanID, Integer testProjectId, String customFieldName, ResponseDetails details)` Gets the test case custom field value on test execution scope.
`CustomField`	`getTestCaseCustomFieldTestPlanDesignValue(Integer testCaseId, Integer testCaseExternalId, Integer versionNumber, Integer testProjectId, String customFieldName, ResponseDetails details)` Gets the test case custom field value on test plan design scope.
`Integer`	`getTestCaseIDByName(String testCaseName, String testSuiteName, String testProjectName, String testCasePathName)` Get a test case ID by a test case Name
`List<String>`	`getTestCaseKeywords(Integer testProjectId, Integer testCaseId)` Gets list of keywords for a given Test case
`TestCase[]`	`getTestCasesForTestPlan(Integer testPlanId, List<Integer> testCasesIds, Integer buildId, List<Integer> keywordsIds, String keywords, Boolean executed, List<Integer> assignedTo, String[] executeStatus, ExecutionType executionType, Boolean getStepInfo, TestCaseDetails detail)` Retrieves Test Cases for Test Plans.
`TestCase[]`	`getTestCasesForTestSuite(Integer testSuiteId, Boolean deep, TestCaseDetails detail)` Retrieves Test Cases for a Test Suite.
`TestPlan`	`getTestPlanByName(String planName, String projectName)` Retrieves a Test Plan by its name.
`CustomField`	`getTestPlanCustomFieldDesignValue(Integer testPlanId, Integer testProjectId, String customFieldName, ResponseDetails details)` Gets the test plan custom field value
`Platform[]`	`getTestPlanPlatforms(Integer planId)` Retrieves Platforms of a Test Plan.
`TestProject`	`getTestProjectByName(String projectName)` Retrieves a Test Project by its name.
`Attachment[]`	`getTestSuiteAttachments(Integer testSuiteId)` Return an array of attachments of a Test Suite.
`TestSuite[]`	`getTestSuiteByID(List<Integer> testSuiteIds)` Retrieves Test Suites for given Ids.
`TestSuite[]`	`getTestSuitesForTestPlan(Integer testPlanId)`
`TestSuite[]`	`getTestSuitesForTestSuite(Integer testSuiteId)` Get list of TestSuites which are DIRECT children of a given TestSuite
`Map<String,Object>`	`getTotalsForTestPlan(Integer testPlanId)` Gets stats for test plan.
`URL`	`getUrl()`
`User`	`getUserByLogin(String login)` Get user by login.
`org.apache.xmlrpc.client.XmlRpcClient`	`getXmlRpcClient()`
`String`	`ping()` ping method is an alias for sayHello.
`Map<String,Object>`	`removePlatformFromTestPlan(Integer testProjectId, Integer testPlanId, String platformName)` Removes a platform from a test plan.
`String`	`repeat(String str)` Repeat the text.
`ReportTCResultResponse`	`reportTCResult(Integer testCaseId, Integer testCaseExternalId, Integer testPlanId, ExecutionStatus status, List<TestCaseStepResult> steps, Integer buildId, String buildName, String notes, Integer executionDuration, Boolean guess, String bugId, Integer platformId, String platformName, Map<String,String> customFields, Boolean overwrite, String user, String timestamp)` Reports a Test Case result.
`String`	`sayHello()` Says hello to the user.
`ReportTCResultResponse`	`setTestCaseExecutionResult(Integer testCaseId, Integer testCaseExternalId, Integer testPlanId, ExecutionStatus status, List<TestCaseStepResult> steps, Integer buildId, String buildName, String notes, Integer executionDuration, Boolean guess, String bugId, Integer platformId, String platformName, Map<String,String> customFields, Boolean overwrite, String user, String timestamp)` Reports a Test Case result.
`Map<String,Object>`	`setTestCaseExecutionType(Integer testProjectId, Integer testCaseId, Integer testCaseExternalId, Integer versionNumber, ExecutionType executionType)` Sets the test case execution type.
`Boolean`	`setTestMode(Boolean testMode)` Set the test mode.
`String`	`toString()`
`Map<String,Object>`	`updateBuildCustomFields(Integer buildId, Integer testProjectId, Integer testPlanId, Map<String,String> customFields)` Update build custom fields.
`Map<String,Object>`	`updateTestCase(TestCase tc)` Update an already existing test case with the data of the given test case as a new version.
`Map<String,Object>`	`updateTestCaseCustomFieldDesignValue(Integer testCaseId, Integer versionNumber, Integer testProjectId, String customFieldName, String customFieldValue)` Update the value of an existing custom field for a Test Case
`Attachment`	`uploadAttachment(Integer fkId, String fkTable, String title, String description, String fileName, String fileType, String content)` Upload an attachment linking it to a DB table.
`Attachment`	`uploadExecutionAttachment(Integer executionId, String title, String description, String fileName, String fileType, String content)` Upload an execution attachment.
`Attachment`	`uploadRequirementAttachment(Integer requirementId, String title, String description, String fileName, String fileType, String content)` Uploads an attachment to a Requirement.
`Attachment`	`uploadRequirementSpecificationAttachment(Integer reqSpecId, String title, String description, String fileName, String fileType, String content)` Uploads an attachment to a Requirement Specification.
`Attachment`	`uploadTestCaseAttachment(Integer testCaseId, String title, String description, String fileName, String fileType, String content)` Uploads an attachment to a Test Case.
`Attachment`	`uploadTestProjectAttachment(Integer testProjectId, String title, String description, String fileName, String fileType, String content)` Uploads an attachment to a Test Project.
`Attachment`	`uploadTestSuiteAttachment(Integer testSuiteId, String title, String description, String fileName, String fileType, String content)` Uploads an attachment to a Test Suite.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail
- TestLinkAPI
```
public TestLinkAPI(URL url,
                   String devKey)
            throws TestLinkAPIException
```
  Constructor with parameters.
  Instantiates TestLink services. It also checks the devKey and throws a TestLinkAPIException if it is invalid.
  
  Parameters:
  
  url - The URL to set.
  
  devKey - The Developer Key to set.
  
  Throws:
  
  TestLinkAPIException - if the service returns an error
  
  Since:
  
  1.0
- TestLinkAPI
```
public TestLinkAPI(URL url,
                   String devKey,
                   String proxyHost,
                   int proxyPort)
            throws TestLinkAPIException
```
  Constructor with parameters.
  
  Parameters:
  
  url - The URL to set.
  
  devKey - The Developer Key to set.
  
  proxyHost - The IP address of the proxy server
  
  proxyPort - The proxy server port
  
  Throws:
  
  TestLinkAPIException - if the service returns an error
  
  Since:
  
  1.9.20

Method Detail

getXmlRpcClient

public org.apache.xmlrpc.client.XmlRpcClient getXmlRpcClient()

Returns:: XML-RPC Client.

getUrl
```
public URL getUrl()
```
Returns:

the url

getDevKey
```
public String getDevKey()
```
Returns:

the devKey

toString
```
public String toString()
```
Overrides:

toString in class Object

checkDevKey
```
public Boolean checkDevKey(String devKey)
                    throws TestLinkAPIException
```
Checks developer key.

Parameters:

devKey - Developer Key.

Returns:

true if devKey is valid, false otherwise.

Throws:

TestLinkAPIException - if the service returns an error

Since:

1.0

doesUserExist
```
public Boolean doesUserExist(String user)
                      throws TestLinkAPIException
```
Checks if the given user exists.

Parameters:

user - user user name

Returns:

true if the user exists, false otherwise.

Throws:

TestLinkAPIException - if the service returns an error

getUserByLogin
```
public User getUserByLogin(String login)
                    throws TestLinkAPIException
```
Get user by login.

Parameters:

login - user login

Returns:

user the user

Throws:

TestLinkAPIException - if the service returns an error

ping
```
public String ping()
            throws TestLinkAPIException
```
ping method is an alias for sayHello.

Returns:

Hello message

Throws:

TestLinkAPIException - if the service returns an error

sayHello
```
public String sayHello()
                throws TestLinkAPIException
```
Says hello to the user.

Returns:

Hello message

Throws:

TestLinkAPIException - if the service returns an error

about
```
public String about()
             throws TestLinkAPIException
```
Displays information about TL.

Returns:

About text

Throws:

TestLinkAPIException - if the service returns an error

setTestMode
```
public Boolean setTestMode(Boolean testMode)
                    throws TestLinkAPIException
```
Set the test mode.

Parameters:

testMode - test mode

Returns:

Test mode

Throws:

TestLinkAPIException - if the service returns an error

repeat
```
public String repeat(String str)
              throws TestLinkAPIException
```
Repeat the text.

Parameters:

str - text

Returns:

String repeated

Throws:

TestLinkAPIException - if the service returns an error

uploadAttachment

public Attachment uploadAttachment(Integer fkId,
                                   String fkTable,
                                   String title,
                                   String description,
                                   String fileName,
                                   String fileType,
                                   String content)
                            throws TestLinkAPIException

Upload an attachment linking it to a DB table.

Parameters:: fkId - FK; fkTable - FK table name; title - title; description - description; fileName - file name; fileType - file type; content - content
Returns:: Attachment
Throws:: TestLinkAPIException - if the service returns an error

getFullPath
```
public String[] getFullPath(Integer nodeId)
                     throws TestLinkAPIException
```
Retrieves the full path of a node. Given a nodeId of, let's say, 10, that is a test case. The return array will consist of Name Of Project, Name of Suite, Name of Test Case.

Parameters:

nodeId - node ID

Returns:

Array of name of nodes

Throws:

TestLinkAPIException - if the service returns an error

getLastExecutionResult

public Execution getLastExecutionResult(Integer testPlanId,
                                        Integer testCaseId,
                                        String testCaseExternalId,
                                        Integer platformId,
                                        String platformName,
                                        Integer buildId,
                                        String buildName,
                                        Integer options)
                                 throws TestLinkAPIException

Retrieves last execution result of a Test Case.

Parameters:: testPlanId - test plan ID; testCaseId - test case ID; testCaseExternalId - test case external ID; platformId - platform ID; platformName - platform name; buildId - build ID; buildName - build name; options - array of options
Returns:: last Execution
Throws:: TestLinkAPIException - if the service returns an error

createTestProject

public TestProject createTestProject(String testProjectName,
                                     String testProjectPrefix,
                                     String notes,
                                     Boolean enableRequirements,
                                     Boolean enableTestPriority,
                                     Boolean enableAutomation,
                                     Boolean enableInventory,
                                     Boolean isActive,
                                     Boolean isPublic)
                              throws TestLinkAPIException

Creates a Test Project.

Parameters:: testProjectName - test project name; testProjectPrefix - test project prefix; notes - notes; enableRequirements - flag to enable requirements; enableTestPriority - flag to enable test priority; enableAutomation - flag to enable automation; enableInventory - flag to enable inventory; isActive - whether the project is active or not; isPublic - whether the project is public or not
Returns:: Test Project object
Throws:: TestLinkAPIException - if the service returns an error
Since:: 1.0

getTestProjectByName
```
public TestProject getTestProjectByName(String projectName)
                                 throws TestLinkAPIException
```
Retrieves a Test Project by its name.

Parameters:

projectName - Test Project name.

Returns:

Test Project with given name or null if not found.

Throws:

TestLinkAPIException - if the service returns an error

Since:

1.0

getProjectPlatforms
```
public Platform[] getProjectPlatforms(Integer projectId)
                               throws TestLinkAPIException
```
Retrieves the platforms of a test project.

Parameters:

projectId - test project ID

Returns:

platforms array

Throws:

TestLinkAPIException - if the service returns an error if an error occurs when retrieving the platforms

Since:

1.9.6-0

getProjects
```
public TestProject[] getProjects()
                          throws TestLinkAPIException
```
Retrieves all Test Projects from TestLink.

Returns:

an array of Test Projects.

Throws:

TestLinkAPIException - if the service returns an error

Since:

1.0

getProjectTestPlans
```
public TestPlan[] getProjectTestPlans(Integer projectId)
                               throws TestLinkAPIException
```
Retrieves an array of Test Plans associated to a Test Project.

Parameters:

projectId - Test Project ID

Returns:

Array of Test Plans.

Throws:

TestLinkAPIException - if the service returns an error

uploadTestProjectAttachment

public Attachment uploadTestProjectAttachment(Integer testProjectId,
                                              String title,
                                              String description,
                                              String fileName,
                                              String fileType,
                                              String content)
                                       throws TestLinkAPIException

Uploads an attachment to a Test Project.

Parameters:: testProjectId - test project ID test project ID; title - title; description - description; fileName - file name; fileType - file type; content - content
Returns:: Attachment
Throws:: TestLinkAPIException - if the service returns an error

createTestPlan

public TestPlan createTestPlan(String planName,
                               String projectName,
                               String notes,
                               Boolean isActive,
                               Boolean isPublic)
                        throws TestLinkAPIException

Creates a Test Plan.

Parameters:: planName - Test Plan name.; projectName - Test Project name.; notes - Test Plan notes.; isActive - whether the project is active or not; isPublic - whether the project is public or not
Returns:: Test plan
Throws:: TestLinkAPIException - if the service returns an error
Since:: 1.0

getTestPlanByName

public TestPlan getTestPlanByName(String planName,
                                  String projectName)
                           throws TestLinkAPIException

Retrieves a Test Plan by its name.

Parameters:: planName - Test Plan name.; projectName - Test Project name.
Returns:: Test Plan.
Throws:: TestLinkAPIException - if the service returns an error
Since:: 1.0

getTestPlanPlatforms
```
public Platform[] getTestPlanPlatforms(Integer planId)
                                throws TestLinkAPIException
```
Retrieves Platforms of a Test Plan.

Parameters:

planId - Test Plan Id.

Returns:

Platforms

Throws:

TestLinkAPIException - if the service returns an error

getTotalsForTestPlan
```
public Map<String,Object> getTotalsForTestPlan(Integer testPlanId)
                                        throws TestLinkAPIException
```
Gets stats for test plan.

Parameters:

testPlanId - test plan ID

Returns:

statistics on test plan

Throws:

TestLinkAPIException - if the service returns an error

removePlatformFromTestPlan

public Map<String,Object> removePlatformFromTestPlan(Integer testProjectId,
                                                     Integer testPlanId,
                                                     String platformName)
                                              throws TestLinkAPIException

Removes a platform from a test plan.

Parameters:: testProjectId - test project ID test project ID; testPlanId - test plan ID; platformName - platform name
Returns:: status message
Throws:: TestLinkAPIException - if the service returns an error

addPlatformToTestPlan

public Map<String,Object> addPlatformToTestPlan(Integer testProjectId,
                                                Integer testPlanId,
                                                String platformName)
                                         throws TestLinkAPIException

Adds a platform to a test plan.

Parameters:: testProjectId - test project ID test project ID; testPlanId - test plan ID; platformName - platform name
Returns:: status message
Throws:: TestLinkAPIException - if the service returns an error

updateBuildCustomFields

public Map<String,Object> updateBuildCustomFields(Integer buildId,
                                                  Integer testProjectId,
                                                  Integer testPlanId,
                                                  Map<String,String> customFields)
                                           throws TestLinkAPIException

Update build custom fields.

Parameters:: buildId - Build ID; testProjectId - Test Project ID; testPlanId - test plan ID; customFields - Custom Fields name, value pairs
Returns:: Response XML-RPC Response
Throws:: TestLinkAPIException - if the service returns as error
Since:: 1.9.16-0

createBuild

public Build createBuild(Integer testPlanId,
                         String buildName,
                         String buildNotes)
                  throws TestLinkAPIException

Creates a Build.

Parameters:: testPlanId - test plan ID; buildName - build name; buildNotes - build notes
Returns:: Created Build
Throws:: TestLinkAPIException - if the service returns an error

getBuildsForTestPlan
```
public Build[] getBuildsForTestPlan(Integer testPlanId)
                             throws TestLinkAPIException
```
Retrieves an Array of Builds for a given Test Plan.

Parameters:

testPlanId - Test Plan ID.

Returns:

Array of Builds.

Throws:

TestLinkAPIException - if the service returns an error

getLatestBuildForTestPlan
```
public Build getLatestBuildForTestPlan(Integer testPlanId)
                                throws TestLinkAPIException
```
Retrieves the latest Build for a given Test Plan.

Parameters:

testPlanId - Test Plan ID.

Returns:

Build.

Throws:

TestLinkAPIException - if the service returns an error

getExecCountersByBuild
```
public Map<String,Object> getExecCountersByBuild(Integer testPlanId)
```
Gets the exec counters by build.

Parameters:

testPlanId - test plan ID

Returns:

server response map

createTestSuite

public TestSuite createTestSuite(Integer testProjectId,
                                 String name,
                                 String details,
                                 Integer parentId,
                                 Integer order,
                                 Boolean checkDuplicatedName,
                                 ActionOnDuplicate actionOnDuplicatedName)
                          throws TestLinkAPIException

Create a test suite.

Parameters:: testProjectId - Test project ID; name - Test suite name; details - details; parentId - Parent ID; order - order; checkDuplicatedName - whether to check for duplicated names or not; actionOnDuplicatedName - action when there is a duplicated name
Returns:: TestSuite
Throws:: TestLinkAPIException - if it fails to create a test suite

getTestSuiteByID
```
public TestSuite[] getTestSuiteByID(List<Integer> testSuiteIds)
                             throws TestLinkAPIException
```
Retrieves Test Suites for given Ids.

Parameters:

testSuiteIds - List of Test Suite Ids.

Returns:

Array of Test Suites.

Throws:

TestLinkAPIException - if the service returns an error

uploadTestSuiteAttachment

public Attachment uploadTestSuiteAttachment(Integer testSuiteId,
                                            String title,
                                            String description,
                                            String fileName,
                                            String fileType,
                                            String content)
                                     throws TestLinkAPIException

Uploads an attachment to a Test Suite.

Parameters:: testSuiteId - test suite ID; title - title; description - description; fileName - file name; fileType - file type; content - content
Returns:: Attachment.
Throws:: TestLinkAPIException - if the service returns an error

getTestSuitesForTestPlan
```
public TestSuite[] getTestSuitesForTestPlan(Integer testPlanId)
                                     throws TestLinkAPIException
```
Parameters:

testPlanId - test plan ID

Returns:

Array of Test Suites of Test Plan.

Throws:

TestLinkAPIException - if the service returns an error

getTestSuitesForTestSuite
```
public TestSuite[] getTestSuitesForTestSuite(Integer testSuiteId)
                                      throws TestLinkAPIException
```
Get list of TestSuites which are DIRECT children of a given TestSuite

Parameters:

testSuiteId - test suite ID

Returns:

an array of test suites

Throws:

TestLinkAPIException - if the service returns an error

getFirstLevelTestSuitesForTestProject
```
public TestSuite[] getFirstLevelTestSuitesForTestProject(Integer testProjectId)
                                                  throws TestLinkAPIException
```
Get set of test suites AT TOP LEVEL of tree on a Test Project

Parameters:

testProjectId - test project ID

Returns:

an array of test suites

Throws:

TestLinkAPIException - if the service returns an error

createTestCase

public TestCase createTestCase(String testCaseName,
                               Integer testSuiteId,
                               Integer testProjectId,
                               String authorLogin,
                               String summary,
                               List<TestCaseStep> steps,
                               String preconditions,
                               TestCaseStatus status,
                               TestImportance importance,
                               ExecutionType execution,
                               Integer order,
                               Integer internalId,
                               Boolean checkDuplicatedName,
                               ActionOnDuplicate actionOnDuplicatedName)
                        throws TestLinkAPIException

Creates a Test Case.

Parameters:: testCaseName - test case name; testSuiteId - test suite ID; testProjectId - test project ID; authorLogin - author login; summary - summary; steps - steps; preconditions - preconditions; status - status; importance - importance; execution - execution; order - order; internalId - internal ID; checkDuplicatedName - flag to check for duplicated name; actionOnDuplicatedName - what to do when a duplicated name is found
Returns:: TestCase.
Throws:: TestLinkAPIException - if the service returns an error

updateTestCase
```
public Map<String,Object> updateTestCase(TestCase tc)
                                  throws TestLinkAPIException
```
Update an already existing test case with the data of the given test case as a new version.

Parameters:

tc - new version of the test case

Returns:

response map

Throws:

TestLinkAPIException - if the service returns an error if updating the test case fails

createTestCaseSteps

public Map<String,Object> createTestCaseSteps(Integer testCaseId,
                                              String testCaseExternalId,
                                              Integer version,
                                              TestCaseStepAction action,
                                              List<TestCaseStep> testCaseSteps)
                                       throws TestLinkAPIException

Create, Update or Push a list of TestCaseSteps in a Test Case.

Parameters:: testCaseId - test case ID; testCaseExternalId - test case external ID; version - version; action - action; testCaseSteps - test case steps
Returns:: a Map with results.
Throws:: TestLinkAPIException - if the service returns an error

deleteTestCaseSteps

public Map<String,Object> deleteTestCaseSteps(String testCaseExternalId,
                                              Integer version,
                                              List<TestCaseStep> testCaseSteps)
                                       throws TestLinkAPIException

Delete a list if TestCaseSteps from a Test Case.

Parameters:: testCaseExternalId - test case external ID; version - version; testCaseSteps - test case steps
Returns:: a Map with results.
Throws:: TestLinkAPIException - if the service returns an error

addTestCaseToTestPlan

public Integer addTestCaseToTestPlan(Integer testProjectId,
                                     Integer testPlanId,
                                     Integer testCaseId,
                                     Integer version,
                                     Integer platformId,
                                     Integer order,
                                     Integer urgency)
                              throws TestLinkAPIException

Adds a Test Case to a Test Plan.

Parameters:: testProjectId - test project ID; testPlanId - test plan ID; testCaseId - test case ID; version - version; platformId - platform ID; order - order; urgency - urgency
Returns:: Feature ID.
Throws:: TestLinkAPIException - if the service returns an error

getTestCasesForTestSuite

public TestCase[] getTestCasesForTestSuite(Integer testSuiteId,
                                           Boolean deep,
                                           TestCaseDetails detail)
                                    throws TestLinkAPIException

Retrieves Test Cases for a Test Suite.

Parameters:: testSuiteId - test suite ID; deep - flag for depth; detail - test case details requested
Returns:: Array of Test Cases of the Test Suite.
Throws:: TestLinkAPIException - if the service returns an error

getTestCase

public TestCase getTestCase(Integer testCaseId,
                            Integer testCaseExternalId,
                            Integer version)
                     throws TestLinkAPIException

Get a test case

Parameters:: testCaseId - test case ID; testCaseExternalId - test case external ID; version - version
Returns:: Test Case.
Throws:: TestLinkAPIException - if the service returns an error

getTestCaseByExternalId
```
public TestCase getTestCaseByExternalId(String fullTestCaseExternalId,
                                        Integer version)
                                 throws TestLinkAPIException
```
Get a Test Case using the full external id, composed by the prefix and the external id: prefix-externalId

Parameters:

fullTestCaseExternalId - Full external id: prefix-externalId

version - version

Returns:

Test Case.

Throws:

TestLinkAPIException - if the service returns an error

getTestCasesForTestPlan

public TestCase[] getTestCasesForTestPlan(Integer testPlanId,
                                          List<Integer> testCasesIds,
                                          Integer buildId,
                                          List<Integer> keywordsIds,
                                          String keywords,
                                          Boolean executed,
                                          List<Integer> assignedTo,
                                          String[] executeStatus,
                                          ExecutionType executionType,
                                          Boolean getStepInfo,
                                          TestCaseDetails detail)
                                   throws TestLinkAPIException

Retrieves Test Cases for Test Plans.

Parameters:: testPlanId - test plan ID; testCasesIds - test case ID's; buildId - build ID; keywordsIds - keyword ID's; keywords - keywords; executed - flag for executed or not; assignedTo - assignee; executeStatus - execution status; executionType - execution type; getStepInfo - test case step info; detail - test case details
Returns:: Array of Test Cases of the Test Plan.
Throws:: TestLinkAPIException - if the service returns an error

getTestCaseIDByName

public Integer getTestCaseIDByName(String testCaseName,
                                   String testSuiteName,
                                   String testProjectName,
                                   String testCasePathName)
                            throws TestLinkAPIException

Get a test case ID by a test case Name

Parameters:: testCaseName - test case name; testSuiteName - test suite name; testProjectName - test project name; testCasePathName - test case path name
Returns:: Test Case ID.
Throws:: TestLinkAPIException - if the service returns an error

uploadTestCaseAttachment

public Attachment uploadTestCaseAttachment(Integer testCaseId,
                                           String title,
                                           String description,
                                           String fileName,
                                           String fileType,
                                           String content)
                                    throws TestLinkAPIException

Uploads an attachment to a Test Case.

Parameters:: testCaseId - test case ID; title - title; description - description; fileName - file name; fileType - file type; content - content
Returns:: Attachment.
Throws:: TestLinkAPIException - if the service returns an error

getTestCaseAttachments

public Attachment[] getTestCaseAttachments(Integer testCaseId,
                                           Integer testCaseVersion,
                                           Integer testCaseExternalId)
                                    throws TestLinkAPIException

Return an array of attachments of a Test Case.

Parameters:: testCaseId - test case ID; testCaseExternalId - test case external ID; testCaseVersion - test case version
Returns:: Array of Attachments
Throws:: TestLinkAPIException - if the service returns an error

getTestSuiteAttachments
```
public Attachment[] getTestSuiteAttachments(Integer testSuiteId)
                                     throws TestLinkAPIException
```
Return an array of attachments of a Test Suite.

Parameters:

testSuiteId - test suite ID

Returns:

Array of Attachments.

Throws:

TestLinkAPIException - if service return error

uploadExecutionAttachment

public Attachment uploadExecutionAttachment(Integer executionId,
                                            String title,
                                            String description,
                                            String fileName,
                                            String fileType,
                                            String content)
                                     throws TestLinkAPIException

Upload an execution attachment.

Parameters:: executionId - execution ID; title - title; description - description; fileName - file name; fileType - file type; content - content
Returns:: attachment
Throws:: TestLinkAPIException - if the service returns an error

deleteExecution
```
public void deleteExecution(Integer executionId)
                     throws TestLinkAPIException
```
Deletes an execution.

Parameters:

executionId - Execution Id.

Throws:

TestLinkAPIException - if the service returns an error

reportTCResult

public ReportTCResultResponse reportTCResult(Integer testCaseId,
                                             Integer testCaseExternalId,
                                             Integer testPlanId,
                                             ExecutionStatus status,
                                             List<TestCaseStepResult> steps,
                                             Integer buildId,
                                             String buildName,
                                             String notes,
                                             Integer executionDuration,
                                             Boolean guess,
                                             String bugId,
                                             Integer platformId,
                                             String platformName,
                                             Map<String,String> customFields,
                                             Boolean overwrite,
                                             String user,
                                             String timestamp)
                                      throws TestLinkAPIException

Reports a Test Case result.

Parameters:: testCaseId - test case ID; testCaseExternalId - test case external ID; testPlanId - test plan ID; status - status; steps - test steps results; buildId - build ID; buildName - build name; notes - notes; executionDuration - execution duration (minutes); guess - flag to guess other parameters or not; bugId - bug ID; platformId - platform ID; platformName - platform name; customFields - custom fields; overwrite - flag to overwrite or not; user - if present checks if user is a valid login; timestamp - format YYYY-MM-DD HH:MM:SS (e.g. 2015-05-22 12:15:45)
Returns:: report test case result server response
Throws:: TestLinkAPIException - if the service returns an error

setTestCaseExecutionResult

public ReportTCResultResponse setTestCaseExecutionResult(Integer testCaseId,
                                                         Integer testCaseExternalId,
                                                         Integer testPlanId,
                                                         ExecutionStatus status,
                                                         List<TestCaseStepResult> steps,
                                                         Integer buildId,
                                                         String buildName,
                                                         String notes,
                                                         Integer executionDuration,
                                                         Boolean guess,
                                                         String bugId,
                                                         Integer platformId,
                                                         String platformName,
                                                         Map<String,String> customFields,
                                                         Boolean overwrite,
                                                         String user,
                                                         String timestamp)
                                                  throws TestLinkAPIException

Reports a Test Case result.

Parameters:: testCaseId - test case ID; testCaseExternalId - test case external ID; testPlanId - test plan ID; status - status; steps - test steps results; buildId - build ID; buildName - build name; notes - notes; executionDuration - execution duration (minutes); guess - flag to guess other parameters or not; bugId - bug ID; platformId - platform ID; platformName - platform name; customFields - custom fields; overwrite - flag to overwrite or not; user - if present checks if user is a valid login; timestamp - format YYYY-MM-DD HH:MM:SS (e.g. 2015-05-22 12:15:45)
Returns:: response
Throws:: TestLinkAPIException - if the service returns an error

getTestCaseCustomFieldDesignValue

public CustomField getTestCaseCustomFieldDesignValue(Integer testCaseId,
                                                     Integer testCaseExternalId,
                                                     Integer versionNumber,
                                                     Integer testProjectId,
                                                     String customFieldName,
                                                     ResponseDetails details)
                                              throws TestLinkAPIException

Retrieves list of Custom Fields for a Test Case.

Parameters:: testCaseId - test case ID; testCaseExternalId - test case external ID; versionNumber - version number; testProjectId - test project ID; customFieldName - custom field name; details - details
Returns:: Custom Field.
Throws:: TestLinkAPIException - if the service returns an error

getTestPlanCustomFieldDesignValue

public CustomField getTestPlanCustomFieldDesignValue(Integer testPlanId,
                                                     Integer testProjectId,
                                                     String customFieldName,
                                                     ResponseDetails details)
                                              throws TestLinkAPIException

Gets the test plan custom field value

Parameters:: testPlanId - test plan ID; testProjectId - test project ID; customFieldName - custom field name; details - details
Returns:: custom field
Throws:: TestLinkAPIException - if the service returns an error

getTestCaseCustomFieldTestPlanDesignValue

public CustomField getTestCaseCustomFieldTestPlanDesignValue(Integer testCaseId,
                                                             Integer testCaseExternalId,
                                                             Integer versionNumber,
                                                             Integer testProjectId,
                                                             String customFieldName,
                                                             ResponseDetails details)
                                                      throws TestLinkAPIException

Gets the test case custom field value on test plan design scope.

Parameters:: testCaseId - test case ID; testCaseExternalId - test case external ID; versionNumber - version number; testProjectId - test project ID; customFieldName - custom field name; details - details
Returns:: custom field
Throws:: TestLinkAPIException - if the service returns an error

getTestCaseCustomFieldExecutionValue

public CustomField getTestCaseCustomFieldExecutionValue(Integer testCaseId,
                                                        Integer testCaseExternalId,
                                                        Integer versionNumber,
                                                        Integer executionId,
                                                        Integer testPlanID,
                                                        Integer testProjectId,
                                                        String customFieldName,
                                                        ResponseDetails details)
                                                 throws TestLinkAPIException

Gets the test case custom field value on test execution scope.

Parameters:: testCaseId - test case ID; testCaseExternalId - test case external ID; versionNumber - version number; executionId - execution ID; testPlanID - test plan ID; testProjectId - test project ID; customFieldName - custom field name; details - details
Returns:: custom field
Throws:: TestLinkAPIException - if the service returns an error

getTestCaseKeywords

public List<String> getTestCaseKeywords(Integer testProjectId,
                                        Integer testCaseId)
                                 throws TestLinkAPIException

Gets list of keywords for a given Test case

Parameters:: testProjectId - test project ID; testCaseId - test case ID
Returns:: test case keywords
Throws:: TestLinkAPIException - if the service returns an error

setTestCaseExecutionType

public Map<String,Object> setTestCaseExecutionType(Integer testProjectId,
                                                   Integer testCaseId,
                                                   Integer testCaseExternalId,
                                                   Integer versionNumber,
                                                   ExecutionType executionType)

Sets the test case execution type.

Parameters:: testProjectId - test project ID; testCaseId - test case ID; testCaseExternalId - test case external ID; versionNumber - version number; executionType - execution type
Returns:: server response map

updateTestCaseCustomFieldDesignValue

public Map<String,Object> updateTestCaseCustomFieldDesignValue(Integer testCaseId,
                                                               Integer versionNumber,
                                                               Integer testProjectId,
                                                               String customFieldName,
                                                               String customFieldValue)

Update the value of an existing custom field for a Test Case

Parameters:: testCaseId - test case ID; versionNumber - version number; testProjectId - test project ID; customFieldName - custom field name; customFieldValue - custom field value
Returns:: server response map

assignTestCaseExecutionTask

public void assignTestCaseExecutionTask(Integer testPlanId,
                                        String testCaseExternalId,
                                        String user,
                                        String buildName)
                                 throws TestLinkAPIException

Assign user to execute Test Case in Test Plan

Parameters:: testPlanId - test plan ID; testCaseExternalId - test case external ID; user - user; buildName - build name
Throws:: TestLinkAPIException - if the service returns an error

uploadRequirementSpecificationAttachment

public Attachment uploadRequirementSpecificationAttachment(Integer reqSpecId,
                                                           String title,
                                                           String description,
                                                           String fileName,
                                                           String fileType,
                                                           String content)
                                                    throws TestLinkAPIException

Uploads an attachment to a Requirement Specification.

Parameters:: reqSpecId - requirement specification ID; title - title; description - description; fileName - file name; fileType - file type; content - content
Returns:: Attachment.
Throws:: TestLinkAPIException - if the service returns an error

uploadRequirementAttachment

public Attachment uploadRequirementAttachment(Integer requirementId,
                                              String title,
                                              String description,
                                              String fileName,
                                              String fileType,
                                              String content)
                                       throws TestLinkAPIException

Uploads an attachment to a Requirement.

Parameters:: requirementId - requirement ID; title - title; description - description; fileName - file name; fileType - file type; content - content
Returns:: Attachment.
Throws:: TestLinkAPIException - if the service returns an error

assignRequirements

public void assignRequirements(Integer testCaseId,
                               Integer testProjectId,
                               List<Requirement> requirements)
                        throws TestLinkAPIException

Assign a requirements to a Test Case.

Parameters:: testCaseId - test case ID; testProjectId - test project ID; requirements - list of requirements
Throws:: TestLinkAPIException - if the service returns an error

executeXmlRpcCall
```
public Object executeXmlRpcCall(String methodName,
                                Map<String,Object> executionData)
                         throws org.apache.xmlrpc.XmlRpcException,
                                TestLinkAPIException
```
Executes a XML-RPC call. Use this method to talk with TestLink in a lower level.

Parameters:

methodName - Name of the method.

executionData - Execution data map.

Returns:

Object returned from the server.

Throws:

org.apache.xmlrpc.XmlRpcException - if the XML-RPC call is invalid

TestLinkAPIException - if the service returns an error

addTestCaseKeywords
```
public Map<String,Object> addTestCaseKeywords(Map<String,List<String>> testCaseKeywordsMap)
```
Add keywords to existing test cases.

Parameters:

testCaseKeywordsMap - - Map of testcase externalId to list of keywords

Returns:

Object returned from the server.

Throws:

TestLinkAPIException - if the service returns an error

getTestCaseBugs

public List<Integer> getTestCaseBugs(Integer testPlanId,
                                     Integer testCaseId,
                                     Integer testCaseExternalId,
                                     Integer platformId,
                                     String platformName,
                                     Integer buildId,
                                     String buildName)

Get bugs related to a test case.

Parameters:: testPlanId - test plan ID; testCaseId - test case ID; testCaseExternalId - test case external ID; platformId - platform ID; platformName - platform name; buildId - build ID; buildName - build name
Returns:: array with the ID's of bugs

Class TestLinkAPI

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TestLinkAPI

TestLinkAPI

Method Detail

getXmlRpcClient

getUrl

getDevKey

toString

checkDevKey

doesUserExist

getUserByLogin

ping

sayHello

about

setTestMode

repeat

uploadAttachment

getFullPath

getLastExecutionResult

createTestProject

getTestProjectByName

getProjectPlatforms

getProjects

getProjectTestPlans

uploadTestProjectAttachment

createTestPlan

getTestPlanByName

getTestPlanPlatforms

getTotalsForTestPlan