Environments

Get Environments

GET https://[customer].testresults.io/api/projects/:pId/environments

Gets all active (without archive) Environments.

Path Parameters

Name	Type	Description
pId	string	Project ID

Headers

Name	Type	Description
Authentication	string	Authentication token

200 Cake successfully retrieved.

[
  {
    "Name": "Ubuntu 17 (local)",
    "ImageFileId": null,
    "ContainedSubject": null,
    "ImageFileSize": 0,
    "ModificationAllowed": true,
    "TargetGroup": "ubuntu17box",
    "FileProjectId": "00000000-0000-0000-0000-000000000000",
    "Username": "TestResults",
    "Password": "tr.io",
    "Id": "a30e91bc-50c0-4815-9d33-c46d53ba943f"
  },
  {
    "Name": "Windows 10 (local)",
    "ImageFileId": null,
    "ContainedSubject": null,
    "ImageFileSize": 0,
    "ModificationAllowed": true,
    "TargetGroup": "b8aeed7fa02a",
    "FileProjectId": "00000000-0000-0000-0000-000000000000",
    "Username": "TestResults",
    "Password": "tr.io",
    "Id": "e6dd6cdb-acec-4452-99ca-52fa6b6ef06a"
  }
]

Get archive Environments

GET https://[customer].testresults.io/api/projects/:pId/environments/archive

Gets archive Environments.

Path Parameters

Name	Type	Description
pId	string	Project ID

Headers

Name	Type	Description
Authentication	string	Authentication token

200

[
  {
    "Name": "Ubuntu 17 (local)",
    "ImageFileId": null,
    "ContainedSubject": null,
    "ImageFileSize": 0,
    "ModificationAllowed": true,
    "TargetGroup": "ubuntu17box",
    "FileProjectId": "00000000-0000-0000-0000-000000000000",
    "Username": "TestResults",
    "Password": "tr.io",
    "Id": "a30e91bc-50c0-4815-9d33-c46d53ba943f"
  },
  {
    "Name": "Windows 10 (local)",
    "ImageFileId": null,
    "ContainedSubject": null,
    "ImageFileSize": 0,
    "ModificationAllowed": true,
    "TargetGroup": "b8aeed7fa02a",
    "FileProjectId": "00000000-0000-0000-0000-000000000000",
    "Username": "TestResults",
    "Password": "tr.io",
    "Id": "e6dd6cdb-acec-4452-99ca-52fa6b6ef06a"
  }
]

Get Environment details

GET https://[customer].testresults.io/api/projects/:pId/environments/:eId

Gets Environment details.

Path Parameters

Name	Type	Description
pId	string	Project ID
eId	string	Environment ID

Headers

Name	Type	Description
Authentication	string	Authentication token

200

{
  "DataVersion": "AAAAAAANT4E=",
  "Archived": false,
  "ProjectId": "f00d03ed-38d1-4c65-b42e-cb1ab768ff05",
  "Name": "Ubuntu 17 (local)",
  "ImageFileId": null,
  "ContainedSubject": null,
  "ImageFileSize": 0,
  "ModificationAllowed": true,
  "TargetGroup": "ubuntu17box",
  "FileProjectId": "00000000-0000-0000-0000-000000000000",
  "Username": "TestResults",
  "Password": "tr.io",
  "Id": "a30e91bc-50c0-4815-9d33-c46d53ba943f"
}

Create new Environment

POST https://[customer].testresults.io/api/projects/:pId/environments

Creates new Environment.

Path Parameters

Name	Type	Description
pId	string	Project ID

Headers

Name	Type	Description
Authentication	string	Authentication token

Request Body

Name	Type	Description
Username	string	User name
Password	string	Password
ContainedSubject	string	Contained Subject
ImageFileId	string	Image file ID
Name	string	Environment Name
TargetGroup	string	Target Group

200

{
  "Name": "bbbb",
  "ImageFileId": "bfa1669a-4ac7-4c01-a461-8d8f0fddded4",
  "ContainedSubject": null,
  "ImageFileSize": 0,
  "ModificationAllowed": false,
  "TargetGroup": "azure",
  "FileProjectId": "00000000-0000-0000-0000-000000000000",
  "Username": "aa",
  "Password": "aa",
  "Id": "f7077338-0cc1-4707-95e7-4e7ca2c6c6fb"
}

Update Environment

PUT https://[customer].testresults.io/api/projects/:pId/environments/:eId

Updates an existing Environment

Path Parameters

Name	Type	Description
pId	string	Project ID
eId	string	Environment ID

Headers

Name	Type	Description
Authentication	string	Authentication token

Request Body

Name	Type	Description
Archived	boolean	Archive flag
ContainedSubject	string	Contained subject ID
DataVersion	string	Data Version of Environment
FileProjectId	string	File project ID
Id	string	Environment ID
ImageFileId	string	Image file ID
ImageFileSize	number	Image file size
ModificationAllowed	boolean	Modification allowed
Name	string	Environment Name
Password	string	Password
ProjectId	string	Project ID
TargetGroup	string	Target group
Username	string	User name

200

{
  "DataVersion": "AAAAAAAzly0=",
  "Archived": false,
  "ProjectId": "3e4b7f24-76ec-4bf4-941d-09972e1c46a7",
  "Name": "bbbb",
  "ImageFileId": "bfa1669a-4ac7-4c01-a461-8d8f0fddded4",
  "ContainedSubject": null,
  "ImageFileSize": 207164,
  "ModificationAllowed": true,
  "TargetGroup": "azure",
  "FileProjectId": "3e4b7f24-76ec-4bf4-941d-09972e1c46a7",
  "Username": "aa",
  "Password": "aa",
  "Id": "f7077338-0cc1-4707-95e7-4e7ca2c6c6fb"
}

Delete Environment

DELETE https://[customer].testresults.io/api/projects/:pId/environments/:eId

Removes an Environment.

Path Parameters

Name	Type	Description
pId	string	Project ID
eId	string	Environment ID

Headers

Name	Type	Description
Authentication	string	Authentication token

200