Type alias Service

Type declaration

• createServiceExportTemplate:function

  • createServiceExportTemplate(): ServiceExportInterface

  • Returns ServiceExportInterface

• deleteFullService:function

  • deleteFullService(serviceId: string, globalConfig?: boolean): Promise<AmServiceSkeleton>

  • Deletes the specified service

    Parameters

    • serviceId: string

      The service to delete
    • Optional globalConfig: boolean

      true if the global service is the target of the operation, false otherwise. Default: false.

    Returns Promise<AmServiceSkeleton>

• deleteFullServices:function

  • deleteFullServices(globalConfig?: boolean): Promise<AmServiceSkeleton[]>

  • Deletes all services

    Parameters

    • Optional globalConfig: boolean

      true if the global service is the target of the operation, false otherwise. Default: false.

    Returns Promise<AmServiceSkeleton[]>

• exportService:function

  • exportService(serviceId: string, globalConfig?: boolean): Promise<ServiceExportInterface>

  • Export service. The response can be saved to file as is.

    Parameters

    • serviceId: string

      service id/name
    • Optional globalConfig: boolean

      true if the global service is the target of the operation, false otherwise. Default: false.

    Returns Promise<ServiceExportInterface>

    Promise resolving to a ServiceExportInterface object.

• exportServices:function

  • exportServices(globalConfig?: boolean): Promise<ServiceExportInterface>

  • Export all services

    Parameters

    • Optional globalConfig: boolean

      true if the global service is the target of the operation, false otherwise. Default: false.

    Returns Promise<ServiceExportInterface>

• getFullServices:function

  • getFullServices(globalConfig?: boolean): Promise<FullService[]>

  • Get all services including their descendents.

    Parameters

    • Optional globalConfig: boolean

      true if the global service is the target of the operation, false otherwise. Default: false.

    Returns Promise<FullService[]>

    Promise resolving to an array of services with their descendants

• getListOfServices:function

  • getListOfServices(globalConfig?: boolean): Promise<AmServiceSkeleton[]>

  • Get list of services

    Parameters

    • Optional globalConfig: boolean

      true if the list of global services is requested, false otherwise. Default: false.

    Returns Promise<AmServiceSkeleton[]>

• importService:function

  • importService(serviceId: string, importData: ServiceExportInterface, options: ServiceImportOptions): Promise<AmServiceSkeleton>

  • Imports a single service using a reference to the service and a file to read the data from. Optionally clean (remove) an existing service first

    Parameters

    • serviceId: string

      The service id/name to add
    • importData: ServiceExportInterface

      The service configuration export data to import
    • options: ServiceImportOptions

      Import options

    Returns Promise<AmServiceSkeleton>

    A promise resolving to a service object

• importServices:function

  • importServices(importData: ServiceExportInterface, options: ServiceImportOptions): Promise<AmServiceSkeleton[]>

  • Imports multiple services from the same file. Optionally clean (remove) existing services first

    Parameters

    • importData: ServiceExportInterface

      The service configuration export data to import
    • options: ServiceImportOptions

      Import options

    Returns Promise<AmServiceSkeleton[]>

    A promise resolving to an array of service objects