Skip to main content
Skip table of contents

Content Scheduler REST API

The endpoint of the Content Scheduler API is /rest/content-scheduler/1.0/

content/{id}

An endpoint to manage the scheduled content.

Resource URL  /rest/content-scheduler/1.0/content/{id}

Methods: GET POST DELETE

  • GET

  • Parameters

    Parameter

    Type

    Description

    id

    Long

    The (required) content id of the page or blog

    Response

    Returns the scheduling information. Please note the isScheduled property. If this property is false all the returned settings aren't stored in the database right now.

    {
      "result": {
        "creator": "4028800f5ca1c499015ca1c5586f0002",
        "scheduledTime": "12:00",
        "permissionsDraft": {
          "users": [],
          "groups": []
        },
        "shortUrl": "l74h",
        "scheduledDate": "2017-06-16",
        "title": "",
        "spaceKey": "ds",
        "spaceName": "Demonstration Space",
        "permissionsLive": {
          "users": [],
          "groups": []
        },
        "permissionsArchive": {
          "users": [],
          "groups": []
        },
        "scheduledDateFormatted": "Jun 16, 2017 12:00",
        "userCanSetPermission": true,
        "serverTime": "Jun 15, 2017 11:01",
        "id": 557077,
        "state": "scheduled"
      },
      "isScheduled": true,
      "fieldError": {}
    }

  • POST

  • Save the scheduled content

    Parameters

    Parameter

    Type

    Description

    id

    Long

    The (required) content id of the page or blog

    scheduledDate

    String

    The publish date in the format yyyy-MM-dd

    scheduledTime

    String

    The publish time in the format HH:mm. If this field isn't given in the request, the default value is 00:00

    shortUrl

    String

    A short URL for the content

    permissionsDraft

    String

    A comma separated list of groups and users.

    Groups have the prefix group_ and users the prefix user_ Example:

    group_confluence-administrators,user_4028800f5ca1c499015ca1c5586f0002

    permissionsLive

    String

    Permissions for the live mode. Same syntax as for permissionsDraft

    Response

    Returns the scheduled content.

    {
       "data":{
          "result":{
             "creator":"4028800f5ca1c499015ca1c5586f0002",
             "scheduledTime":"12:00",
             "permissionsDraft":{
                "users":[
     
                ],
                "groups":[
     
                ]
             },
             "shortUrl":"l74h",
             "scheduledDate":"2017-06-16",
             "title":"Important Information",
             "spaceKey":"ds",
             "spaceName":"Demonstration Space",
             "permissionsLive":{
                "users":[
                   {
                      "anonymous":false,
                      "userKey":"4028800f5ca1c499015ca1c5586f0002",
                      "name":"admin",
                      "displayName":"admin"
                   }
                ],
                "groups":[
                   "confluence-administrators"
                ]
             },
             "permissionsArchive":{
                "users":[
     
                ],
                "groups":[
     
                ]
             },
             "scheduledDateFormatted":"Jun 16, 2017 12:00",
             "userCanSetPermission":true,
             "serverTime":"Jun 15, 2017 11:10",
             "id":557077,
             "state":"scheduled"
          },
          "isScheduled":true,
          "fieldError":{
     
          }
       },
       "hasError":false,
       "fields":{
     
       }
    }

  • DELETE

  • Parameters

    Parameter

    Type

    Description

    id

    Long

    The (required) content id of the page or blog

    Response
    Status 200


content/{id}/publish

An endpoint to manage the scheduled content.

Resource URL  /rest/content-scheduler/1.0/content/{id}/publish

Methods:  POST 

  • POST

  • Publish the scheduled content

    Parameters

    Parameter

    Type

    Description

    id

    Long

    The (required) content id of the page or blog

    Response

    {
       "success":true,
       "url":"/display/ds/Important+Information"
    }



JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.