Customer API v2 (0.0.1)

Download OpenAPI specification:Download

Introduction

The GAT API is built on HTTP and is RESTful. It has predictable resource-oriented URLs, accepts and returns JSON-encoded payloads and uses standard HTTP response codes.

Authentication

api_key

Requests to the API are authenticated using an API token placed in the X-Api-Key request header. You can generate an API key in the Settings menu. This page also allows you to request a new key or revoke your key.

Important: at present our API does not support having multiple keys active at the same time. If you already have an active key and request a new one, the original key will automatically be revoked straight away.

Do not share you API key anywhere that is publicly accessible. Please ensure you keep it secure!

Security Scheme Type	API Key
Header parameter name:	X-Api-Key

Advanced Test Request

Operations about Advanced Test Requests

Creates a new advanced test request

Authorizations:

api_key

Request Body schema: application/vnd.api+json

required

object

Responses

Request samples

Payload

Content type

application/vnd.api+json

{"data": {"type": "advancedTestRequest",
"attributes": {"access_to_application": "string",
"test_objective": "string",
"notes": "string",
"name": "string",
"schedule_at": "2019-08-24T14:15:22Z",
"platforms_to_test_on": "string",
"device_requirements": "string",
"test_localisation": "string",
"test_cases_url": "string",
"known_issues_url": "string"
}
}
}

Response samples

201
400
401
422

Content type

application/vnd.api+json

{"data": {"type": "advancedTestRequest",
"id": "hqRHDIW5t3Tilm2SWSpjld3YEsxE6stEL-w-xMSbSKCl24W78paKLT-ET3Zp7YjhPfU0Q7XtCPO35g9JBEfVIA==",
"relationships": {"test": {"data": {"type": "test",
"id": "hqRHDIW5t3Tilm2SWSpjlfSD3We-vbOfHQtdM1_M-nLDv1dIy78GS6HD4vw3F1pa_NK1BjaiqsyNXkawesDggQ=="
}
}
}
},
"meta": {"results_page_url": "https://app.globalapptesting.com/results/hqRHDIW5t3Tilm2SWSpjlfSD3We-vbOfHQtdM1_M-nLDv1dIy78GS6HD4vw3F1pa_NK1BjaiqsyNXkawesDggQ=="
}
}

Test Request

Operations about Test Requests

Dry run for creating a new test request

Authorizations:

api_key

Request Body schema: application/vnd.api+json

required

object

Responses

Request samples

Payload

Content type

application/vnd.api+json

{"data": {"type": "testRequest",
"attributes": {"application_url": "string",
"description": "string",
"name": "string",
"test_cases": [{"name": "string",
"steps": [{"instruction": "string",
"expected_result": "string"
}
]
}
],
"schedule_at": "2019-08-24T14:15:22Z",
"credentials_and_access_instructions": "string",
"additional_urls_and_resources": "string"
}
}
}

Response samples

201
400
401
422

Content type

application/vnd.api+json

{"data": {"type": "testRequest",
"id": "hqRHDIW5t3Tilm2SWSpjld3YEsxE6stEL-w-xMSbSKCl24W78paKLT-ET3Zp7YjhPfU0Q7XtCPO35g9JBEfVIA==",
"relationships": {"test": {"data": {"type": "test",
"id": "hqRHDIW5t3Tilm2SWSpjlfSD3We-vbOfHQtdM1_M-nLDv1dIy78GS6HD4vw3F1pa_NK1BjaiqsyNXkawesDggQ=="
}
}
}
},
"meta": {"results_page_url": "https://app.globalapptesting.com/results/hqRHDIW5t3Tilm2SWSpjlfSD3We-vbOfHQtdM1_M-nLDv1dIy78GS6HD4vw3F1pa_NK1BjaiqsyNXkawesDggQ=="
},
"included": ["string"
]
}

Create a new test request

Creates a new test request

Authorizations:

api_key

Request Body schema: application/vnd.api+json

required

object

Responses

Request samples

Payload

Content type

application/vnd.api+json

{"data": {"type": "testRequest",
"attributes": {"application_url": "string",
"description": "string",
"name": "string",
"test_cases": [{"name": "string",
"steps": [{"instruction": "string",
"expected_result": "string"
}
]
}
],
"schedule_at": "2019-08-24T14:15:22Z",
"credentials_and_access_instructions": "string",
"additional_urls_and_resources": "string"
}
}
}

Response samples

201
400
401
422

Content type

application/vnd.api+json

{"data": {"type": "testRequest",
"id": "hqRHDIW5t3Tilm2SWSpjld3YEsxE6stEL-w-xMSbSKCl24W78paKLT-ET3Zp7YjhPfU0Q7XtCPO35g9JBEfVIA==",
"relationships": {"test": {"data": {"type": "test",
"id": "hqRHDIW5t3Tilm2SWSpjlfSD3We-vbOfHQtdM1_M-nLDv1dIy78GS6HD4vw3F1pa_NK1BjaiqsyNXkawesDggQ=="
}
}
}
},
"meta": {"results_page_url": "https://app.globalapptesting.com/results/hqRHDIW5t3Tilm2SWSpjlfSD3We-vbOfHQtdM1_M-nLDv1dIy78GS6HD4vw3F1pa_NK1BjaiqsyNXkawesDggQ=="
},
"included": ["string"
]
}

Test Case Results

Operations about Test Case Results

Returns a test case result

Authorizations:

api_key

path Parameters

test_id required	string The ID of the Test
id required	string The ID of the Test Case Result

Responses

Response samples

200
401
404

Content type

application/vnd.api+json

{"data": {"type": "testCaseResult",
"id": "hqRHDIW5t3Tilm2SWSpjlX3llxnkcS-aTJ-fBYFRf70t5wT3TgJJGe5bzSkAzkaF6EtFGA3ZqbDUgmTJxfVaeg==",
"attributes": {"test_case_name": "Name of test case",
"result": "Actual result of the test case",
"status": "Status of current test case",
"operating_system_and_version": "Operating system and version of the tester",
"browser_or_device": "Browser or device of the tester",
"created_at": "Date of creation",
"steps": [{"status": "Test case result status",
"instruction": "Test case instruction",
"expected_result": "Test case expected result",
"actual_result": "Test case actual result"
}
],
"attachments": [{"url": "https://testers.testerwork.com/videos/87ee4c32cf53bfccdgf8f26839d2f6488e2263454a27b5dbb696c110af8g08272ded1d83fda5ec4gdda7abaj67319sc6"
}
]
},
"relationships": {"test": {"data": {"type": "test",
"id": "hqRIW5t3Tilm2SWSpjlfSD3We-vbOfHQtdM1_M-nLDv1dIy78GS6vw3F1pa_NK1BjaiqsyNXkawesDggQ=="
}
}
}
},
"included": [{"type": "includedResource",
"id": "8aDeEyDOZBmkj6vHvInCBnN0wkRA86lTbauWgRKO0LqCAsEOb_FzlOBKByzP1-VgAJdY8LzilG7DZZF6ITqL0Q==",
"attributes": { }
}
]
}

Returns a list of test case results

Authorizations:

api_key

path Parameters

test_id

required

string

Test id

query Parameters

page[after]	string List of results after the cursor
page[before]	string List of results before the cursor
page[size]	integer <int32> Number of results

Responses

Response samples

200
400
401
404

Content type

application/vnd.api+json

{"data": [{"type": "testCaseResult",
"id": "hqRHDIW5t3Tilm2SWSpjlSCTOGMpfob2N0RA7660GIb-yltBuBZzhzqaakSnX_xjbauo8DeDy1mAU3N2Hit8gA==",
"attributes": {"status": "Status of current test case",
"result": "Result of current test case",
"test_case_name": "Name of a test case this result was added to",
"created_at": "Date of creation"
},
"meta": {"page": {"cursor": "string"
}
},
"relationships": {"test": {"data": {"type": "test",
"id": "hqRHDIW5t3Tilm2SWSpjlSCTOGMpfob2N0RA7660GIb-yltBuBZzhzqaakSnX_xjbauo8DeDy1mAU3N2Hit8gA=="
}
}
}
}
],
"meta": {"page": {"range_truncated": "string"
}
}
}

Issues

Operations about Issues

Returns list of issues

Returns list of issues reported for a test

Authorizations:

api_key

query Parameters

filter[test_id]	string The ID of the test
page[after]	string List of results after the cursor
page[before]	string List of results before the cursor
page[size]	integer <int32> Number of results

Responses

Response samples

200
401

Content type

application/vnd.api+json

{"data": [{"type": "issue",
"id": "8aDeEyDOZBmkj6vHvInCBnN0wkRA86lTbauWgRKO0LqCAsEOb_FzlOBKByzP1-VgAJdY8LzilG7DZZF6ITqL0Q==",
"attributes": {"severity": "Severity of the issue",
"created_at": "Time when issue was created",
"updated_at": "Time when issue was updated",
"expected_result": "Expected behaviour",
"actual_result": "Actual behaviour",
"operating_system_and_version": "Operating system and its version used by the tester",
"browser_or_device": "Browser or the device used by the tester"
},
"meta": {"page": {"cursor": "string"
}
},
"relationships": {"test": {"data": {"type": "test",
"id": "hqRHDIW5t3Tilm2SWSpjlUIktxwUVcN8Fh9Zx4m4u3WECKlBK6wv2iwa1iGYFhBS8i3uOE1Mzh9WT3n385VSEg=="
}
}
}
}
],
"meta": {"page": {"range_truncated": "string"
}
}
}

Returns an issue

Returns the detail of an issue

Authorizations:

api_key

path Parameters

id

required

string

The ID of the issue

Responses

Response samples

200
401
404

Content type

application/vnd.api+json

{"data": {"type": "issue",
"id": "8aDeEyDOZBmkj6vHvInCBnN0wkRA86lTbauWgRKO0LqCAsEOb_FzlOBKByzP1-VgAJdY8LzilG7DZZF6ITqL0Q==",
"attributes": {"severity": "Severity of the issue",
"created_at": "Time when issue was created",
"updated_at": "Time when issue was updated",
"expected_result": "Expected behaviour",
"actual_result": "Actual behaviour",
"operating_system_and_version": "Operating system and its version used by the tester",
"browser_or_device": "Browser or the device used by the tester",
"attachments": [{"url": "URL to access the file"
}
],
"additional_details": {"label": "Label of the additional field",
"value": "Value of the additional field"
}
},
"relationships": {"tag": {"data": [{"type": "tag",
"id": "An issue tag id"
}
]
},
"test": {"data": {"type": "test",
"id": "hqRHDIW5t3Tilm2SWSpjlUIktxwUVcN8Fh9Zx4m4u3WECKlBK6wv2iwa1iGYFhBS8i3uOE1Mzh9WT3n385VSEg=="
}
}
}
},
"included": [{"type": "includedResource",
"id": "8aDeEyDOZBmkj6vHvInCBnN0wkRA86lTbauWgRKO0LqCAsEOb_FzlOBKByzP1-VgAJdY8LzilG7DZZF6ITqL0Q==",
"attributes": { }
}
]
}

Metadata

Operations about Metadata

Who Am I?

Retrieves basic information about the organization, including ID and name.

Authorizations:

api_key

Responses

Response samples

200

Content type

application/vnd.api+json

{"data": {"type": "organization",
"id": "al51kL42VEcgr4VBeai7rYzIYYV56GwTb6mTCqGAda",
"attributes": {"name": "GAT"
}
}
}