Page History
...
API provided by | type of API | versions | URL syntax | authentication | purpose | notes | |
---|---|---|---|---|---|---|---|
1 | Xray | REST API | v1, v2 | https://xray.cloud.getxray.app/api/v1/<resource_name> https://xray.cloud.getxray.app/api/v2/<resource_name> |
|
| This is the most used API, as it used for importing test automation results. |
2 | Xray | GraphQL | v2 | https://xray.cloud.getxray.app/api/v2/graphql |
Note: to make GraphQL requests, an initial REST API call needs to be made to the authentication endpoint |
| This API cannot be used to import test automation results. This API is more advanced and usually only required whenever implementing some custom scenarios. |
3 | Jira | REST API | v3 | https://<site_url>/rest/api/3/<resource_name> Note: <site_url> can be something like <xxx>.atlassian.net or it can be your own domain, in case you have it defined for your Jira cloud instance. |
|
| This API does not provide ways of accessing/modifying internal Xray data, such as test steps, for example. |
...
API provided by | type of API | versions | URL syntax | authentication | purpose | notes | |
---|---|---|---|---|---|---|---|
1 | Xray | REST API | v1.0, v2.0 | <jira_base_url>/rest/raven/1.0/api/<resource_name> <jira_base_url>/rest/raven/2.0/api/<resource_name> |
|
| This is the most used API, as it used for importing test automation results. |
2 | Jira | REST API | latest | <jira_base_url>/rest/api/latest/<resource_name> |
|
| This API does not provide ways of accessing/modifying internal Xray data, such as test steps, for example. |
...
Therefore, make sure you are using the proper documentation of the REST API, either Xray Cloud REST API or the Xray server/DC REST API one.
There's an open-source repository on GitHub with some code samples, in different languages, that you can check out
Note: the import of Cucumber or Behave JSON reports follows a different flow than the standard one. More info on that here.
...