{"id":18459175,"url":"https://github.com/smartbear/zephyr-scale-server-rest-api-scripts","last_synced_at":"2025-07-11T18:37:10.812Z","repository":{"id":46900871,"uuid":"408959493","full_name":"SmartBear/zephyr-scale-server-rest-api-scripts","owner":"SmartBear","description":null,"archived":false,"fork":false,"pushed_at":"2024-08-14T09:10:45.000Z","size":43,"stargazers_count":2,"open_issues_count":0,"forks_count":4,"subscribers_count":17,"default_branch":"main","last_synced_at":"2025-04-08T05:34:53.829Z","etag":null,"topics":["on-prem","open-source","zephyr-scale"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SmartBear.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-09-21T20:06:22.000Z","updated_at":"2025-01-10T10:44:02.000Z","dependencies_parsed_at":"2024-11-06T08:36:43.170Z","dependency_job_id":null,"html_url":"https://github.com/SmartBear/zephyr-scale-server-rest-api-scripts","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/SmartBear/zephyr-scale-server-rest-api-scripts","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SmartBear%2Fzephyr-scale-server-rest-api-scripts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SmartBear%2Fzephyr-scale-server-rest-api-scripts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SmartBear%2Fzephyr-scale-server-rest-api-scripts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SmartBear%2Fzephyr-scale-server-rest-api-scripts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SmartBear","download_url":"https://codeload.github.com/SmartBear/zephyr-scale-server-rest-api-scripts/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SmartBear%2Fzephyr-scale-server-rest-api-scripts/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264872554,"owners_count":23676680,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["on-prem","open-source","zephyr-scale"],"created_at":"2024-11-06T08:22:07.843Z","updated_at":"2025-07-11T18:37:10.782Z","avatar_url":"https://github.com/SmartBear.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Zephyr Scale Server REST API Scripts\n\nExample scripts to automate tasks in Zephyr Scale Server via the [REST API](https://support.smartbear.com/zephyr-scale-server/api-docs/v1/).\n\nThe examples are intentionally simple to provide a quick start for REST API users.\n\nWe recommend you to fork this repository and change it to meet your specifications.\n\nSee the [Zephyr Scale API Docs](https://support.smartbear.com/zephyr-scale-server/api-docs/v1/) for more information about the API usage.\n\n# Requirements\n\nThe scripts are based on [Node.js](https://nodejs.org/), please make sure you have the latest Node.js LTS version installed.\n\nAfter forking or cloning the project, go to the root folder and run the following command to install the dependencies:\n\n```\nnpm install\n```\n\nIn the sections below you can see the current available scripts.\n\n## Projects\n\nZephyr Scale resources are linked to Jira projects, so in order to use Zephyr Scale, first create the projects in Jira and then create the Zephyr Scale projects.\n\n### Create Zephyr Scale Projects\n\nFirst, open the template file `projects/resources/projects.js` and edit it to meet your requirements.\n\nThen, create the Zephyr Scale projects running the following command:\n\n```\nnpm run projects:create -- \\\n  --host https://JIRA_HOST \\\n  --username JIRA_USERNAME \\\n  --password JIRA_PASSWORD\n```\n\n## Custom Fields\n\nZephyr Scale supports Custom Fields for different resources, like Test Cases, Test Cycles and more.\n\n### Create Custom Fields\n\nFirst, open the template file `customFields/resources/customFields.js` and edit it to meet your requirements.\n\nThen, create the Custom Fields running the following command:\n\n```\nnpm run customFields:create -- \\\n  --host http://JIRA_HOST \\\n  --username JIRA_USERNAME \\\n  --password JIRA_PASSWORD\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmartbear%2Fzephyr-scale-server-rest-api-scripts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsmartbear%2Fzephyr-scale-server-rest-api-scripts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmartbear%2Fzephyr-scale-server-rest-api-scripts/lists"}