A Notes object represents a note (comment) added to a defect, requirement, agile task, contact, or other item in QAComplete.
Properties
FKId : integer
The ID of the item (defect, requirement, and so on) that contains the note.
EntityCode : string (max 30 chars)
The type of the item that contains the note. Possible values:
- Bugs (defects)
- Contacts
- FileExchanges (shared documents)
- FunctionalSpecs (requirements)
- ProjectPlans
- ProjectPlanTasks
- ProjectTasks (agile tasks)
- Releases
- TestCases (legacy test cases used in release 9.6.0 and earlier)
- TestConfigurations
- Tests
- TestSets
Description : string
The note content. Can include HTML markup.
DateCreated : dateTime
The date and time the note was created.
DateUpdated : dateTime
The date and time the note was last changed.
NotesId : integer
The unique identifier of the note.
NotesTypeCode : string (max 100 chars)
Reserved.
Seq : integer
The note’s index among other notes assigned to the item.
UpdateUserId : integer
The ID of the user who last updated the note.
UserName : string (max 78 chars)
The name of the user who updated the note, in the Lastname, Firstname format.
OriginalId : integer
If the entity to which the note belongs is synchronized with a JIRA item, the OriginalId property specifies the ID of the corresponding comment in JIRA.
DateCreated : dateTime
The date and time the note was created.
DateUpdated : dateTime
The date and time the note was last changed.
Description : string
The note content. Can include HTML markup.
EntityCode : string (max 30 chars)
The type of the item that contains the note. Possible values:
- Bugs (defects)
- Contacts
- FileExchanges (shared documents)
- FunctionalSpecs (requirements)
- ProjectPlans
- ProjectPlanTasks
- ProjectTasks (agile tasks)
- Releases
- TestCases (legacy test cases used in release 9.6.0 and earlier)
- TestConfigurations
- Tests
- TestSets
FKId : integer
The ID of the item (defect, requirement, and so on) that contains the note.
NotesId : integer
The unique identifier of the note.
NotesTypeCode : string (max 100 chars)
Reserved.
OriginalId : integer
If the entity to which the note belongs is synchronized with a JIRA item, the OriginalId property specifies the ID of the corresponding comment in JIRA.
Seq : integer
The note’s index among other notes assigned to the item.
UpdateUserId : integer
The ID of the user who last updated the note.
UserName : string (max 78 chars)
The name of the user who updated the note, in the Lastname, Firstname format.
Relevant Operations
Example
XML
<Notes>
<FKId>3</FKId>
<EntityCode>Bugs</EntityCode>
<Description>A note</Description>
<DateCreated>2014-07-09T10:30:00</DateCreated>
<DateUpdated>2014-07-09T10:30:00</DateUpdated>
<NotesId>2</NotesId>
<Seq>2</Seq>
<UpdateUserId>24661</UpdateUserId>
<UserName>Doe, John</UserName>
</Notes>