DevSpec 10.1 REST API documentation

This is the reference document for the REST API and resources provided by TechExcel, Inc. To Test Page

Index

This documents the current REST API provided by TechExcel. Inc.

Resources

/ReqItemList

Methods

POST

DevSpecAPI/ReqItemList

Search the applicable requirements in a requirement folder

request query parameters

available response representations:

/ReqItem

Methods

GET

DevSpecAPI/ReqItem?ProjectID=144&ItemID=1330

Get the selected requirement info.

available response representations:

POST

DevSpecAPI/ReqItem

Create the requirement item

request query parameters

available response representations:

PUT

DevSpecAPI/ReqItem

Update the requirement item

request query parameters

available response representations:

DELETE

DevSpecAPI/ReqItem?ProjectID=144&ItemIDs=1,2,3

available response representations:

/ReqFolderTree

Methods

GET

DevSpecAPI/ReqFolderTree?ProjectID=144

Return the requirement folder tree.

available response representations:

/ReqFolderChild

Methods

POST

DevSpecAPI/ReqFolderChild

Return the selected folder child folder tree

request query parameters

available response representations:

/ReqFolder

Methods

GET

DevSpecAPI/ReqFolder?ProjectID=144&FolderID=73

Get the selected requirement folder info.

available response representations:

POST

DevSpecAPI/ReqFolder

Create requirement folder

request query parameters

available response representations:

PUT

DevSpecAPI/ReqFolder

Update the requirement folder

request query parameters

available response representations:

DELETE

DevSpecAPI/ReqFolder?ProjectID=144&FolderID=7

available response representations:

/ReqNoteList

Methods

POST

DevSpecAPI/ReqNoteList

Search the applicable requirements in the requirement note list

request query parameters

available response representations:

/ReqNote

Methods

GET

DevSpecAPI/ReqNote?ProjectID=144&ItemID=1330&NoteID=54

Get the selected requirement note.

available response representations:

POST

DevSpecAPI/ReqNote

Create requirement note

request query parameters

available response representations:

PUT

DevSpecAPI/ReqNote

Update the requirement note

request query parameters

available response representations:

DELETE

DevSpecAPI/ReqNote?ProjectID=144&ItemID=1058&NoteID=84

available response representations:

/ReqDocument

Methods

GET

DevSpecAPI/ReqDocument?ProjectID=144&FileID=1&VersionID=0

Get the requirement's document.

available response representations:

POST

DevSpecAPI/ReqDocument?ProjectID=144&ItemID=1&FileName=file1.doc

Add requirement's document

request query parameters

available response representations:

DELETE

DevSpecAPI/ReqDocument?ProjectID=144&ItemID=1058&FileID=84

available response representations:

/ReqAttachment

Methods

GET

DevSpecAPI/ReqAttachment?ProjectID=144&FileID=1&VersionID=0

Get the requirement note's Attachment.

available response representations:

POST

DevSpecAPI/ReqAttachment?ProjectID=144&NoteID=1&FileName=file1.doc&ItemID=90

Add requirement note Attachment

request query parameters

available response representations:

DELETE

DevSpecAPI/ReqAttachment?ProjectID=144&FileID=84&NoteID=88

available response representations:

/ReqDocumentInfo

Methods

POST

DevSpecAPI/ReqDocumentInfo

Search the applicable requirements in the ReqDocumentInfo

request query parameters

available response representations:

/ReqAttachmentInfo

Methods

POST

DevSpecAPI/ReqAttachmentInfo

Search the applicable requirements in the ReqAttachmentInfo

request query parameters

available response representations:

/Project

Methods

POST

DevSpecAPI/Project

Search the applicable requirements in the Project

request query parameters

available response representations:

/ProjectReload

Methods

POST

DevSpecAPI/ProjectReload

Search the applicable requirements in the ProjectReload

request query parameters

available response representations:

/ReqAllLink

Methods

GET

DevSpecAPI/ReqAllLink?ProjectID=144&ItemID=1358

Return the requirement All Links

available response representations:

POST

DevSpecAPI/ReqAllLink

Add DevTest Template Link

request query parameters

available response representations:

DELETE

DevSpecAPI/ReqAllLink?ProjectID=144&ItemID=1376&DevTestProjectID=2&DevTestTemplateID=30

available response representations:

/KWItemList

Methods

POST

DevSpecAPI/KWItemList

Search the applicable knowledges in a knowledge folder

request query parameters

available response representations:

/KWItem

Methods

GET

DevSpecAPI/KWItem?ProjectID=21&ItemID=105

Get the selected knowledge info.

available response representations:

POST

DevSpecAPI/KWItem

Create the knowledge item

request query parameters

available response representations:

PUT

DevSpecAPI/KWItem

Update the knowledge item

request query parameters

available response representations:

DELETE

DevSpecAPI/KWItem?ProjectID=184&ItemIDs=1,2,3

available response representations:

/KWFolderTree

Methods

GET

DevSpecAPI/KWFolderTree?ProjectID=21

Return the knowledge folder tree.

available response representations:

/KWFolderChild

Methods

POST

DevSpecAPI/KWFolderChild

Return the selected folder child folder tree.

request query parameters

available response representations:

/KWFolder

Methods

GET

DevSpecAPI/KWFolder?ProjectID=21&FolderID=152

Get the selected knowledge folder info.

available response representations:

POST

DevSpecAPI/KWFolder

Create knowledge folder

request query parameters

available response representations:

PUT

DevSpecAPI/KWFolder

Update the requirement folder

request query parameters

available response representations:

DELETE

DevSpecAPI/KWFolder?ProjectID=184&FolderID=145

available response representations:

/KWNoteList

Methods

POST

DevSpecAPI/KWNoteList

Search the applicable requirements in the knowledge note list

request query parameters

available response representations:

/KWNote

Methods

GET

DevSpecAPI/ReqNote?ProjectID=21&ItemID=76&NoteID=55

Get the selected knowledge note.

available response representations:

POST

DevSpecAPI/KWNote

Create requirement note

request query parameters

available response representations:

PUT

DevSpecAPI/KWNote

Update the requirement note

request query parameters

available response representations:

DELETE

DevSpecAPI/KWNote?ProjectID=184&ItemID=96&NoteID=85

available response representations:

/KWDocument

Methods

GET

DevSpecAPI/KWDocument?ProjectID=184&FileID=1&VersionID=0

Get the knowledge's document.

available response representations:

POST

DevSpecAPI/KWDocument?ProjectID=184&ItemID=1&FileName=file1.doc

Add knowledge's document

request query parameters

available response representations:

DELETE

DevSpecAPI/KWDocument?ProjectID=184&ItemID=96&FileID=84

available response representations:

/KWAttachment

Methods

GET

DevSpecAPI/KWAttachment?ProjectID=184&FileID=1&VersionID=0

Get the knowledge note's Attachment.

available response representations:

POST

DevSpecAPI/KWAttachment?ProjectID=184&NoteID=1&FileName=file1.doc&ItemID=90

Add knowledge note Attachment

request query parameters

available response representations:

DELETE

DevSpecAPI/KWAttachment?ProjectID=184&FileID=84&NoteID=88

available response representations:

/KWDocumentInfo

Methods

POST

DevSpecAPI/KWDocumentInfo

Search the applicable requirements in the KWDocumentInfo

request query parameters

available response representations:

/KWAttachmentInfo

Methods

POST

DevSpecAPI/KWAttachmentInfo

Search the applicable requirements in the KWAttachmentInfo

request query parameters

available response representations:

/DevTestTemplateProject

Methods

GET

DevSpecAPI/DevTestTemplateProject?SpecProjID=144

Get DevSpec Linked DevTest Template projects.

available response representations:

/DevTestTemplateItemList

Methods

GET

DevSpecAPI/DevTestTemplateItemList?ProjectID=2

Get DevTest Template item list.

available response representations:

Status Code

Status Code Meaning
200 OK
203 NonAuthoritativeInformation
201 Created
401 Unauthorized
404 NotFound
406 NotAcceptable
415 UnsupportedMediaType

Top