Unstable

Import document (unstable)

Changed on
post/api/unstable/documents/import

Request

  • Base URL
    https://omniapp.co (the document declares no server; this is the origin it was published from)
  • URL
    https://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 vis configs, keyed by export-local key

exportVersion'0.1' required

Export format version

fileUploadsobject

File uploads included in the export

folderPathstring

Destination folder path

identifierstring

Document identifier for the imported document

queryModelsobject

Query models included in the export

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 data

Response

Document imported successfully

documentIdstring uuid required

ID of the imported document

identifierstring required

Document identifier (miniUuid)

Changes

    • info

      added the new optional request property

    • breaking

      added the new required request property /

    • 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 became required

    • breaking

      the request property became required

    • breaking

      the request property type changed from no type to object

    • breaking

      the / request property type changed from no type to object

    • breaking

      the request property type changed from string to no type

    • breaking

      the / request property type changed from no type to object

    • breaking

      the request property type changed from no type to object

    • 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

      the request property became optional

    • info

      the request property default value {} was added