Type Alias Application

Type declaration

• createApplication:function

  • createApplication(
        applicationId: string,
        applicationData: ApplicationSkeleton,
    ): Promise<ApplicationSkeleton>

    Create application

    Parameters

    • applicationId: string

      application id/name
    • applicationData: ApplicationSkeleton

      application data

    Returns Promise<ApplicationSkeleton>

    a promise that resolves to an application object

• createApplicationExportTemplate:function

  • createApplicationExportTemplate(): ApplicationExportInterface

    Create an empty application export template

    Returns ApplicationExportInterface

    an empty application export template

• deleteApplication:function

  • deleteApplication(
        applicationId: string,
        deep?: boolean,
    ): Promise<ApplicationSkeleton>

    Delete application

    Parameters

    • applicationId: string

      application uuid
    • Optionaldeep: boolean

      deep delete (remove dependencies)

    Returns Promise<ApplicationSkeleton>

    a promise that resolves to an application object

• deleteApplicationByName:function

  • deleteApplicationByName(
        applicationName: string,
        deep?: boolean,
    ): Promise<ApplicationSkeleton>

    Delete application by name

    Parameters

    • applicationName: string

      application name
    • Optionaldeep: boolean

      deep delete (remove dependencies)

    Returns Promise<ApplicationSkeleton>

    a promise that resolves to an application object

• deleteApplications:function

  • deleteApplications(deep?: boolean): Promise<ApplicationSkeleton[]>

    Delete all applications

    Parameters

    • Optionaldeep: boolean

      deep delete (remove dependencies)

    Returns Promise<ApplicationSkeleton[]>

    a promise that resolves to an array of application objects

• exportApplication:function

  • exportApplication(
        applicationId: string,
        options: ApplicationExportOptions,
    ): Promise<ApplicationExportInterface>

    Export application. The response can be saved to file as is.

    Parameters

    • applicationId: string

      application uuid
    • options: ApplicationExportOptions

      export options

    Returns Promise<ApplicationExportInterface>

    Promise resolving to an ApplicationExportInterface object.

• exportApplicationByName:function

  • exportApplicationByName(
        applicationName: string,
        options: ApplicationExportOptions,
    ): Promise<ApplicationExportInterface>

    Export application by name. The response can be saved to file as is.

    Parameters

    • applicationName: string

      application name
    • options: ApplicationExportOptions

      export options

    Returns Promise<ApplicationExportInterface>

    Promise resolving to an ApplicationExportInterface object.

• exportApplications:function

  • exportApplications(
        options?: ApplicationExportOptions,
    ): Promise<ApplicationExportInterface>

    Export all applications. The response can be saved to file as is.

    Parameters

    • Optionaloptions: ApplicationExportOptions

    Returns Promise<ApplicationExportInterface>

    Promise resolving to an ApplicationExportInterface object.

• getRealmManagedApplication:function

  • getRealmManagedApplication(): string

    Get application managed object type

    Returns string

    application managed object type in this realm

• importApplication:function

  • importApplication(
        applicationId: string,
        importData: ApplicationExportInterface,
        options: ApplicationImportOptions,
    ): Promise<ApplicationSkeleton>

    Import application. The import data is usually read from an application export file.

    Parameters

    • applicationId: string

      application uuid
    • importData: ApplicationExportInterface

      application import data.
    • options: ApplicationImportOptions

    Returns Promise<ApplicationSkeleton>

    Promise resolving to an application object.

• importApplicationByName:function

  • importApplicationByName(
        applicationName: string,
        importData: ApplicationExportInterface,
        options: ApplicationImportOptions,
    ): Promise<ApplicationSkeleton>

    Import application by name. The import data is usually read from an application export file.

    Parameters

    • applicationName: string

      application name
    • importData: ApplicationExportInterface

      application import data.
    • options: ApplicationImportOptions

    Returns Promise<ApplicationSkeleton>

    Promise resolving to an application object.

• importApplications:function

  • importApplications(
        importData: ApplicationExportInterface,
        options: ApplicationImportOptions,
    ): Promise<ApplicationSkeleton[]>

    Import applications. The import data is usually read from an application export file.

    Parameters

    • importData: ApplicationExportInterface

      application import data.
    • options: ApplicationImportOptions

    Returns Promise<ApplicationSkeleton[]>

• importFirstApplication:function

  • importFirstApplication(
        importData: ApplicationExportInterface,
        options: ApplicationImportOptions,
    ): Promise<ApplicationSkeleton[]>

    Import first application. The import data is usually read from an application export file.

    Parameters

    • importData: ApplicationExportInterface

      application import data.
    • options: ApplicationImportOptions

    Returns Promise<ApplicationSkeleton[]>

• queryApplications:function

  • queryApplications(
        filter: string,
        fields?: string[],
    ): Promise<ApplicationSkeleton[]>

    Query applications

    Parameters

    • filter: string

      CREST search filter
    • Optionalfields: string[]

      array of fields to return

    Returns Promise<ApplicationSkeleton[]>

• readApplication:function

  • readApplication(applicationId: string): Promise<ApplicationSkeleton>

    Read application

    Parameters

    • applicationId: string

      application uuid

    Returns Promise<ApplicationSkeleton>

    a promise that resolves to an application object

• readApplicationByName:function

  • readApplicationByName(applicationName: string): Promise<ApplicationSkeleton>

    Read application by name

    Parameters

    • applicationName: string

      application name

    Returns Promise<ApplicationSkeleton>

    a promise that resolves to an application object

• readApplications:function

  • readApplications(): Promise<ApplicationSkeleton[]>

    Read all applications. Results are sorted aphabetically.

    Returns Promise<ApplicationSkeleton[]>

    a promise that resolves to an array of application objects

• updateApplication:function

  • updateApplication(
        applicationId: string,
        applicationData: ApplicationSkeleton,
    ): Promise<ApplicationSkeleton>

    Update application

    Parameters

    • applicationId: string

      application uuid
    • applicationData: ApplicationSkeleton

      application data

    Returns Promise<ApplicationSkeleton>

    a promise that resolves to an application object