{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"d5b7ebcf-9c12-477b-8af3-5e4d47cec575","name":"Vansah Test Management For Jira","description":"Vansah's API can be used to integrate Vansah with various tools, automation and development frameworks including third-party applications. The main usage for the API is to allow our customers to integrate their automated tests and submit test results to [Vansah Test Management For Jira](https://marketplace.atlassian.com/apps/1224250/vansah-test-management-for-jira). For a full detail of what other tasks you can perform using the API the list can be obtained from this documentation.\n\nAPI Endpoint URL can be obtained from your Jira workspace under Apps > Vansah.\n\n<img src=\"https://content.pstmn.io/c8d6aab4-7a7b-4166-a55e-1ffb6994c251/YXBwcy12YW5zYWgucG5n\">\n\nClick on settings from top right hand corner of screen.\n\n<img src=\"https://content.pstmn.io/6ef27502-f69d-4f26-b634-162e537a4bf3/dmFuc2FoLWFwaS10b2tlbnMucG5n\">\n\nFrom menu select: **Vansah API Tokens**\n\n<img src=\"https://content.pstmn.io/d037f95a-b48c-49d8-8f72-c1cfcb2ae0c4/dmFuc2FoLWFwaS11cmwucG5n\">\n\n# Overview\n\nVansah's API is HTTP-based and can used from any framework, programming language and tool. Submitting data to Vansah via the API is done via simple POST requests. Requesting data is done through GET requests. All requests and responses use the JSON format and UTF-8 encoding.\n\nVansah's API is HTTP-based and you can use simple HTTP requests to interact with it. All written requests must use the HTTP POST method, and all read requests must use the HTTP GET method. Data is transferred in the JSON format and UTF-8 encoding.\n\n# Authentication\n\nVansah expects an authorization token to be provided for all API's.\n\nAPI tokens can be generated from your Vansah app settings found within your Jira Workspace. API tokens can be generated and revoked at any time.\n\n**More Information:** [API &amp; Integrations](https://help.vansah.com/en/collections/10346619-api-integrations) | [API Documentation](https://apidocs.vansah.com)\n\nLearn how to generate a Vansah [API Token](https://help.vansah.com/en/articles/9824979-generate-a-vansah-api-token-from-jira) in Jira\n\n# Error Codes\n\n**10XX : Main App Errors**  \n'1000': 'App Server Error, please contact the admin'  \n'1001': 'Missing Headers'  \n'1002': 'Missing Parameters'  \n'1003': 'Invalid offset or limit'  \n'1004': 'Invalid Locale'  \n'1005': 'Invalid Timezone'  \n'1006': 'You exceeded the limit of requests per minute\n\n**11XX : Http Errors**  \n'1101': 'Unauthorized'  \n'1102': 'Not authorized to access'  \n'1103': 'Un-processable Entity'  \n'1104': 'Authentication Failed'  \n'1105': 'Not Found'\n\n**12XX : Auth Erorrs**  \n'1201': 'Your session is expired, please login again' # **Token expired**  \n'1202': 'Your sessions is invalid' # verification error  \n'1203': 'Your sessions is invalid' # Error encountered while decoding token  \n'1204': 'Your sessions token is invalid' # Invalid token  \n'1205': 'You are Unauthorized, Please login' # You are Unauthorized, Please login  \n'1206': 'Authentication Error, User Not found' # Authentication Error, User Not found  \n'1207': 'User token not authorized for workspace\"\n\n**13XX : Session Errors**  \n'1301': 'Invalid Session or Token'  \n'1302': 'Invalid Login Type'  \n'1303': 'Invalid Social Type'  \n'1304': 'Authentication Error'  \n'1305': 'You Account is disabled by the admin.'  \n'1306': 'Invalid details.'  \n'1307': 'Wrong confirmation code! Try again.'  \n'1308': 'Invalid token'  \n'1309': 'Duplicate data found.'  \n'1310': 'Your request is invalid.'  \n'1311': 'You are not authorized to access this app'  \n'1312': 'link has expired'  \n'1312': 'token has expired'  \n'1313': 'API Token Rate Limit reached'\n\n# Rate limit\n\nAPI Rate Limits: 500 hits per min for each token applies.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"2945476","team":270678,"collectionId":"d5b7ebcf-9c12-477b-8af3-5e4d47cec575","publishedId":"2sAY545yHe","public":true,"publicUrl":"https://apidocs.vansah.com","privateUrl":"https://go.postman.co/documentation/2945476-d5b7ebcf-9c12-477b-8af3-5e4d47cec575","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"f07530"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Explore Vansah's comprehensive API documentation for seamless test management integration with Jira. Leverage AI-powered test case generation, real-time reporting, and automation framework support. Streamline your testing workflow, enhance productivity, and deliver higher-quality software with Vansah's powerful REST AP"},{"name":"title","value":"Vansah API Collection"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/f9331944-ebde-4929-b8f3-a10c6ad79a94/NTEyeDUxMi0wMS0xWzFdLnBuZw==","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"f07530"}},{"name":"light","logo":"https://content.pstmn.io/f9331944-ebde-4929-b8f3-a10c6ad79a94/NTEyeDUxMi0wMS0xWzFdLnBuZw==","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"f07530"}}]}},"version":"8.10.1","publishDate":"2024-11-12T04:48:07.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Vansah API Collection","description":"Explore Vansah's comprehensive API documentation for seamless test management integration with Jira. Leverage AI-powered test case generation, real-time reporting, and automation framework support. Streamline your testing workflow, enhance productivity, and deliver higher-quality software with Vansah's powerful REST AP"},"logos":{"logoLight":"https://content.pstmn.io/f9331944-ebde-4929-b8f3-a10c6ad79a94/NTEyeDUxMi0wMS0xWzFdLnBuZw==","logoDark":"https://content.pstmn.io/f9331944-ebde-4929-b8f3-a10c6ad79a94/NTEyeDUxMi0wMS0xWzFdLnBuZw=="}},"statusCode":200},"environments":[{"name":"Demo","id":"29808cbf-0cba-46d9-96a5-db3ffccb92ef","owner":"2945476","values":[{"key":"project_identifier","value":"","enabled":true},{"key":"step_key","value":"","enabled":true},{"key":"release_identifier","value":"","enabled":true},{"key":"case_key","value":"","enabled":true},{"key":"case_type_identifier","value":"","enabled":true},{"key":"case_state_identifier","value":"","enabled":true},{"key":"case_status_identifier","value":"","enabled":true},{"key":"search_type","value":"jira_issue_key","enabled":true},{"key":"jira_issue_key","value":"","enabled":true},{"key":"release_key","value":"R1","enabled":true},{"key":"environment_key","value":"UAT","enabled":true},{"key":"build_key","value":"","enabled":true},{"key":"cycle_key","value":"1","enabled":true},{"key":"build_identifier","value":"","enabled":true},{"key":"environment_identifier","value":"","enabled":true},{"key":"case_identifier","value":"","enabled":true},{"key":"agent_key","value":"","enabled":true},{"key":"parent_cycle_identifier","value":"","enabled":true},{"key":"cycle_identifier","value":"","enabled":true},{"key":"plan_identifier","value":"","enabled":true},{"key":"asset_key","value":"","enabled":true},{"key":"asset_associate_key","value":"","enabled":true},{"key":"user_identifier","value":"","enabled":true},{"key":"log_identifier","value":"","enabled":true},{"key":"export_cols","value":"headline","enabled":true},{"key":"asset_identifier","value":"","enabled":true},{"key":"selected_row_identifiers","value":"","enabled":true},{"key":"asset","value":"case","enabled":true},{"key":"asset_type_identifier","value":"","enabled":true},{"key":"custom_field_identifier","value":"","enabled":true},{"key":"dashboard_identifier","value":"","enabled":true},{"key":"category","value":"priority","enabled":true},{"key":"category_identifier","value":"","enabled":true},{"key":"asset_state_identifier","value":"","enabled":true},{"key":"industry","value":"","enabled":true},{"key":"company","value":"","enabled":true},{"key":"workspace_name","value":"","enabled":true},{"key":"testplan_identifier","value":"","enabled":true},{"key":"testplan_key","value":"","enabled":true},{"key":"vansah_incident_key","value":"","enabled":true},{"key":"sequence_identifier","value":"","enabled":true},{"key":"step_identifier","value":"","enabled":true},{"key":"step_order","value":"","enabled":true},{"key":"vansahConnectToken","value":"<vansahConnectToken>","enabled":true},{"key":"case_keys","value":"","enabled":true},{"key":"jira_account_id","value":"","enabled":true},{"key":"group_by","value":"case","enabled":true,"type":"default"},{"key":"test_run_type","value":"misc","enabled":true,"type":"default"},{"key":"case_context_token","value":"","enabled":true,"type":"default"},{"key":"jiraContextToken","value":"","enabled":true,"type":"default"},{"key":"apiUrl","value":"https://prod.vansah.com","enabled":true,"type":"default"},{"key":"testRunIdentifier2","value":"<testRunIdentifier>","enabled":true,"type":"any"},{"key":"testRunKey","value":"<testRunKey>","enabled":true,"type":"default"},{"key":"nodeApiVersion","value":"v1","enabled":true,"type":"default"},{"key":"logIdentifier","value":"","enabled":true,"type":"default"},{"key":"projectKey","value":"DEMO","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/30d0b5685bd20eb0a7f5674b37bad6830da478ec13c39531da4e43690cecc874","favicon":"https://res.cloudinary.com/postman/image/upload/v1731374385/team/f4d2b253d5ebe2a4c24a3be68dbd2f88.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Demo","value":"2945476-29808cbf-0cba-46d9-96a5-db3ffccb92ef"}],"canonicalUrl":"https://apidocs.vansah.com/view/metadata/2sAY545yHe"}