Update a test case folder
editFolderDestructiveIdempotent
Updates the title and/or description of an existing test case folder. Only provided fields are changed. Pass the '_etag' from the last read to have the edit rejected instead of overwriting a change somebody else made in the meantime.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| _etag | No | Optional conflict tag from the last read or edit of this entity, for a safe read-modify-write: the edit is only applied while nobody else has changed the entity since. Pass it back verbatim, including an empty string. On a mismatch nothing is written and the call answers with status "update_conflict" and the current '_etag' to re-read from. Omit it to overwrite whatever is stored. | |
| title | No | New title for the folder. Omit to keep the existing title. | |
| format | No | Format for rich-text fields (descriptions, preconditions, comments, step & result cells, stepsText & expectedResultText) on both input and output: 'markdown' (default) or 'xml'. Read the matching rich-text format reference resource before producing either. Use 'xml' for BOTH the read and the write whenever you are changing a field that already has content: markdown cannot carry an underline or a text color, so an edit written as markdown writes those away. 'markdown' is for writing new content and for reading you will not edit. | |
| project | Yes | Project ID (number or string), project key or part of the project name | |
| folderId | Yes | The id of the folder to update | |
| description | No | New description for the folder - rich text in the chosen 'format'. Pass an empty string to clear it. Omit to keep the existing description. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| _etag | No | Conflict tag of the entity - pass it to an edit tool's '_etag' to have that edit rejected if somebody changed the entity in the meantime. Empty for an entity that carries no tag yet. | |
| title | No | ||
| status | Yes | ||
| folderId | No |