OMomniapp
Documents

Create document

Changed on
post/api/v1/documents

Request

  • Base URL
    https://omniapp.co (the document declares no server; this is the origin it was published from)
  • URL
    https://omniapp.co/api/v1/documents
  • Auth
    HTTP bearer

Request body

branchIdstring uuid

Optional branch ID to associate the document with a model branch

descriptionstring nullable

Document description

facetFiltersboolean

Enable facet filters on the dashboard

filterConfigOmniDashboardFilterConfiguration

Dashboard filter configuration

filterOrderstring[]

Order of filters in the dashboard

identifierstring

Optional document identifier. If omitted, an identifier is auto-generated. Must be unique within the organization.

metadataVersion2

Dashboard metadata version (required when metadata is provided)

modelIdstring required

Shared model ID to base the document on

namestring required

Document name

Example request

{
  "branchId": "123e4567-e89b-12d3-a456-426614174001"
}

Response

Document created successfully

Changes

  • 3939110e279bRevision changes
    • breaking

      request property // was restricted to a list of enum values

    • info

      added the new optional request property //

    • info

      added the new area enum value to the request property //

    • info

      added the new areaStacked enum value to the request property //

    • info

      added the new areaStackedPercentage enum value to the request property //

    • info

      added the new auto enum value to the request property //

    • info

      added the new bar enum value to the request property //

    • info

      added the new barGrouped enum value to the request property //

    • info

      added the new barLine enum value to the request property //

    • info

      added the new barStacked enum value to the request property //

    • info

      added the new barStackedPercentage enum value to the request property //

    • info

      added the new boxplot enum value to the request property //

    • info

      added the new code enum value to the request property //

    • info

      added the new column enum value to the request property //

    • info

      added the new columnGrouped enum value to the request property //

    • info

      added the new columnStacked enum value to the request property //

    • info

      added the new columnStackedPercentage enum value to the request property //

    • info

      added the new funnel enum value to the request property //

    • info

      added the new heatmap enum value to the request property //

    • info

      added the new kpi enum value to the request property //

    • info

      added the new line enum value to the request property //

    • info

      added the new lineColor enum value to the request property //

    • info

      added the new map enum value to the request property //

    • info

      added the new markdown enum value to the request property //

    • info

      added the new omni-ai-summary-markdown enum value to the request property //

    • info

      added the new omni-spreadsheet enum value to the request property //

    • info

      added the new pie enum value to the request property //

    • info

      added the new point enum value to the request property //

    • info

      added the new pointColor enum value to the request property //

    • info

      added the new pointSize enum value to the request property //

    • info

      added the new pointSizeColor enum value to the request property //

    • info

      added the new regionMap enum value to the request property //

    • info

      added the new sankey enum value to the request property //

    • info

      added the new singleRecord enum value to the request property //

    • info

      added the new summaryValue enum value to the request property //

    • info

      added the new svgMap enum value to the request property //

    • info

      added the new table enum value to the request property //

    • info

      added the new treemap enum value to the request property //

    • info

      added the new undefined enum value to the request property //

  • c39971154a1dRevision changes
    • info

      added the new omni-custom-vis enum value to the request property ///