Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

If you are creating pages with the Confluence API and you want to turn on numbering, you can use the numbering API.

Expand
titlePUT https://localhost:1990/confluence /rest/numberedheadings/1.0/page-configuration/:content-id

Configure page numbering

This endpoint allows to configure page numbering. You can effectively turn numbering on or off, configure formatting, or anything that you can configure using the UI.

Parameters

Path

Code Block
content-id        string          ID of the page

Header

Code Block
Content-Type      string      application/json

Responses

200 Cake successfully retrieved.

Code Block
{}

The request payload that you should send for this request is as documented in Page properties.

Curl example

Code Block
curl 'https://localhost:1990/confluence/rest/numberedheadings/1.0/page-configuration/360482' 
-X 'PUT' 
-H 'Content-Type: application/json' 
--data-binary '{"isEnabled":true,"numberFormatField":"decimal","startingNumberField":"3","startingHeadingField":"H1","skipHeadingField":"","customFormatFieldH1":"","customFormatFieldH2":"","customFormatFieldH3":"","customFormatFieldH4":"","customFormatFieldH5":"","customFormatFieldH6":""}' 
Expand
titlePUT https://localhost:1990/confluence /rest/numberedheadings/1.0/space-configuration/:spacekey

Configure page numbering

This endpoint allows you to configure space numbering. You can effectively configure custom formatting through this endpoint.

Parameters

Path

Code Block
spacekey        string        The space key

Header

Code Block
Content-Type      string      application/json

Responses

200 Cake successfully retrieved.

Code Block
{}

The request payload that you should send for this request is as documented in Page properties.

Curl example

Code Block
curl 'http://localhost:1990/confluence/rest/numberedheadings/1.0/space-configuration/ds' \
-X 'PUT' \
-H 'Content-Type: application/json' \
--data-binary '{"isEnabled":true,"numberFormatField":"decimal","startingNumberField":"2","startingHeadingField":"H2","skipHeadingField":"","customFormatFieldH1":"","customFormatFieldH2":"","customFormatFieldH3":"","customFormatFieldH4":"","customFormatFieldH5":"","customFormatFieldH6":""}'

...