Class ConfigurationsService

Hierarchy

  • ConfigurationsService

Constructors

constructor

Methods

getConfiguration getConfigurations

Constructors

constructor

Methods

Static getConfiguration

  • (Beta) Get a configuration Use this API to get a single configuration by its ID.

    Token Permissions: [ ep_configuration:read ]

    Returns

    ConfigurationResponse The configuration.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          id: string;
          xContextId?: string;
      }
      • id: string

        The ID of the configuration. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<ConfigurationResponse>

Static getConfigurations

  • (Beta) Get a list of configurations Use this API to get a list of configurations that match the given parameters.

    Token Permissions: [ ep_configuration:read ]

    Returns

    ConfigurationsResponse Get a list of configurations and the accompanying metadata.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          configurationTypes?: string[];
          entityIds?: string[];
          entityTypes?: string[];
          eventBrokerIds?: string[];
          ids?: string[];
          pageNumber?: number;
          pageSize?: number;
          sort?: string;
          xContextId?: string;
      }
      • Optional configurationTypes?: string[]

        Match only configurations with the given configuration type names separated by commas.
        Refer here for details on configuration types. *

      • Optional entityIds?: string[]

        Match only configurations with the given entity IDs separated by commas. *

      • Optional entityTypes?: string[]

        Match only configurations with the given entity type values separated by commas. *

      • Optional eventBrokerIds?: string[]

        Match only configurations with the given messaging service IDs separated by commas. *

      • Optional ids?: string[]

        Match only configurations with the given IDs separated by commas. *

      • Optional pageNumber?: number

        The page number to get. *

      • Optional pageSize?: number

        The number of configurations to get per page. *

      • Optional sort?: string

        Sort based on the provided parameters.
        The value can be either a standalone field name (?sort=<field>) or a field and direction, delimited by a colon (?sort=<field>:<asc|desc>). If the direction is not specified, the default is ascending. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<ConfigurationsResponse>

Settings

Member Visibility

Theme