Bloom tools

Tools for Bloom PLM. Each one calls the Bloom API as the signed-in user, so Bloom’s own permissions and rules apply.

50 tools: 28 read-only, 22 that change data.

Projects and dashboard

bloom_projects_list

List Bloom projects

read-only

List Bloom projects visible to the authenticated user.

No input.

bloom_projects_get

Get Bloom project

read-only

Get one Bloom project by its numeric ID.

Input	Type	Required	Notes
project_id	integer	yes

bloom_projects_create

Create Bloom project

changes data

Create a Bloom project. Requires Bloom maintainer or admin permissions.

Input	Type	Required	Notes
name	string	yes
prefix	string	yes
description	string
status	string		Default "Active".

bloom_dashboard_stats

Get Bloom dashboard statistics

read-only

Get summary PLM statistics across accessible projects (requirements, test cases, coverage, campaigns, defects).

No input.

Requirements

bloom_requirements_list

List Bloom requirements

read-only

List requirements in a Bloom project with optional status filtering.

Input	Type	Required	Notes
project_id	integer	yes
status	string
skip	integer		Default 0. 0 to 9007199254740991.
limit	integer		Default 50. 1 to 200.

bloom_requirements_get

Get Bloom requirement

read-only

Get one Bloom requirement including the data returned by the Bloom API.

Input	Type	Required	Notes
requirement_id	integer	yes

bloom_requirements_create

Create Bloom requirement

changes data

Create a structured requirement in Bloom.

Input	Type	Required	Notes
project_id	integer	yes
parent_id	integer
title	string	yes
description	string
status	string		Default "Draft".
visibility	internal \	customer
priority	string		Default "Medium".
req_type	string		Default "Functional".
req_origin	string		Default "Internal".
reviewer_id	integer
approver_id	integer
content_json	object
content_html	string

bloom_requirements_update

Update Bloom requirement

changes dataupdates or deletes

Update fields on an existing Bloom requirement.

Input	Type	Required	Notes
requirement_id	integer	yes
title	string
description	string
status	string
visibility	internal \	customer
priority	string
req_type	string
req_origin	string
reviewer_id	integer
approver_id	integer
parent_id	integer
content_json	object
content_html	string

bloom_requirements_link_test_run

Link Bud test run to Bloom requirement

changes data

Link an externally hosted Bud test run to a Bloom requirement.

Input	Type	Required	Notes
requirement_id	integer	yes
test_run_id	integer	yes
test_run_name	string
teststation_url	string
status	string

bloom_requirements_list_test_runs

List test runs linked to Bloom requirement

read-only

List Bud test runs linked to a Bloom requirement.

Input	Type	Required	Notes
requirement_id	integer	yes

Test cases and suites

bloom_test_cases_list

List Bloom test cases

read-only

List test cases in a Bloom project with pagination.

Input	Type	Required	Notes
project_id	integer	yes
skip	integer		Default 0. 0 to 9007199254740991.
limit	integer		Default 50. 1 to 200.

bloom_test_cases_get

Get Bloom test case

read-only

Get one Bloom test case by numeric ID including linked requirements, suites, and campaigns.

Input	Type	Required	Notes
test_case_id	integer	yes

bloom_test_cases_create

Create Bloom test case

changes data

Create a verification test case in Bloom.

Input	Type	Required	Notes
project_id	integer	yes
tag_ids	integer[]
title	string	yes
description	string
preconditions	string
steps	object[]
status	string		Default "Draft".
visibility	internal \	customer
reviewer_id	integer
approver_id	integer
content_json	object
content_html	string

bloom_test_cases_update

Update Bloom test case

changes dataupdates or deletes

Update an existing Bloom test case.

Input	Type	Required	Notes
test_case_id	integer	yes
title	string
description	string
preconditions	string
steps	object[]
status	string
visibility	internal \	customer
reviewer_id	integer
approver_id	integer
content_json	object
content_html	string

bloom_test_suites_list

List Bloom test suites

read-only

List reusable test suites in a Bloom project.

Input	Type	Required	Notes
project_id	integer	yes
skip	integer		Default 0. 0 to 9007199254740991.
limit	integer		Default 50. 1 to 200.

bloom_test_suites_get

Get Bloom test suite

read-only

Get one Bloom test suite including its ordered test cases and related requirements.

Input	Type	Required	Notes
suite_id	integer	yes

bloom_test_suites_create

Create Bloom test suite

changes data

Create a reusable test suite in Bloom.

Input	Type	Required	Notes
project_id	integer	yes
tag_ids	integer[]
name	string	yes
description	string
status	string		Default "Draft".
visibility	internal \	customer
test_case_ids	integer[]

bloom_test_suites_update

Update Bloom test suite

changes dataupdates or deletes

Update metadata on a Bloom test suite.

Input	Type	Required	Notes
suite_id	integer	yes
name	string
description	string
status	string
visibility	internal \	customer

bloom_test_suites_add_item

Add test case to Bloom test suite

changes data

Add a test case to a Bloom test suite.

Input	Type	Required	Notes
suite_id	integer	yes
test_case_id	integer	yes

Test campaigns

bloom_campaigns_list

List Bloom test campaigns

read-only

List test campaigns in a Bloom project.

Input	Type	Required	Notes
project_id	integer	yes
status	string
skip	integer		Default 0. 0 to 9007199254740991.
limit	integer		Default 50. 1 to 200.

bloom_campaigns_get

Get Bloom test campaign

read-only

Get one Bloom test campaign including suite scopes, execution items, and related requirements.

Input	Type	Required	Notes
campaign_id	integer	yes

bloom_campaigns_create

Create Bloom test campaign

changes data

Create a test campaign in Bloom.

Input	Type	Required	Notes
project_id	integer	yes
tag_ids	integer[]
name	string	yes
description	string
visibility	internal \	customer
suite_ids	integer[]
test_case_ids	integer[]
bud_run_id	integer
bud_run_url	string
bud_run_status	string

bloom_campaigns_update

Update Bloom test campaign

changes dataupdates or deletes

Update metadata, status, or Bud run reference on a Bloom test campaign.

Input	Type	Required	Notes
campaign_id	integer	yes
name	string
description	string
visibility	internal \	customer
suite_ids	integer[]
bud_run_id	integer
bud_run_url	string
bud_run_status	string
status	string

bloom_campaigns_add_item

Add execution item to Bloom test campaign

changes data

Add a test case execution item to a Bloom test campaign.

Input	Type	Required	Notes
campaign_id	integer	yes
test_case_id	integer	yes

bloom_campaigns_update_item

Update Bloom campaign execution item

changes dataupdates or deletes

Update the comment on a Bloom test campaign execution item.

Input	Type	Required	Notes
campaign_id	integer	yes
item_id	integer	yes
comment	string

Links and traceability

bloom_links_list

List Bloom artefact links

read-only

List typed cross-artefact links in a Bloom project (such as TC verifies REQ).

Input	Type	Required	Notes
project_id	integer	yes
source_type	string
source_id	integer
target_type	string
target_id	integer

bloom_links_create

Create Bloom artefact link

changes data

Create a typed relationship between two Bloom artefacts (e.g. source_type='TC', target_type='REQ', role='verifies').

Input	Type	Required	Notes
project_id	integer	yes
source_type	string	yes
source_id	integer	yes
target_type	string	yes
target_id	integer	yes
role	string	yes
suspect	boolean		Default false.

bloom_links_delete

Delete Bloom artefact link

changes dataupdates or deletes

Delete a cross-artefact link by its numeric ID.

Input	Type	Required	Notes
link_id	integer	yes

bloom_traceability_matrix

Read Bloom traceability matrix

read-only

Read the Bloom traceability matrix for a project.

Input	Type	Required	Notes
project_id	integer	yes
coverage_filter	Covered \	Partial \	Uncovered
priority_filter	string
sort_by	req_id \	priority \	coverage
skip	integer		Default 0. 0 to 9007199254740991.
limit	integer		Default 50. 1 to 200.

bloom_traceability_impact

Analyse Bloom requirement impact

read-only

Compute upstream and downstream impact analysis for a Bloom requirement.

Input	Type	Required	Notes
requirement_id	integer	yes
depth	integer		Default 5. 1 to 20.

bloom_traceability_coverage_gaps

Find Bloom coverage gaps

read-only

Find requirement coverage gaps for a Bloom project.

Input	Type	Required	Notes
project_id	integer	yes

Defects

bloom_defects_list

List Bloom defects

read-only

List defects in a Bloom project with optional status and severity filters.

Input	Type	Required	Notes
project_id	integer	yes
status	string
severity	string
skip	integer		Default 0. 0 to 9007199254740991.
limit	integer		Default 50. 1 to 200.

bloom_defects_get

Get Bloom defect

read-only

Get one Bloom defect by numeric ID.

Input	Type	Required	Notes
defect_id	integer	yes

bloom_defects_create

Create Bloom defect

changes data

Create a defect record in Bloom.

Input	Type	Required	Notes
project_id	integer	yes
tag_ids	integer[]
title	string	yes
description	string
status	string		Default "Open".
severity	string		Default "Medium".
priority	string		Default "Medium".
source_type	string
source_id	integer
owner_id	integer
reporter_id	integer
reviewer_id	integer
resolution_summary	string
external_tracker	string
external_repo_full_name	string
external_issue_number	integer
external_issue_url	string
external_issue_state	string
visibility	internal \	customer

bloom_defects_update

Update Bloom defect

changes dataupdates or deletes

Update an existing Bloom defect.

Input	Type	Required	Notes
defect_id	integer	yes
title	string
description	string
status	string
severity	string
priority	string
source_type	string
source_id	integer
owner_id	integer
reporter_id	integer
reviewer_id	integer
resolution_summary	string
external_tracker	string
external_repo_full_name	string
external_issue_number	integer
external_issue_url	string
external_issue_state	string
visibility	internal \	customer

Designs

bloom_designs_list

List Bloom design items

read-only

List design items in a Bloom project.

Input	Type	Required	Notes
project_id	integer	yes
skip	integer		Default 0. 0 to 9007199254740991.
limit	integer		Default 50. 1 to 200.

bloom_designs_get

Get Bloom design item

read-only

Get one Bloom design item by numeric ID.

Input	Type	Required	Notes
design_id	integer	yes

bloom_designs_create

Create Bloom design item

changes data

Create a design item in Bloom.

Input	Type	Required	Notes
project_id	integer	yes
tag_ids	integer[]
title	string	yes
description	string
status	string		Default "Draft".
priority	string		Default "Medium".
design_type	string		Default "Architecture".
visibility	internal \	customer
content_json	object
content_html	string

bloom_designs_update

Update Bloom design item

changes dataupdates or deletes

Update an existing Bloom design item.

Input	Type	Required	Notes
design_id	integer	yes
title	string
description	string
status	string
priority	string
design_type	string
visibility	internal \	customer
content_json	object
content_html	string

Risks

bloom_risks_list

List Bloom risks

read-only

List risk items in a Bloom project.

Input	Type	Required	Notes
project_id	integer	yes
skip	integer		Default 0. 0 to 9007199254740991.
limit	integer		Default 50. 1 to 200.

bloom_risks_get

Get Bloom risk

read-only

Get one Bloom risk item by numeric ID.

Input	Type	Required	Notes
risk_id	integer	yes

bloom_risks_create

Create Bloom risk

changes data

Create a risk assessment item in Bloom.

Input	Type	Required	Notes
project_id	integer	yes
tag_ids	integer[]
title	string	yes
description	string
status	string		Default "Open".
severity	string		Default "Medium".
probability	string		Default "Medium".
mitigation	string
risk_category	string		Default "Technical".
visibility	internal \	customer
content_json	object
content_html	string

bloom_risks_update

Update Bloom risk

changes dataupdates or deletes

Update an existing Bloom risk item.

Input	Type	Required	Notes
risk_id	integer	yes
title	string
description	string
status	string
severity	string
probability	string
mitigation	string
risk_category	string
visibility	internal \	customer
content_json	object
content_html	string

Baselines

bloom_baselines_list

List Bloom baselines

read-only

List frozen configuration baselines for a Bloom project.

Input	Type	Required	Notes
project_id	integer	yes

bloom_baselines_get

Get Bloom baseline

read-only

Get one Bloom baseline and its frozen artefact snapshot.

Input	Type	Required	Notes
baseline_id	integer	yes

bloom_baselines_create

Create Bloom baseline

changes data

Snapshot current project artefacts into a new Bloom baseline.

Input	Type	Required	Notes
project_id	integer	yes
name	string	yes
description	string
baseline_type	string		Default "Milestone".

Search and document registry

bloom_search

Search Bloom artefacts

read-only

Search across all Bloom artefacts by human document ID or title.

Input	Type	Required	Notes
q	string	yes
project_id	integer
limit	integer		Default 25. 1 to 50.

bloom_docs_list

List Bloom documents

read-only

List documents across all artefact types in a Bloom project (by numeric ID or prefix). project_ref must not be empty, "." or "..".

Input	Type	Required	Notes
project_ref	string	yes
q	string
priority	string
links	linked \	unlinked \	incoming \
related_to	string
role	string
direction	incoming \	outgoing
sort	updated_at \	created_at \	doc_id \
dir	asc \	desc
skip	integer		Default 0. 0 to 9007199254740991.
limit	integer		Default 50. 1 to 500.

bloom_docs_type_summary

Summarise Bloom document types

read-only

Get counts per document type and suspect link counts for a Bloom project. project_ref must not be empty, "." or "..".

Input	Type	Required	Notes
project_ref	string	yes

bloom_docs_get_by_ref

Get Bloom artefact by reference

read-only

Look up any Bloom artefact by project prefix/ID, kind slug (requirements, test-cases, designs, risks, changes, test-concepts, defects, campaigns, test-suites, specifications, protocols, reports, standards), and human document ID (e.g. PRJ-REQ-001). project_ref, kind_slug and doc_id_str must not be empty, "." or "..".

Input	Type	Required	Notes
project_ref	string	yes
kind_slug	string	yes
doc_id_str	string	yes