Skip to content

workflow

archive

Archive a page

POST /wiki/rest/api/content/archive

FlagTypeRequiredDescription
--idstringNopage ID to archive (required)
--no-waitboolNoreturn immediately without polling
--timeoutstringNotimeout for async operation (e.g. 30s, 2m)

Example:

bash
cf workflow archive

comment

Add a plain-text comment to a page

POST /pages/{id}/footer-comments

FlagTypeRequiredDescription
--bodystringNocomment text (required)
--idstringNopage ID to comment on (required)

Example:

bash
cf workflow comment

copy

Copy a page to a target parent

POST /wiki/rest/api/content/{id}/copy

FlagTypeRequiredDescription
--copy-attachmentsboolNoinclude attachments in copy
--copy-labelsboolNoinclude labels in copy
--copy-permissionsboolNoinclude permissions in copy
--idstringNopage ID to copy (required)
--no-waitboolNoreturn immediately without polling
--target-idstringNotarget parent page ID (required)
--timeoutstringNotimeout for async operation (e.g. 30s, 2m)
--titlestringNotitle for the copied page

Example:

bash
cf workflow copy

move

Move a page to a different parent

PUT /wiki/rest/api/content/{id}/move/append/{targetId}

FlagTypeRequiredDescription
--idstringNopage ID to move (required)
--target-idstringNotarget parent page ID (required)

Example:

bash
cf workflow move

publish

Publish a draft page

PUT /pages/{id}

FlagTypeRequiredDescription
--idstringNopage ID to publish (required)

Example:

bash
cf workflow publish

restrict

View, add, or remove page restrictions

GET /wiki/rest/api/content/{id}/restriction

FlagTypeRequiredDescription
--addboolNoadd a restriction
--groupstringNogroup name
--idstringNopage ID to manage restrictions (required)
--operationstringNorestriction operation: read or update
--removeboolNoremove a restriction
--userstringNouser account ID

Example:

bash
cf workflow restrict