REST API Extender for Confluence

REST API for automated Confluence configuration with URMS

Resources

All resources produce JSON (media type: application/json) results.

Page versions

Get and delete outdated page versions

• GET /rest/extender/1/api/versions/all

  QueryString

  • type: all or page or attachment. (default:all)
  • endDays: 1～ (0=today, 1=yesterday) (default:0)
  • limit: 1～1000 (default:1000)

  Get all page versions in all instance.

  Responses

  

  

  Returned if the current user is not authenticated.

  

  Returned if the current user is not an administrator.

• DELETE /rest/extender/1/api/versions/all

  QueryString

  • type: all or page or attachment. (default:all)
  • endDays: 1～ (0=today, 1=yesterday) (default:0)
  • limit: 1～1000 (default:1000)

  Remove all page versions in all instance.

  Responses

  

  

  Returned if the current user is not authenticated.

  

  Returned if the current user is not an administrator.

• GET /rest/extender/1/api/versions/space/{spaceKey}

  QueryString

  • spaceKey: Key of the target space. (required)
  • type: all or page or attachment. (default:all)
  • endDays: 1～ (0=today, 1=yesterday) (default:0)
  • limit: 1～1000 (default:1000)

  Get all page versions in space with key=spaceKey.

  Responses

  

  

  Returned if the current user is not authenticated.

  

  Returned if the current user is not an administrator.

• DELETE /rest/extender/1/api/versions/space/{spaceKey}

  QueryString

  • spaceKey: Key of the target space. (required)
  • type: all or page or attachment. (default:all)
  • endDays: 1～ (0=today, 1=yesterday) (default:0)
  • limit: 1～1000 (default:1000)

  Remove all page versions in space with key=spaceKey.

  Responses

  

  

  Returned if the current user is not authenticated.

  

  Returned if the current user is not an administrator.

• GET /rest/extender/1/api/versions/page/{pageId}

  QueryString

  • pageId: Id of the target page. (required)
  • type: all or page or attachment. (default:all)
  • endDays: 1～ (0=today, 1=yesterday) (default:0)
  • limit: 1～1000 (default:1000)

  Get versions of the page with id=pageId.

  Responses

  

  

  Returned if the current user is not authenticated.

  

  Returned if the current user is not an administrator.

• DELETE /rest/extender/1/api/versions/page/{pageId}

  QueryString

  • pageId: Id of the target page. (required)
  • type: all or page or attachment. (default:all)
  • endDays: 1～ (0=today, 1=yesterday) (default:0)
  • limit: 1～1000 (default:1000)

  Remove versions of the page with id=pageId.

  Responses

  

  

  Returned if the current user is not authenticated.

  

  Returned if the current user is not an administrator.

Trashes

Get and delete trash

• GET /rest/extender/1/api/trash/all

  QueryString

  • limit: 1～1000 (default:1000)

  Get all trash in all instance.

  Responses

  

  

  Returned if the current user is not authenticated.

  

  Returned if the current user is not an administrator.

• DELETE /rest/extender/1/api/trash/all

  QueryString

  • limit: 1～1000 (default:1000)

  Remove all trash in all instance.

  Responses

  

  

  Returned if the current user is not authenticated.

  

  Returned if the current user is not an administrator.

• GET /rest/extender/1/api/trash/space/{spaceKey}

  QueryString

  • spaceKey: Key of the target space. (required)
  • limit: 1～1000 (default:1000)

  Get trash from space with key=spaceKey.

  Responses

  

  

  Returned if the current user is not authenticated.

  

  Returned if the current user is not an administrator.

• DELETE /rest/extender/1/api/trash/space/{spaceKey}

  QueryString

  • spaceKey: Key of the target space. (required)
  • limit: 1～1000 (default:1000)

  Remove trash from space with key=spaceKey.

  Responses

  

  

  Returned if the current user is not authenticated.

  

  Returned if the current user is not an administrator.

  QueryString

  • type: all or page or attachment. (default:all)
  • endDays: 1～ (0=today, 1=yesterday) (default:0)
  • limit: 1～1000 (default:1000)

  Remove versions of the page with id=pageId.

  Responses

  

  

  Returned if the current user is not authenticated.

  

  Returned if the current user is not an administrator.

Syncronise Crowd User Directory

• GET /rest/extender/1/directory

  Get info about User Directories.

  Responses

  

  [
    {
      "id": 262145,
      "type": "INTERNAL",
      "issynchronising": false
    },
    {
      "id": 1277953,
      "type": "CROWD",
      "issynchronising": false
    }
  ]
  

  

  Returned if the current user is not authenticated.

  

  Returned if the current user is not an administrator.

• PUT /rest/extender/1/directory

  QueryString

  • id: User Directory ID. (required)

  Start sycronyse User Directory.

  Responses

  

  If OK, issynchronising of target directory returned as true

  [
    {
      "id": 262145,
      "type": "INTERNAL",
      "issynchronising": false
    },
    {
      "id": 1277953,
      "type": "CROWD",
      "issynchronising": true
    }
  ]
  

  

  Returned if the current user is not authenticated.

  

  Returned if the current user is not an administrator.