Most QAComplete SOAP API operations require authentication. To authenticate, you pass the application code, user ID, password, QAComplete project ID (or IDs), and department ID in the AuthenticationData
object inside the SOAP request body. You can find these IDs on the > Setup screen in QAComplete, or get them using the GetLoginInfo
operation. For details, see Authentication.
Properties
AppCode : string
For QAComplete SaaS (hosted on qacomplete.smartbear.com), use agSP.
For QAComplete On-Premises (hosted on your company-owned server), this is typically agSPEnt.
You can see the needed AppCode value on the
DeptId : integer
The department ID.
ProjId : integer
The ID of the project you want to access. To specify several projects, use ProjIds
instead.
UserId : integer
The user ID.
PassCode : string (max 15 chars)
The user’s password.
ProjIds : array of integers
IDs of the projects you want to access. To specify one project, use ProjId
instead.
AppCode : string
For QAComplete SaaS (hosted on qacomplete.smartbear.com), use agSP.
For QAComplete On-Premises (hosted on your company-owned server), this is typically agSPEnt.
You can see the needed AppCode value on the
DeptId : integer
The department ID.
PassCode : string (max 15 chars)
The user’s password.
ProjId : integer
The ID of the project you want to access. To specify several projects, use ProjIds
instead.
ProjIds : array of integers
IDs of the projects you want to access. To specify one project, use ProjId
instead.
UserId : integer
The user ID.
Remarks
The authenticating user must have security rights to the project and area being accessed. For example, to manage test cases in a project, the user must have the Read, Add, Update, or Delete rights to the test cases in that project.
Example
XML
<AuthenticationData>
<AppCode>agSPEnt</AppCode>
<DeptId>7154</DeptId>
<ProjId>10372</ProjId>
<UserId>25315</UserId>
<PassCode>p@ssword</PassCode>
</AuthenticationData>
XML
<AuthenticationData>
<AppCode>agSP</AppCode>
<DeptId>7154</DeptId>
<UserId>25315</UserId>
<PassCode>p@ssword</PassCode>
<ProjIds>
<int>10369</int>
<int>10372</int>
</ProjIds>
</AuthenticationData>