REST API¶
新的HTTP/JSON API在没有JSON-RPC信封的情况下,从MCP目录中披露了业务业务. 可用的操作依赖于已安装的服务器版本. 它是一个面向操作的API,而不是每个数据库表格的单独的CRUD接口.
访问和权限¶
发送现有的 MCP API 密钥为 Authorization: Bearer <key>。 。 。 。 必须在全球和项目中扶持多边方案。 项目密钥也要求 X-ZTM-Project-UniqueId。 。 。 。 全球钥匙需要明确的项目进入项目业务。 浏览器和 Windows 的登录不能替换 API 密钥 。
用户权限,写出闸门,允许的能力和演示限制与MCP一样适用. 在本地测试之外使用HTTPS. 永远不要在 URL,源代码或日志中设置密钥. 见 安全行动与多方案方案.
发现操作¶
| 请求 | 结果 |
|---|---|
GET /api/v1/operations |
现有关键和项目可用的业务和投入合同 |
GET /api/v1/operations/{operationId} |
一份业务合同 |
GET /api/v1/openapi.json |
OpenAPI 3.1 用于同一授权背景 |
POST /api/v1/operations/{operationId} |
以参数对象执行为请求正文 |
POST /api/v1/resources/read |
读取密钥绑定导出资源 |
OpenAPI包含每个可用操作的混凝土POST路径. 输入使用与MCP相同的计划. 图书馆健康、结果稳定性、项目附件和发布比较/shot已输入输出计划。 其他动态查询/行动结果保留了可扩展的JSON合同。 该目录包括共享查询和动作工具;并非每个Web菜单项目都有专用的终点.
$headers = @{
Authorization = "Bearer $env:ZTM_API_KEY"
'X-ZTM-Project-UniqueId' = $env:ZTM_PROJECT_UNIQUE_ID
}
$baseUrl = 'https://your-server.example'
Invoke-RestMethod "$baseUrl/api/v1/operations" -Headers $headers
Invoke-RestMethod "$baseUrl/api/v1/operations/ztm_usage_guide" `
-Method Post -Headers $headers -ContentType 'application/json' -Body '{}'
这些环境变量由调用PowerShell脚本读取;它们不会自动配置服务器. 路由工程使用信头,而非操作参数. JSON体限1米B和32个筑巢水平. 重复的地产名称被拒绝.
读取办公室预览设置¶
一个全局的 MCP API 密钥可以用 POST /api/v1/operations/ztm_admin_office_preview_settings_get 和身体的颜色 {}曰如何是无碍境. 一个例子是: {"xlsxPreviewMode":"HtmlTable"}; 其他可能的值为 DevExpressPdf曰如何是无碍境. 项目密钥不足 。 此操作只读 。 使用 服务器管理 来改变设置。
书写和出口¶
遵循每个操作的预览和明确承诺合同,例如ztm_project_action_prepare和ztm_project_action_commit. API访问不取代业务审批. 保留预览、 偶数键, 并输入相同的用户和项目上下文 。 超时后,检查动作状态,而不是盲目重复写作.
出口可返回a resourceUri。 。 。 。 读一遍 POST /api/v1/resources/read 与 {"uri":"<resourceUri>"} 使用相同的密钥和项目。 答复中包含: contents 带有文本或Base64数据以及MIME类型。 车票可能过期或允许单读;将资源URI视为机密.
错误¶
错误返回 HTTP 状态和 application/problem+json 包含 code 财务报告和已审计财务报表 traceId:400 无效输入,401 缺失/拒绝认证,403 权限不足,404 无法使用的对象或操作,409 动作冲突,413 超大小的机体,415 个不支持的内容类型,500 个内部故障. 冲突需要审查,而不是自动重复。 给支持 traceId,从钥匙或保密有效载荷。
先决条件规则和被阻断的试验¶
ztm_project_query 包含 rule 用于图书馆和计划附属单位: 0 仅仅提示, 1 必须成功, 2 = 一定没有失败。
要改变现有的库依赖性, 使用 ztm_project_action_context,则 ztm_project_action_prepare 与 capabilityId: project.test-case.dependency.set-rule 辩论 testCaseId, dependencyId, rule。 。 。 。 检查预览并用 ztm_project_action_commit。 。 。 。 键需要这种明确的写作能力. 创建保持兼容性:新关系开始作为提示;然后可以更改其规则. 现有的计划和运行不自动同步.
POST /api/v1/operations/ztm_test_prerequisites_read 与 {"plannedVariantId":123} 评估一个可见的计划测试。 答复包括: isBlocked, needsRecheck 财务报告和已审计财务报表 blockers。 。 。 。 隐形或失踪的前身不透露姓名; hasHiddenPrerequisites 显示他们。 这种时间点评估不授予执行权或取代个人重新测试确认. 同样的操作是通过MCP提供的.
项目附件¶
ztm_project_attachments_read 列出项目附件及其 ownerId,与 offset 财务报告和已审计财务报表 limit (最多100个). 供应 attachmentId 要下载 contentBase64 (最高32米B). 需要一名活跃的项目管理员或项目经理。 动态链接的文件被列出,但无法通过此操作下载.
写作需要单独的 project.attachment.upload, project.attachment.update 或 减 减 project.attachment.delete 能力。 现有的规划附赠赠款不提供项目档案查阅。 使用返回的键 ownerId,对于一个项目来说可以是 0。
- 上传: 调用
ztm_project_attachment_stage与targetKind: "project",targetId: <ownerId>,fileName,mimeType财务报告和已审计财务报表contentBase64曰如何是无碍境. 现有的装配极限为每个文件512 KiB. - 调用
ztm_project_action_prepare有了这个能力,就有了一个新的idempotencyKey财务报告和已审计财务报表arguments。 。 。 。 上传参数 :ownerKind: "project",ownerId罚单attachmentReferenceId选择displayName财务报告和已审计财务报表remarks。 。 。 。 元数据更新 :ownerKind,ownerId,attachmentId,displayName,remarks。 。 。 。 删除:ownerKind,ownerId,attachmentId. - 审查预览并通过
ztm_project_action_commit同样的钥匙。 同步编辑会引发冲突;重放成功的承诺不会创建另一个附件.
发布比较和决定¶
ztm_release_snapshots_list 列表可读保存的比较与可选选项 targetId 过滤器。 传回 NextCursor 作为 cursor 以读取下一页。
ztm_release_compare 接受 baseId, targetId,明确 baseRunIds/targetRunIds 和可选 baseScopeRunIds/targetScopeRunIds 数组 { "runId": 123, "scopeRunId": 123 }。 。 。 。 可选 baseSnapshotId/targetSnapshotId 选择保存的证据。 它返回网络比较,包括 Fingerprint,应用相同的选择和对象许可规则。
为了保全证据,明确准许 project.release-review.snapshot-create 编写/承诺论点 query (比较参数对象), name 财务报告和已审计财务报表 fingerprint。 。 。 。 证据的更改被驳回。 读一下保存的比较 decisionRevision 和决定历史 ztm_release_snapshot_read 财务报告和已审计财务报表 snapshotId; historyBeforeRevision 页面 旧的决定。
一项决定还要求: project.release-review.decision-record、项目管理许可和明确的人类授权。 准备接受 snapshotId, targetId, revision, outcome (1项接受,2项有条件接受,3项拒绝,4项撤销), responsibleUserId, comment, openPoints (每行1条)和 humanConfirmed: true曰如何是无碍境. 服务器记录了经认证的演员;旗帜并不取代实际的人类认可. 检查预览,然后承诺。 网络规则依然适用:当前修订,符合条件的责任用户,解释,完整范围和未变证据. 历史项目副本无法收到新的决定。
覆盖面和限制¶
REST和MCP共享其运行目录. 这并不意味着对每个Web功能的完整报道. 项目附件现在有一个单独的写作合同;现有的测试案例、要求和计划上传合同仍然是分开的。 在能力目录中仍然可以看到推迟的行动。
浏览器演示文稿,文件选择器对话框和交互式登录不需要单独的域端点. 个人确认实际人工重试不是代表测试者自动生成的. 发布概览/PDF和自动化进口使用其现有的业务;REST运输没有扩大其域范围. 如上文所述,项目附件撰写和发布比较/决定操作现已提供。 任意服务器路径和本地桥文件链接仍然停留在这些API操作之外. 独立变体复制和显示文件导入不是审查的Web执行中单独的动作. 类型输出包括项目附件和发布比较/snapshot;现有的动态查询/动作输出仍然可扩展的JSON,没有完全输入SDK模型.
测试大小写版本¶
测试大小写版本 可通过下列方式获取: POST /api/v1/operations/ztm_project_test_case_versions曰如何是无碍境. 使用 operation: "list", testCaseID 和可选 skip 财务报告和已审计财务报表 take 对于带有当前标题的限定列表。 read 还要求 revisionID时 compare 添加 otherRevisionID; asset 用途 revisionID 财务报告和已审计财务报表 assetID 并返回基数64-编码字节。 restore-preview 检查 revisionID 反对 expectedHead.
准备通过 ztm_project_action_prepare,能力 project.test-case-version.restore,和参数 testCaseID, revisionID, expectedHead选择 note 财务报告和已审计财务报表 options。 。 。 。 通过确认返回的代号 ztm_project_action_commit. options 可能载有明确排除的内容。 excludedAttributeIDs 财务报告和已审计财务报表 flattenUnavailableReusableSteps。 。 。 。 项目绑定,活动用户身份,对象权限,写范围以及演示保护仍然适用. 永远不要将 API 密钥放入实例,日志或 shell 历史 。
图书馆健康和结果稳定¶
这些读取操作使用与Web报告相同的服务和对象权限. 无需提供书面赠款。 它们不修改、删除或执行测试。
| 行动 | 可选过滤器 |
|---|---|
ztm_library_health_read |
unitId 包括后裔 或 减 减 caseId; ageDays 1–36500(违约180); reason; page 从1开始; pageSize 1 - 100( 默认 50) |
ztm_test_stability_read |
testPlanId; testEnvironmentId (0用于无环境); fromUtc, toUtc 作为 UTC 时间戳, 如 2026-11-08T12:00:00Z; lookbackRuns 1 - 200( 默认 50) |
示例 POST /api/v1/operations/ztm_library_health_read 与 {"ageDays":180,"reason":"NoVisibleUsage","pageSize":25}曰如何是无碍境. 输入的响应包括: Findings, CandidateCount, ScannedCaseCount, IsComplete, Limit, Page 财务报告和已审计财务报表 PageSize。 。 。 。 原因是 NoVisibleUsage, NeverVisiblyExecuted, LongUnchanged, MissingTitle, MissingSteps, MissingExpectedResults, EmptyQuickContent 财务报告和已审计财务报表 NoVariants曰如何是无碍境. 原因可能重叠。 没有明显的使用不能确定整个项目没有使用测试;长期不变的内容不会自动过时。 分析仅限于2000个明显案例和20000个明显用途。 当使用分析不完整时,负使用指标就会被抑制.
示例 POST /api/v1/operations/ztm_test_stability_read 与 {"lookbackRuns":50}曰如何是无碍境. 答复包括: Series, FailureGroups,个人 Evidence 和计数 EligibleRuns, IncludedRuns, EligibleResults, IncludedResults, Truncated 财务报告和已审计财务报表 InvalidEvidenceCount。 。 。 。 它在可见的完成运行中使用当前每个运行/大小写/变量的结果,而不是完整的执行历史. 最多对20000个结果观测结果进行分析。 各种变体、环境和原产地是分开的;建筑差异仍然显而易见。 ContentDifferences 财务报告和已审计财务报表 ContentFingerprint 仅比较保存的测试大小写描述,而不是完整的历史规格. 结果变化是指标,而不是片面性的证据。 匹配失败文本不能证明一个共同的原因 。 Origin:0 = 经核实的电流自动化,1 = 其他或未经核实的来源,2 = 已更改或无效的自动化证据.
使用显示的输入外壳 。 无效范围, 时间戳或未知过滤器返回400; 无法读取的显式库对象返回403. 同样的工具和过滤器也通过MCP提供.
参考基线¶
参考基线 提供工程选项、列表、历史内容、当前比较和保存文件的输入操作。 创作使用准备/承诺明确授予的 project.library-baseline.create 能力; 没有编辑、恢复或删除操作。 参见链接的章节,关于工具名称,范围参数,重试规则和API文件响应的512 KiB限制.
规划树和定制结果状况¶
ztm_project_planning_tree_read 返回允许的规划树以及可用的结果定义和运行过滤器。 示例请求:
{"resultDefinitionIds": [12, 15], "includeNoResult": true}
使用来自 resultDefinitions;示例ID是占位符。 状态ID使用 OR; 可选 treeFilterObjectId 进一步限制运行。 发件选择( Omited selections) 表示该请求没有过滤器, 独立于保存的 UI 偏好 。 结果遵循了用户的树可见度设置,返回时只允许节点. 未知的显式ID被拒绝 。 阅读操作不改变个人喜好或测试结果. 同一合同可通过MCP获得。
属性值来源¶
对于现有的属性动作, ztm_project_action_context 添加 Metadata 改为: PromotedFields 财务报告和已审计财务报表 ObjectAttributes。 。 。 。 包括: AttributeId, AttributeStyleFieldId,字段名称,样式ID和名称,字段类型,所有者类型和ID, Entail,以及 SourceKind (direct, inherited, default) (中文(简体) ). 未保存的默认值没有所有者ID 。 缺失的字段定义保留其原始字段ID,而其定义细节则无效.
通过MCP和MCP可获取同样的信息。 POST /api/v1/operations/ztm_project_action_context。 。 。 。 现有的属性动作的权限和能力仍然适用;上下文访问不会给予额外的读取权限. 密码字段不在此列 。 阅读上下文不会持续默认 。 属性 解释因名而得的继承与晋田的区别.
目标明确的成果反馈¶
仅读工具 ztm_result_feedback_read, ztm_result_feedback_preview 财务报告和已审计财务报表 ztm_result_feedback_export 也可作为下文的POST业务提供 /api/v1/operations/。 。 。 。 每一个都要求其阅读能力 project.result-feedback.read, .preview 或 减 减 .export,加上对选定对象的读取访问。
read 接受 testRunId. preview 添加 resultItemIds (1至100个独特的ID),可选 recipient, subject, message, externalReference 财务报告和已审计财务报表 includeResultText (默认) false) (中文(简体) ). 它的答复包括审查的内容。 Fingerprint. export 使用相同的输入加 expectedFingerprint, format (html 或 减 减 xlsx)和可选 language (de 或 减 减 en) (中文(简体) ). 答复中包含: FileName, ContentType 财务报告和已审计财务报表 ContentBase64.
更改的内容需要另一个预览 。 无法获取的选定结果拒绝整个产出;没有静默的部分导出。 任何操作都不会在工程中发送消息或存储收件人. 见 共享测试结果 用于用户流量和内容限制。
AD 作用规则¶
ztm_ldap_role_rules_get 读取导入配置的规则; ztm_ldap_role_rules_save 以预计的修订本保存它们; ztm_ldap_role_rules_preview 预览成员变化。 ztm_ldap_import_run 运行现有的 AD 导入,包括保存的规则。 与MCP工具相同的操作也可用.
所有电话都要求 configurationId。 。 。 。 保存、预览和导入也要求 expectedRevision 从最新读取的回复。 保存接受 rules 包含稳定的规则ID,启用状态,属性名称,准确值,角色和一个专用的组名称. 呼叫者不选择组ID. 生成的 OpenAPI 合同描述了完整的字段.
保存和导入是行政书写,需要启用具有项目访问和匹配范围的行政密钥。 项目管理许可也经过检查。 预览会更改不包含成员, 但需要访问配置的目录 。 公众演示阻止了这些行政部门的呼唤。 关于修改冲突,请再次阅读和审查配置,而不是盲目重试过时设置的导入。
新鲜度和人工释放缺陷评估¶
ztm_release_evidence_read, ztm_release_evidence_configure 财务报告和已审计财务报表 ztm_release_evidence_observe 阅读年龄限制或存储限制,并明确进行人工缺陷评估。 他们使用匹配的 MCP 合同和当前 expectedRevision。 。 。 。 冲突后重读(409);不要盲目重试. observe 需要实际 referenceId 财务报告和已审计财务报表 sourceFingerprint 从概览来看 report.EvidenceAssessment.Defects外加时 state, criticality, observedUtc 带有明确时区,以及 comment.
专用写框为: project.release-evidence.configure 财务报告和已审计财务报表 project.release-evidence.observe。 。 。 。 已启用的工程写入和与Web相同的放行管理权限也适用. 语句包括录制用户和时间;它们不是自动核实的跟踪器数据,在没有明确的人类指示的情况下,不得发明. ztm_release_overview_read 添加 EvidenceAssessment 用于新实时捕获; 现有 assessment 级别和理由都包含在内。 历史上的俘虏没有改变。 见 释放比较和接受.
结构化测试数据集¶
这些多边CP工具也作为 POST /api/v1/operations/<tool-name> 与同样的合同。 见 测试数据矩阵 功能规则。
工具( 前缀) ztm_test_data_set_) |
参数 | 结果 |
|---|---|---|
list |
无 | 允许的数据集 items |
read |
dataSetId |
带有修订和稳定行标识的数据集 |
save |
data, expectedRevision, confirmed:true |
持续数据集,并作新修订 |
delete |
dataSetId, expectedRevision, confirmed:true |
deleted:true; 引用数据仍然受到保护 |
binding |
variantId |
binding 或 减 减 null |
preview |
variantId, dataSetId, rowId |
文本、诊断和指纹无改动 |
apply |
预览参数, expectedFingerprint, confirmed:true |
继续维持具有约束力和已解决的案文 |
unbind |
variantId, expectedFingerprint, confirmed:true |
unbound:true; 已解决的文本保留 |
export |
dataSetId |
XLSX 密码 fileName, mimeType, contentBase64 |
import_preview |
dataSetId, expectedRevision, contentBase64 |
未保存的提案;明确调用 save 之后 |
数据集字段为 Id, TestUnitId, Name, Revision, Columns 财务报告和已审计财务报表 Rows; 行内包含 Id 财务报告和已审计财务报表 Values曰如何是无碍境. 创建时使用零 GUID 为 Id 和一个空的 expectedRevision。 。 。 。 行需要独特的非零图形化界面。 更新内容需要修改。 冲突结束后,再读一遍并审查这些变化。
这四篇写作需要个人的视野 project.test-data-set.save, .delete, .apply 或 减 减 .unbind,启用项目写入和相关对象权限。 导入预览从未持续, 但需要像 Web 一样的拥有者编辑权限 。 通过API也适用Demo限制. REST使用无记名密钥而不是浏览器 cookie,不需要CSRF的令牌;Web表格仍然需要防伪令牌.
XLSX 使用一个工作表 _RowId 作为第一栏. 公式、宏和外部引用均被拒绝。 限制:4个米B XLSX,16个米B扩展内容,30个数据列,1000行,每个单元格32,767个字符,每个数据集2个米B. 仅保存和导入预览可接受最多6个米B JSON运输,包括Base64;其他操作保留现有的1-米B限制.
binding 还返回无法获取来源的冻结绑定物: SourceAvailable:false 诊断 SourceUnavailable。 。 。 。 当变体可读时,保存的文本仍然可以读取. 刷新需要访问源;无约束使用当前绑定的指纹.
从另一个测试工具导入¶
目前的发展结构提供 POST /api/v1/operations/ztm_vendor_migration_preview 财务报告和已审计财务报表 POST /api/v1/operations/ztm_vendor_migration_apply (单位:千美元) 从另一个工具迁移曰如何是无碍境. 同等的MCP工具共享这一合同.
供应 targetUnitId, sourceKey, workbookBase64 和可选 attachmentsZipBase64.
供应商表,加上 provider (试验机、xray、zephyr、qase或中性)和 fileName 以.xlsx或.csv结尾. 继续发送字节 workbookBase64。 。 。 。 默认使用检测列。 使用 mapping 指定外部索引、 名称、 文件夹页、 描述、 先决条件、 步骤、 预期成果和附件页。 应用预览时使用相同的源,文件和映射. 没有这些字段的中性XLSX请求保持他们现有的行为.
预览使用读取能力 project.vendor-migration.preview。 。 。 。 一个项目读取密钥就足够了;其用户还需要允许才能在目标中创建案例. 预览不需要写入范围 。 它回来了 Fingerprint, Items, Diagnostics 财务报告和已审计财务报表 CanApply 而不省钱。 仅在下列情况下应用 CanApply 真实; 更改后审查新预览。
要应用,请发送相同的文件,预览指纹为 expectedFingerprint,新的UUUID为 operationId 财务报告和已审计财务报表 confirmed: true。 。 。 。 网络中断后用相同的UUID重试同一操作.
应用需要启用的写入动作和 project.vendor-migration.apply 范围。 对象权限和演示限制与Web工作流程匹配. JSON请求包括Base64数据仅限于6个米B.
当项目数据库繁忙时, REST 返回 HTTP 503 与 DatabaseBusy 财务报告和已审计财务报表 Retry-After: 2。 。 。 。 MCP 返回 actionErrorCode: "DatabaseBusy" 财务报告和已审计财务报表 retryAfterSeconds: 2 在错误数据中。 访问发布后, 用同样的请求重试 operationId;保存的收据在检查权限和当前内容后再次返回,而不再创建副本。
交出试运行¶
使用个人工程密钥 project.test-run.handover 写入读取合格收件人和当前修改的范围。 MCP和REST使用相同的论据.
- 调用
ztm_project_action_context与{"capabilityId":"project.test-run.handover","itemKind":"test-run","itemId":23}. - 选择一个 ID 从
Recipients和使用情况Revision作为expectedRevision。 。 。 。 例如,电话ztm_run_handover或 减 减POST /api/v1/operations/ztm_run_handover与{"runId":23,"recipientUserId":7,"expectedRevision":0}.
Applied 证实移交已保存。 mailStatus 报告提交情况(续)Sent, NotConfigured, MissingAddress, MissingLink 或 减 减 Failed) (中文(简体) ). 重复请求当前收件人返回 AlreadyApplied 与 mailStatus: null。 。 。 。 冲突结束后再次读取上下文(HTTP 409)。 密钥所有者需要权限来编辑运行 。 全局密钥和演示实例无法执行移交 。
分配计划测试案例¶
- 使用
ztm_project_action_context读取每次运行的当前状态。 发送{"capabilityId":"project.test-run.assign","itemKind":"test-run","itemId":23}。 。 。 。 选择从Cases和收件者从Recipients. - 调用
ztm_run_assign输入或发送POST /api/v1/operations/ztm_run_assign。 。 。 。 对于未指定的案件,请提供例如:{"recipientUserId":7,"selection":[{"caseId":42,"runId":23,"expected":null}]}。 。 。 。 如果案件已经指定,请通过userId,assignedUtc财务报告和已审计财务报表assignedByUserId下级expected曰如何是无碍境. 传球recipientUserId: null以清除任务。 - 读取工作量通过
ztm_run_workload_read或 减 减POST /api/v1/operations/ztm_run_workload_read与{"planId":9}.
书写需要个人密钥,其中包含 project.test-run.assign 范围、运行编辑权限和访问所选实例。 公众演示中无法提供。 关于冲突,请再次读取当前状态. 每个请求都会在一个操作中保存其选择. 工作负荷只包括可见的开跑.
读取发布覆盖¶
- 调用
ztm_coverage_matrix_read输入或发送POST /api/v1/operations/ztm_coverage_matrix_read与{}.Releases包含可见的释放ID和名称。 - 发送选中的
releaseId和可选filter。 。 。 。 举例来说,{"releaseId":"6bebaee0-20b9-4ff8-b4d1-abdd5d37833c","filter":"without-result"}。 。 。 。 过滤器all,without-test,without-result财务报告和已审计财务报表failed匹配浏览器视图。 - 读取
Rows要求、试验案例和环境。Status无结果为0,不可评估为1,通过为2,失败为3,部分通过为4。 所保存的证据可见的地方,单元格包括ResultItemId,RunTitle,RecordedUtc财务报告和已审计财务报表Tester.Totals计算过滤要求。 一项要求可能涉及若干类别。
您需要个人项目密钥并读取请求的数据 。 项目必须启用要求功能。 这个操作读取矩阵.
创建和撤销状态链接¶
调用 ztm_share_link_create 在MCP中,或 POST /api/v1/operations/ztm_share_link_create 在REST。 。 。 。 两人接受同样的JSON身体.
{"targetKind":"run","targetId":"23","validityDays":7,"requestId":"869744c5-8cdb-45e1-a300-918d308345f1","includeErrors":false,"includeFindings":false}
设定 targetKind 改为: run, plan 或 减 减 release。 。 。 。 将目标ID作为字符串提供,使用它的UUID发布. 选择七或三十日. 问题和调查结果默认是隐藏的。 添加 recipientEmail 通过项目电子邮件发送链接。
保留 shareId 用于撤销。 回复返回来宾地址 url 一次,连同 expiresUtc 财务报告和已审计财务报表 mailStatus (NotRequested, Sent 或 减 减 Failed) (中文(简体) ). 根据 API 端点的源头解决相对的宾客地址 。 把地址,包括它的碎片,当作密码处理. 如果发送失败, 链接已经创建 。 重试中相同的 requestId 无法创建另一个链接或发送另一个电子邮件。 如果答复丢失,应撤销原条目 共享链接 在创建替换之前。
撤销为 ztm_share_link_revoke 或 减 减 POST /api/v1/operations/ztm_share_link_revoke 财务报告和已审计财务报表 {"shareId":"<share UUID>"}曰如何是无碍境. 答复中包含: shareId 财务报告和已审计财务报表 revokedUtc。 。 。 。 重复撤销返回原时间戳.
两种动作都需要 HTTPS( 本地允许循环) , 启用的项目写法和带有相关内容的个人项目密钥 project.share-link.create 或 减 减 project.share-link.revoke 范围。 目标权限和演示限制与网络客户端一样适用. 见 来宾访问.
编辑数个测试大小写¶
调用 ztm_library_bulk_update 在MCP中,或 POST /api/v1/operations/ztm_library_bulk_update曰如何是无碍境. 例如,预览设置模块属性 :
{"operation":"preview","action":"attribute","caseIds":[12,31],"attributeName":"Modul","attributeValue":"Checkout"}
检查 Rows。 。 。 。 准备 operation 改为: apply 并提交返回的参数 Fingerprint 输入 fingerprint。 。 。 。 在其中添加一个 UUID requestId 重新来过。 在服务器保留工作时,用该ID重复同样的请求返回其收件. HTTP 409需要新的预览.
使用 targetUnitId 与 move 或 减 减 archive, reviewGroupId 与 review,以及 variantValueIds 与 variant。 。 。 。 存档目的地必须标注为存档单位. 每一份申请最多接受200个测试案例。 使用个人工程密钥 project.test-library.bulk-update 范围。 服务器检查每个案件的当前权限 。 全球密钥和演示访问被封禁 。
使用 {"operation":"undo","requestId":"<RequestId from receipt>"} 在任务留在服务器内存时,使用相同的工程密钥来撤销移动或属性变化。 再次检查权限和干扰更改 。
可选布尔 isArchive 输入 project.test-unit.update 参数标记单位为归档。 使用已有的预览/承诺流 itemId 财务报告和已审计财务报表 title。 。 。 。 发声 isArchive 保留其价值。 项目知识股也读出 isArchive.
重新测试选定结果¶
ztm_library_retest 或 减 减 POST /api/v1/operations/ztm_library_retest 使用与 维护测试库:
- 发送
operation: "options"财务报告和已审计财务报表findings读取允许的源运行、环境和测试器。 每项发现都包含caseId,plannedCaseId或 减 减resultId; 包括已知variantId,planId财务报告和已审计财务报表runId。 。 。 。 明确选择有多个时的上下文 。 - 发送
operation: "preview",相同的选择,和planId,runId,environment财务报告和已审计财务报表testerId.Items列出有效的变体,包括强制性先决条件。Skipped以零基选择指数识别被排除在外的结果。 设定acceptOldTemplate: true只有在明确决定使用过时模板之后。 - 发送
operation: "create"输入相同,返回Fingerprint作为fingerprint,以及RequestId作为requestId曰如何是无碍境. 收据包括:RunId,Url并跳过了发现。 在连接失败后, 重试相同的请求ID以避免创建第二次运行 。
预览在30分钟后过期,属于项目和用户. 对选择、权限或内容的修改需要新的预览。 每项请求最多接受200项调查结果;需要现有来源运行。 可选 tab 参数 (health, impact, results也检查是否有相应的标签。
使用带有写范围的个人工程密钥 project.test-library.retest 和在所选计划中创建运行的许可。 全局管理员密钥和公开演示模式不在此列. 现有工具和同步 project.planned-test-case.synchronize-from-library 保持不变。
对象注释¶
使用 ztm_comment_read 以读取一个对象的注释和活动。 供应 kind (test-case, requirement, run, result和(或) id. offset 财务报告和已审计财务报表 activityOffset 独立页。 使用 commentId 查找含有注释的页面。 将返回的Markdown作为用户内容处理 。
ztm_comment_add 保存 markdown 用客户端生成的 UUID 作为 commentId曰如何是无碍境. 供应 parentId 答复。 你可以用这个 mentionUserIds 通知有读取权限的明确选定的项目用户。 案文必须包括提及这些内容。 用相同的UUID和内容重试. Created 区分新注释和重试。 MailFailed 报告一个发送问题,而评论保留。
这两个工具都需要为项目提供评论意见。 它们使用个人项目密钥的主动所有者,并检查当前对象权限. 张贴需要项目写作和 project.comments.add 范围。 REST 用途 POST /api/v1/operations/ztm_comment_read 财务报告和已审计财务报表 POST /api/v1/operations/ztm_comment_add. 网络工作流程
从运行中创建重试¶
MCP 工具 ztm_retest_create 和 REST 路线 POST /api/v1/operations/ztm_retest_create 接受同样的论点。 先预览选择. 这个例子除了失败和被屏蔽的变体外,还包括未经测试的变体.
{"mode":"preview","sourceRunId":36,"includeUntested":true}
审查 RequestedCount,附加先决条件RequiredCount和(或) Errors曰如何是无碍境. 使用环境( E)Environment),测试者身份 Testers 页:1 ComparisonToken 从此预览。 替换示例值,并为每个新请求生成新的 UUID 。 若为: RequiresOldTemplate 创建需要明确批准 acceptOldTemplate: true.
{
"mode": "create",
"sourceRunId": 36,
"includeUntested": true,
"environment": "Staging",
"testerId": 7,
"comparisonToken": "<ComparisonToken>",
"creationId": "179e6928-a673-4dac-acae-b913914a13df"
}
反应包含新的,未启动的运行的 testRunId曰如何是无碍境. 如果连接失败, 请重试相同的请求, 包括其请求 creationId曰如何是无碍境. 两种模式都要求启用写入,即 project.retest.create 范围、工程和对象权限以查看源并创建运行。 也适用解禁限制。 使用网络仪表板.
从测试结果创建一个问题¶
ztm_issue_create_from_result · POST /api/v1/operations/ztm_issue_create_from_result
使用 MCP 工具或其匹配 REST 操作与个人写入范围 project.defect.create曰如何是无碍境. 该 testCaseId 是计划中的变体 ID。 对于结构化步骤,快速行和列表项目, stepIndex 开始于 0。 为总体结果和无结构文字而放弃它。
{"mode":"prepare","testRunId":40,"testCaseId":371,"stepKind":"structured","stepIndex":3}
审查返回的字段和附件选项 。 确定后, 使用返回的 RequestId 作为 requestId 并发送所选值和可访问结果附件ID。
{"mode":"create","testRunId":40,"testCaseId":371,"requestId":"4c2ef7c8-b3a2-43e4-a721-6f04bb164b42","attachmentIds":[38]}
之后 Retryable,一旦有追踪器,就用同样的ID重试。 之后 Unknown,检查跟踪器,并将现有编号发送为 existingIssueReference曰如何是无碍境. 之后 LinkPending,重复将已知问题联系起来的请求。 要直接粘贴截图, 请使用网页对话框 。