Sign in
Workbooks

Publish dashboard

post/api/v1/deployments/{deploymentId}/workbooks/{workbookId}/publish

Path parameters

deploymentIdnumber required
workbookIdnumber required

Request body

allowEmbedboolean nullable
dashboardIdinteger nullable
descriptionstring nullable
titlestring nullable
workbookIdinteger required

Response

allowEmbedboolean required
createdByinteger nullable
deploymentIdinteger required
descriptionstring nullable
fromSharedWorkspaceboolean nullable
idinteger required
publicIdstring required
restrictDataDownloadboolean nullable
status'draft' | 'published' | 'archived' required
titlestring nullable
useBoardDashboardsboolean nullable
versionIdinteger required
versionNumberinteger required
workbookIdinteger required

Changes

Changed in 4 of the 10 revisions of this API.168

  • 3adb3c5e66ca1See the full diff
    • ●

      added the new sankey enum value to the reportSnapshots/items/kind/oneOf[ReportSnapshotDtoKind]/ response property for the response status 200

      response-property-enum-value-added

  • 97e15146014312See the full diff
    • ●

      added the new PARENT enum value to the config/widgets/oneOf[subschema #1]/items/type response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new PARENT enum value to the request property config/oneOf[DashboardConfigInput]/widgets/oneOf[subschema #1]/items/type

      request-property-enum-value-added

    • ○

      added the optional property reportSnapshots/items/pythonCode to the response with the 200 status

      response-optional-property-added

  • 29d481391a25145See the full diff
    • ▲

      removed the enum value TABS_CONTAINER of the request property config/oneOf[DashboardConfigInput]/widgets/oneOf[subschema #1]/items/type

      request-property-enum-value-removed

    • ●

      the config/oneOf[DashboardConfigInput]/widgets/oneOf[subschema #1]/items/id request property's maxLength was set to 128

      request-property-max-length-set

    • ●

      added the new CONTAINER enum value to the config/widgets/oneOf[subschema #1]/items/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new DIVIDER enum value to the config/widgets/oneOf[subschema #1]/items/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new SPACER enum value to the config/widgets/oneOf[subschema #1]/items/type response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new CONTAINER enum value to the request property config/oneOf[DashboardConfigInput]/widgets/oneOf[subschema #1]/items/type

      request-property-enum-value-added

    • ○

      added the new DIVIDER enum value to the request property config/oneOf[DashboardConfigInput]/widgets/oneOf[subschema #1]/items/type

      request-property-enum-value-added

    • ○

      added the new SPACER enum value to the request property config/oneOf[DashboardConfigInput]/widgets/oneOf[subschema #1]/items/type

      request-property-enum-value-added

    • ○

      added the optional property reportSnapshots/items/isSourceReport to the response with the 200 status

      response-optional-property-added

    • ○

      removed the TABS_CONTAINER enum value from the config/widgets/oneOf[subschema #1]/items/type response property for the response status 200

      response-property-enum-value-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • a0c6b1d2ac961See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog