![]() It also provides the necessary endpoints to import/export tests and test results. It provides the ability to obtain and update Xray related entities and their relations. Version 1.0 has been provided until Xray v3.6.x. importing results) are only available in the Xray REST API. This is the preferred API for Xray cloud, even though some features (e.g. It provides an extensive set of features, allowing you to query and update Xray related data. Xray GraphQL, as of July 2020, is only available in Xray on Jira cloud. In Xray cloud, a specific authentication mechanism is used instead. The Xray REST API in Xray cloud is much more limited (GraphQL is preferred instead).Īs Xray server/DC provides the REST API on top of Jira's REST API, it reuses the same authentication mechanisms provided by Jira (e.g. importing results, obtain relations between entities) for historical reasons, Xray server/DC provides an extensive set of endpoints. Xray REST APIs are used to manipulate data (e.g. In Jira Cloud you need to use API tokens and authenticate using them. using basic auth and the Jira user credentials). In order to use Jira REST API you need to authenticate (e.g. As an example, creating a Test issue can be done using Jira REST API /issue call. As most Xray entities are issue type based, then you can create, delete and even update (to an extent) these using Jira REST API calls. Jira REST API can be used to access and manipulate Jira related entities (e.g. There are several APIs used to interact with Xray related entities: (obtained from a Xray API (JIRA Api token)Īfter adjusting the variables, it is recommended to run the requests in bulk using the collection runner in order to populate the variables (you could also run just the "setup" related requests).Īfterwards, you can send requests individually right from Postman's main screen (i.e. Server specific variables, normally defined within a Postman environment VariableĬloud specific variables, normally defined within a Postman environment VariableĠ011233. Part of them, if not all, can be defined as environment variables in this case you need to create an environment in Postman and define the variables there. In Postman you need to configure variables on the collection adjusting them to the specifics of your environment. Note: Some few requests depend on the outcomes of previous requests. Each request has some basic Postman tests implemented as such, so you can assess their behaviour. The actual requests are organized in multiple folders and subfolders, by the semantics of the requests/URL of endpoint calls. These test data initialization requests are stored under the "setup" folder and will populate some global variables used by subsequent requests. The collection starts by some initial requests that populate the destination Jira instance with some data that will be used by the requests of the collection. Xray on Jira Cloud has a REST API along with a GraphQL API. Xray on Jira server/DC has a pubic REST API. However, APIs allow to do a lot more: obtain entities, their relations and modify/delete them.Īlthough similar, Xray server/datacenter and Xray on Jira cloud are two different products with also slight different characteristics. It's easier to learn by example, isn't it?ĪPIs are used to obtain and update data in Xray, most times they are used to import results from automation frameworks. Then you can play with them and adapt to your needs. The idea is to have some concrete examples of how to make certain, basic requests. ![]() Here you can find some Postman collections that exemplify usage of Xray Test Management public APIs. Table of contents generated with markdown-toc
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |