The WebIssues Server Manual
Issue tracking and team collaboration system
Home » WebIssues Protocol Reference
« Line Format
Arguments »

## Commands Syntax

### System Commands

HELLO

  SERVER 'name' 'uuid'

LOGIN 'login' 'password'

  USER userId access

LIST FEATURES

  F 'feature'

### User Management

LIST USERS

  U userId 'login' 'name' access

  M userId projectId access

ADD USER 'login' 'name' 'password'

  ID userId

SET PASSWORD userId 'password'

  OK

RENAME USER userId 'newName'

  OK

GRANT USER userId access

  OK

GRANT MEMBER userId projectId access

  OK

### Type Management

LIST TYPES

  T typeId 'name'

  A attributeId typeId 'name' 'definition'

ADD TYPE 'name'

  ID typeId

RENAME TYPE typeId 'newName'

  OK

DELETE TYPE typeId

  OK

ADD ATTRIBUTE typeId 'name' 'definition'

  ID attributeId

RENAME ATTRIBUTE attributeId 'newName'

  OK

MODIFY ATTRIBUTE attributeId 'definition'

  OK

DELETE ATTRIBUTE attributeId

  OK

### Project Management

LIST PROJECTS

  P projectId 'name'

  F folderId projectId 'name' typeId stamp

ADD PROJECT 'name'

  ID projectId

RENAME PROJECT projectId 'newName'

  OK

DELETE PROJECT projectId

  OK

ADD FOLDER projectId typeId 'name'

  ID folderId

RENAME FOLDER folderId 'newName'

  OK

DELETE FOLDER folderId

  OK

### Issue Operations

LIST ISSUES folderId sinceStamp

  I issueId folderId 'name' stamp createdDate createdUser modifiedDate modifiedUser

  V attributeId issueId 'value'

GET DETAILS issueId sinceStamp

  I issueId folderId 'name' stamp createdDate createdUser modifiedDate modifiedUser

  V attributeId issueId 'value'

  C commentId issueId createdDate createdUser 'text'

  A attachmentId issueId 'name' createdDate createdUser size 'description'

  H changeId issueId modifiedDate modifiedUser attributeId 'oldValue' 'newValue'

ADD ISSUE folderId 'name'

  ID issueId

RENAME ISSUE issueId 'newName'

  ID changeId

SET VALUE issueId attributeId 'newValue'

  ID changeId

ADD COMMENT issueId 'text'

  ID commentId

ADD ATTACHMENT issueId 'name' 'description'

  ID attachmentId

GET ATTACHMENT attachmentId

  >binary response<

FIND ITEM itemId

  ID issueId

### User Preferences

LIST PREFERENCES userId

  P 'key' 'value'

SET PREFERENCE userId 'key' 'value'

  OK

### Notifications

LIST NOTIFICATIONS

  F folderId

  I issueId

NOTIFY FOLDER folderId status

  OK

NOTIFY ISSUE issueId status

  OK

« Line Format
Arguments »

Copyright © 2007-2009 WebIssues Team