DevSpec 10.1.2 REST API Documentation

request query parameters

• application/json [expand]

  Example

  {"ProjectID":144,"FolderID":41,
  	"ShowAll": 1,
  	"PageIndex": "1",
  	"PageSize": "10",
  	"Fields": ["ProjectID", "ID", "Title", "Status", "Spec Owner", "Spec OwnerID", "Planned Start Date", "Planned Finish Date", "Date Last Modified", "StateID", "Points", "Priority Value", "Finish"],
  	"SortFields": ["1101"],
  	"SortOrder": [1],
  	"KeyWord": "1486,1487",
  	"SupportFieldID": 1,
      "LinkedTestTempFolderID":1
  }

• 200 Search OK [expand]

  Example

  {"TotalCount":1,"CurrentPage":0,"PageSize":50,"ListItems":[{"ID":"1325","Title":"zzzzzzzzzzz","Status":"To
                              be Committed"}]}

• 406 Search Item List Error [expand]
  Error Message
• 401 [expand]
  The request is forbidden if the user token is invalid.

• 200 Get OK[expand]

  Example

  {"ProjectID":144,"FolderID":36,"FolderName":"Improvements","FolderPath":["Instant Messenger v1.0","Improvements"],"Title":"Updatexxxx API Created Spec2","Description":"kkkkkk",
                          "Assigned by":"","Last Modified by":"Terry Johnson","Created by":"Terry Johnson","ID":1330,"Spec Owner":"","Status":"In Development","Spec Type":"Spec","External ID":"","Time Estimate":2,"Points":3,
                          "Priority Value":4,"Planned Start Date":null,"Planned Finish Date":null}

• 404 Not Found [expand]
  item not exist.
• 401 [expand]
  The request is forbidden if the user token is invalid.

request query parameters

• application/json [expand]

  Example

  {"ProjectID":144,"FolderID":36,"FolderPath":["Instant Messenger v1.0","Improvements"],"Title":"Created API Created Spec2","FolderName":"Improvements","Description":"kkkkkk","Assigned by":"","Last Modified by":"Terry Johnson",
                          "Created by":"Terry Johnson","Spec Owner":"","Status":"In Development","Spec Type":"Spec","External ID":"","Time Estimate":2,"Points":3,"Priority Value":4,"Planned Start Date":null,"Planned Finish Date":null}

• 201 Create OK [expand]
  New ItemID
• 203 Item Title is empty[expand]
  Item Title can not been empty
• 406 Created Error[expand]
  Error message.
• 401 [expand]
  The request is forbidden if the user token is invalid.

request query parameters

• application/json[expand]

  Example

  {"ProjectID":144,"FolderID":36,"FolderPath":["Instant Messenger v1.0","Improvements"],"ID":1330,"FolderName":"Improvements","Title":"Update222 API Created Spec2","Description":"kkkkkk","Assigned by":"",
                          "Last Modified by":"Terry Johnson","Created by":"Terry Johnson","Spec Owner":"","Status":"In Development","Spec Type":"Spec","External ID":"","Time Estimate":2,"Points":3,"Priority Value":4,"Planned Start Date":null,"Planned Finish Date":null}

• 200 Update OK [expand]
  Update OK
• 404 Not Found [expand]
  Not Exist!
• 406 Update Error [expand]
  Error message
• 401 [expand]
  The request is forbidden if the user token is invalid.

• 200 Get OK [expand]

  Example

  {"FolderNodes":[{"FolderID":1,"FolderName":"Spec Root","FolderStatusID":0,"FolderNodes":[{"FolderID":2,"FolderName":"Content
                              Sharing Manager v1.0","FolderStatusID":1,"FolderNodes":[{"FolderID":4,"FolderName":"Customer
                              Requests","FolderStatusID":1,"FolderNodes":[]},{"FolderID":20,"FolderName":"Internal
                              Feature Enhancement","FolderStatusID":1,"FolderNodes":[]},{"FolderID":33,"FolderName":"Requirements
                              using Word Addin","FolderStatusID":1,"FolderNodes":[]}]},{"FolderID":17,"FolderName":"Content
                              Sharing Manager v2.0","FolderStatusID":1,"FolderNodes":[{"FolderID":5,"FolderName":"Roadmap","FolderStatusID":1,"FolderNodes":[]}]},{"FolderID":14,"FolderName":"Instant
                              Messenger v1.0","FolderStatusID":1,"FolderNodes":[{"FolderID":6,"FolderName":"Improvements","FolderStatusID":1,"FolderNodes":[]}]},{"FolderID":18,"FolderName":"Instant
                              Messenger v2.0","FolderStatusID":1,"FolderNodes":[]},{"FolderID":35,"FolderName":"ddd","FolderStatusID":0,"FolderNodes":[{"FolderID":40,"FolderName":"AA","FolderStatusID":0,"FolderNodes":[{"FolderID":42,"FolderName":"test
                              folder AAA BB","FolderStatusID":1,"FolderNodes":[{"FolderID":62,"FolderName":"API
                              add folder 3","FolderStatusID":1,"FolderNodes":[]},{"FolderID":70,"FolderName":"API
                              add folder 222","FolderStatusID":1,"FolderNodes":[]},{"FolderID":71,"FolderName":"API
                              add folder 222","FolderStatusID":1,"FolderNodes":[]},{"FolderID":72,"FolderName":"API
                              add folder 12","FolderStatusID":1,"FolderNodes":[]}]},{"FolderID":43,"FolderName":"cccc","FolderStatusID":1,"FolderNodes":[]},{"FolderID":44,"FolderName":"ddd","FolderStatusID":1,"FolderNodes":[]},{"FolderID":45,"FolderName":"eeee","FolderStatusID":1,"FolderNodes":[]},{"FolderID":53,"FolderName":"ccccc","FolderStatusID":1,"FolderNodes":[]},{"FolderID":54,"FolderName":"xxxxxxxxxxxxxxxxxxxxxx","FolderStatusID":1,"FolderNodes":[]},{"FolderID":55,"FolderName":"zzzzz","FolderStatusID":1,"FolderNodes":[]},{"FolderID":56,"FolderName":"API
                              add folder 2","FolderStatusID":1,"FolderNodes":[]},{"FolderID":57,"FolderName":"API
                              add folder 3","FolderStatusID":1,"FolderNodes":[]},{"FolderID":58,"FolderName":"API
                              update folder 33","FolderStatusID":1,"FolderNodes":[]},{"FolderID":59,"FolderName":"ccc","FolderStatusID":1,"FolderNodes":[]},{"FolderID":60,"FolderName":"API
                              add folder 3","FolderStatusID":1,"FolderNodes":[]},{"FolderID":61,"FolderName":"xyz","FolderStatusID":1,"FolderNodes":[]},{"FolderID":69,"FolderName":"API
                              add folder 1111","FolderStatusID":1,"FolderNodes":[]},{"FolderID":73,"FolderName":"Update
                              Test folder123","FolderStatusID":1,"FolderNodes":[]},{"FolderID":74,"FolderName":"API
                              Create Test folder123","FolderStatusID":1,"FolderNodes":[]}]},{"FolderID":41,"FolderName":"folder
                              b","FolderStatusID":0,"FolderNodes":[]},{"FolderID":49,"FolderName":"API add folder
                              2","FolderStatusID":1,"FolderNodes":[]},{"FolderID":50,"FolderName":"API add folder
                              3","FolderStatusID":1,"FolderNodes":[]},{"FolderID":51,"FolderName":"API add folder
                              3","FolderStatusID":1,"FolderNodes":[]}]},{"FolderID":46,"FolderName":"space1","FolderStatusID":1,"FolderNodes":[]}]},{"FolderID":11,"FolderName":"Template
                              Root","FolderStatusID":0,"FolderNodes":[]},{"FolderID":75,"FolderName":"Idea Books","FolderStatusID":0,"FolderNodes":[]},{"FolderID":28,"FolderName":"Document
                              Templates","FolderStatusID":0,"FolderNodes":[{"FolderID":29,"FolderName":"Attachment
                              Templates","FolderStatusID":0,"FolderNodes":[{"FolderID":52,"FolderName":"document
                              folder1","FolderStatusID":1,"FolderNodes":[]}]},{"FolderID":30,"FolderName":"Epic
                              Document Templates","FolderStatusID":0,"FolderNodes":[]}]}]}

• 404 Not Found [expand]
  item not exist.
• 401 [expand]
  The request is forbidden if the user token is invalid.

request query parameters

• application/json [expand]

  Example

  { "ProjectID":144,"FolderID":2 } 

• 200 Get OK [expand]

  Example

  { "FolderNodes":[{"FolderID":4,"FolderName":"Customer Requests","FolderOwnerSameAsParent":null,"FolderOwnerSelectionOption":null,"FolderAccessSameAsParent":1,"AccessFolderType":0,"ChildNumber":0,"TypeID":0,"WikiBookOption":null,"ReadyforWikiBook":null,"FolderDescription":null,"FolderDescriptionHTML":null,"ProductVersionFolderType":0,"MyDevSuiteAccessOption":0,"FolderNodes":[],"FileID":0,"EnableWikiBook":0,"FolderStatusID":1,"ChildItemIDs":null,"KloudFolderID":null,"KloudFolderType":null,"IsInChangeRequest":null},
                          {"FolderID":20,"FolderName":"Internal Feature Enhancement","FolderOwnerSameAsParent":1,"FolderOwnerSelectionOption":0,"FolderAccessSameAsParent":1,"AccessFolderType":0,"ChildNumber":0,"TypeID":0,"WikiBookOption":null,"ReadyforWikiBook":null,"FolderDescription":null,"FolderDescriptionHTML":null,"ProductVersionFolderType":0,"MyDevSuiteAccessOption":0,"FolderNodes":[],"FileID":0,"EnableWikiBook":0,"FolderStatusID":1,"ChildItemIDs":null,"KloudFolderID":null,"KloudFolderType":null,"IsInChangeRequest":null}],"ChildNumber":0 } 

• 401 [expand]
  The request is forbidden if the user token is invalid.

request query parameters

• application/json [expand]

  Example

  {"ProjectID":144,"FolderID":42,"ShowAll":1,"Query":[{"Name":"FolderID","Operate":">=","choices":"70"},{"Name":"FolderName","Operate":"LIKE","choices":"222"}]}

• 200 Get OK [expand]

  Example

  {"FolderNodes":[{"FolderID":70,"FolderName":"API add folder1","ChildNumber":0,"FolderStatusID":"Open","FolderNodes":[]},{"FolderID":71,"FolderName":"API add folder2","ChildNumber":0,"FolderStatusID":"Open","FolderNodes":[]}]}

• 401 [expand]
  The request is forbidden if the user token is invalid.
• 404 [expand]
  Not Found

• 200 Get Folder OK [expand]

  Example

  {"ProjectID":144,"Folder Name":"Improvements","Folder Description":"desc123","Folder Status":"Open","Is Read-only":null,"Folder Product/Version":0,"Release Info":0,"FolderID":36,
                          "FolderPath":["Instant Messenger v1.0","Improvements"],"Same as Parent":1,"PlanStartDate":null,"PlanEndDate":null,"DefaultKWKTemplateID":null,"TypeID":0}

• 404 Folder Not Exist [expand]
  Folder Not Exist.
• 401 [expand]
  The request is forbidden if the user token is invalid.

request query parameters

• application/json [expand]

  Example

  {"ProjectID":144,"ParentFolderID":40,"Folder Name":"Improvements","ParentFolderPath":["Instant Messenger v1.0","Improvements"],"Position":"Normal","Folder Description":"desc123","Folder Status":"Open","Is Read-only":null,
                          "Folder Product/Version":0,"Release Info":0,"Same as Parent":1,"TypeID":0}

• 201 Created OK [expand]
  New FolderID
• 203 Folder Name Empty [expand]
  Folder name can not been empty.
• 406 Create Error [expand]
  0
• 401 [expand]
  The request is forbidden if the user token is invalid.

request query parameters

• application/json [expand]

  Example

  {"ProjectID":144,"Folder Name":"Improvements","FolderID":36,"FolderPath":["Instant Messenger v1.0","Improvements"],"Folder Description":"desc123333",
                          "Folder Status":"Open","Is Read-only":null,"Folder Product/Version":0,"Release Info":0,"Same as Parent":1,"TypeID":0}

• 200 Update OK [expand]
  Update OK
• 203 Folder Name Empty [expand]
  Folder name can not been empty.
• 406 Update Error[expand]
  Error Message
• 401 [expand]
  The request is forbidden if the user token is invalid.

request query parameters

• application/json [expand]

  Example

  {"ProjectID":144,"ItemID":1330}

• 200 Search OK [expand]

  Example

  {
      "NoteItems": [
          {
              "ProjectID": 144,
              "ItemID": 1299,
              "NoteID": 94,
              "Title": "Comments",
              "Created By": "Terry Johnson",
              "CreatedByID":13,
              "Created Date": "2017-11-21T09:48:29.433",
              "Description": "PHA+bm90ZTE8L3A+Cg==",
              "ReplyUserID": 0,
              "ReplyUser": "",
              "ChildNoteItems": [
                  {
                      "ProjectID": 144,
                      "ItemID": 1299,
                      "NoteID": 95,
                      "Title": "Comments",
                      "Created By": "Terry Johnson",
                      "CreatedByID":13,
                      "Created Date": "2017-11-21T09:48:39.74",
                      "Description": "PHA+bm90ZTEgcmVwbHkxPC9wPgo=",
                      "ReplyUserID": 0,
                      "ReplyUser": "",
                      "ChildNoteItems": []
                  },
                  {
                      "ProjectID": 144,
                      "ItemID": 1299,
                      "NoteID": 97,
                      "Title": "Comments",
                      "Created By": "Terry Johnson",
                      "CreatedByID":13,
                      "Created Date": "2017-11-21T09:53:01.123",
                      "Description": "PHA+cmVwMjwvcD4K",
                      "ReplyUserID": 13,
                      "ReplyUser": "Terry Johnson",
                      "ChildNoteItems": []
                  },
                  {
                      "ProjectID": 144,
                      "ItemID": 1299,
                      "NoteID": 98,
                      "Title": "Comments",
                      "Created By": "Bill Blackwood",
                      "CreatedByID":13,
                      "Created Date": "2017-11-22T10:42:55.51",
                      "Description": "PHA+YmlsbCByZXBseTM8L3A+Cg==",
                      "ReplyUserID": 13,
                      "ReplyUser": "Terry Johnson",
                      "ChildNoteItems": []
                  }
              ]
          },
          {
              "ProjectID": 144,
              "ItemID": 1299,
              "NoteID": 96,
              "Title": "Comments",
              "Created By": "Terry Johnson",
              "CreatedByID":13,
              "Created Date": "2017-11-21T09:52:06.127",
              "Description": "PHA+bm90ZTI8L3A+Cg==",
              "ReplyUserID": 0,
              "ReplyUser": "",
              "ChildNoteItems": []
          }
      ]
  }

• 406 Search Item List Error [expand]
  Error Message
• 401 [expand]
  The request is forbidden if the user token is invalid.

• 200 Get Note OK [expand]

  Example

  {
      "ProjectID": 144,
      "ItemID": 1299,
      "NoteID": 94,
      "Title": "Comments",
      "Created By": "Terry Johnson",
      "Created Date": "2017-11-21T09:48:29.433",
      "Description": "PHA+bm90ZTE8L3A+Cg==",
      "CreatedByID": 13
  }
                          

• 404 Note not found[expand]
  Note not found.
• 401 [expand]
  The request is forbidden if the user token is invalid.

request query parameters

• application/json [expand]

  Example

  {"ProjectID":144,"ItemID":1330,"Title":"API add Note2","Created By":"Terry Johnson","Description":"RGVzYyBNb2RpZnky","ParentID":68} 

• 201 Created OK [expand]
  New NoteID
• 203 Note Title is empty [expand]
  Note Title can not been empty
• 406 Created error [expand]
  Error messgae
• 401 [expand]
  The request is forbidden if the user token is invalid.

request query parameters

• application/json [expand]

  Example

  {"ProjectID":144,"ItemID":1330,"NoteID":54,"Title":"API update Note1","Created By":"Terry Johnson","Description":"RGVzYyBNb2RpZnky"} 

• 200 Update OK [expand]
  Update OK
• 203 Note Title is empty [expand]
  Note Title can not been empty
• 406 Update error [expand]
  Error message
• 401 [expand]
  The request is forbidden if the user token is invalid.

• 200 Get Document OK [expand]
  File stream
• 406 Get Document Error [expand]
  Error message
• 401 [expand]
  The request is forbidden if the user token is invalid.

request query parameters

• application/octet-stream [expand]
  File Stream

• 200 Add OK [expand]
  New FileID
• 406 Add Document fail [expand]
  Error Message
• 401 [expand]
  The request is forbidden if the user token is invalid.

• 200 Get Attachment OK [expand]
  File Stream
• 406 Get Attachment error [expand]
  Error message
• 401 [expand]
  The request is forbidden if the user token is invalid.

request query parameters

• application/octet-stream [expand]
  File Stream

• 200 Add OK [expand]
  New FileID
• 406 Add Document fail [expand]
  Error Message
• 401 [expand]
  The request is forbidden if the user token is invalid.

request query parameters

• application/json [expand]

  Example

  {"ProjectID":144,"ItemID":1325,"Fields":["ProjectID","FileID","FileName","DisplayFileName","VersionID","LastCheckInDate"]}

• 200 Search OK [expand]

  Example

  {"ProjectID":144,"FileID":130,"FileName":"DevSuite Overview.docx","DisplayFileName":"DevSuite Overview.docx","VersionID":1,"LastCheckInDate":"2014-04-11T17:54:38.627"}

• 406 Search Item List Error [expand]
  Error Message
• 401 [expand]
  The request is forbidden if the user token is invalid.

request query parameters

• application/json [expand]

  Example

  {"ProjectID":144,"ItemID":1314,"NoteID":60,"Fields":["ProjectID","FileID","FileName","DisplayFileName","VersionID","LastCheckInDate"]}

• 200 Search OK [expand]

  Example

  {"ProjectID":144,"FileID":649,"FileName":"a.docx","DisplayFileName":"a.docx","VersionID":1,"LastCheckInDate":"2014-04-29T14:22:23.69"}

• 406 Search Item List Error [expand]
  Error Message
• 401 [expand]
  The request is forbidden if the user token is invalid.

request query parameters

• application/json [expand]

  Example

  {"ProjectID":144}

• 200 Search OK [expand]

  Example

  {"ProjectID":144,"ProjectName":"DevSpec Sample Project","ProjectType":32,"LinkedKnowledgeProjectID":21}

• 406 Search Item List Error [expand]
  Error Message
• 401 [expand]
  The request is forbidden if the user token is invalid.

request query parameters

• application/json [expand]

  Example

  {"ProjectID":144}

• 200 OK [expand]

  Example

  "http://127.0.0.1/devspec/clearcache.aspx is OK"

• 203 Non-Authoritative Information [expand]

  Example

  "Please input \"ProjectID\" or \"ProjectName\""

• 401 [expand]
  The request is forbidden if the user token is invalid.

• 200 Get OK [expand]

  Example

  {
  	"ProjectID": 144,
  	"ItemID": 1358,
  	"LinkedDevSpec": [{
  		"ProjectID": 144,
  		"ItemID": 1411,
  		"ParentFeatureID": 1358,
  		"LinkReferenceTypeID": 0,
  		"Title": "pid1336",
  		"State": "{New}",
  		"Owner": "",
  		"LastModifiedBy": "Terry Johnson",
  		"LastModifiedTime": "2018-05-07T10:20:28.343"
  	}, {
  		"ProjectID": 144,
  		"ItemID": 1439,
  		"ParentFeatureID": 1358,
  		"LinkReferenceTypeID": 0,
  		"Title": "pid1336",
  		"State": "{New}",
  		"Owner": "",
  		"LastModifiedBy": "Terry Johnson",
  		"LastModifiedTime": "2018-05-07T10:31:25.753"
  	}],
  	"LinkedDevTestTemplate": [{
  			"TemplateProjectID": 2,
  			"TemplateID": 19,
  			"TemplateTitle": "Client-TestX",
  			"State": "Approved",
  			"Owner": "Terry Johnson",
  			"LastModifiedBy": "Terry Johnson",
  			"LastModifiedTime": "2004-06-09T18:46:55"
  		},
  		{
  			"TemplateProjectID": 2,
  			"TemplateID": 20,
  			"TemplateTitle": "WebSubversionIntegration",
  			"State": "Approved",
  			"Owner": "Terry Johnson",
  			"LastModifiedBy": "Terry Johnson",
  			"LastModifiedTime": "2014-01-30T17:49:36"
  		},
  		{
  			"TemplateProjectID": 2,
  			"TemplateID": 29,
  			"TemplateTitle": "SupportforHTML5andCSS3",
  			"State": "PendingApproval",
  			"Owner": "James Robinson",
  			"LastModifiedBy": "Terry Johnson",
  			"LastModifiedTime": "2014-02-06T14:26:15"
  		},
  		{
  			"TemplateProjectID": 2,
  			"TemplateID": 30,
  			"TemplateTitle": "HardwareSpec",
  			"State": "Pending Approval",
  			"Owner": "Terry Johnson",
  			"LastModifiedBy": "Terry Johnson",
  			"LastModifiedTime": "2014-02-06T14:26:21"
  		}
  	],
  	"LinkedDevTest": [{
  			"TemplateProjectID": 2,
  			"TemplateID": 30,
  			"TestProjectID": 3,
  			"TestID": 188,
  			"TestTitle": "Hardware Spec",
  			"State": "Inprogress",
  			"Owner": "+ForReview",
  			"LastModifiedBy": "Terry Johnson",
  			"LastModifiedTime": "2014-01-06T13:58:29",
  			"OpenOrClose": "AllOpen"
  		},
  		{
  			"TemplateProjectID": 2,
  			"TemplateID": 30,
  			"TestProjectID": 3,
  			"TestID": 189,
  			"TestTitle": "HardwareSpec",
  			"State": "Fail",
  			"Owner": "+ForReview",
  			"LastModifiedBy": "Terry Johnson",
  			"LastModifiedTime": "2014-01-06T13:59:20",
  			"OpenOrClose": "Last Closed"
  		}
  	],
  	"LinkedDevelopment": [{
  			"LinkedStoryName": "1358-0:AllLinktest1",
  			"TaskID": 137,
  			"TaskTitle": "[QA]AllLinktest1",
  			"Status": "Tobeassigned",
  			"Owner": "Terry Johnson",
  			"LastModifiedBy": "",
  			"LastModifiedTime": "0001-01-01T00:00:00",
  			"DevTrackProjectID": 181,
  			"DevTrackProjectName": "Sample DevelopmentProject-DevTrack",
  			"SubProjectID": 2150,
  			"SubProjectPath": "\\Content SharingManagerV1.0(Agile)\\Sprint1"
  		},
  		{
  			"LinkedStoryName": "1358-0:AllLinktest1",
  			"TaskID": 140,
  			"TaskTitle": "[WindowsDevelopment]AllLinktest1",
  			"Status": "To beassigned",
  			"Owner": "Terry Johnson",
  			"LastModifiedBy": "",
  			"LastModifiedTime": "0001-01-01T00:00:00",
  			"DevTrackProjectID": 181,
  			"DevTrackProjectName": "Sample DevelopmentProject-DevTrack",
  			"SubProjectID": 2150,
  			"SubProjectPath": "\\Content SharingManagerV1.0(Agile)\\Sprint1"
  		}
  	]
  }

• 404 Not Found [expand]
  item not exist.
• 401 [expand]
  The request is forbidden if the user token is invalid.

request query parameters

• application/json [expand]

  Example

  {
          "ProjectID": 144,
  	"ItemID": 1471,
  	"LinkedProjectID": 144,
  	"LinkedItemIDs": "1476",
  	"LinkTypeID": 7,
  	"LinkReferenceTypeID": 0,
  	"ActionType": 2
      }

  "ActionType"
  
  -1 , (None)
  0 , (Change Link type)
  1 , (Add Link)
  2 , (Delete Link)

• Add Link OK [expand]
  Add OK
• 406 Add Link Error [expand]
  Error Message
• 401 [expand]
  The request is forbidden if the user token is invalid.

request query parameters

• application/json [expand]

  Example

  {"ProjectID":144,"ItemID":50,"Fields":["ProjectID","FileID","FileName","DisplayFileName","VersionID","LastCheckInDate"]}

• 200 Get OK [expand]

  Example

  {"AttachmentInfoList":[{"ProjectID":144,"FileID":798,"FileName":"123 office.doc","DisplayFileName":"123 office.doc","VersionID":1,"LastCheckInDate":"2017-09-19T18:06:37.787"},{"ProjectID":144,"FileID":797,"FileName":"111.doc","DisplayFileName":"111.doc","VersionID":1,"LastCheckInDate":"2017-09-19T18:05:36.94"}]}

• 406 Search Item List Error [expand]
  Error Message
• 401 [expand]
  The request is forbidden if the user token is invalid.

• 200 Get Attachment Image OK [expand]
  File Stream
• 406 Get Attachment error [expand]
  Error message
• 401 [expand]
  The request is forbidden if the user token is invalid.

• 200 Get Attachment OK [expand]
  File Stream
• 406 Get Attachment error [expand]
  Error message
• 401 [expand]
  The request is forbidden if the user token is invalid.

• 200 Get Owner list OK [expand]

  Example

  {"OwnerList":[{"ProjectID":144,"UserID":-2,"UserName":"{All Members}"},{"ProjectID":144,"UserID":0,"UserName":"{Unassigned}"},{"ProjectID":144,"UserID":1001,"UserName":"Bill Blackwood"},{"ProjectID":144,"UserID":16,"UserName":"Dean Stewart"},{"ProjectID":144,"UserID":19,"UserName":"James Robinson"},{"ProjectID":144,"UserID":6,"UserName":"Judith Brown"},{"ProjectID":144,"UserID":15,"UserName":"Matt Peterson"},{"ProjectID":144,"UserID":18,"UserName":"Pamela Miller "},{"ProjectID":144,"UserID":14,"UserName":"Paul Wagner"},{"ProjectID":144,"UserID":9,"UserName":"Scott Williams"},{"ProjectID":144,"UserID":13,"UserName":"Terry Johnson"},{"ProjectID":144,"UserID":17,"UserName":"Tim Simpson"},{"ProjectID":144,"UserID":8,"UserName":"William Neil"}]}

• 406 Get Owner list error [expand]
  Error message
• 401 [expand]
  The request is forbidden if the user token is invalid.

• 200 Get Status list OK [expand]

  Example

  {"StatusList":[{"ProjectID":144,"StateID":-10,"StateName":"{Unspecified}","IsClosed":0},{"ProjectID":144,"StateID":11,"StateName":"Pending Change","IsClosed":0},{"ProjectID":144,"StateID":13,"StateName":"To be Committed","IsClosed":0},{"ProjectID":144,"StateID":88,"StateName":"In Development","IsClosed":0},{"ProjectID":144,"StateID":89,"StateName":"Released","IsClosed":1},{"ProjectID":144,"StateID":90,"StateName":"Developed","IsClosed":0},{"ProjectID":144,"StateID":92,"StateName":"Dropped","IsClosed":1}]}

• 406 Get Status list error [expand]
  Error message
• 401 [expand]
  The request is forbidden if the user token is invalid.

• 200 Get OK [expand]

  Example

  {
      "ProjectID": 144,
      "ItemID": 69,
      "TagList": [
          {
              "TagID": 1,
              "TagName": "t1",
              "TagColor": "#d93651",
              "TagOrder": 1
          },
          {
              "TagID": 2,
              "TagName": "t2",
              "TagColor": "#ff9f1b",
              "TagOrder": 2
          },
          {
              "TagID": 3,
              "TagName": "t3",
              "TagColor": "#ffd500",
              "TagOrder": 3
          },
          {
              "TagID": 4,
              "TagName": "t4",
              "TagColor": "#8acc47",
              "TagOrder": 4
          }
      ]
  }

• 404 Not Found [expand]
  tag not exist.
• 401 [expand]
  The request is forbidden if the user token is invalid.

request query parameters

• application/json [expand]

  Example

  {
      "ProjectID": 144,
      "ItemID": 69,
      "TagList": [
          {
              "TagID": 1,
              "TagName": "t1",
              "TagColor": "#d93651",
              "TagOrder": 1
          },
          {
              "TagID": 2,
              "TagName": "t2",
              "TagColor": "#ff9f1b",
              "TagOrder": 2
          },
          {
              "TagID": 3,
              "TagName": "t3",
              "TagColor": "#ffd500",
              "TagOrder": 3
          },
          {
              "TagID": 4,
              "TagName": "t4",
              "TagColor": "#8acc47",
              "TagOrder": 4
          }
      ]
  }

• Update requirement tags (Add and Delete) OK [expand]
  Update requirement tags OK
• 406 Update requirement tags Error [expand]
  Error Message
• 401 [expand]
  The request is forbidden if the user token is invalid.

request query parameters

• application/json [expand]

  Example

  {
      "ProjectID": 144,
      "OperationType": 5,
      "FileID": 868,
      "ItemID": 69,
      "Args": "Document.docx"
  }

  "OperationType"
  
  5 , (Check Out attachment)
  6 , (Check In attachment)
  203 , (Save as idea)

• Operation for requirement attachment OK. [expand]
  Operation for requirement attachment OK.
• 406 Operation for requirement attachment Error [expand]
  Error Message
• 401 [expand]
  The request is forbidden if the user token is invalid.

• 200 Get OK [expand]

  Example

  {
      "ProjectID": 144,
      "ItemID": 0,
      "TagList": [
          {
              "TagID": 1,
              "TagName": "t1",
              "TagColor": "#d93651",
              "TagOrder": 1,
              "LinkedItemID": 0
          },
          {
              "TagID": 2,
              "TagName": "t2",
              "TagColor": "#ff9f1b",
              "TagOrder": 2,
              "LinkedItemID": 0
          },
          {
              "TagID": 3,
              "TagName": "t3",
              "TagColor": "#ffd500",
              "TagOrder": 3,
              "LinkedItemID": 0
          }
      ]
  }

• 404 Not Found [expand]
  tag not exist.
• 401 [expand]
  The request is forbidden if the user token is invalid.

request query parameters

• application/json [expand]

  Example

  {
      "ProjectID": 144,
      "ItemID": 0,
      "TagList": [
          {
              "TagID": 0,
              "TagName": "t11",
              "TagColor": "#d93651",
              "TagOrder": 0,
              "LinkedItemID": 0
          }
      ]
  }

• Add Project Tag OK [expand]
  New TagID
• 406 Add Project tags Error [expand]
  Error Message
• 401 [expand]
  The request is forbidden if the user token is invalid.

request query parameters

• application/json [expand]

  Example

  {
      "ProjectID": 144,
      "ItemID": 0,
      "TagList": [
          {
              "TagID": 1,
              "TagName": "new t1",
              "TagColor": "#d93651",
              "TagOrder": 1,
              "LinkedItemID": 0
          }
      ]
  }

• 200 Update OK [expand]
  Update OK
• 406 Update error [expand]
  Error message
• 401 [expand]
  The request is forbidden if the user token is invalid.

• 200 Query Attachment Status OK [expand]
  { "AttachmentsStatusList": [ { "FileID": 839, "QueryStatus": 0 }, { "FileID": 838, "QueryStatus": 0 } ], "DocumentStatusList": [ { "FileID": 71, "QueryStatus": 0 }, { "FileID": 72, "QueryStatus": 0 } ] }
  
  "Query Status"
  
  0 , (Idea convert OK)
  10 , (Convert Processing)
  61 , (Convert PDF To Swf Error)
  62 , (Convert Doc To Swf Error)
  63 , (Convert Excel To Swf Error)
  64 , (Convert PPT To Swf Error)
  72 , (Upload PDF File Error)
  
  
• 406 Query Attachment Status error [expand]
  Error message
• 401 [expand]
  The request is forbidden if the user token is invalid.

request query parameters

• application/json [expand]

  Example

  {
      "ProjectID": 144,
      "ItemID": 646,
      "FileID": 839,
      "ViewType": 402,
      "FileName": "111.doc"
  }

• 200 Start converting attachment. [expand]
  Start converting attachment.
• 406 Convert for requirement attachment Error [expand]
  Error Message
• 401 [expand]
  The request is forbidden if the user token is invalid.

request query parameters

• application/json [expand]

  Example

  {
  	"ProjectID": 144,
  	"FolderID": 50,
  	"ItemIDs": [1353]
  }

• 201 Copy requirement item OK. [expand]
  New ItemID.
• 406 copy Error [expand]
  Error Message
• 401 [expand]
  The request is forbidden if the user token is invalid.

request query parameters

• application/json [expand]

  Example

  {
  	"ProjectID": 144,
  	"ItemID": 44,
  	"ParentItemID": 47,
  	"PriorityValue": 1
  }

• 200 Update Priority Order OK. [expand]
  200 Update Priority Order OK.
• 406 Update Error [expand]
  Error Message
• 401 [expand]
  The request is forbidden if the user token is invalid.

request query parameters

• application/json [expand]

  Example

  {
      "ProjectID": 144,
      "OperationType": 0,
      "FolderID": 50,
      "ParentFolderID": 48,
      "Position": 0
  }

  "OperationType"
  1 , (Move Folder)
  
  "Position"
  -1 , (Position Above)
  0 , (Position Normal, move folder as child)
  1 , (Position Below)

• 200 Operation for requirement folder OK. [expand]
  200 Operation for requirement folder OK.
• 406 Operation for requirement folder Error [expand]
  Error Message
• 401 [expand]
  The request is forbidden if the user token is invalid.

• 200 Get user info OK [expand]

  Example

  {
  "MobilePhone":"+8613912345678",
  "ID":13
  }

• 404 user not found[expand]
  Note not found.
• 401 [expand]
  The request is forbidden if the user token is invalid.

request query parameters

• application/json [expand]

  Example

  {
  "MobilePhone":"+8613912345678",
  "ID":13
  }

• 200 Update OK [expand]
  Update OK
• 406 Update error [expand]
  Error message
• 401 [expand]
  The request is forbidden if the user token is invalid.

request query parameters

• application/json [expand]

  Example

  {
      "ProjectID": 144,
      "OperationType": 1,
      "FolderID": 38,
      "ItemIDs": "1302,1303"
  }

  "OperationType"
  1 , (Move Item)
  

• 200 Operation for requirement folder OK. [expand]
  200 Operation for requirement item OK.
• 406 Operation for requirement item Error [expand]
  Error Message
• 401 [expand]
  The request is forbidden if the user token is invalid.

request query parameters

• application/json [expand]

  Example

  {
      "ProjectID": 144,
      "OperationType": 1
  }

  "OperationType"
  1 , (Get Reqirement item type list)
  2 , (Get Reqirement field definition list)
  

• 200 Operation for requirement project setting OK. [expand]
  200 Operation for requirement project setting OK.
• 406 Operation for requirement project setting Error [expand]
  Error Message
• 401 [expand]
  The request is forbidden if the user token is invalid.

• 200 Get Requirement items linked DevTest Templates OK [expand]

  Example

  {
  	"ItemsTestTempLinks": [{
  		"ProjectID": 144,
  		"ItemID": 21,
  		"LinkedDevTestTemplate": [{
  			"TemplateProjectID": 2,
  			"TemplateID": 1,
  			"TemplateTitle": "Log into the admin module"
  		}, {
  			"TemplateProjectID": 2,
  			"TemplateID": 3,
  			"TemplateTitle": "Update license key (cancel)"
  		}]
  	}, {
  		"ProjectID": 144,
  		"ItemID": 22,
  		"LinkedDevTestTemplate": [{
  			"TemplateProjectID": 2,
  			"TemplateID": 22,
  			"TemplateTitle": "Notification subscriptions"
  		}, {
  			"TemplateProjectID": 2,
  			"TemplateID": 30,
  			"TemplateTitle": "Hardware Spec"
  		}]
  	}]
  }

• 404 user not found[expand]
  Note not found.
• 401 [expand]
  The request is forbidden if the user token is invalid.

• 200 Get Requirement Item status and owner history OK [expand]

  pamerter Example

  {
          "ItemId":"9",
  	"projectId":144,
  	"VersionID":0
  }

• 404 user not found[expand]
  Note not found.
• 401 [expand]
  The request is forbidden if the user token is invalid.

• 200 Get OK [expand]

  Example

  { "TotalCount":2,"PageSize":50,"CurrentPage":0,
                              "ListItems":[{"ItemID":"3","ItemTitle":"DownloadPlus Summary","KnowledgeID":"3","DisplayID":"3","Title":"DownloadPlus
                              Summary","CrntOwnerID":"-1","CrntStateID":"","CreatedByID":null,"AssignedByID":null,"DateAssigned":null,"DateCreated":null,"DateLastModified":"12/22/2011
                              3:32:14 PM","LastModifiedBy":null,"FolderID":"102","SubStataID":null,"DocumentOption":"","DescriptionTXT":null,"DescriptionHTML":null,"TemplateFileOption":"","ItemTypeID":"","IsStatusClosed":0,"DocumentAttachment":null,"FileAttachment":null,"ProductVersion":null,"FileID":3,"AttachmentTypeID":0,"HTMLPath":null,"ExternalID":"","IsDeleted":0,"IsReadOnly":0,"NoOfFileOpened":0,"NoOfPeopleOpened":0,"NoOfViewIdea":0,"NoOfPeopleView":0,"MemoInfos":[],"SelectionInfos":[],"ProjectID":0,"ImplementationCopyID":null,"Parent4ImplementationCopyID":null,"IsInChangeRequest":null,"LinkItemCount":null,"CustomFields":[{"ColumnName":"FieldInt1","FieldValue":"7"},{"ColumnName":"FieldInt2","FieldValue":"4"}],"VotingColumns":[],"ItemChangeStatus":null,"IsOffline":null,"AccessLevel":0,"LinkedDevTestTemplateItems":[]},
                              {"ItemID":"13","ItemTitle":"DevTime Problems.txt","KnowledgeID":"13","DisplayID":"13","Title":"DevTime
                              Problems.txt","CrntOwnerID":"","CrntStateID":"","CreatedByID":null,"AssignedByID":null,"DateAssigned":null,"DateCreated":null,"DateLastModified":"","LastModifiedBy":null,"FolderID":"103","SubStataID":null,"DocumentOption":"","DescriptionTXT":null,"DescriptionHTML":null,"TemplateFileOption":"","ItemTypeID":"","IsStatusClosed":0,"DocumentAttachment":null,"FileAttachment":null,"ProductVersion":null,"FileID":13,"AttachmentTypeID":0,"HTMLPath":null,"ExternalID":"","IsDeleted":0,"IsReadOnly":0,"NoOfFileOpened":0,"NoOfPeopleOpened":0,"NoOfViewIdea":0,"NoOfPeopleView":0,"MemoInfos":[],"SelectionInfos":[],"ProjectID":0,"ImplementationCopyID":null,"Parent4ImplementationCopyID":null,"IsInChangeRequest":null,"LinkItemCount":null,"CustomFields":[{"ColumnName":"FieldInt1","FieldValue":"6"},{"ColumnName":"FieldInt2","FieldValue":"1"}],"VotingColumns":[],"ItemChangeStatus":null,"IsOffline":null,"AccessLevel":0,"LinkedDevTestTemplateItems":[]}],
                              "ChildListItems":[],"LinkedListItems":[],"ChangeItems":[],"RelationshipListItems":[],"ImplementationCopyItems":[],"BacklogStoryItems":[]
                              } 

• 406 Get Error [expand]
  Error message
• 401 [expand]
  The request is forbidden if the user token is invalid.

request query parameters

• application/json [expand]

  Example

  {

     OperationType:2,

     ProjectID:21,

     FolderID:155,

     ItemIDs:"96,97"

  }

• Normal Reponse: [expand]

  Example

  {

  "98"

  }

• 406——Search Item List Error [expand]
  Error Message
• 401——Invalid User[expand]
  The request is forbidden if the user token is invalid.

• 200 Get OK [expand]

  Example

  {"ProjectID":21,"FolderID":129,"FolderName":"Team Documents","FolderPath":["Sample Knowledge Base Project","Team Documents"],"Title":"kw test item1333333","Description":"test description1111\n",
                          "Assigned by":"","Last Modified by":"Terry Johnson","Created by":"Terry Johnson","Knowledge ID":105,"Knowledge Owner":"","Knowledge State":"Draft Version","External ID":""}

• 404 Not Found [expand]
  Not Found
• 401 [expand]
  The request is forbidden if the user token is invalid.

request query parameters

• application/json [expand]

  Example

  {"ProjectID":21,"FolderID":129,"FolderPath":["Sample Knowledge Base Project","Team Documents"],"Title":"API add kw test item1333333","FolderName":"Team Documents","Description":"test description1111\n","Assigned by":"",
                          "Last Modified by":"Terry Johnson","Created by":"Terry Johnson","Knowledge Owner":"","Knowledge State":"Draft Version","External ID":""}

• 201 Created OK [expand]
  New Knowledge ItemID
• 203 Knowledge Title is empty [expand]
  Knowledge Title can not been empty.
• 406 Create Error [expand]
  Error messgae
• 401 [expand]
  The request is forbidden if the user token is invalid.

request query parameters

• application/json [expand]

  Example

  {"ProjectID":21,"FolderID":129,"FolderPath":["Sample Knowledge Base Project","Team Documents"],"Knowledge ID":105,"FolderName":"Team Documents","Title":"API Update kw test item1333333","Description":"test description1111\n",
                          "Assigned by":"","Last Modified by":"Terry Johnson","Created by":"Terry Johnson","Knowledge Owner":"","Knowledge State":"Draft Version","External ID":""}

• 200 Update OK [expand]
  Update OK
• 203 Knowledge Title is empty [expand]
  Knowledge Title can not been empty
• 406 Update Error [expand]
  Error messgae
• 401 [expand]
  The request is forbidden if the user token is invalid.

• 200 Get OK [expand]

  Example

  {"FolderNodes":[{"FolderID":1,"FolderName":"Knowledge Root","FolderStatusID":0,"FolderNodes":[{"FolderID":11,"FolderName":"Documents","FolderStatusID":0,"FolderNodes":[]},{"FolderID":12,"FolderName":"Knowledge
                              Topics","FolderStatusID":0,"FolderNodes":[]},{"FolderID":13,"FolderName":"HTML Links","FolderStatusID":0,"FolderNodes":[]},{"FolderID":128,"FolderName":"Sample
                              Knowledge Base Project","FolderStatusID":0,"FolderNodes":[]},{"FolderID":130,"FolderName":"Development","FolderStatusID":0,"FolderNodes":[]},{"FolderID":150,"FolderName":"KW
                              space1","FolderStatusID":0,"FolderNodes":[]}]},{"FolderID":3,"FolderName":"Document
                              Templates","FolderStatusID":0,"FolderNodes":[]},{"FolderID":124,"FolderName":"Wiki","FolderStatusID":0,"FolderNodes":[]},{"FolderID":125,"FolderName":"Document
                              Templates","FolderStatusID":0,"FolderNodes":[{"FolderID":126,"FolderName":"Attachment
                              Document Templates","FolderStatusID":0,"FolderNodes":[]}]},{"FolderID":127,"FolderName":"Idea
                              Books","FolderStatusID":0,"FolderNodes":[{"FolderID":132,"FolderName":"aaaa","FolderStatusID":0,"FolderNodes":[]}]}]}

• 401 [expand]
  The request is forbidden if the user token is invalid.

request query parameters

• application/json [expand]

  Example

  { "ProjectID":21,"FolderID":11 } 

• 200 Get OK [expand]

  Example

  { "FolderNodes":[{"FolderID":102,"FolderName":"WhitePaper","FolderOwnerSameAsParent":null,"FolderOwnerSelectionOption":null,"FolderAccessSameAsParent":0,"AccessFolderType":0,"ChildNumber":0,"TypeID":0,"WikiBookOption":null,"ReadyforWikiBook":null,"ProductVersionFolderType":0,"MyDevSuiteAccessOption":0,"FolderNodes":[],"FileID":0,"EnableWikiBook":0,"FolderStatusID":0,"ChildItemIDs":null,"KloudFolderID":null,"KloudFolderType":null,"IsInChangeRequest":null},{"FolderID":103,"FolderName":"API
                              EDIT Demo","FolderOwnerSameAsParent":null,"FolderOwnerSelectionOption":null,"FolderAccessSameAsParent":0,"AccessFolderType":0,"ChildNumber":0,"TypeID":0,"WikiBookOption":null,"ReadyforWikiBook":null,"ProductVersionFolderType":0,"MyDevSuiteAccessOption":0,"FolderNodes":[],"FileID":0,"EnableWikiBook":0,"FolderStatusID":0,"ChildItemIDs":null,"KloudFolderID":null,"KloudFolderType":null,"IsInChangeRequest":null},{"FolderID":134,"FolderName":"API
                              Demo","FolderOwnerSameAsParent":null,"FolderOwnerSelectionOption":null,"FolderAccessSameAsParent":null,"AccessFolderType":null,"ChildNumber":0,"TypeID":0,"WikiBookOption":null,"ReadyforWikiBook":null,"ProductVersionFolderType":0,"MyDevSuiteAccessOption":0,"FolderNodes":[],"FileID":0,"EnableWikiBook":0,"FolderStatusID":0,"ChildItemIDs":null,"KloudFolderID":null,"KloudFolderType":null,"IsInChangeRequest":null}],"ChildNumber":0
                              } 

• 401 [expand]
  The request is forbidden if the user token is invalid.

request query parameters

• application/json [expand]

  Example

  {"ProjectID":21,"FolderID":130,"ShowAll":1,"Query":[{"Name":"FolderID","Operate":">=","choices":"131"},{"Name":"FolderName","Operate":"LIKE","choices":"API Create"}]}

• 200 Get OK [expand]

  Example

  {"FolderNodes":[{"FolderID":154,"FolderName":"API Create KW test folder1","FolderStatus":"Open","FolderNodes":[]}]}

• 401 [expand]
  The request is forbidden if the user token is invalid.
• 404 [expand]
  Not Found

• 200 Get OK[expand]

  Example

  {"ProjectID":21,"FolderID":129,"Folder Name":"Team Documents","FolderPath":["Sample Knowledge Base Project","Team Documents"],"Folder Description":"123","Folder Status":"Open","Is Read-only":null,"Same as Parent":1,"DefaultKWKTemplateID":null,"TypeID":0}

• 404 NotFound [expand]
  Not Found
• 401 [expand]
  The request is forbidden if the user token is invalid.

request query parameters

• application/json [expand]

  Example

  {"ProjectID":21,"ParentFolderID":128,"Folder Name":"Team Documents","ParentFolderPath":["Sample Knowledge Base Project","Team Documents"],"Position":"Normal","Folder Description":"1233333","Folder Status":"Open","Is Read-only":null,"Same as Parent":1,"TypeID":0}
                          

• 201 Created OK [expand]
  New Folder ID
• 203 Folder Name Empty [expand]
  Folder name can not been empty.
• 406 Create Error [expand]
  Create Error
• 401 [expand]
  The request is forbidden if the user token is invalid.

request query parameters

• application/json [expand]

  Example

  {"ProjectID":21,"FolderID":129,"Folder Name":"Team Documents","FolderPath":["Sample Knowledge Base Project","Team Documents"],"Folder Description":"1233333","Folder Status":"Open","Is Read-only":null,"Same as Parent":1,"TypeID":0}

• 200 Update OK [expand]
  Update OK
• 203 Folder Name Empty [expand]
  Folder name can not been empty.
• 406 Update Error[expand]
  Error Message
• 401 [expand]
  The request is forbidden if the user token is invalid.

request query parameters

• application/json [expand]

  Example

  {"ProjectID":21,"ItemID":76,"Fields":["ProjectID","NoteID","Title","Created By","Created Date","Description"]}

• 200 Search OK [expand]

  Example

  {"NoteItems":[{"ProjectID":21,"NoteID":55,"Title":"KW Note122222","Created By":"Terry Johnson","Created Date":"2014-04-18T16:15:18.903","Description":"Desc111133333"},
                          {"ProjectID":21,"NoteID":56,"Title":"Updtae KW Note1","Created By":"Terry Johnson","Created Date":"2014-04-18T16:32:22.153","Description":"Desc1111222"},
                          {"ProjectID":21,"NoteID":59,"Title":"API add Note333","Created By":"Terry Johnson","Created Date":"2014-04-21T14:00:58.723","Description":"Desc111222333"}]}

• 406 Search Item List Error [expand]
  Error Message
• 401 [expand]
  The request is forbidden if the user token is invalid.

• 200 Get OK [expand]

  Example

  {"ProjectID":21,"ItemID":76,"NoteID":55,"Title":"KW Note122222","Created By":"Terry Johnson","Description":"Desc111133333","AttachFileID":648,"AttachedFileName":"a.docx","AttachType":1}

• 404 Note not found [expand]
  Note not exit
• 401 [expand]
  The request is forbidden if the user token is invalid.

request query parameters

• application/json [expand]

  Example

  {"ProjectID":21,"ItemID":76,"Title":"API add Note3333","Created By":"Terry Johnson","Description":"Desc111222333"}

• 201 Created OK [expand]
  New Note ID
• 203 Note Title is empty [expand]
  Note title can not been empty
• 406 Created Error [expand]
  Error Message
• 401 [expand]
  The request is forbidden if the user token is invalid.

request query parameters

• application/json [expand]

  Example

  {"ProjectID":21,"ItemID":76,"NoteID":55,"Title":"KW Note122222","Created By":"Terry Johnson","Description":"Desc111133333","OldNoteTitle":"note title","OldNoteDescription":"Desc111"}

• 200 Update OK [expand]
  Update OK
• 203 Note Title can not been empty [expand]
  Knowledge Note Title can not been empty
• 406 Update Error[expand]
  Error message
• 401 [expand]
  The request is forbidden if the user token is invalid.

• 200 Get OK[expand]
  File stream
• 406 Get Error[expand]
  Error Message
• 401 [expand]
  The request is forbidden if the user token is invalid.

request query parameters

• application/octet-stream [expand]
  File Stream

• 200 Add OK [expand]
  New FileID
• 406 Add Document fail [expand]
  Error Message
• 401 [expand]
  The request is forbidden if the user token is invalid.

• 200 Get OK application/octet-stream [expand]
  File stream
• 406 Get Error[expand]
  Error Message
• 401 [expand]
  The request is forbidden if the user token is invalid.

request query parameters

• application/octet-stream [expand]
  File Stream

• 201 Add OK [expand]
  New FileID
• 406 Add Document fail [expand]
  Error Message
• 401 [expand]
  The request is forbidden if the user token is invalid.

request query parameters

• application/json [expand]

  Example

  {"ProjectID":21,"ItemID":103,"Fields":["ProjectID","FileID","FileName","DisplayFileName","VersionID","LastCheckInDate"]}

• 200 Search OK [expand]

  Example

  {"ProjectID":21,"FileID":80,"FileName":"DevSuite Overview.docx","DisplayFileName":"DevSuite Overview.docx","VersionID":1,"LastCheckInDate":"2014-04-11T14:16:08.33"}

• 406 Search Item List Error [expand]
  Error Message
• 401 [expand]
  The request is forbidden if the user token is invalid.

request query parameters

• application/json [expand]

  Example

  {"ProjectID":21,"ItemID":13,"NoteID":61,"Fields":["ProjectID","FileID","FileName","DisplayFileName","VersionID","LastCheckInDate"]}

• 200 Search OK [expand]

  Example

  {"ProjectID":21,"FileID":650,"FileName":"a.docx","DisplayFileName":"a.docx","VersionID":1,"LastCheckInDate":"2014-05-08T15:42:16.52"}

• 406 Search Item List Error [expand]
  Error Message
• 401 [expand]
  The request is forbidden if the user token is invalid.

• 200 Get OK[expand]

  Example

  {"DevTestTemplateProjects":[{"TemplateProjectID":2,"TemplateProjectName":"Sample Template Base Project"}]}

• 406 Get Error[expand]
  Error Message
• 401 [expand]
  The request is forbidden if the user token is invalid.

• 200 Get OK[expand]

  Example

  {"DevTestTemplateItems": [{"ProjectID": 2,"TemplateID": 1,"TemplateTitle": "Log into the admin module","CrntOwner": "Terry Johnson","CrntState": "Pending Approval"},
                              {"ProjectID": 2,"TemplateID": 3,"TemplateTitle": "Update license key (cancel)","CrntOwner": "Pamela Miller ","CrntState": "Approved"},
                              {"ProjectID": 2,"TemplateID": 5,"TemplateTitle": "Jump sound effect","CrntOwner": "Pamela Miller ","CrntState": "Approved"}]}

• 406 Get Error[expand]
  Error Message
• 401 [expand]
  The request is forbidden if the user token is invalid.

request query parameters

• application/json [expand]

  Example

  {
  	"ProjectID": 144,
  	"IssueID": 108,
  	"FileName": "test.doc",
  	"ViewType": 2
  }

• 200 add OK [expand]

  Return

  NewFileID,VersionID,FileName

  Example

  "778,1,dGVzdDIyMi5kb2M="

• 406 Error [expand]
  Error Message
• 401 [expand]
  The request is forbidden if the user token is invalid.