Skip to Content
DocsOperationsExportBundle

ExportBundle

Parameters:

  • Title - operation titile can be any text
  • Source - source name where the bundle will be stored
  • Space - source space where the bundle will be stored
  • Specification - must be a valid JSON. It contains a specification of bundle’s content and metadata. content is the only required property. See examples below.
    • bundleName - (optional) name of the bundle, used by the marketplace to list and search bundles
    • type - (optinal) type of the bundle, used by the marketplace to list and search bundles.
    • createdBy - (optional) name of the bundle creator, used by the marketplace to list and search bundles.
    • version - (optional) version of the bundle (can be any string). It is used to construct the name of the bundle file if bundleFileRootName is specified: read bundleFileRootName for more details. Also it is used by the marketplace to list and search bundles.
    • bundleFileRootName - (optional) used to construct the bundle file name. The default value is bundle_. If bundleFileRootName is specified and version is specified, then the name of the bundle file is <bundleFileRootName>_<version>.zip (for example, Connectors_2.1.zip). If bundleFileRootName is specified but version is not, then the name is <bundleFileRootName>_<current timestemp>.zip (for example, Connectors-2022_10_10_10_03_52.zip). If bundleFileRootName is not specified the default value bundle- is used as follows bundle_<current timestemp>.zip (for example, bundle-2022_10_10_10_03_52.zip)
    • bundleFileName - (optional) defines the bundle file name. It has precedence over the name constructed from bundleFileRootName.
    • description - (optional) free-text description.
    • docURL - (optional) link to the documentation, displayed by the marketplace in bundle’s details.
    • applications (optional) - "all" to export all apps; array to list particular objects to export:
      • type - can be "source", "specification", "scenario"
      • name - name of the object
    • decrypt (optional) - "true" decrypts data if metadata encryption is enabled; "false" exports encrypted data. "false" assumes that you will import into an instance that is configured with the same encryption key. The default value is "true".
    • globalObjects - "all" to include all global objects (except apps) such as users, privileges, etc.

Specification example to export all applications (used for backup):

{
    "applications": "all"
}

Specification example to export an entire application called Tests (as if you exported it manually from the home page):

{
    "applications": [
        {
            "name": "Tests"        
            "objects": "all"
        }
        ]
}

Specification example to export some object from the current application (used for creating a bundle to publish on a marketplace):

{
    "bundleName": "HubSpot Connector",
    "bundleFileRootName": "hubspot_connector",
    "type": "Connector",
    "createdBy": "Palo Alto Databases, Inc.",
    "version": "1.0",
    "docURL": "https://infolinkcloud.com/doc/hubspot.html",
    "applications": [
        {
            "objects": [
                {"type": "specification", "name": "HubSpot_REST_API"},
                {"type": "scenario", "name": "HubSpot - loadBatch"},
                {"type": "scenario", "name": "HubSpot - loadOpen"}
                ]
        }
        ]
}

Specification example to export with a custom name:

{
    "bundleName": "HubSpot Connector",
    "bundleFileName": "my_very_special_bundle",
    "applications": [
        {
            "objects": [
                {"type": "specification", "name": "HubSpot_REST_API"},
                {"type": "scenario", "name": "HubSpot - loadBatch"},
                {"type": "scenario", "name": "HubSpot - loadOpen"}
                ]
        }
        ]
}
Last updated on
ExportFilter