Summary
Rebuild (recalculate) a field.- Operation ID:
fields.rebuild - API member path:
editor.doc.fields.rebuild(...) - Mutates document:
yes - Idempotency:
idempotent - Supports tracked mode:
no - Supports dry run:
yes - Deterministic target resolution:
yes
Expected result
Returns a FieldMutationResult indicating success or a failure.Input fields
| Field | Type | Required | Description |
|---|---|---|---|
target | object(kind=“field”) | yes | |
target.blockId | string | yes | |
target.fieldId | string | no | |
target.kind | "field" | yes | Constant: "field" |
target.nestingDepth | integer | no | |
target.occurrenceIndex | integer | yes | |
target.storyId | string | no |
Example request
{
"target": {
"blockId": "block-abc123",
"kind": "field",
"nestingDepth": 1,
"occurrenceIndex": 1,
"storyId": "example"
}
}
Output fields
Variant 1 (success=true)
| Field | Type | Required | Description |
|---|---|---|---|
field | object(kind=“field”) | yes | |
field.blockId | string | yes | |
field.fieldId | string | no | |
field.kind | "field" | yes | Constant: "field" |
field.nestingDepth | integer | no | |
field.occurrenceIndex | integer | yes | |
field.storyId | string | no | |
success | true | yes | Constant: true |
Variant 2 (success=false)
| Field | Type | Required | Description |
|---|---|---|---|
failure | object | yes | |
failure.code | string | yes | |
failure.details | any | no | |
failure.message | string | yes | |
success | false | yes | Constant: false |
Example response
{
"field": {
"blockId": "block-abc123",
"kind": "field",
"nestingDepth": 1,
"occurrenceIndex": 1,
"storyId": "example"
},
"success": true
}
Pre-apply throws
TARGET_NOT_FOUNDINVALID_TARGETINVALID_INPUTCAPABILITY_UNAVAILABLE
Non-applied failure codes
- None
Raw schemas
Raw input schema
Raw input schema
{
"additionalProperties": false,
"properties": {
"target": {
"additionalProperties": false,
"properties": {
"blockId": {
"type": "string"
},
"fieldId": {
"type": "string"
},
"kind": {
"const": "field"
},
"nestingDepth": {
"type": "integer"
},
"occurrenceIndex": {
"type": "integer"
},
"storyId": {
"type": "string"
}
},
"required": [
"kind",
"blockId",
"occurrenceIndex"
],
"type": "object"
}
},
"required": [
"target"
],
"type": "object"
}
Raw output schema
Raw output schema
{
"oneOf": [
{
"additionalProperties": false,
"properties": {
"field": {
"additionalProperties": false,
"properties": {
"blockId": {
"type": "string"
},
"fieldId": {
"type": "string"
},
"kind": {
"const": "field"
},
"nestingDepth": {
"type": "integer"
},
"occurrenceIndex": {
"type": "integer"
},
"storyId": {
"type": "string"
}
},
"required": [
"kind",
"blockId",
"occurrenceIndex"
],
"type": "object"
},
"success": {
"const": true
}
},
"required": [
"success",
"field"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"failure": {
"additionalProperties": false,
"properties": {
"code": {
"type": "string"
},
"details": {},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object"
},
"success": {
"const": false
}
},
"required": [
"success",
"failure"
],
"type": "object"
}
]
}
Raw success schema
Raw success schema
{
"additionalProperties": false,
"properties": {
"field": {
"additionalProperties": false,
"properties": {
"blockId": {
"type": "string"
},
"fieldId": {
"type": "string"
},
"kind": {
"const": "field"
},
"nestingDepth": {
"type": "integer"
},
"occurrenceIndex": {
"type": "integer"
},
"storyId": {
"type": "string"
}
},
"required": [
"kind",
"blockId",
"occurrenceIndex"
],
"type": "object"
},
"success": {
"const": true
}
},
"required": [
"success",
"field"
],
"type": "object"
}
Raw failure schema
Raw failure schema
{
"additionalProperties": false,
"properties": {
"failure": {
"additionalProperties": false,
"properties": {
"code": {
"type": "string"
},
"details": {},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object"
},
"success": {
"const": false
}
},
"required": [
"success",
"failure"
],
"type": "object"
}