Projects

Get Projects

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

Gets all active (without archive) projects.

Headers

Name	Type	Description
Authentication	string	Authentication token (Bearer Token) is a unique identifier of an application requesting access to your service. (!) Do not forget to add "Bearer" word and space before token string. Example: "Brearer yourtokenstring"

200 Cake successfully retrieved.

[
    {
        "Name": "0Trio Designer",
        "Description": "",
        "Id": "4ee9cb6a-4b75-4740-96f7-b870f34b16d1"
    }
]

Get recent Projects

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

Gets all recently opened projects.

Headers

Name	Type	Description
Authentication	string	Authentication token

200

[
    {
        "Name": "0Trio Designer",
        "Description": "",
        "Id": "4ee9cb6a-4b75-4740-96f7-b870f34b16d1"
    }
]

Get favorites Projects

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

Gets all favorites projects.

Headers

Name	Type	Description
Authentication	string	Authentication token

200

[
    {
        "Name": "0Trio Designer",
        "Description": "",
        "Id": "4ee9cb6a-4b75-4740-96f7-b870f34b16d1"
    }
]

Get archive Projects

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

Gets all archive projects.

Headers

Name	Type	Description
Authentication	string	Authentications token

200

[
    {
        "Name": "0Trio Designer",
        "Description": "",
        "Id": "4ee9cb6a-4b75-4740-96f7-b870f34b16d1"
    }
]

Get Project details

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

Gets project details.

Path Parameters

Name	Type	Description
pId	string	Project ID

Headers

Name	Type	Description
Authentication	string	Authentication token

200

{
  "DataVersion": "AAAAAAAqAWE=",
  "ReportTemplateId": null,
  "OverallResult": "Error",
  "OverallStatus": "InReview",
  "Archived": false,
  "CustomerId": "00000000-0000-0000-0000-000000000010",
  "Name": "TestResults.io Regression",
  "Description": "",
  "Id": "f00d03ed-38d1-4c65-b42e-cb1ab768ff05"
}

Create new Project

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

Creates a new project.

Headers

Name	Type	Description
Authentication	string	Authentication token

Request Body

Name	Type	Description
Name	string	Project name
Description	string	Project description

200

{
  "DataVersion": "AAAAAAAzfzM=",
  "ReportTemplateId": null,
  "OverallResult": null,
  "OverallStatus": null,
  "Archived": false,
  "CustomerId": "00000000-0000-0000-0000-000000000010",
  "Name": "andr3",
  "Description": "descr",
  "Id": "27a14bd8-7b0e-4e14-83ac-04cc4836a25e"
}

Update Project

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

Updates an existing project.

Path Parameters

Name	Type	Description
pId	string	Project ID

Headers

Name	Type	Description
Authentication	string	Authentication token

Request Body

Name	Type	Description
DataVersion	string	Data Version of project
Id	string	Project ID
Description	string	Project description
Name	string	Project name
Archived	boolean	The flag indicating that the project is in the archive or not
ReportTemplateId	string	Report Template ID

200

{
  "DataVersion": "AAAAAAAqAWE=",
  "ReportTemplateId": null,
  "OverallResult": "Error",
  "OverallStatus": "InReview",
  "Archived": false,
  "CustomerId": "00000000-0000-0000-0000-000000000010",
  "Name": "TestResults.io Regression",
  "Description": "",
  "Id": "f00d03ed-38d1-4c65-b42e-cb1ab768ff05"
}

Remove Project

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

Removes an existing project.

Path Parameters

Name	Type	Description
pId	string	Project ID

Headers

Name	Type	Description
Authentication	string	Authentication token

200