kythene.v1.KytheneService

SetPageState

SetPageState moves a page through its lifecycle by naming a target state - the aggregate of publish / request approval / approve / unpublish / archive / restore / discard.

post/kythene.v1.KytheneService/SetPageState

Request

  • Base URL: https://kythene.com (the document declares no server; this is the origin it was published from)
  • URL: https://kythene.com/kythene.v1.KytheneService/SetPageState
  • Auth: none required

Headers

Connect-Protocol-Version1 required

Define the version of the Connect protocol

Connect-Timeout-Msnumber

Define the timeout, in ms

Request body

wikistring

wiki is the wiki the page is in - its id or slug.

pagestring

page is the page's id or its full path within the wiki.

statestring

state is the target: "published" - publish the newest version. Where the wiki requires an approval this is refused: ask for one instead. "awaiting_approval" - ask for an approval. Optionally name a reviewer. "approved" - approve AND publish in one act. "changes_requested" - send it back to draft with a note saying why. "draft" - withdraw an approval request, or unpublish a live page (readers lose it). "discarded" - drop unpublished changes and go back to what is live. The discarded version stays in the history. "archived" - archive the page AND everything beneath it. It leaves the tree, search and every reader path; its paths keep redirecting. "restored" - bring an archived page and its subtree back.

reviewerstring

reviewer optionally directs an approval request at one person (a user id).

notestring

note is required when requesting changes.

spacestring

space optionally selects which of your spaces to act in (an id or name from list_spaces). Omit it when you belong to a single space.

Response

Success

statestring

state is the page's state afterwards.

revisioninteger

revision is the live revision after a publish; 0 otherwise.

pagesinteger

pages is how many pages the act covered - more than one for an archive or a restore, which cascade over the subtree.

Changes

No recorded changes to this operation across all 1 revision of this API.