- Introduction
- Authentication
- Users
- Teams
- SUTs
- Requirements
- Specifications
- Tests
- Test Attributes
- Gherkin Steps
- Test Scanner
- Test cases
- Test case Parameters
- Testcases referencing reusable testcases
- Campaigns
- Schedules
- Sessions
- Bugs
- Assets
- Agents
- SQL Reports
- Dashboard
- New Features
- Reports
- Folders
- Companies
- Categories
- Versioning
- Attachments
- Embedded Images
- Custom Fields
- Search
- Discussion threads
- Summary (Pre-formatted HTML)
- Miscellaneous
- Types
Methods
getRequirementTypes
getRequirementsTree
getRequirementForm
getGenericRequirementForm
getExternalRequirementForm
getRequirementDetails
getRequirementDetailsRevision
getRequirementCoverageSpecifications
getRequirementCoverageTests
getRequirementLinkedRequirements
getRequirementLinkedSuts
getRequirementLinkedSpecifications
getRequirementLinkedTests
getRequirementLinkedBugs
getRequirementRelatedSpecifications
getRequirementCustomFields
getRequirementsTree
getRequirementForm
getGenericRequirementForm
getExternalRequirementForm
getRequirementDetails
getRequirementDetailsRevision
getRequirementCoverageSpecifications
getRequirementCoverageTests
getRequirementLinkedRequirements
getRequirementLinkedSuts
getRequirementLinkedSpecifications
getRequirementLinkedTests
getRequirementLinkedBugs
getRequirementRelatedSpecifications
getRequirementCustomFields
getRequirementAttachments
getRequirementInheritedAttachments
getRequirementRevisions
getRequirementChanges
getRequirementResultsTests
getRequirementResultsTestcases
getRequirementResultsSteps
getRequirementFreezeStatus
createRequirement
createGenericRequirement
createExternalRequirement
updateRequirementDetails
updateRequirementsStatus
updateRequirementsPriority
updateRequirementsRisk
getRequirementInheritedAttachments
getRequirementRevisions
getRequirementChanges
getRequirementResultsTests
getRequirementResultsTestcases
getRequirementResultsSteps
getRequirementFreezeStatus
createRequirement
createGenericRequirement
createExternalRequirement
updateRequirementDetails
updateRequirementsStatus
updateRequirementsPriority
updateRequirementsRisk
updateRequirementsType
linkRequirementToRequirements
linkRequirementToSuts
linkRequirementToSpecifications
linkRequirementToTests
insertRequirementCustomFieldValue
copyRequirements
moveRequirements
moveGenericRequirements
freezeRequirement
unfreezeRequirement
signRequirement
deleteRequirements
deleteGenericRequirements
linkRequirementToRequirements
linkRequirementToSuts
linkRequirementToSpecifications
linkRequirementToTests
insertRequirementCustomFieldValue
copyRequirements
moveRequirements
moveGenericRequirements
freezeRequirement
unfreezeRequirement
signRequirement
deleteRequirements
deleteGenericRequirements
| Type | Ver. | Command parameter | Parameters |
| Getters | |||
| GET | 5beta2+ | getRequirementTypes | |
|
Example of success: | |||
| GET | 7+ | getRequirementTypes | treeFilter=<treeFilter> |
|
Example of success: | |||
| GET | 3.0b1+ | getRequirementsTree | (opt.) connectorIndex=<index> |
|
Example of success: |
|||
| GET | 3.0sp6+ | getRequirementForm | |
|
Example of success: | |||
| GET | 3.3+ | getGenericRequirementForm | |
|
Example of success: | |||
| GET | 5.0b0+ | getExternalRequirementForm | (opt.) connectorIndex=<index> |
|
Example of success: | |||
| GET | 3.0b3+ | getRequirementDetails | requirementId=<id> frozen=<true|false> (opt.) connectorIndex=<index> |
|
Example of success: |
|||
| GET | 3.0sp7+ | getRequirementDetailsRevision | requirementId=<id> revision=<revision> |
|
Example of success: |
|||
| GET | 3.0b3+ | getRequirementCustomFields | requirementId=<id> |
|
Example of success: |
|||
| GET | 3.3b1+ | getRequirementCoverageSpecifications | sutId=<id> (opt.) connectorIndex=<index> |
|
Example of success: |
|||
| GET | 3.3b1+ | getRequirementCoverageTests | sutId=<id> (opt.) connectorIndex=<index> |
|
Example of success: |
|||
| GET | 3.0b3+ | getRequirementLinkedRequirements | requirementIds=<id, id, ...> (opt.) connectorIndex=<index> |
|
Example of success: |
|||
| GET | 3.2+ | getRequirementLinkedSuts | requirementIds=<id, id, ...> (opt.) connectorIndex=<index> |
|
Example of success: |
|||
| GET | 3.2+ | getRequirementLinkedSpecifications | requirementIds=<id, id, ...> (opt.) connectorIndex=<index> |
|
Example of success: |
|||
| GET | 3.2+ | getRequirementLinkedTests | requirementIds=<id, id, ...> (opt.) connectorIndex=<index> |
|
Example of success: |
|||
| GET | 6+ | getRequirementLinkedBugs | requirementIds=<id, id, ...> (opt.) connectorIndex=<index> |
|
Example of success: |
|||
| GET | 10+ | getRequirementRelatedSpecifications | requirementIds=<id, id, ...> (opt.) connectorIndex=<index> |
|
Example of success: |
|||
| GET | 3.0b3+ | getRequirementAttachments | requirementId=<id> |
|
Example of success: |
|||
| GET | 3.0b3+ | getRequirementInheritedAttachments | requirementId=<id> |
|
Example of success: |
|||
| GET | 3.0b3+ | getRequirementRevisions | requirementId=<id> |
|
Example of success: |
|||
| GET | 3.0b3+ | getRequirementChanges | requirementId=<id> |
|
Example of success: |
|||
| GET | 5+ | getRequirementResultsTests | requirementId=<id> (opt.) connectorIndex=<index> |
|
Example of success: |
|||
| GET | 5+ | getRequirementResultsTestcases | requirementId=<id> (opt.) connectorIndex=<index> |
|
Example of success: |
|||
| GET | 5+ | getRequirementResultsSteps | requirementId=<id> (opt.) connectorIndex=<index> |
|
Example of success: |
|||
| GET | 6+ | getRequirementFreezeStatus | requirementId=<id> |
|
Example of success: |
|||
| Setters | |||
| POST | 3.0+ | createRequirement | parentFolderId=<id> Content of the form with values (see getRequirementForm) must be passed in the request's body as multi-part. |
|
Example of success: |
|||
| Setters | |||
| POST | 3.3+ | createGenericRequirement | parentFolderId=<id> Content of the form with values (see getGenericRequirementForm) must be passed in the request's body as multi-part. |
|
Example of success: |
|||
| Setters | |||
| POST | 5.0b0+ | createExternalRequirement | projectName=<name> Content of the form with values (see getExternlRequirementForm) must be passed in the request's body as multi-part. (opt.) connectorIndex=<index> |
|
Example of success: |
|||
| POST | 3.0sp6+ | update Requirement Details | Content of the form with values (see getRequirementDetails) must be passed in the request's body as multi-part. |
|
Example of success: Example of failure: | |||
| POST | 5+ | updateRequirementsStatus | requirementIds=<id, id, ...> status=<requirementStatus> |
|
Example of success: Example of failure: | |||
| POST | 5+ | updateRequirementsPriority | requirementIds=<id, id, ...> priority=<requirementPriority> |
|
Example of success: Example of failure: | |||
| POST | 5+ | updateRequirementsRisk | requirementIds=<id, id, ...> risk=<risk> |
|
Example of success: Example of failure: | |||
| POST | 5+ | updateRequirementsType | requirementIds=<id, id, ...> type=<requirementType> |
|
Example of success: Example of failure: | |||
| POST | 10+ | linkRequirementToRequirements |
requirementId=<id> (opt.) connectorIndex1=<index> (source requirement) (opt.) connectorIndex2=<index> (destination requirements) The list of the requirement Ids must be passed in the request's body in the object list format |
|
Example of success: Example of failure: | |||
| POST | 3.2b0 | linkRequirementToSuts |
requirementId=<id> (opt.) connectorIndex=<index> The list of the SUT Ids must be passed in the request's body in the object list format |
|
Example of success: Example of failure: | |||
| POST | 3.2b0 | linkRequirementToSpecifications |
requirementId=<id> (opt.) connectorIndex=<index> The list of the specification Ids must be passed in the request's body in the object list format |
|
Example of success: Example of failure: | |||
| POST | 3.2b0 | linkRequirementToTests |
requirementId=<id> (opt.) connectorIndex=<index> The list of the test Ids must be passed in the request's body in the object list format |
|
Example of success: Example of failure: | |||
| POST | 3.0+ | insertRequirementCustomFieldValue | requirementId=<id> type=<customFieldType> customFieldId=<id> customFieldValue=<value> |
|
Example of success: |
|||
| POST | 3.0+ | copyRequirements | requirementIds=<id, id, ...> destParentFolderId=<id> |
|
Example of success: |
|||
| POST | 3.0+ | moveRequirements | requirementIds=<id, id, ...> destParentFolderId=<id> |
|
Example of success: |
|||
| POST | 9+ | moveGenericRequirements | requirementIds=<id, id, ...> destParentFolderId=<id> |
|
Example of success: |
|||
| POST | 3.0+ | freezeRequirement | requirementId=<id> |
|
Example of success: |
|||
| POST | ? | signRequirement | requirementId=<id> |
|
Example of success: |
|||
| POST | 3.0+ | unfreezeRequirement | requirementId=<id> |
|
Example of success: |
|||
| POST | 3.0+ | deleteRequirements | requirementIds=<id, id, ...> |
|
Example of success: |
|||
| POST | 9+ | deleteGenericRequirements | requirementIds=<id, id, ...> |
|
Example of success: |
|||