Skip to content

Latest commit

 

History

History
87 lines (52 loc) · 1.89 KB

GadgetsApi.md

File metadata and controls

87 lines (52 loc) · 1.89 KB

GadgetsApi

All URIs are relative to https://<CONFLUENCE_URL>/rest/bootstrapi/1

Method HTTP request Description
deleteGadgets DELETE /gadgets Delete all gadgets
getGadgets GET /gadgets Get all gadgets
setGadgets PUT /gadgets Set a list of gadgets

deleteGadgets

deleteGadgets(force)

Delete all gadgets

NOTE: The &#39;force&#39; parameter must be set to &#39;true&#39; in order to execute this request.

Parameters

Name Type Description Notes
force Boolean [optional] [default to null]

Return type

null (empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

getGadgets

List getGadgets()

Get all gadgets

Parameters

This endpoint does not need any parameter.

Return type

List

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

setGadgets

List setGadgets(GadgetBean)

Set a list of gadgets

NOTE: This will only create gadgets that does not exist yet as there is no real &#39;update&#39;.

Parameters

Name Type Description Notes
GadgetBean List

Return type

List

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json