Applies to QAComplete 12.30 SaaS, last modified on August 15, 2019

Returns a note by its ID. To specify the item whose note you want to get, use the EntityCode parameter.

Parameters

The operation uses the following parameters:

AuthenticationData  :  AuthenticationData, required

An AuthenticationData object containing the login information and the ID of the project whose item’s note you want to get.

EntityCode  :  string, required

The type of the item to which the note belongs. 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

NoteId  :  integer, required

The ID of the note to get.

Result

A Notes object containing information on the specified note.

Example

Sample Code

C#

string login = "john.doe@example.com";
string password = "p@ssword";
int projID = 10372;

// Specify the ID of the desired note
int noteID = 32;
// Specify the type of the item that contains the note
string entityCode = "Bugs";

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 note
Notes note = service.Notes_Get(authData, entityCode, noteID);
Console.WriteLine("Note description:" + note.Description);

Java

String login = "john.doe@example.com";
String password = "p@ssword";
int projID = 10372;

// Specify the ID of the desired note
int noteID = 32;
// Specify the type of the item that contains the note
String entityCode = "Bugs";

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

// Prepare authentication data
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);

// Get the note
Notes note = service.notesGet(authData, entityCode, noteID);
System.out.println("Note description:" + note.getDescription());

Sample Request XML

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

<?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_Get 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>
      <NoteId>1</NoteId>
    </Notes_Get>
  </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: 518 {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_Get 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>
      <NoteId>1</NoteId>
    </Notes_Get>
  </soap12:Body>
</soap12:Envelope>

Sample Response XML

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: 657 {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_GetResponse xmlns="http://www.pragmaticsw.com/">
      <Notes_GetResult>
        <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_GetResult>
    </Notes_GetResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: 667 {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_GetResponse xmlns="http://www.pragmaticsw.com/">
      <Notes_GetResult>
        <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_GetResult>
    </Notes_GetResponse>
  </soap12:Body>
</soap12:Envelope>

See Also

Notes_Add Operation
Notes_GetList Operation
Notes_Delete Operation
Notes_Update Operation
Notes Object
Helper Operations
SOAP API Reference

Highlight search results