lists.setLevelRestart

Summary

Set the restart behavior for a specific list level.

Operation ID: lists.setLevelRestart
API member path: editor.doc.lists.setLevelRestart(...)
Mutates document: yes
Idempotency: conditional
Supports tracked mode: no
Supports dry run: yes
Deterministic target resolution: yes

Expected result

Returns a ListsMutateItemResult receipt.

Input fields

Field	Type	Required	Description
`level`	integer	yes
`restartAfterLevel`	integer \| null	yes
`scope`	enum	no	`"definition"`, `"instance"`
`target`	ListItemAddress	yes	ListItemAddress
`target.kind`	`"block"`	yes	Constant: `"block"`
`target.nodeId`	string	yes
`target.nodeType`	`"listItem"`	yes	Constant: `"listItem"`
`target.story`	StoryLocator	no	StoryLocator

Example request

{
  "level": 1,
  "restartAfterLevel": 1,
  "scope": "definition",
  "target": {
    "kind": "block",
    "nodeId": "node-def456",
    "nodeType": "listItem",
    "story": {
      "kind": "story",
      "storyType": "body"
    }
  }
}

Output fields

Variant 1 (success=true)

Field	Type	Required	Description
`item`	ListItemAddress	yes	ListItemAddress
`item.kind`	`"block"`	yes	Constant: `"block"`
`item.nodeId`	string	yes
`item.nodeType`	`"listItem"`	yes	Constant: `"listItem"`
`item.story`	StoryLocator	no	StoryLocator
`success`	`true`	yes	Constant: `true`

Variant 2 (success=false)

Field	Type	Required	Description
`failure`	object	yes
`failure.code`	enum	yes	`"INVALID_TARGET"`, `"LEVEL_OUT_OF_RANGE"`
`failure.details`	any	no
`failure.message`	string	yes
`success`	`false`	yes	Constant: `false`

Example response

{
  "item": {
    "kind": "block",
    "nodeId": "node-def456",
    "nodeType": "listItem",
    "story": {
      "kind": "story",
      "storyType": "body"
    }
  },
  "success": true
}

Pre-apply throws

TARGET_NOT_FOUND
CAPABILITY_UNAVAILABLE
INVALID_TARGET

Non-applied failure codes

INVALID_TARGET
LEVEL_OUT_OF_RANGE

Raw schemas

Raw input schema

{
  "additionalProperties": false,
  "properties": {
    "level": {
      "maximum": 8,
      "minimum": 0,
      "type": "integer"
    },
    "restartAfterLevel": {
      "type": [
        "integer",
        "null"
      ]
    },
    "scope": {
      "enum": [
        "definition",
        "instance"
      ]
    },
    "target": {
      "$ref": "#/$defs/ListItemAddress"
    }
  },
  "required": [
    "target",
    "level",
    "restartAfterLevel"
  ],
  "type": "object"
}

Raw output schema

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

Raw success schema

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

Raw failure schema

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

Getting Started

Editor

Document Engine

AI

Solutions

Resources

lists.setLevelRestart

Summary

Expected result

Input fields

Example request

Output fields

Variant 1 (success=true)

Variant 2 (success=false)

Example response

Pre-apply throws

Non-applied failure codes

Raw schemas

​Summary

​Expected result

​Input fields

​Example request

​Output fields

​Variant 1 (success=true)

​Variant 2 (success=false)

​Example response

​Pre-apply throws

​Non-applied failure codes

​Raw schemas

Summary

Expected result

Input fields

Example request

Output fields

Variant 1 (success=true)

Variant 2 (success=false)

Example response

Pre-apply throws

Non-applied failure codes

Raw schemas