Class ApplicationDomainsService

Hierarchy

  • ApplicationDomainsService

Constructors

constructor

Methods

createApplicationDomain deleteApplicationDomain exportApplicationDomains getApplicationDomain getApplicationDomains importApplicationDomains updateApplicationDomain

Constructors

constructor

Methods

Static createApplicationDomain

  • Create an application domain To help keep your event-driven architecture organized, use application domains to create namespaces for your applications, events and schemas.

    Token Permissions: [ application_domain:create:* ]

    Returns

    ApplicationDomainResponse Created. The newly saved application domain is returned in the response body.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          requestBody: ApplicationDomain;
          xContextId?: string;
      }
      • requestBody: ApplicationDomain

        Application domains have a name and topic domain. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<ApplicationDomainResponse>

Static deleteApplicationDomain

  • Delete an application domain Use this API to delete an application domain. This action also deletes all applications, events, and schemas in the application domain. You cannot undo this operation.

    Token Permissions: [ application_domain:delete:* ]

    Returns

    void

    Throws

    ApiError

    Parameters

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

        The ID of the application domain. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<void>

Static exportApplicationDomains

  • (Beta) Get application domains and their entities for export Use this API to export application domains and their nested entities. Please note that this endpoint is in beta and could be subject to change in the future

    Token Permissions: [ application_domain:export:* ]

    Returns

    ApplicationDomainExportDTO Export file containing the application domains and accompanying entities

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          ids: string[];
          xContextId?: string;
      }
      • ids: string[]

        The IDs of the application domains to export *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<ApplicationDomainExportDTO>

Static getApplicationDomain

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

    Token Permissions: [ application_domain:get:* ]

    Returns

    ApplicationDomainResponse The application domain.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          id: string;
          include?: string[];
          xContextId?: string;
      }
      • id: string

        The ID of the application domain. *

      • Optional include?: string[]

        Specify extra data to be included, options are: stats *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<ApplicationDomainResponse>

Static getApplicationDomains

  • Get a list of the application domains Use this API to get a list of application domains that match the given parameters.

    Token Permissions: [ event_designer:access ]

    Returns

    ApplicationDomainsResponse Get a list of application domains and the accompanying metadata.

    Throws

    ApiError

    Parameters

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

        Match only application domains with the given IDs separated by commas. *

      • Optional include?: string[]

        Specify extra data to be included, options are: stats *

      • Optional name?: string

        Name to be used to match the application domain. *

      • Optional pageNumber?: number

        The page number to get. *

      • Optional pageSize?: number

        The number of application domains to get per page. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<ApplicationDomainsResponse>

Static importApplicationDomains

  • (Beta) Create application domains and their entities from import Use this API to import application domains and their nested entities. Please note that this endpoint is in beta and could be subject to change in the future

    Token Permissions: [ application_domain:import:* ]

    Returns

    any Successfully registered import job with location identified in the response header

    Throws

    ApiError

    Parameters

    Returns CancelablePromise<any>

Static updateApplicationDomain

  • Update an application domain Use this API to update an application domain. You only need to specify the fields that need to be updated.

    Token Permissions: [ application_domain:update:* ]

    Returns

    ApplicationDomainResponse The updated application domain.

    Throws

    ApiError

    Parameters

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

        The ID of the application domain. *

      • requestBody: ApplicationDomain

        The application domain. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<ApplicationDomainResponse>

Settings

Member Visibility

Theme