Lists operations

Lists operation reference from the canonical Document API contract.

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

Back to full reference

List inspection and list mutations.

Operation	Member path	Mutates	Idempotency	Tracked	Dry run
lists.list	lists.list	No	idempotent	No	No
lists.get	lists.get	No	idempotent	No	No
lists.insert	lists.insert	Yes	non-idempotent	Yes	Yes
lists.create	lists.create	Yes	non-idempotent	No	Yes
lists.attach	lists.attach	Yes	conditional	No	Yes
lists.detach	lists.detach	Yes	conditional	No	Yes
lists.indent	lists.indent	Yes	conditional	No	Yes
lists.outdent	lists.outdent	Yes	conditional	No	Yes
lists.join	lists.join	Yes	conditional	No	Yes
lists.canJoin	lists.canJoin	No	idempotent	No	No
lists.separate	lists.separate	Yes	conditional	No	Yes
lists.setLevel	lists.setLevel	Yes	conditional	No	Yes
lists.setValue	lists.setValue	Yes	conditional	No	Yes
lists.continuePrevious	lists.continuePrevious	Yes	conditional	No	Yes
lists.canContinuePrevious	lists.canContinuePrevious	No	idempotent	No	No
lists.setLevelRestart	lists.setLevelRestart	Yes	conditional	No	Yes
lists.convertToText	lists.convertToText	Yes	conditional	No	Yes