EntityMetadata_GetAll Operation

Applies to QAComplete 12.75 SaaS, last modified on April 01, 2021
Since release 10.2, this functionality is obsolete and is supported for backward compatibility only. We recommend that you use QAComplete REST API to access and manage data in QAComplete.

Returns an array of Grid objects that represent all the fields the edit form of an item (Defects, Releases, and so on) can have in QAComplete.

Parameters

The operation uses the following parameters:

AuthenticationData  :  AuthenticationData, required

An AuthenticationData object with the login information and the ID of the project, whose entity’s fields you want to get.

formName  :  string, required

The name of the form in QAComplete, whose fields you want to get. Possible values:

  • Bugs (defects)
  • FunctionalSpecs (requirements)
  • Releases
  • TestCases (legacy test cases used in release 9.6.0 and earlier)
  • TestConfigurations
  • Tests
  • TestSets

Result

An array of Grid objects.

Example

Sample Code

C#

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

// Specify the desired entity
string entity = "FunctionalSpecs";

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;

// Load an array of fields
Grid[] grids = service.EntityMetadata_GetAll(authData, entity);
foreach (Grid grid in grids)
{
  Console.WriteLine(grid.ColCaption);
}

Java

String login = "john.doe@example.com";
String password = "p@ssword";
int projId = 1032;

// Specify the desired entity
String entity = "FunctionalSpecs";

ServiceSoap 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);

// Load an array of fields
List<Grid> grids = service.entityMetadataGetAll(authData, entity).getGrid();
for (Grid grid : grids)
{
  System.out.format(grid.getColName());
}

Sample Request XML

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

<?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>
    <EntityMetadata_GetAll xmlns="http://www.pragmaticsw.com/">
      <AuthenticationData>
        <AppCode>agSP</AppCode>
        <DeptId>7154</DeptId>
        <ProjId>1032</ProjId>
        <UserId>25315</UserId>
        <PassCode>p@ssword</PassCode>
      </AuthenticationData>
      <formName>FunctionalSpecs</formName>
    </EntityMetadata_GetAll>
  </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: 530 {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>
    <EntityMetadata_GetAll xmlns="http://www.pragmaticsw.com/">
      <AuthenticationData>
        <AppCode>agSP</AppCode>
        <DeptId>7154</DeptId>
        <ProjId>1032</ProjId>
        <UserId>25315</UserId>
        <PassCode>p@ssword</PassCode>
      </AuthenticationData>
      <formName>FunctionalSpecs</formName>
    </EntityMetadata_GetAll>
  </soap12:Body>
</soap12:Envelope>

Sample Response XML

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: 1219 {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>
    <EntityMetadata_GetAllResponse xmlns="http://www.pragmaticsw.com/">
      <EntityMetadata_GetAllResult>
        <Grid>
          <ColName>Title</ColName>
          <ColCaption>Title</ColCaption>
          <IsColLocked>N</IsColLocked>
          <IsRequired>Y</IsRequired>
          <DataType>TextBox</DataType>
        </Grid>
        <Grid>
          <ColName>OpenedByName</ColName>
          <ColCaption>Opened By Name</ColCaption>
          <IsColLocked>Y</IsColLocked>
          <IsRequired>N</IsRequired>
          <DataType>ComboBox</DataType>
          <ListOfValues>
            <KeyValueItem>
              <Key>Herrera, Maxine</Key>
              <Value>Herrera, Maxine</Value>
            </KeyValueItem>
            <KeyValueItem>
              <Key>Beasley, Lewis</Key>
              <Value>Beasley, Lewis</Value>
            </KeyValueItem>
          </ListOfValues>
        </Grid>
      </EntityMetadata_GetAllResult>
    </EntityMetadata_GetAllResponse>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: 1227 {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>
    <EntityMetadata_GetAllResponse xmlns="http://www.pragmaticsw.com/">
      <EntityMetadata_GetAllResult>
        <Grid>
          <ColName>Title</ColName>
          <ColCaption>Title</ColCaption>
          <IsColLocked>N</IsColLocked>
          <IsRequired>Y</IsRequired>
          <DataType>TextBox</DataType>
        </Grid>
        <Grid>
          <ColName>OpenedByName</ColName>
          <ColCaption>Opened By Name</ColCaption>
          <IsColLocked>Y</IsColLocked>
          <IsRequired>N</IsRequired>
          <DataType>ComboBox</DataType>
          <ListOfValues>
            <KeyValueItem>
              <Key>Herrera, Maxine</Key>
              <Value>Herrera, Maxine</Value>
            </KeyValueItem>
            <KeyValueItem>
              <Key>Beasley, Lewis</Key>
              <Value>Beasley, Lewis</Value>
            </KeyValueItem>
          </ListOfValues>
        </Grid>
      </EntityMetadata_GetAllResult>
    </EntityMetadata_GetAllResponse>
  </soap12:Body>
</soap12:Envelope>

See Also

Helper Operations
SOAP API Reference

Highlight search results