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

200 Cake successfully retrieved.

[
  {
    "Identifier": "1.0",
    "Name": "TestResults.io",
    "Uri": "https://stage.testresults.io",
    "SoftwareFileId": "6cd6774c-cf1a-4419-bb44-659f32face0c",
    "SubjectType": "Webpage",
    "NeedsPublicIp": false,
    "InstallationFileId": "92a1ca92-03dc-42a4-b24c-5a0bf134f083",
    "InstructionFileId": null,
    "SoftwareFileSize": 34,
    "SoftwareFileName": "webpage.bat",
    "InstallationFileName": "WebpageInstaller.dll",
    "InstructionFileName": null,
    "ModificationAllowed": true,
    "FrameworkFileId": "77317f79-2167-414e-a21b-30cc1f2b028f",
    "BaseSubjectId": null,
    "BaseSubjectIdentifier": null,
    "PassRate": 89,
    "Id": "fe36cc18-87dc-4b02-969a-1559641c8a9c"
  },
  {
    "Identifier": "dummy",
    "Name": "no installer",
    "Uri": "https://stage.testresults.io",
    "SoftwareFileId": "6a7b3085-690e-40a3-916f-f4231150b4e2",
    "SubjectType": "Webpage",
    "NeedsPublicIp": false,
    "InstallationFileId": null,
    "InstructionFileId": null,
    "SoftwareFileSize": 34,
    "SoftwareFileName": "webpage.bat",
    "InstallationFileName": null,
    "InstructionFileName": null,
    "ModificationAllowed": true,
    "FrameworkFileId": "9187536c-4c4b-4468-9ce1-26fd121e5bbd",
    "BaseSubjectId": null,
    "BaseSubjectIdentifier": null,
    "PassRate": 3,
    "Id": "96c2a4de-6865-48e0-8b29-89f20e166f32"
  }
]

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

200

[
  {
    "Identifier": "1.0",
    "Name": "TestResults.io",
    "Uri": "https://stage.testresults.io",
    "SoftwareFileId": "6cd6774c-cf1a-4419-bb44-659f32face0c",
    "SubjectType": "Webpage",
    "NeedsPublicIp": false,
    "InstallationFileId": "92a1ca92-03dc-42a4-b24c-5a0bf134f083",
    "InstructionFileId": null,
    "SoftwareFileSize": 34,
    "SoftwareFileName": "webpage.bat",
    "InstallationFileName": "WebpageInstaller.dll",
    "InstructionFileName": null,
    "ModificationAllowed": true,
    "FrameworkFileId": "77317f79-2167-414e-a21b-30cc1f2b028f",
    "BaseSubjectId": null,
    "BaseSubjectIdentifier": null,
    "PassRate": 89,
    "Id": "fe36cc18-87dc-4b02-969a-1559641c8a9c"
  },
  {
    "Identifier": "dummy",
    "Name": "no installer",
    "Uri": "https://stage.testresults.io",
    "SoftwareFileId": "6a7b3085-690e-40a3-916f-f4231150b4e2",
    "SubjectType": "Webpage",
    "NeedsPublicIp": false,
    "InstallationFileId": null,
    "InstructionFileId": null,
    "SoftwareFileSize": 34,
    "SoftwareFileName": "webpage.bat",
    "InstallationFileName": null,
    "InstructionFileName": null,
    "ModificationAllowed": true,
    "FrameworkFileId": "9187536c-4c4b-4468-9ce1-26fd121e5bbd",
    "BaseSubjectId": null,
    "BaseSubjectIdentifier": null,
    "PassRate": 3,
    "Id": "96c2a4de-6865-48e0-8b29-89f20e166f32"
  }
]

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

200

{
  "DataVersion": "AAAAAAAzliY=",
  "Archived": false,
  "Variables": [
    {
      "PoolName": "",
      "IsSecured": true,
      "ValidationRule": "",
      "ValidationErrorMsg": null,
      "Name": "AdminPW",
      "DisplayName": "Automation user password",
      "Content": "admin"
    },
    {
      "PoolName": "",
      "IsSecured": false,
      "ValidationRule": "",
      "ValidationErrorMsg": null,
      "Name": "AdminLoginName",
      "DisplayName": "Automation user Login Email",
      "Content": "[e-mail]"
    }
  ],
  "ProjectId": "f00d03ed-38d1-4c65-b42e-cb1ab768ff05",
  "Identifier": "1.0",
  "Name": "TestResults.io",
  "Uri": "https://stage.testresults.io",
  "SoftwareFileId": "6cd6774c-cf1a-4419-bb44-659f32face0c",
  "SubjectType": "Webpage",
  "NeedsPublicIp": false,
  "InstallationFileId": "92a1ca92-03dc-42a4-b24c-5a0bf134f083",
  "InstructionFileId": null,
  "SoftwareFileSize": 34,
  "SoftwareFileName": "webpage.bat",
  "InstallationFileName": "WebpageInstaller.dll",
  "InstructionFileName": null,
  "ModificationAllowed": true,
  "FrameworkFileId": "77317f79-2167-414e-a21b-30cc1f2b028f",
  "BaseSubjectId": null,
  "BaseSubjectIdentifier": null,
  "PassRate": 89,
  "Id": "fe36cc18-87dc-4b02-969a-1559641c8a9c"
}

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")

200

{
  "Identifier": "222",
  "Name": "test sw",
  "Uri": "http://google.com",
  "SoftwareFileId": "ea9064a8-2043-4b39-90b8-316d6a3bea1c",
  "SubjectType": "Webpage",
  "NeedsPublicIp": false,
  "InstallationFileId": null,
  "InstructionFileId": null,
  "SoftwareFileSize": 0,
  "SoftwareFileName": null,
  "InstallationFileName": null,
  "InstructionFileName": null,
  "ModificationAllowed": true,
  "FrameworkFileId": null,
  "BaseSubjectId": "f1cf141e-55bf-4fb3-a6e0-73cf977b868f",
  "BaseSubjectIdentifier": null,
  "PassRate": 0,
  "Id": "ef4723c8-07db-4551-805a-9f5f7cd1b217"
}

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

200

{
  "DataVersion": "AAAAAAAzljA=",
  "Archived": false,
  "Variables": [
    {
      "PoolName": "",
      "IsSecured": true,
      "ValidationRule": "",
      "ValidationErrorMsg": null,
      "Name": "AdminPW",
      "DisplayName": "Automation user password",
      "Content": "admin"
    },
    {
      "PoolName": "",
      "IsSecured": false,
      "ValidationRule": "",
      "ValidationErrorMsg": null,
      "Name": "AdminLoginName",
      "DisplayName": "Automation user Login Email",
      "Content": "[e-mail]"
    },
    {
      "PoolName": "",
      "IsSecured": false,
      "ValidationRule": "",
      "ValidationErrorMsg": null,
      "Name": "ProjectName",
      "DisplayName": "Name of the Automated Project",
      "Content": "Automated Regression Project"
    },
    {
      "PoolName": "",
      "IsSecured": true,
      "ValidationRule": "",
      "ValidationErrorMsg": null,
      "Name": "LoginPW",
      "DisplayName": "Password",
      "Content": "demo"
    },
    {
      "PoolName": "",
      "IsSecured": false,
      "ValidationRule": "",
      "ValidationErrorMsg": null,
      "Name": "LoginName",
      "DisplayName": "Login Email",
      "Content": "[e-mail]"
    }
  ],
  "ProjectId": "f00d03ed-38d1-4c65-b42e-cb1ab768ff05",
  "Identifier": "1.0",
  "Name": "TestResults.io",
  "Uri": "https://stage.testresults.io",
  "SoftwareFileId": "6cd6774c-cf1a-4419-bb44-659f32face0c",
  "SubjectType": "Webpage",
  "NeedsPublicIp": false,
  "InstallationFileId": "92a1ca92-03dc-42a4-b24c-5a0bf134f083",
  "InstructionFileId": null,
  "SoftwareFileSize": 34,
  "SoftwareFileName": "webpage.bat",
  "InstallationFileName": "WebpageInstaller.dll",
  "InstructionFileName": null,
  "ModificationAllowed": false,
  "FrameworkFileId": "77317f79-2167-414e-a21b-30cc1f2b028f",
  "BaseSubjectId": null,
  "BaseSubjectIdentifier": null,
  "PassRate": 89,
  "Id": "fe36cc18-87dc-4b02-969a-1559641c8a9c"
}

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

200