Zephyr: Update Test Cycle
zephyr_update_test_cycleUpdate an existing test cycle by merging changes to prevent accidental property deletion. Modify fields such as name, dates, folder, status, owner, or custom fields.
Instructions
Update an existing Test Cycle in Zephyr. This operation fetches the current test cycle and merges your updates with it to prevent accidental property deletion. To remove a property, set it to null explicitly. The plannedStartDate and plannedEndDate fields cannot be cleared
Toolset: Test Cycles
Parameters:
testCycleIdOrKey (string) required: The ID or key of the test cycle.
id (number): The ID of the entity
key (string): Unique key of the test cycle
name (string)
project (object): ID and link relative to Zephyr project.
jiraProjectVersion (number): The ID of the Jira project version (release) to associate.
status (object): ID and link to the status resource.
folder (number): The ID of the folder to move the test cycle into.
description (string): Description outlining the scope.
plannedStartDate (string): Planned start date of the test cycle. This field cannot be blank. Setting it as null or excluding it from the request will leave the field values unchanged. ISO 8601 Format (i.e., yyyy-MM-dd'T'HH:mm:ss'Z')
plannedEndDate (string): The planned end date of the test cycle. This field cannot be blank. Setting it as null or excluding it from the request will leave the field values unchanged. ISO 8601 Format (i.e., yyyy-MM-dd'T'HH:mm:ss'Z')
owner (string): Atlassian Account ID of the Jira user to set as owner.
customFields (record<string, any>): Multi-line text fields support HTML and should denote new lines with the <br> tag. Dates should be in the format 'yyyy-MM-dd'. Users should have values of Jira User Account IDs.
Examples:
Update the name of the test cycle 'SA-R40' to 'Sprint 1 Regression - Updated' and set description.
{
"testCycleIdOrKey": "SA-R40",
"name": "Sprint 1 Regression - Updated",
"description": "Updated regression scope for Sprint 1"
}Expected Output: The test cycle should be updated, but no output is expected.
Update planned dates for test cycle id '1' (keep everything else unchanged).
{
"testCycleIdOrKey": "1",
"plannedStartDate": "2018-05-19T13:15:13Z",
"plannedEndDate": "2018-05-20T13:15:13Z"
}Expected Output: The test cycle should be updated, but no output is expected.
Change folder and status for test cycle 'SA-R40' by setting folder id and status id.
{
"testCycleIdOrKey": "SA-R40",
"folder": 100006,
"status": {
"id": 10000
}
}Expected Output: The test cycle should be updated, but no output is expected.
Update custom fields on test cycle 'SA-R40' while keeping other custom fields intact.
{
"testCycleIdOrKey": "SA-R40",
"customFields": {
"Build Number": 20,
"Release Date": "2020-01-01"
}
}Expected Output: The test cycle should be updated, but no output is expected.
Remove the owner from test cycle 'SA-R40'.
{
"testCycleIdOrKey": "SA-R40",
"owner": null
}Expected Output: The test cycle should be updated, but no output is expected.
Remove a specific custom field 'Pre-Condition(s)' from test cycle 'SA-R40' while keeping other custom fields intact.
{
"testCycleIdOrKey": "SA-R40",
"customFields": {
"Pre-Condition(s)": null,
"Implemented": false
}
}Expected Output: The test cycle should be updated, but no output is expected.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | The ID of the entity | |
| key | No | Unique key of the test cycle | |
| name | No | ||
| owner | No | Atlassian Account ID of the Jira user to set as owner. | |
| folder | No | The ID of the folder to move the test cycle into. | |
| status | No | ID and link to the status resource. | |
| project | No | ID and link relative to Zephyr project. | |
| description | No | Description outlining the scope. | |
| customFields | No | Multi-line text fields support HTML and should denote new lines with the \<br\> tag. Dates should be in the format 'yyyy-MM-dd'. Users should have values of Jira User Account IDs. | |
| plannedEndDate | No | The planned end date of the test cycle. This field cannot be blank. Setting it as null or excluding it from the request will leave the field values unchanged. ISO 8601 Format (i.e., yyyy-MM-dd'T'HH:mm:ss'Z') | |
| plannedStartDate | No | Planned start date of the test cycle. This field cannot be blank. Setting it as null or excluding it from the request will leave the field values unchanged. ISO 8601 Format (i.e., yyyy-MM-dd'T'HH:mm:ss'Z') | |
| testCycleIdOrKey | Yes | The ID or key of the test cycle. | |
| jiraProjectVersion | No | The ID of the Jira project version (release) to associate. |