ContributionsMost RecentMost LikesSolutionsRe: REST API Documentation ebarbera Thanks for the information, I found the API documentation at: https://getzephyr.docs.apiary.io Best regards, Raphael REST API Documentation Hello, i am using the following products: https://aaaaaaaaaaaaaaa/rest/zapi/latest/systemInfo Version: 6.2.4 .... Zephyr for Jira - Test Management for JIRA (Server) ..... ..... ZAPI für JIRA .... ZAPI free App Where can I find the appropriate REST API? Thanks. I think https://zephyrsquad.docs.apiary.io is not the correct site for our installation. Best regards, Raphael SolvedRe: Authentificate using a Token with curl.exe using ZAPI We installed a newer version of Jira Squar, i.e. 6.2.4. Wit this version PATs are supported. Each user can create one and use ist e.g. via curl: curl -X GET -H "Authorization: Bearer <personal_access_token>" -H "Content-Type:multipart/form-data" https://jira-test.intern.hessen.de/rest/zapi/latest/cccccc?ddddd=eeeee On windows cammandline you have to escape "&" character via "^&". Re: Zephyr Squad Server Rest API Hi Anupam1989, I am only starting to use the REST API two weeks ago. You have GET and POST requests. In case you are logged in. You just can open a new browser tab and copy the URL of the GET request you want to issue. Since you are authenticated/login within the browser the request will be processed without asking for credentials. You can do the same via windows comandline using curl.exe (built in in win10). E.g. curl -D- -u XXXXX:YYYYY -X GET -H "X-Atlassian-Token: no-check" https://jira-test.xxxx.de/rest/zapi/latest/cycle?projectId=14145 You have to replace XXXX and YYYYY with your Jira Username and Password. Of course it is no valid approach to hardcode your user credentials within a script. In case you omit ":YYYY" you will be prompted for the password. I am currently looking for a way to use another more secure authentification mechanism (tokens?), which can be used for an impersonate access within scripts. Can you give some more details: OS Windows or Linux, Script/Programming Language to be used for REST communication: Python, Perl, Java, ... Best regards, Raphael Re: Authentificate using a Token with curl.exe using ZAPI I like to use the the OAuth Athentification using curl. I.e. " curl -H "Authorization: OAuth <ACCESS_TOKEN>" ". What is the most straight forward way to generate such an Access Token under Win10. E.g. download an openssl binary run it with some parameters, Log into Zephyr webpage as admin and upload public key? Best regards, Raphael Re: Authentificate using a Token with curl.exe using ZAPI Content of 20211018_upload_attachments_wip_pl.txt: use strict; use warnings; use Term::ReadKey; use JSON; use Data::Dumper; my $user = "USERID"; print "Please supply password and press enter:\n"; ReadMode('noecho'); my $password = ReadLine(0); chomp $password; if ($password eq "") { print "No password supplied. Script will exit.\n"; exit 1; } my $input_cycle = "1231233"; my $response; $response = `curl -sS -u USERID:$password -X GET -H "X-Atlassian-Token: no-check" https://jira-test.mycompany.es/rest/zapi/latest/cycle?projectId=34234`; my $decoded_json; $decoded_json = decode_json($response); my $hr = $decoded_json->{234234}[0]; ... #$response = `curl -sS -u USERID:$password -X POST -H "X-Atlassian-Token: no-check" -H "Content-Type:multipart/form-data" -F "file=\@C:\\Users\\ABC\\Desktop\\Work\\evidence.png" https://jira-test.mycompany.es/rest/zapi/latest/attachment?entityId=${last}&entityType=SCHEDULE`; print $response; Authentificate using a Token with curl.exe using ZAPI Hi, after using the JUnit import functionality in Zephyr Squad, I have to attach some log files as evidence to the executions created by the JUnit test result upload. Since I am not a Java developer but more the scripting guy kind, I was looking for examples how to do this in the most direct way. I found that this is e.g. for uploading an attachment this is to send a POST message to the Jira Server using the ZAPI REST API. On Windows you can use for example curl.exe. E.g. curl -D- -u MyUserID -X POST -H "X-Atlassian-Token: no-check" -F "file=@test_time.txt" https://jira-server.mycompany.es/rest/api/2/issue/ABC-11/attachments Using a 20 line perl script I am able to for example, to retrieve the ids of the test executions via GET requests and then attach specific attachments as evidence to the executions. I have uploaded this script as "20211018_upload_attachments_wip.pl". The script is work in progress and only demonstrated that information can be retrieved via ZAPI API and attachments can be uploaded - nothing else. I read that within the admin interface of the Zephyr Squad plugin it should be possible to generate an access key that can be used in scripts and can be assigned fine tunes access rights (similiar to github tokens). How can I generate these tokens? How can I use the token in curl.exe. Thanks. Best regards, Raphael SolvedRe: Import of TestNG results file Can someone from smartbear confirm that it is an bug within the TestNG import? Thanks. I can provide the generated TestNG result xml file. Re: Usage of REST API in Zephyr Squad Server Post is obsolete. Problem might be that "&" character has to be escaped. Closing Post. Re: Python Example to retrieve information via REST API Hi Matt, thanks a lot for the direction/information. I currently have found a python project (mentioned by atlassian) which works for me to extract data. Also the module seems to have a lot of feature and I do not understand it completely. Also as an authenitfication method I have to provide my domain password, I have not managed to run it with a autentification token. But meanwhile I have wriiten a 20-line perl script which uses plain curl invokations to retrieve and upload data using the ZAPI REST API. Since this worked better understandable for me I am going to use plain GET/POST resquests using curl.exe on windows. I will mark this question as answered. Thanks for your help.