Copy a dashboard version into the editable draft.

POST

/api/workspace/admin/reporting/dashboards/{dashboardDefinitionId}/versions/{versionNumber}/clone-draft

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://example.com/api/workspace/admin/reporting/dashboards/example/versions/1/clone-draft"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://example.com/api/workspace/admin/reporting/dashboards/example/versions/1/clone-draft';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/workspace/admin/reporting/dashboards/example/versions/1/clone-draft \
  --header 'Authorization: Bearer <token>'

Authorizations

WorkspaceBearer

Parameters

Path Parameters

dashboardDefinitionId

required

string

versionNumber

required

integer format: int32

Query Parameters

access_token

string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Responses

200

application/json

object

Data

Dashboard definition detail.

object

Summary

Dashboard definition summary.

object

Definition id.

string

nullable

Key

Definition key.

string

nullable

Title

Definition title.

string

nullable

Description

Definition description.

string

nullable

State

Lifecycle state for a dashboard or report definition.

integer format: int32

Allowed values: 0 1 2

Priority

Ordering priority.

integer format: int32

PublishedVersionNumber

Current published version number.

integer format: int32

nullable

ModifiedAt

Last modification timestamp.

string format: date-time

nullable

RowVersion

Optimistic concurrency token.

string format: uuid

Draft

Dashboard definition document.

object

Key

Stable dashboard key.

string

nullable

Title

Dashboard title.

string

nullable

Description

Dashboard description.

string

nullable

Priority

Dashboard ordering priority.

integer format: int32

nullable

Visibility

Visibility policy for dashboard and report definitions.

object

RoleIds

Role ids that can see the definition.

Array<string>

nullable

UserIds

User ids that can see the definition.

Array<string>

nullable

PermissionKeys

Permission keys that can see the definition.

Array<string>

nullable

RequireAllPermissionKeys

Whether all permission keys are required instead of any one key.

boolean

ModuleDependencies

Modules that must be active before the definition is visible.

Array<string>

nullable

ModuleDependencies

Modules required by the dashboard.

Array<string>

nullable

Filters

Shared filter JSON definition.

nullable

Layout

Layout JSON definition.

nullable

Widgets

Dashboard widgets.

Array<object>

nullable

Reusable data-source block used by dashboard widgets and report blocks.

object

Stable block id inside the definition document.

string

nullable

Title

Display title.

string

nullable

DataSource

Stable data-source reference stored by dashboard widgets and report blocks.

object

SourceKind

Identifies the authoring surface that provides a DataSource.

integer format: int32

Allowed values: 0 1 2 3

StableId

Stable provider identifier.

string

nullable

Key

Human-readable provider key.

string

nullable

ExpectedSchemaFingerprint

Descriptor fingerprint validated at publish time.

string

nullable

ParameterBindings

Parameter bindings keyed by data-source parameter key.

object

key

additional properties

Parameter binding for one data-source parameter.

object

Kind

How a dashboard/report block supplies a data-source parameter value.

integer format: int32

Allowed values: 0 1

FilterKey

Shared filter key when Kind is Moltaro.Reporting.Models.ReportingParameterBindingKindEnum.Filter.

string

nullable

Value

Static JSON value when Kind is Moltaro.Reporting.Models.ReportingParameterBindingKindEnum.Static.

nullable

Renderer

Defines renderer families that can consume a DataSource output.

integer format: int32

Allowed values: 1 2 3 4 5 6 7 8

RuntimeOptions

Dashboard/report-owned runtime options that must stay within source-owned limits.

object

PageSize

Configured page size for table/list sources.

integer format: int32

nullable

ExportEnabled

Whether this block exposes export.

boolean

ExportRowLimit

Configured export row limit.

integer format: int32

nullable

RendererOptions

Options of the renderer a dashboard widget or report block uses. Publish accepts bar options only for a bar chart and the share measure only for a source that declares a share field. A null option means its default.

object

BarOrientation

Direction of the bars of a bar chart block.

integer format: int32

Allowed values: 0 1

BarArrangement

How the bars of several series share one category.

integer format: int32

Allowed values: 0 1

BarMeasure

What the length of a bar shows.

integer format: int32

Allowed values: 0 1

Drilldown

Drilldown configuration JSON.

nullable

EmptyState

Empty-state configuration JSON.

nullable

ErrorBehavior

Error-behavior configuration JSON.

nullable

ExportBehavior

Export behavior JSON.

nullable

RefreshPolicy

Dashboard refresh policy JSON.

nullable

Type

How a dashboard renders its runtime surface.

integer format: int32

Allowed values: 0 1

WorkspaceUiPage

Workspace UI page reference stored by page-type dashboards.

object

PageKey

Manifest page key inside the active Workspace UI artifact.

string

nullable

Published

Dashboard definition version.

object

Version id.

string

nullable

VersionNumber

Version number scoped to the definition.

integer format: int32

PublishedAtUtc

Publish timestamp.

string format: date-time

PublishedByUserId

Publishing user id.

string

nullable

Document

Dashboard definition document.

object

Key

Stable dashboard key.

string

nullable

Title

Dashboard title.

string

nullable

Description

Dashboard description.

string

nullable

Priority

Dashboard ordering priority.

integer format: int32

nullable

Visibility

Visibility policy for dashboard and report definitions.

object

RoleIds

Role ids that can see the definition.

Array<string>

nullable

UserIds

User ids that can see the definition.

Array<string>

nullable

PermissionKeys

Permission keys that can see the definition.

Array<string>

nullable

RequireAllPermissionKeys

Whether all permission keys are required instead of any one key.

boolean

ModuleDependencies

Modules that must be active before the definition is visible.

Array<string>

nullable

ModuleDependencies

Modules required by the dashboard.

Array<string>

nullable

Filters

Shared filter JSON definition.

nullable

Layout

Layout JSON definition.

nullable

Widgets

Dashboard widgets.

Array<object>

nullable

Reusable data-source block used by dashboard widgets and report blocks.

object

Stable block id inside the definition document.

string

nullable

Title

Display title.

string

nullable

DataSource

Stable data-source reference stored by dashboard widgets and report blocks.

object

SourceKind

Identifies the authoring surface that provides a DataSource.

integer format: int32

Allowed values: 0 1 2 3

StableId

Stable provider identifier.

string

nullable

Key

Human-readable provider key.

string

nullable

ExpectedSchemaFingerprint

Descriptor fingerprint validated at publish time.

string

nullable

ParameterBindings

Parameter bindings keyed by data-source parameter key.

object

key

additional properties

Parameter binding for one data-source parameter.

object

Kind

How a dashboard/report block supplies a data-source parameter value.

integer format: int32

Allowed values: 0 1

FilterKey

Shared filter key when Kind is Moltaro.Reporting.Models.ReportingParameterBindingKindEnum.Filter.

string

nullable

Value

Static JSON value when Kind is Moltaro.Reporting.Models.ReportingParameterBindingKindEnum.Static.

nullable

Renderer

Defines renderer families that can consume a DataSource output.

integer format: int32

Allowed values: 1 2 3 4 5 6 7 8

RuntimeOptions

Dashboard/report-owned runtime options that must stay within source-owned limits.

object

PageSize

Configured page size for table/list sources.

integer format: int32

nullable

ExportEnabled

Whether this block exposes export.

boolean

ExportRowLimit

Configured export row limit.

integer format: int32

nullable

RendererOptions

object

BarOrientation

Direction of the bars of a bar chart block.

integer format: int32

Allowed values: 0 1

BarArrangement

How the bars of several series share one category.

integer format: int32

Allowed values: 0 1

BarMeasure

What the length of a bar shows.

integer format: int32

Allowed values: 0 1

Drilldown

Drilldown configuration JSON.

nullable

EmptyState

Empty-state configuration JSON.

nullable

ErrorBehavior

Error-behavior configuration JSON.

nullable

ExportBehavior

Export behavior JSON.

nullable

RefreshPolicy

Dashboard refresh policy JSON.

nullable

Type

How a dashboard renders its runtime surface.

integer format: int32

Allowed values: 0 1

WorkspaceUiPage

Workspace UI page reference stored by page-type dashboards.

object

PageKey

Manifest page key inside the active Workspace UI artifact.

string

nullable

DataSources

Validated data-source references.

Array<object>

nullable

Published data-source reference snapshot for a definition version.

object

BlockId

Widget or report block id.

string

nullable

SourceKind

Identifies the authoring surface that provides a DataSource.

integer format: int32

Allowed values: 0 1 2 3

StableId

Stable provider id.

string

nullable

Key

Provider key.

string

nullable

SchemaFingerprint

Validated descriptor fingerprint.

string

nullable

Renderer

Defines renderer families that can consume a DataSource output.

integer format: int32

Allowed values: 1 2 3 4 5 6 7 8

PublishedByUserName

Materialized publishing user display name.

string

nullable

Versions

Published version history.

Array<object>

nullable

Dashboard definition version.

object

Version id.

string

nullable

VersionNumber

Version number scoped to the definition.

integer format: int32

PublishedAtUtc

Publish timestamp.

string format: date-time

PublishedByUserId

Publishing user id.

string

nullable

Document

Dashboard definition document.

object

Key

Stable dashboard key.

string

nullable

Title

Dashboard title.

string

nullable

Description

Dashboard description.

string

nullable

Priority

Dashboard ordering priority.

integer format: int32

nullable

Visibility

Visibility policy for dashboard and report definitions.

object

RoleIds

Role ids that can see the definition.

Array<string>

nullable

UserIds

User ids that can see the definition.

Array<string>

nullable

PermissionKeys

Permission keys that can see the definition.

Array<string>

nullable

RequireAllPermissionKeys

Whether all permission keys are required instead of any one key.

boolean

ModuleDependencies

Modules that must be active before the definition is visible.

Array<string>

nullable

ModuleDependencies

Modules required by the dashboard.

Array<string>

nullable

Filters

Shared filter JSON definition.

nullable

Layout

Layout JSON definition.

nullable

Widgets

Dashboard widgets.

Array<object>

nullable

Reusable data-source block used by dashboard widgets and report blocks.

object

Stable block id inside the definition document.

string

nullable

Title

Display title.

string

nullable

DataSource

Stable data-source reference stored by dashboard widgets and report blocks.

object

SourceKind

Identifies the authoring surface that provides a DataSource.

integer format: int32

Allowed values: 0 1 2 3

StableId

Stable provider identifier.

string

nullable

Key

Human-readable provider key.

string

nullable

ExpectedSchemaFingerprint

Descriptor fingerprint validated at publish time.

string

nullable

ParameterBindings

Parameter bindings keyed by data-source parameter key.

object

key

additional properties

Parameter binding for one data-source parameter.

object

Kind

How a dashboard/report block supplies a data-source parameter value.

integer format: int32

Allowed values: 0 1

FilterKey

Shared filter key when Kind is Moltaro.Reporting.Models.ReportingParameterBindingKindEnum.Filter.

string

nullable

Value

Static JSON value when Kind is Moltaro.Reporting.Models.ReportingParameterBindingKindEnum.Static.

nullable

Renderer

Defines renderer families that can consume a DataSource output.

integer format: int32

Allowed values: 1 2 3 4 5 6 7 8

RuntimeOptions

Dashboard/report-owned runtime options that must stay within source-owned limits.

object

PageSize

Configured page size for table/list sources.

integer format: int32

nullable

ExportEnabled

Whether this block exposes export.

boolean

ExportRowLimit

Configured export row limit.

integer format: int32

nullable

RendererOptions

object

BarOrientation

Direction of the bars of a bar chart block.

integer format: int32

Allowed values: 0 1

BarArrangement

How the bars of several series share one category.

integer format: int32

Allowed values: 0 1

BarMeasure

What the length of a bar shows.

integer format: int32

Allowed values: 0 1

Drilldown

Drilldown configuration JSON.

nullable

EmptyState

Empty-state configuration JSON.

nullable

ErrorBehavior

Error-behavior configuration JSON.

nullable

ExportBehavior

Export behavior JSON.

nullable

RefreshPolicy

Dashboard refresh policy JSON.

nullable

Type

How a dashboard renders its runtime surface.

integer format: int32

Allowed values: 0 1

WorkspaceUiPage

Workspace UI page reference stored by page-type dashboards.

object

PageKey

Manifest page key inside the active Workspace UI artifact.

string

nullable

DataSources

Validated data-source references.

Array<object>

nullable

Published data-source reference snapshot for a definition version.

object

BlockId

Widget or report block id.

string

nullable

SourceKind

Identifies the authoring surface that provides a DataSource.

integer format: int32

Allowed values: 0 1 2 3

StableId

Stable provider id.

string

nullable

Key

Provider key.

string

nullable

SchemaFingerprint

Validated descriptor fingerprint.

string

nullable

Renderer

Defines renderer families that can consume a DataSource output.

integer format: int32

Allowed values: 1 2 3 4 5 6 7 8

PublishedByUserName

Materialized publishing user display name.

string

nullable

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": {
    "Summary": {
      "State": 0
    },
    "Draft": {
      "Widgets": [
        {
          "DataSource": {
            "SourceKind": 0
          },
          "ParameterBindings": {
            "additionalProperty": {
              "Kind": 0
            }
          },
          "Renderer": 1,
          "RendererOptions": {
            "BarOrientation": 0,
            "BarArrangement": 0,
            "BarMeasure": 0
          }
        }
      ],
      "Type": 0
    },
    "Published": {
      "Document": {
        "Widgets": [
          {
            "DataSource": {
              "SourceKind": 0
            },
            "ParameterBindings": {
              "additionalProperty": {
                "Kind": 0
              }
            },
            "Renderer": 1,
            "RendererOptions": {
              "BarOrientation": 0,
              "BarArrangement": 0,
              "BarMeasure": 0
            }
          }
        ],
        "Type": 0
      },
      "DataSources": [
        {
          "SourceKind": 0,
          "Renderer": 1
        }
      ]
    },
    "Versions": [
      {
        "Document": {
          "Widgets": [
            {
              "DataSource": {
                "SourceKind": 0
              },
              "ParameterBindings": {
                "additionalProperty": {
                  "Kind": 0
                }
              },
              "Renderer": 1,
              "RendererOptions": {
                "BarOrientation": 0,
                "BarArrangement": 0,
                "BarMeasure": 0
              }
            }
          ],
          "Type": 0
        },
        "DataSources": [
          {
            "SourceKind": 0,
            "Renderer": 1
          }
        ]
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Forbidden

application/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

application/json

object

Data

Dashboard definition detail.

object

Summary

Dashboard definition summary.

object

Definition id.

string

nullable

Key

Definition key.

string

nullable

Title

Definition title.

string

nullable

Description

Definition description.

string

nullable

State

Lifecycle state for a dashboard or report definition.

integer format: int32

Allowed values: 0 1 2

Priority

Ordering priority.

integer format: int32

PublishedVersionNumber

Current published version number.

integer format: int32

nullable

ModifiedAt

Last modification timestamp.

string format: date-time

nullable

RowVersion

Optimistic concurrency token.

string format: uuid

Draft

Dashboard definition document.

object

Key

Stable dashboard key.

string

nullable

Title

Dashboard title.

string

nullable

Description

Dashboard description.

string

nullable

Priority

Dashboard ordering priority.

integer format: int32

nullable

Visibility

Visibility policy for dashboard and report definitions.

object

RoleIds

Role ids that can see the definition.

Array<string>

nullable

UserIds

User ids that can see the definition.

Array<string>

nullable

PermissionKeys

Permission keys that can see the definition.

Array<string>

nullable

RequireAllPermissionKeys

Whether all permission keys are required instead of any one key.

boolean

ModuleDependencies

Modules that must be active before the definition is visible.

Array<string>

nullable

ModuleDependencies

Modules required by the dashboard.

Array<string>

nullable

Filters

Shared filter JSON definition.

nullable

Layout

Layout JSON definition.

nullable

Widgets

Dashboard widgets.

Array<object>

nullable

Reusable data-source block used by dashboard widgets and report blocks.

object

Stable block id inside the definition document.

string

nullable

Title

Display title.

string

nullable

DataSource

Stable data-source reference stored by dashboard widgets and report blocks.

object

SourceKind

Identifies the authoring surface that provides a DataSource.

integer format: int32

Allowed values: 0 1 2 3

StableId

Stable provider identifier.

string

nullable

Key

Human-readable provider key.

string

nullable

ExpectedSchemaFingerprint

Descriptor fingerprint validated at publish time.

string

nullable

ParameterBindings

Parameter bindings keyed by data-source parameter key.

object

key

additional properties

Parameter binding for one data-source parameter.

object

Kind

How a dashboard/report block supplies a data-source parameter value.

integer format: int32

Allowed values: 0 1

FilterKey

Shared filter key when Kind is Moltaro.Reporting.Models.ReportingParameterBindingKindEnum.Filter.

string

nullable

Value

Static JSON value when Kind is Moltaro.Reporting.Models.ReportingParameterBindingKindEnum.Static.

nullable

Renderer

Defines renderer families that can consume a DataSource output.

integer format: int32

Allowed values: 1 2 3 4 5 6 7 8

RuntimeOptions

Dashboard/report-owned runtime options that must stay within source-owned limits.

object

PageSize

Configured page size for table/list sources.

integer format: int32

nullable

ExportEnabled

Whether this block exposes export.

boolean

ExportRowLimit

Configured export row limit.

integer format: int32

nullable

RendererOptions

object

BarOrientation

Direction of the bars of a bar chart block.

integer format: int32

Allowed values: 0 1

BarArrangement

How the bars of several series share one category.

integer format: int32

Allowed values: 0 1

BarMeasure

What the length of a bar shows.

integer format: int32

Allowed values: 0 1

Drilldown

Drilldown configuration JSON.

nullable

EmptyState

Empty-state configuration JSON.

nullable

ErrorBehavior

Error-behavior configuration JSON.

nullable

ExportBehavior

Export behavior JSON.

nullable

RefreshPolicy

Dashboard refresh policy JSON.

nullable

Type

How a dashboard renders its runtime surface.

integer format: int32

Allowed values: 0 1

WorkspaceUiPage

Workspace UI page reference stored by page-type dashboards.

object

PageKey

Manifest page key inside the active Workspace UI artifact.

string

nullable

Published

Dashboard definition version.

object

Version id.

string

nullable

VersionNumber

Version number scoped to the definition.

integer format: int32

PublishedAtUtc

Publish timestamp.

string format: date-time

PublishedByUserId

Publishing user id.

string

nullable

Document

Dashboard definition document.

object

Key

Stable dashboard key.

string

nullable

Title

Dashboard title.

string

nullable

Description

Dashboard description.

string

nullable

Priority

Dashboard ordering priority.

integer format: int32

nullable

Visibility

Visibility policy for dashboard and report definitions.

object

RoleIds

Role ids that can see the definition.

Array<string>

nullable

UserIds

User ids that can see the definition.

Array<string>

nullable

PermissionKeys

Permission keys that can see the definition.

Array<string>

nullable

RequireAllPermissionKeys

Whether all permission keys are required instead of any one key.

boolean

ModuleDependencies

Modules that must be active before the definition is visible.

Array<string>

nullable

ModuleDependencies

Modules required by the dashboard.

Array<string>

nullable

Filters

Shared filter JSON definition.

nullable

Layout

Layout JSON definition.

nullable

Widgets

Dashboard widgets.

Array<object>

nullable

Reusable data-source block used by dashboard widgets and report blocks.

object

Stable block id inside the definition document.

string

nullable

Title

Display title.

string

nullable

DataSource

Stable data-source reference stored by dashboard widgets and report blocks.

object

SourceKind

Identifies the authoring surface that provides a DataSource.

integer format: int32

Allowed values: 0 1 2 3

StableId

Stable provider identifier.

string

nullable

Key

Human-readable provider key.

string

nullable

ExpectedSchemaFingerprint

Descriptor fingerprint validated at publish time.

string

nullable

ParameterBindings

Parameter bindings keyed by data-source parameter key.

object

key

additional properties

Parameter binding for one data-source parameter.

object

Kind

How a dashboard/report block supplies a data-source parameter value.

integer format: int32

Allowed values: 0 1

FilterKey

Shared filter key when Kind is Moltaro.Reporting.Models.ReportingParameterBindingKindEnum.Filter.

string

nullable

Value

Static JSON value when Kind is Moltaro.Reporting.Models.ReportingParameterBindingKindEnum.Static.

nullable

Renderer

Defines renderer families that can consume a DataSource output.

integer format: int32

Allowed values: 1 2 3 4 5 6 7 8

RuntimeOptions

Dashboard/report-owned runtime options that must stay within source-owned limits.

object

PageSize

Configured page size for table/list sources.

integer format: int32

nullable

ExportEnabled

Whether this block exposes export.

boolean

ExportRowLimit

Configured export row limit.

integer format: int32

nullable

RendererOptions

object

BarOrientation

Direction of the bars of a bar chart block.

integer format: int32

Allowed values: 0 1

BarArrangement

How the bars of several series share one category.

integer format: int32

Allowed values: 0 1

BarMeasure

What the length of a bar shows.

integer format: int32

Allowed values: 0 1

Drilldown

Drilldown configuration JSON.

nullable

EmptyState

Empty-state configuration JSON.

nullable

ErrorBehavior

Error-behavior configuration JSON.

nullable

ExportBehavior

Export behavior JSON.

nullable

RefreshPolicy

Dashboard refresh policy JSON.

nullable

Type

How a dashboard renders its runtime surface.

integer format: int32

Allowed values: 0 1

WorkspaceUiPage

Workspace UI page reference stored by page-type dashboards.

object

PageKey

Manifest page key inside the active Workspace UI artifact.

string

nullable

DataSources

Validated data-source references.

Array<object>

nullable

Published data-source reference snapshot for a definition version.

object

BlockId

Widget or report block id.

string

nullable

SourceKind

Identifies the authoring surface that provides a DataSource.

integer format: int32

Allowed values: 0 1 2 3

StableId

Stable provider id.

string

nullable

Key

Provider key.

string

nullable

SchemaFingerprint

Validated descriptor fingerprint.

string

nullable

Renderer

Defines renderer families that can consume a DataSource output.

integer format: int32

Allowed values: 1 2 3 4 5 6 7 8

PublishedByUserName

Materialized publishing user display name.

string

nullable

Versions

Published version history.

Array<object>

nullable

Dashboard definition version.

object

Version id.

string

nullable

VersionNumber

Version number scoped to the definition.

integer format: int32

PublishedAtUtc

Publish timestamp.

string format: date-time

PublishedByUserId

Publishing user id.

string

nullable

Document

Dashboard definition document.

object

Key

Stable dashboard key.

string

nullable

Title

Dashboard title.

string

nullable

Description

Dashboard description.

string

nullable

Priority

Dashboard ordering priority.

integer format: int32

nullable

Visibility

Visibility policy for dashboard and report definitions.

object

RoleIds

Role ids that can see the definition.

Array<string>

nullable

UserIds

User ids that can see the definition.

Array<string>

nullable

PermissionKeys

Permission keys that can see the definition.

Array<string>

nullable

RequireAllPermissionKeys

Whether all permission keys are required instead of any one key.

boolean

ModuleDependencies

Modules that must be active before the definition is visible.

Array<string>

nullable

ModuleDependencies

Modules required by the dashboard.

Array<string>

nullable

Filters

Shared filter JSON definition.

nullable

Layout

Layout JSON definition.

nullable

Widgets

Dashboard widgets.

Array<object>

nullable

Reusable data-source block used by dashboard widgets and report blocks.

object

Stable block id inside the definition document.

string

nullable

Title

Display title.

string

nullable

DataSource

Stable data-source reference stored by dashboard widgets and report blocks.

object

SourceKind

Identifies the authoring surface that provides a DataSource.

integer format: int32

Allowed values: 0 1 2 3

StableId

Stable provider identifier.

string

nullable

Key

Human-readable provider key.

string

nullable

ExpectedSchemaFingerprint

Descriptor fingerprint validated at publish time.

string

nullable

ParameterBindings

Parameter bindings keyed by data-source parameter key.

object

key

additional properties

Parameter binding for one data-source parameter.

object

Kind

How a dashboard/report block supplies a data-source parameter value.

integer format: int32

Allowed values: 0 1

FilterKey

Shared filter key when Kind is Moltaro.Reporting.Models.ReportingParameterBindingKindEnum.Filter.

string

nullable

Value

Static JSON value when Kind is Moltaro.Reporting.Models.ReportingParameterBindingKindEnum.Static.

nullable

Renderer

Defines renderer families that can consume a DataSource output.

integer format: int32

Allowed values: 1 2 3 4 5 6 7 8

RuntimeOptions

Dashboard/report-owned runtime options that must stay within source-owned limits.

object

PageSize

Configured page size for table/list sources.

integer format: int32

nullable

ExportEnabled

Whether this block exposes export.

boolean

ExportRowLimit

Configured export row limit.

integer format: int32

nullable

RendererOptions

object

BarOrientation

Direction of the bars of a bar chart block.

integer format: int32

Allowed values: 0 1

BarArrangement

How the bars of several series share one category.

integer format: int32

Allowed values: 0 1

BarMeasure

What the length of a bar shows.

integer format: int32

Allowed values: 0 1

Drilldown

Drilldown configuration JSON.

nullable

EmptyState

Empty-state configuration JSON.

nullable

ErrorBehavior

Error-behavior configuration JSON.

nullable

ExportBehavior

Export behavior JSON.

nullable

RefreshPolicy

Dashboard refresh policy JSON.

nullable

Type

How a dashboard renders its runtime surface.

integer format: int32

Allowed values: 0 1

WorkspaceUiPage

Workspace UI page reference stored by page-type dashboards.

object

PageKey

Manifest page key inside the active Workspace UI artifact.

string

nullable

DataSources

Validated data-source references.

Array<object>

nullable

Published data-source reference snapshot for a definition version.

object

BlockId

Widget or report block id.

string

nullable

SourceKind

Identifies the authoring surface that provides a DataSource.

integer format: int32

Allowed values: 0 1 2 3

StableId

Stable provider id.

string

nullable

Key

Provider key.

string

nullable

SchemaFingerprint

Validated descriptor fingerprint.

string

nullable

Renderer

Defines renderer families that can consume a DataSource output.

integer format: int32

Allowed values: 1 2 3 4 5 6 7 8

PublishedByUserName

Materialized publishing user display name.

string

nullable

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": {
    "Summary": {
      "State": 0
    },
    "Draft": {
      "Widgets": [
        {
          "DataSource": {
            "SourceKind": 0
          },
          "ParameterBindings": {
            "additionalProperty": {
              "Kind": 0
            }
          },
          "Renderer": 1,
          "RendererOptions": {
            "BarOrientation": 0,
            "BarArrangement": 0,
            "BarMeasure": 0
          }
        }
      ],
      "Type": 0
    },
    "Published": {
      "Document": {
        "Widgets": [
          {
            "DataSource": {
              "SourceKind": 0
            },
            "ParameterBindings": {
              "additionalProperty": {
                "Kind": 0
              }
            },
            "Renderer": 1,
            "RendererOptions": {
              "BarOrientation": 0,
              "BarArrangement": 0,
              "BarMeasure": 0
            }
          }
        ],
        "Type": 0
      },
      "DataSources": [
        {
          "SourceKind": 0,
          "Renderer": 1
        }
      ]
    },
    "Versions": [
      {
        "Document": {
          "Widgets": [
            {
              "DataSource": {
                "SourceKind": 0
              },
              "ParameterBindings": {
                "additionalProperty": {
                  "Kind": 0
                }
              },
              "Renderer": 1,
              "RendererOptions": {
                "BarOrientation": 0,
                "BarArrangement": 0,
                "BarMeasure": 0
              }
            }
          ],
          "Type": 0
        },
        "DataSources": [
          {
            "SourceKind": 0,
            "Renderer": 1
          }
        ]
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

Copy a dashboard version into the editable draft.

Authorizations

Parameters

Path Parameters

Query Parameters

Responses

200

Example

403

Examplegenerated

404

Example

Example^generated