Returns the list of notes (comments) added to the specified item (a defect, release, and so on). To specify the item whose notes you want to get, use the EntityCode and FKId parameters.

Parameters

The operation uses the following parameters:

AuthenticationData : AuthenticationData, required

An AuthenticationData object containing the login information and the ID of the project that contains the item whose notes you want to get.

EntityCode : string, required

The type of the item to which the notes belong. Possible values are:

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, required

The ID of the item (defect, requirement, and so on) to which the notes belong.

Result

An array of Notes objects that represent the item’s notes.

Example

Sample Code

The sample code below gets the notes added to a defect.

C#

Java

C#

string login = "[email protected]";
string password = "p@ssword";
int projID = 10372;

// Specify the item whose list of notes you want to get
string entityCode = "Bugs";
int defectID = 3;

ServiceSoapClient service = new ServiceSoapClient();

// Prepare authentication data
LoginInfo loginInfo = service.GetLoginInfo("", login, password);
AuthenticationData authData = new AuthenticationData();
authData.AppCode = loginInfo.AppCode;
authData.UserId = loginInfo.UserId;
authData.PassCode = password;
authData.DeptId = loginInfo.DeptId;
authData.ProjId = projID;

// Get the list of added notes
Notes[] notes = service.Notes_GetList(authData, entityCode, defectID); foreach (Notes note in notes)
{
Console.WriteLine("Note description:" + note.Description);
}

Java

String login = "[email protected]";
String password = "p@ssword";
int projID = 10372;

// Specify the item whose list of notes you want to get
String entityCode = "Bugs";
int defectID = 3;

ServiceSoapClient service = new Service().getServiceSoap12();

// Preparing AuthenticationData
LoginInfo loginInfo = service.getLoginInfo("", login, password);
AuthenticationData authData = new AuthenticationData();
authData.setAppCode(loginInfo.getAppCode());
authData.setUserId(loginInfo.getUserId());
authData.setPassCode(password);
authData.setDeptId(loginInfo.getDeptId());
authData.setProjId(projID);

List<Notes> notes // Get the list of added notes
notes = service.notesGetList(authData, entityCode, defectID);
for (Notes note : notes)
{
System.out.println("Note description:" + note.getDescription());
}

Sample Request XML

SOAP 1.1

SOAP 1.2

POST /psws/psws.asmx HTTP/1.1
Host: myteam.mysite.com
Content-Type: text/xml; charset=utf-8
Content-Length: 514 {Insert an appropriate value here}
SOAPAction: "http://www.pragmaticsw.com/Notes_GetList"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <Notes_GetList xmlns="http://www.pragmaticsw.com/">
      <AuthenticationData>
        <AppCode>agSP</AppCode>
        <DeptId>8162</DeptId>
        <ProjId>11873</ProjId>
        <UserId>24661</UserId>
        <PassCode>p@ssword</PassCode>
      </AuthenticationData>
      <EntityCode>Bugs</EntityCode>
      <FKId>3</FKId>
    </Notes_GetList>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

POST /psws/psws.asmx HTTP/1.1
Host: myteam.mysite.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: 522 {Insert an appropriate value here}

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <Notes_GetList xmlns="http://www.pragmaticsw.com/">
      <AuthenticationData>
        <AppCode>agSP</AppCode>
        <DeptId>8162</DeptId>
        <ProjId>11873</ProjId>
        <UserId>24661</UserId>
        <PassCode>p@ssword</PassCode>
      </AuthenticationData>
      <EntityCode>Bugs</EntityCode>
      <FKId>3</FKId>
    </Notes_GetList>
  </soap12:Body>
</soap12:Envelope>

Sample Response XML

SOAP 1.1

SOAP 1.2

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: 1004 {The server returns an appropriate value here}

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <Notes_GetListResponse xmlns="http://www.pragmaticsw.com/">
      <Notes_GetListResult>
        <Notes>
          <FKId>3</FKId>
          <EntityCode>Bugs</EntityCode>
          <Description>Note 1.</Description>
          <DateCreated>2014-10-06T11:53:46</DateCreated>
          <DateUpdated>2014-10-06T11:56:13</DateUpdated>
          <NotesId>1</NotesId>
          <NotesTypeCode>Notes</NotesTypeCode>
          <Seq>1</Seq>
          <UpdateUserId>24674</UpdateUserId>
          <UserName>Doe, John</UserName>
        </Notes>
        <Notes>
          <FKId>3</FKId>
          <EntityCode>Bugs</EntityCode>
          <Description>Note 2.</Description>
          <DateCreated>2014-10-07T09:18:37</DateCreated>
          <DateUpdated>2014-10-07T09:18:37</DateUpdated>
          <NotesId>2</NotesId>
          <NotesTypeCode>Notes</NotesTypeCode>
          <Seq>2</Seq>
          <UpdateUserId>24675</UpdateUserId>
          <UserName>Doe, Jane</UserName>
        </Notes>
      </Notes_GetListResult>
    </Notes_GetListResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: 1014 {The server returns an appropriate value here}

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <Notes_GetListResponse xmlns="http://www.pragmaticsw.com/">
      <Notes_GetListResult>
        <Notes>
          <FKId>3</FKId>
          <EntityCode>Bugs</EntityCode>
          <Description>Note 1.</Description>
          <DateCreated>2014-10-06T11:53:46</DateCreated>
          <DateUpdated>2014-10-06T11:56:13</DateUpdated>
          <NotesId>1</NotesId>
          <NotesTypeCode>Notes</NotesTypeCode>
          <Seq>1</Seq>
          <UpdateUserId>24674</UpdateUserId>
          <UserName>Doe, John</UserName>
        </Notes>
        <Notes>
          <FKId>3</FKId>
          <EntityCode>Bugs</EntityCode>
          <Description>Note 2.</Description>
          <DateCreated>2014-10-07T09:18:37</DateCreated>
          <DateUpdated>2014-10-07T09:18:37</DateUpdated>
          <NotesId>2</NotesId>
          <NotesTypeCode>Notes</NotesTypeCode>
          <Seq>2</Seq>
          <UpdateUserId>24675</UpdateUserId>
          <UserName>Doe, Jane</UserName>
        </Notes>
      </Notes_GetListResult>
    </Notes_GetListResponse>
  </soap12:Body>
</soap12:Envelope>

Notes_GetList Operation

Parameters

Result

Example

Sample Code

Sample Request XML

Sample Response XML

See Also