list_document_enum_options
Retrieve valid enum options for a document field by document type to avoid setting invalid values when updating a document.
Instructions
List valid enum options for a document field of the given document type.
Call this before update_document when you need to pick a value
for a document's status / type / custom enum field. Polarion
does NOT validate these values on write -- unknown ids are stored
verbatim as ghost values -- so resolve them first. This tool covers
DOCUMENT fields only; work-item fields are surfaced via
list_work_item_enum_options.
Returns the FULL enum set for the field on the given document type.
Workflow transitions are NOT filtered by the document's current
state; that is a separate Polarion endpoint not exposed here.
document_type='~' returns the type-agnostic option set. An unknown
document_type is silently treated as ~ by Polarion with no error,
so verify the type id (e.g. via get_document) before trusting
the result.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| project_id | Yes | Polarion project ID. | |
| field_id | Yes | Field id (e.g. 'status', 'type', or a custom field id). | |
| document_type | Yes | Document type id (e.g. 'systemReqSpecification'). Pass '~' for type-agnostic options. | |
| page_size | No | Number of options per page (1-100, default 100). | |
| page_number | No | Page number to retrieve (1-based, default 1). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| items | Yes | ||
| total_count | Yes | ||
| page | Yes | ||
| page_size | Yes | ||
| has_more | No | True if more pages follow. |