Xray
Operations
Retrieves a CSV file with the dataset information. The response will contain all information related to the dataset, e.g., parameters and values.
Endpoint used to imports a dataset through a CSV file to an entity. It is only possible to import dataset to the following entities: Test Test Plan - Test Test Execution - Test (Test Run)
Retrives the configuration of the Test Run custom fields for a project, given the project id. The response contains all information related to the custom fields, such as id, name, description, if t...
Retrives the configuration of the Test Step custom fields for a project, given the project id. The response contains all information related to the custom fields, such as id, name, description, if ...
Reset Requirement Status.
Returns a list of projects that are activated for Xray coverage
Activates a list of projects for Xray coverage
Returns all the steps of a test issue given the key. The response contains for each step the corresponding id, index, fields and the attachments. The Test Step fields are identified by their name a...
Create a new test step. All step fields values are listed under fields and identified by the name and a list of attachments to add to the step. The field values should follow a certain format accor...
Deletes a test step attachment, given the test key and step and attachment ids.
Returns all the attachments of a test step, given the test key and step id.
Deletes a test step given the test key and the step id.
Returns the values of a single test step, given the test key and the step id. The response follows the same format as the previous endpoints, containing the step id, index, fields and the attachmen...
Updates the values of an existing test step, given the test key and step id. The user can update the field values and the attachments of a step. The values should follow a specific format similar t...
Retrieves information about a given Test Repository folder. The response will contain all information related to that folder, e.g., id, name, tests count and direct children folder ids.
Retrieves a Test Run given the Test Execution and Test keys. The response will contain all information related to a Test Run, e.g., status, created and finish dates, step results, test environments...
Retrieves a Test Run Custom Field, given the Test Run and the Test Run Custom Field ids.
Updates the value of a test run custom field, given the Test Run and the Test Run Custom Field ids. The custom field value should be a valid value according to the field type. - Toggle Fields value...
Retrieves a Test Run given the Test Execution and Test keys. The response will contain all information related to a Test Run, e.g., status, created and finish dates, step results, test environments...
Retrieves an iteration given the Test Run id and the id of the iteration. The response will contain all the information regarding the iteration (status, parameters, and the steps). The steps will a...
Update all values from an iteration in a Test Run. The user can update the iteration status and the Test Step results of that iteration.
Retrieves all Test Step results for the given iteration.
Remove an evidence from a Test Step result within an iteration.
Remove all evidences with the same filename from the Test step result within an iteration.
Return a json that contains an array with all the execution evidences the Test Step has within an iteration.
Add a new evidence to the Test Step result within an iteration.
Retrieves all the information for the given Test Step result within an iteration.
Updates the Test Step result within an iteration.
Retrieves the Test Step status of a Test Step Result within an iteration.
Updates the Test Step status within an iteration.
Update all the values of a Test Run. The user can update the values of the overall status, step results, assignee, test environments, add defects and evidences and so on. To update the value of a T...
Reset the status of a TestRun.
Returns the list of all Xray issue types.
Installs Xray Issue Type Screens in a received list of projects. From the received list of Projects, for each project it executes the following: Creates the respective screens and screen scheme per...
Returns information about the Xray license, including its status and type.