Software
Get Subjects
GET
https://[customer].testresults.io/api/projects/:pId/subjects
Gets all active (without archive) subjects.
Path Parameters
Name | Type | Description |
---|---|---|
pId | string | Project ID |
Headers
Name | Type | Description |
---|---|---|
Authentication | string | Authentication token |
Get archive Subjects
GET
https://[customer].testresults.io/api/projects/:pId/subjects/archive
Gets archive Subjects.
Path Parameters
Name | Type | Description |
---|---|---|
pId | string | Project ID |
Headers
Name | Type | Description |
---|---|---|
Authentication | string | Authentication token |
Get Subject details
GET
https://[customer].testresults.io/api/projects/:pId/subjects/:sId
Gets Subject details.
Path Parameters
Name | Type | Description |
---|---|---|
pId | string | Project ID |
sId | string | Subject ID |
Headers
Name | Type | Description |
---|---|---|
Authentication | string | Authentication token |
Create new Subject
POST
https://[customer].testresults.io/api/projects/:pId/subjects
Creates new Subject.
Path Parameters
Name | Type | Description |
---|---|---|
pId | string | Project ID |
Headers
Name | Type | Description |
---|---|---|
Authentication | string | Authentication token |
Request Body
Name | Type | Description |
---|---|---|
BaseSubjectId | string | Base Subject ID |
Variables | array | Variables array |
Identifier | string | Software Identifier |
InstructionFileId | string | Instruction file ID (require in case if SubjectType is "RequiresInstallation") |
ModificationAllowed | boolean | Modification allowed flag |
Name | string | Software Name |
NeedsPublicIp | boolean | Public IP flag |
SoftwareFileId | string | Software file ID (require in case if SubjectType is "RequiresInstallation") |
SubjectType | string | Subject type |
Uri | string | Webpage URL (required in case if SubjectType is "Webpage") |
Update Subject
PUT
https://[customer].testresults.io/api/projects/:pId/subjects/:sId
Updates an existing Subject.
Path Parameters
Name | Type | Description |
---|---|---|
pId | string | Project ID |
sId | string | Subject ID |
Headers
Name | Type | Description |
---|---|---|
Authentication | string | Authentication token |
Request Body
Name | Type | Description |
---|---|---|
BaseSubjectId | boolean | Archive flag |
BaseSubjectId | string | Base Subject ID |
BaseSubjectIdentifier | string | Base Subject Identifier |
DataVersion | string | Data Version of Software |
FrameworkFileId | string | Framework file ID |
Id | string | Software ID |
Identifier | string | Software Identifier |
InstallationFileId | string | Installation file ID |
InstallationFileName | string | Installation file name |
InstructionFileId | string | Instruction file ID |
InstructionFileName | string | Instruction file name |
ModificationAllowed | boolean | Modification allowed flag |
Name | string | Software Name |
NeedsPublicIp | boolean | Public IP flag |
ProjectId | string | Project ID |
SoftwareFileId | string | Software file ID |
SoftwareFileName | string | Software file name |
SoftwareFileSize | number | Software file size |
SubjectType | string | Subject type |
Uri | string | Webpage URL |
Variables | array | Variables array |
Delete Subject
DELETE
https://[customer].testresults.io/api/projects/:pId/subjects/:sId
Removes Subject.
Path Parameters
Name | Type | Description |
---|---|---|
pId | string | Project ID |
sId | string | Subject ID |
Headers
Name | Type | Description |
---|---|---|
Authentication | string | Authentication token |
Last updated