OMomni
Content migration

Import dashboard

Changed on
<Warning> This API is in beta and may have future breaking changes. </Warning>

Import dashboard to Omni instance.

post/unstable/documents/import

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/unstable/documents/import
  • Auth
    HTTP bearer

Request body

baseModelIdstring uuid required

Base model ID for the imported document

colorPalettesobject

Custom color palettes referenced by visualization configurations, keyed by export-local key. Include the colorPalettes field from the export response to carry custom palettes to the destination organization.

exportVersion'0.1' required

Export format version (must be 0.1)

fileUploadsobject

Spreadsheet file data to restore during import. Include the fileUploads field from the export response to restore spreadsheet tiles in the imported dashboard.

folderPathstring

Destination folder path

identifierstring

Custom identifier for the imported document. A 2–48 character slug.

queryModelsobject

Query model definitions from export. Defaults to {} if omitted.

resetQueryIdentifierMapboolean

Renumber tabs 1, 2, 3... in the export's ephemeral order instead of keeping each tab's queryIdentifierMapKey from the source. Defaults to false, so deliveries and alerts can address the same tab in the source and the copy.

workbookModelobject required

Workbook model from export. Required.

Response

Document imported successfully

documentIdstring uuid required

ID of the imported document

identifierstring required

Document identifier (miniUuid)

Changes

  • 43290040f88fRevision changes
    • breaking

      added the new required request property /

    • breaking

      added the new required request property /

    • breaking

      added subschema #2 to the request property allOf list

    • breaking

      the request property type changed from array to object

    • breaking

      the request property type changed from string to no type

    • breaking

      removed the success response with the status

    • info

      added the new optional request property

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the success response with the status