Class EnvironmentsService

Hierarchy

  • EnvironmentsService

Constructors

constructor

Methods

getEnvironment getEnvironments

Constructors

constructor

Methods

Static getEnvironment

  • Get an environment Use this API to get a single environment by its ID.

    Token Permissions: [ event_designer:access ]

    Returns

    EnvironmentResponse The environment.

    Throws

    ApiError

    Parameters

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

        The ID of the environment. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<EnvironmentResponse>

Static getEnvironments

  • Get a list of environments Use this API to get a list of all environments.

    Token Permissions: [ event_designer:access ]

    Returns

    EnvironmentsResponse Get a list of environments and the accompanying metadata.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          ids?: string[];
          like?: string;
          pageNumber?: number;
          pageSize?: number;
          sort?: string;
          xContextId?: string;
      }
      • Optional ids?: string[]
      • Optional like?: string
      • Optional pageNumber?: number

        The page number to get. *

      • Optional pageSize?: number

        The number of environments to get per page. *

      • Optional sort?: string
      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<EnvironmentsResponse>

Settings

Member Visibility

Theme