Package com.appiancorp.suiteapi.ix

Interface ImportExportService

public interface ImportExportService

  • Method Summary

    Modifier and Type
    Method
    Description
    ImportResults
    importPackage(InputStream importPackage)
    Imports objects inside a package and returns the detailed results about the import.
    ImportResults
    importPackage(InputStream importPackage, InputStream importCustomizationFile)
    Imports objects inside applications, as well as admin console settings.
    ImportResults
    inspectPackage(InputStream importPackage)
    Inspects objects inside a package and returns detailed results about the inspection.
    ImportResults
    inspectPackage(InputStream importPackage, InputStream importCustomizationFile)
    Inspects objects inside an application package or an admin console package and returns detailed results about the inspection.

    Valid Inputs:
    1) application package
    2) admin console package
    3) admin console package + import customization file

    inspectPackage is a read-only operation and does not modify objects in the target environment.

  • Method Details

    • importPackage

      ImportResults importPackage(InputStream importPackage) throws AppianException
      Imports objects inside a package and returns the detailed results about the import. Valid import packages are ones exported from an Appian environment that is the same as or earlier than the version of Appian where this API is being called.
      Parameters:
      importPackage - An input stream representation of a .zip file.
      Returns:
      The results of the import operation.
      Throws:
      AppianException

    • inspectPackage

      ImportResults inspectPackage(InputStream importPackage) throws AppianException
      Inspects objects inside a package and returns detailed results about the inspection. inspectPackage is a read-only operation and does not modify objects in the target environment. When inspecting process models that use the Call Web Service smart service, the inspection result reports an error for the process models if the data types used by the Call Web Service smart service are not included in the package and are not in the target environment. This error can be ignored because the process models will automatically create the necessary data types when they are published during import. As a best practice, Appian recommends including all necessary data types in your package if they are not present in the target environment, or if they need to be updated.
      Parameters:
      importPackage - An input stream representation of a .zip file.
      Returns:
      The results of the inspect operation.
      Throws:
      AppianException

    • importPackage

      ImportResults importPackage(InputStream importPackage, InputStream importCustomizationFile) throws AppianException
      Imports objects inside applications, as well as admin console settings. The import customization file allows you to change values for admin console settings that are different between environments.

      Valid Inputs:
      1) application package
      2) admin console package
      3) admin console package + import customization file

      Valid import packages are ones exported from an Appian environment that is the same as or earlier than the version of Appian where this API is being called.
      Parameters:
      importPackage - An input stream representation of an application package or admin console package
      importCustomizationFile - An input stream representation of an import customization file
      Returns:
      The results of the import operation.
      Throws:
      AppianException

    • inspectPackage

      ImportResults inspectPackage(InputStream importPackage, InputStream importCustomizationFile) throws AppianException
      Inspects objects inside an application package or an admin console package and returns detailed results about the inspection.

      Valid Inputs:
      1) application package
      2) admin console package
      3) admin console package + import customization file

      inspectPackage is a read-only operation and does not modify objects in the target environment. When inspecting process models that use the Call Web Service smart service, the inspection result reports an error for the process models if the data types used by the Call Web Service smart service are not included in the package and are not in the target environment. This error can be ignored because the process models will automatically create the necessary data types when they are published during import. As a best practice, Appian recommends including all necessary data types in your package if they are not present in the target environment, or if they need to be updated.
      Parameters:
      importPackage - An input stream representation of an application package or admin console package
      importCustomizationFile - An input stream representation of an import customization file
      Returns:
      The results of the inspect operation.
      Throws:
      AppianException