Skip to main content
Alpha: Document API is currently alpha and subject to breaking changes.

​
Summary

Set page numbering format/start for a section.
  • Operation ID: sections.setPageNumbering
  • API member path: editor.doc.sections.setPageNumbering(...)
  • Mutates document: yes
  • Idempotency: conditional
  • Supports tracked mode: no
  • Supports dry run: yes
  • Deterministic target resolution: yes

​
Expected result

Returns a SectionMutationResult receipt; reports NO_OP if page numbering format already matches.

​
Input fields

FieldTypeRequiredDescription
formatenumno"decimal", "lowerLetter", "upperLetter", "lowerRoman", "upperRoman", "numberInDash"
startintegerno
targetSectionAddressyesSectionAddress

​
Example request

{
  "format": "decimal",
  "start": 1,
  "target": {
    "kind": "section",
    "sectionId": "example"
  }
}

​
Output fields

No fields.

​
Example response

{
  "section": {
    "kind": "section",
    "sectionId": "example"
  },
  "success": true
}

​
Pre-apply throws

  • TARGET_NOT_FOUND
  • INVALID_TARGET
  • INVALID_INPUT
  • CAPABILITY_UNAVAILABLE
  • INTERNAL_ERROR

​
Non-applied failure codes

  • NO_OP
  • INVALID_TARGET
  • CAPABILITY_UNAVAILABLE

​
Raw schemas

{
  "additionalProperties": false,
  "oneOf": [
    {
      "required": [
        "target",
        "start"
      ]
    },
    {
      "required": [
        "target",
        "format"
      ]
    }
  ],
  "properties": {
    "format": {
      "enum": [
        "decimal",
        "lowerLetter",
        "upperLetter",
        "lowerRoman",
        "upperRoman",
        "numberInDash"
      ]
    },
    "start": {
      "minimum": 1,
      "type": "integer"
    },
    "target": {
      "$ref": "#/$defs/SectionAddress"
    }
  },
  "required": [
    "target"
  ],
  "type": "object"
}

{
  "oneOf": [
    {
      "additionalProperties": false,
      "properties": {
        "section": {
          "$ref": "#/$defs/SectionAddress"
        },
        "success": {
          "const": true
        }
      },
      "required": [
        "success",
        "section"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "failure": {
          "additionalProperties": false,
          "properties": {
            "code": {
              "enum": [
                "NO_OP",
                "INVALID_TARGET",
                "CAPABILITY_UNAVAILABLE"
              ]
            },
            "details": {},
            "message": {
              "type": "string"
            }
          },
          "required": [
            "code",
            "message"
          ],
          "type": "object"
        },
        "success": {
          "const": false
        }
      },
      "required": [
        "success",
        "failure"
      ],
      "type": "object"
    }
  ]
}

{
  "additionalProperties": false,
  "properties": {
    "section": {
      "$ref": "#/$defs/SectionAddress"
    },
    "success": {
      "const": true
    }
  },
  "required": [
    "success",
    "section"
  ],
  "type": "object"
}

{
  "additionalProperties": false,
  "properties": {
    "failure": {
      "additionalProperties": false,
      "properties": {
        "code": {
          "enum": [
            "NO_OP",
            "INVALID_TARGET",
            "CAPABILITY_UNAVAILABLE"
          ]
        },
        "details": {},
        "message": {
          "type": "string"
        }
      },
      "required": [
        "code",
        "message"
      ],
      "type": "object"
    },
    "success": {
      "const": false
    }
  },
  "required": [
    "success",
    "failure"
  ],
  "type": "object"
}