REST API: Specifications

Methods

getSpecificationsTree
getSpecificationForm
getSpecificationDetails
getSpecificationDetailsRevision
getSpecificationCoverageTests
getSpecificationLinkedSpecifications
getSpecificationLinkedSuts
getSpecificationLinkedRequirements
getSpecificationLinkedTests
getSpecificationLinkedBugs
getSpecificationCustomFields
getSpecificationAttachments
getSpecificationInheritedAttachments
getSpecificationRevisions
getSpecificationChanges
getSpecificationResultsTests
getSpecificationResultsTestcases
getSpecificationResultsSteps
getSpecificationFreezeStatus
createSpecification
updateSpecificationDetails
updateSpecificationsStatus
updateSpecificationsPriority
linkSpecificationToSpecifications
linkSpecificationToRequirements
linkSpecificationToTests
insertSpecificationCustomFieldValue
copySpecifications
moveSpecifications
freezeSpecification
unfreezeSpecification
signSpecification
deleteSpecifications

s
TypeVer.Command parameterParameters
Getters
GET3.3b1+ getSpecificationsTree
Example of success:
GET7+ getSpecificationsTree treeFilter=<treeFilter>
Example of success:
GET3.3b1+ getSpecificationForm
Example of success:

GET3.3b1+ getSpecificationDetails specificationId=<id>
frozen=<true|false>
Example of success:
GET3.3b1+ getSpecificationDetailsRevision specificationId=<id>
revision=<revision>
Example of success:
GET3.3b1+ getSpecificationCoverageTests sutId=<id>
Example of success:
GET3.2+ getSpecificationLinkedSpecifications specificationIds=<id, id, ...>
Example of success:
GET3.2+ getSpecificationLinkedSuts specificationIds=<id, id, ...>
Example of success:
GET3.2+ getSpecificationLinkedRequirements specificationIds=<id, id, ...>
(opt.) connectorIndex=<index>
Example of success:
GET3.2+ getSpecificationLinkedTests specificationIds=<id, id, ...>
Example of success:
GET3.2+ getSpecificationLinkedBugs specificationIds=<id, id, ...>
(opt.) connectorIndex=<index>
Example of success:
GET3.0+ getSpecificationCustomFields specificationId=<id>
Example of success:
GET3.0+ getSpecificationAttachments specificationId=<id>
Example of success:
GET3.0+ getSpecificationInheritedAttachments specificationId=<id>
Example of success:
GET3.0+ getSpecificationRevisions specificationId=<id>
Example of success:
GET3.0+ getSpecificationChanges specificationId=<id>
Example of success:
GET5+ getSpecificationResultsTests specificationId=<id>
Example of success:
GET5+ getSpecificationResultsTestcases specificationId=<id>
Example of success:
GET5+ getSpecificationResultsSteps specificationId=<id>
Example of success:
GET6+ getSpecificationFreezeStatus specificationId=<id>
Example of success:
Setters
POST3.3b1+createSpecification parentFolderId=<id>
Content of the form with values
(see getSpecificationForm)
must be passed in the request's body
as multi-part.

Example of success:
POST3.3b1+updateSpecificationDetails Content of the form with values
(see getSpecificationDetails)
must be passed in the request's body
as multi-part.
Example of success:

Example of failure:
POST5+updateSpecificationsStatus specificationIds=<id, id, ...>
status=<specificationStatus>
Example of success:

Example of failure:
POST5+updateSpecificationsPriority specificationIds=<id, id, ...>
priority=<specificationPriority>
Example of success:

Example of failure:
POST5+updateSpecificationStatus specificationId=<id>
status=<specificationStatus>
Example of success:

Example of failure:
POST5+updateSpecificationPriority specificationId=<id>
priority=<specificationPriority>
Example of success:

Example of failure:
POST3.2+linkSpecificationToSpecifications specificationId=<id>

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:
POST3.2+linkSpecificationToRequirements specificationId=<id>
(opt.) connectorIndex=<index>

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:
POST3.2+linkSpecificationToTests specificationId=<id>

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:
POST3.2+insertSpecificationCustomFieldValue specificationId=<id>
type=<customFieldType>
customFieldId=<id>
customFieldValue=<value>...
Example of success:
POST?copySpecifications specificationIds=<id, id, ...>
destParentFolderId=<id>
Example of success:
POST3.2sp3+moveSpecifications specificationIds=<id, id, ...>
specificationNames=<name, name, ...>
destParentFolderId=<id>
Example of success:
POST3.0+freezeSpecification specificationId=<id>
Example of success:
POST3.0+unfreezeSpecification specificationId=<id>
Example of success:
GET? signSpecification
Example of success:
POST3.0+deleteSpecifications specificationIds=<id, id, ...>
Example of success: