deleteRequirementDocument

Deletes a requirement document from the project based on number or name. You can also delete all requirements in the document. A SOAP error envelope is returned if the operation fails.

Parameters

Parameter Type Description
cookie long Session cookie returned by projectLogon.
documentNumber long Number of the document to delete. Set as 0 to search by name.
name string Name of the document to delete. If the name matches more than one document, the operation fails. This field is ignored unless documentNumber is 0.
bDeleteAssociatedRequirements boolean Indicates if all requirements in the document should be deleted.

Return value

Value Type Notes
result int 0 indicates success. Check the return value in case of an error.

Example

ttsdk.deleteRequirementDocument(cookie, 0, "Requirement document name", false);