list_document_enum_options
Retrieve valid enum option IDs for a Polarion document field to avoid write rejections. Verify available values before creating or updating documents.
Instructions
List valid enum option ids for a document field of a given type.
Call this before create_document / update_document — invalid enum ids are rejected on write. An unknown document_type silently falls back to '~', so verify the type id first.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"project_id": "<project_id>",
"field_id": "<field_id>",
"document_type": "<document_type>"
},
"name": "list_document_enum_options"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| field_id | Yes | e.g. 'status', 'type', or a custom field id. | |
| page_size | No | ||
| project_id | Yes | Polarion project ID. | |
| page_number | No | ||
| document_type | Yes | e.g. 'systemReqSpecification'; '~' = type-agnostic. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | Yes | ||
| items | Yes | ||
| has_more | No | ||
| page_size | Yes | ||
| total_count | Yes |