| template_get_metadataA | Retrieves template metadata sections for a product template. metadata_type (list[str], required): Sections to fetch.
- "types": Artifact type definitions per artifact kind
(e.g. Requirement types: Use Case, User Story).
- "custom_properties": Custom field definitions per artifact kind.
- "statuses": Status definitions per artifact kind
(Requirement, Incident, Task, Risk, Release, Test Case, Document).
- "priorities": Priority definitions per artifact kind
(Incident, Task, Test Case).
- "severities": Severity definitions (Incident only).
- "importances": Importance definitions (Requirement only).
- "probabilities": Probability definitions (Risk only).
- "impacts": Impact definitions (Risk only).
template_id (int, required): Numeric ID of the product template
(e.g. 45 for PT:45).
artifact_type (str, optional): Filter to a single artifact kind
(e.g. "Requirement"). When omitted, all artifact kinds are fetched.
Returns JSON with template_id, sections dict, and warnings list.
|
| workspace_searchD | – |
| workspace_getD | – |
| product_create_automated_test_runA | Records an automated test result in Spira.
Maps to Spira API: POST /projects/{product_id}/test-runs/record
Use this to push automated test results from CI/CD pipelines into Spira for quality tracking.
Args:
product_id: The numeric ID of the product (e.g., 55 for PR:55). If omitted, uses SPIRA_PROJECT_ID from environment.
test_name: The name of the test being run
short_message: Brief result description (50 chars or less)
long_message: Full test outcome description in plain text
error_count: Number of errors during test (0 if none)
test_case_id: Test case ID without TC prefix (e.g., 12 for TC:12)
execution_status_id: Status (1=Failed, 2=Passed, 3=Not Run, 4=N/A, 5=Blocked, 6=Caution)
Returns:
JSON: {"test_run_id": "TR:123", "message": "Test run recorded successfully"}
Error Responses:
Returns structured JSON with error, error_code, details, and suggestion.
Common error codes: INVALID_PARAMETER, API_ERROR, NOT_FOUND
Example Usage:
result = record_automated_test_run(
product_id=55, test_name="test_login", short_message="Passed",
long_message="Login successful", error_count=0, test_case_id=123, execution_status_id=2
)
|
| product_create_buildA | Creates a new CI/CD pipeline build entry in Spira.
Maps to Spira API: POST /projects/{product_id}/releases/{release_id}/builds
Use this to record CI/CD build results and associate commits with releases.
Args:
product_id: The numeric ID of the product (e.g., 55 for PR:55). If omitted, uses SPIRA_PROJECT_ID from environment.
release_id: Release/sprint ID without RL prefix (e.g., 12 for RL:12)
build_status_id: Build status (1=Failed, 2=Passed)
name: Build name (typically project name + date/time)
description: Detailed build description (what was included and why)
commits: Array of Git commit hashes included in the build
Returns:
JSON: {"build_id": "BL:123", "message": "Build created successfully"}
Error Responses:
Returns structured JSON with error, error_code, details, and suggestion.
Common error codes: INVALID_PARAMETER, API_ERROR, NOT_FOUND
Example Usage:
result = create_build(
product_id=55, release_id=10, build_status_id=2,
name="Build 2024-02-13 v1.5.0", description="Production build",
commits=["abc123", "def456"]
)
|
| get_artifact_schemaA | Returns the field schema for a Spira artifact type as JSON. Args:
artifact_type: One of: task, incident, requirement, test_case,
release, risk, test_set, test_run, automation_host,
capability, milestone
Returns:
JSON: {"artifact_type": "...", "fields": [{"name", "type",
"description"}, ...]}
or {"error": "...", "valid_types": [...]} for unknown types.
Call get_artifact_schema(artifact_type='task') to see fields.
|
| mywork_search_artifactsD | – |
| product_search_artifactsD | – |
| product_get_artifactD | – |
| program_search_artifactsD | – |
