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

​
Summary

Set page border configuration for a section.
  • Operation ID: sections.setPageBorders
  • API member path: editor.doc.sections.setPageBorders(...)
  • 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 border configuration already matches.

​
Input fields

FieldTypeRequiredDescription
bordersany \any \any \any \any \any \anyyesOne of: any, any, any, any, any, any, any
targetSectionAddressyesSectionAddress

​
Example request

{
  "borders": {
    "display": "allPages",
    "offsetFrom": "page",
    "zOrder": "front"
  },
  "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,
  "properties": {
    "borders": {
      "additionalProperties": false,
      "oneOf": [
        {
          "required": [
            "display"
          ]
        },
        {
          "required": [
            "offsetFrom"
          ]
        },
        {
          "required": [
            "zOrder"
          ]
        },
        {
          "required": [
            "top"
          ]
        },
        {
          "required": [
            "right"
          ]
        },
        {
          "required": [
            "bottom"
          ]
        },
        {
          "required": [
            "left"
          ]
        }
      ],
      "properties": {
        "bottom": {
          "additionalProperties": false,
          "oneOf": [
            {
              "required": [
                "style"
              ]
            },
            {
              "required": [
                "size"
              ]
            },
            {
              "required": [
                "space"
              ]
            },
            {
              "required": [
                "color"
              ]
            },
            {
              "required": [
                "shadow"
              ]
            },
            {
              "required": [
                "frame"
              ]
            }
          ],
          "properties": {
            "color": {
              "type": "string"
            },
            "frame": {
              "type": "boolean"
            },
            "shadow": {
              "type": "boolean"
            },
            "size": {
              "minimum": 0,
              "type": "number"
            },
            "space": {
              "minimum": 0,
              "type": "number"
            },
            "style": {
              "type": "string"
            }
          },
          "type": "object"
        },
        "display": {
          "enum": [
            "allPages",
            "firstPage",
            "notFirstPage"
          ]
        },
        "left": {
          "additionalProperties": false,
          "oneOf": [
            {
              "required": [
                "style"
              ]
            },
            {
              "required": [
                "size"
              ]
            },
            {
              "required": [
                "space"
              ]
            },
            {
              "required": [
                "color"
              ]
            },
            {
              "required": [
                "shadow"
              ]
            },
            {
              "required": [
                "frame"
              ]
            }
          ],
          "properties": {
            "color": {
              "type": "string"
            },
            "frame": {
              "type": "boolean"
            },
            "shadow": {
              "type": "boolean"
            },
            "size": {
              "minimum": 0,
              "type": "number"
            },
            "space": {
              "minimum": 0,
              "type": "number"
            },
            "style": {
              "type": "string"
            }
          },
          "type": "object"
        },
        "offsetFrom": {
          "enum": [
            "page",
            "text"
          ]
        },
        "right": {
          "additionalProperties": false,
          "oneOf": [
            {
              "required": [
                "style"
              ]
            },
            {
              "required": [
                "size"
              ]
            },
            {
              "required": [
                "space"
              ]
            },
            {
              "required": [
                "color"
              ]
            },
            {
              "required": [
                "shadow"
              ]
            },
            {
              "required": [
                "frame"
              ]
            }
          ],
          "properties": {
            "color": {
              "type": "string"
            },
            "frame": {
              "type": "boolean"
            },
            "shadow": {
              "type": "boolean"
            },
            "size": {
              "minimum": 0,
              "type": "number"
            },
            "space": {
              "minimum": 0,
              "type": "number"
            },
            "style": {
              "type": "string"
            }
          },
          "type": "object"
        },
        "top": {
          "additionalProperties": false,
          "oneOf": [
            {
              "required": [
                "style"
              ]
            },
            {
              "required": [
                "size"
              ]
            },
            {
              "required": [
                "space"
              ]
            },
            {
              "required": [
                "color"
              ]
            },
            {
              "required": [
                "shadow"
              ]
            },
            {
              "required": [
                "frame"
              ]
            }
          ],
          "properties": {
            "color": {
              "type": "string"
            },
            "frame": {
              "type": "boolean"
            },
            "shadow": {
              "type": "boolean"
            },
            "size": {
              "minimum": 0,
              "type": "number"
            },
            "space": {
              "minimum": 0,
              "type": "number"
            },
            "style": {
              "type": "string"
            }
          },
          "type": "object"
        },
        "zOrder": {
          "enum": [
            "front",
            "back"
          ]
        }
      },
      "type": "object"
    },
    "target": {
      "$ref": "#/$defs/SectionAddress"
    }
  },
  "required": [
    "target",
    "borders"
  ],
  "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"
}