REST API: Specifications

Methods


TypeVer.Command parameterParameters
Getters
GET3.3b1+ getSpecificationsTree
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, ...>
Example of success:

GET3.2+ getSpecificationLinkedTests specificationIds=<id, id, ...>
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:

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+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>
specificationIds=<id, id, ...>
Example of success:

Example of failure:
POST3.2+linkSpecificationToRequirements specificationId=<id>
requirementIds=<id, id, ...>
Example of success:

Example of failure:
POST3.2+linkSpecificationToTests specificationId=<id>
testIds=<id, id, ...>
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.3b1+copySpecifications specificationIds=<id, id, ...>
destParentFolderId=<id>
Example of success:

POST3.3b1+moveSpecifications specificationIds=<id, id, ...>
destParentFolderId=<id>
Example of success:

POST3.0+freezeSpecification specificationId=<id>
Example of success:

POST3.0+unfreezeSpecification specificationId=<id>
Example of success:

POST3.0+deleteSpecifications specificationIds=<id, id, ...>
Example of success: