REST API: Requirements

Methods


TypeVer.Command parameterParameters
Getters
GET5beta2+ getRequirementTypes
Example of success:

GET3.0b1+ getRequirementsTree
Example of success:

GET3.0sp6+ getRequirementForm
Example of success:

GET3.3+ getGenericRequirementForm
Example of success:

GET5.0b0+ getExternalRequirementForm
Example of success:

GET3.0b3+ getRequirementDetails requirementId=<id>
frozen=<true|false>
Example of success:

GET3.0sp7+ getRequirementDetailsRevision requirementId=<id>
revision=<revision>
Example of success:

GET3.0b3+ getRequirementCustomFields requirementId=<id>
Example of success:

GET3.3b1+ getRequirementCoverageSpecifications sutId=<id>
Example of success:

GET3.3b1+ getRequirementCoverageTests sutId=<id>
Example of success:

GET3.0b3+ getRequirementLinkedRequirements requirementIds=<id, id, ...>
Example of success:

GET3.2+ getRequirementLinkedSuts requirementIds=<id, id, ...>
Example of success:

GET3.2+ getRequirementLinkedSpecifications requirementIds=<id, id, ...>
Example of success:

GET3.2+ getRequirementLinkedTests requirementIds=<id, id, ...>
Example of success:

GET3.0b3+ getRequirementAttachments requirementId=<id>
Example of success:

GET3.0b3+ getRequirementInheritedAttachments requirementId=<id>
Example of success:

GET3.0b3+ getRequirementRevisions requirementId=<id>
Example of success:

GET3.0b3+ getRequirementChanges requirementId=<id>
Example of success:

GET5+ getRequirementResultsTests requirementId=<id>
Example of success:

GET5+ getRequirementResultsTestcases requirementId=<id>
Example of success:

GET5+ getRequirementResultsSteps requirementId=<id>
Example of success:

Setters
POST3.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
POST3.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
POST5.0b0+createExternalRequirement projectName=<name>
Content of the form with values
(see getExternlRequirementForm)
must be passed in the request's body
as multi-part.
Example of success:

POST3.0sp6+updateRequirementDetails 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:
POST5+updateRequirementStatus requirementId=<id>
status=<requirementStatus>
Example of success:

Example of failure:
POST5+updateRequirementPriority requirementId=<id>
priority=<requirementPriority>
Example of success:

Example of failure:
POST5+updateRequirementRisk requirementId=<id>
risk=<risk>
Example of success:

Example of failure:
POST5+updateRequirementType requirementId=<id>
type=<requirementType>
Example of success:

Example of failure:
POST3.2b0linkRequirementToRequirements requirementId=<id>
requirementIds=<id, id, ...>
Example of success:

Example of failure:
POST3.2b0linkRequirementToSuts requirementId=<id>
sutIds=<id, id, ...>
Example of success:

Example of failure:
POST3.2b0linkRequirementToSpecifications requirementId=<id>
sutIds=<id, id, ...>
Example of success:

Example of failure:
POST3.2b0linkRequirementToTests requirementId=<id>
sutIds=<id, id, ...>
Example of success:

Example of failure:
POST3.0+insertRequirementCustomFieldValue requirementId=<id>
type=<customFieldType>
customFieldId=<id>
customFieldValue=<value>
Example of success:

POST3.0+copyRequirements requirementIds=<id, id, ...>
destParentFolderId=<id>
Example of success:

POST3.0+moveRequirements requirementIds=<id, id, ...>
destParentFolderId=<id>
Example of success:

POST3.0+freezeRequirement requirementId=<id>
Example of success:

POST?signRequirement requirementId=<id>
Example of success:

POST3.0+unfreezeRequirement requirementId=<id>
Example of success:

POST3.0+deleteRequirements requirementIds=<id, id, ...>
Example of success: