Class EventsService

Hierarchy

  • EventsService

Constructors

constructor

Methods

createEvent createEventVersion createEventVersionForEvent deleteEvent deleteEventVersion deleteEventVersionForEvent getEvent getEventVersion getEventVersionForEvent getEventVersions getEventVersionsForEvent getEvents updateEvent updateEventVersion updateEventVersionForEvent updateEventVersionState updateEventVersionStateForEvent updateMsgSvcAssociationForEventVersion

Constructors

constructor

Methods

Static createEvent

  • Create an event Events are the primary building block of an event-driven architecture. Applications publish and subscribe to events and events reference schemas. In the Event Portal, an event is a type of event as opposed to a specific event instance.

    Token Permissions: [ event:create:* ]

    Returns

    EventResponse Created an event. The newly saved event is returned in the response body.

    Throws

    ApiError

    Parameters

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

        The event requires a name and an application domain ID. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<EventResponse>

Static createEventVersion

  • Create an event version Create an event version

    Token Permissions: [ event:update:* ]

    Returns

    EventVersionResponse Created an event version. Returns the newly saved event version in the response body.

    Throws

    ApiError

    Parameters

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

        App version request body description *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<EventVersionResponse>

Static createEventVersionForEvent

  • Deprecated

    Create an event version *Deprecation Date: 2022-11-01
    Removal Date: 2023-12-01
    Reason: Replaced by another endpoint.

    *Create an event version

    Returns

    EventVersionResponse Created an event version. Returns the newly saved event version in the response body.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          eventId: string;
          requestBody: EventVersion;
          xContextId?: string;
      }
      • eventId: string

        The ID of the parent event *

      • requestBody: EventVersion

        App version request body description *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<EventVersionResponse>

Static deleteEvent

  • Delete an event Use this API to delete an event.

    Token Permissions: [ event:delete:* ]

    Returns

    void

    Throws

    ApiError

    Parameters

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

        The ID of the event. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<void>

Static deleteEventVersion

  • Delete an event version Use this API to delete an event version.

    Token Permissions: [ event:update:* ]

    Returns

    void

    Throws

    ApiError

    Parameters

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

        The ID of the event version *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<void>

Static deleteEventVersionForEvent

  • Deprecated

    Delete an event version *Deprecation Date: 2022-11-01
    Removal Date: 2023-12-01
    Reason: Replaced by another endpoint.

    *Use this API to delete an event version.

    Returns

    void

    Throws

    ApiError

    Parameters

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

        The ID of the parent event *

      • id: string

        The ID of the event version *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<void>

Static getEvent

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

    Token Permissions: [ event:get:* ]

    Returns

    EventResponse The event.

    Throws

    ApiError

    Parameters

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

        The ID of the event. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<EventResponse>

Static getEventVersion

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

    Token Permissions: [ event:get:* ]

    Returns

    EventVersionResponse The event version.

    Throws

    ApiError

    Parameters

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

        The ID of the event version. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<EventVersionResponse>

Static getEventVersionForEvent

  • Deprecated

    Get an event version *Deprecation Date: 2022-11-01
    Removal Date: 2023-12-01
    Reason: Replaced by another endpoint.

    *Use this API to get a single event version by its ID.

    Returns

    EventVersionResponse The event version.

    Throws

    ApiError

    Parameters

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

        The ID of the parent event. *

      • id: string

        The ID of the event version. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<EventVersionResponse>

Static getEventVersions

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

    Token Permissions: [ event_designer:access ]

    Returns

    EventVersionsResponse Get a list of event versions and the accompanying metadata.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          customAttributes?: string;
          eventIds?: string[];
          ids?: string[];
          messagingServiceIds?: string[];
          pageNumber?: number;
          pageSize?: number;
          xContextId?: string;
      }
      • Optional customAttributes?: string

        Returns the entities that match the custom attribute filter.
        To filter by custom attribute name and value, use the format: customAttributes=<custom-attribute-name>==<custom-attribute-value>.
        To filter by custom attribute name, use the format: customAttributes=<custom-attribute-name>.
        The filter supports the AND operator for multiple custom attribute definitions (not multiple values for a given definition). Use ; (semicolon) to separate multiple queries with AND operation.
        Note: the filter supports custom attribute values containing only the characters [a-zA-Z0-9_\-\. ]. *

      • Optional eventIds?: string[]

        Match only event versions of these event IDs, separated by commas. *

      • Optional ids?: string[]

        Match only event versions with the given IDs, separated by commas. *

      • Optional messagingServiceIds?: string[]

        Match only event versions with the given messaging service IDs, separated by commas. *

      • Optional pageNumber?: number

        The page number to get. *

      • Optional pageSize?: number

        The number of event versions to get per page. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<EventVersionsResponse>

Static getEventVersionsForEvent

  • Deprecated

    Get a list of event versions for an event *Deprecation Date: 2022-11-01
    Removal Date: 2023-12-01
    Reason: Replaced by another endpoint.

    *Use this API to get a list of event versions that match the given parameters.

    Returns

    EventVersionsResponse Get a list of event versions.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          customAttributes?: string;
          displayName?: string;
          eventId: string;
          ids?: string[];
          version?: string;
          xContextId?: string;
      }
      • Optional customAttributes?: string

        Returns the entities that match the custom attribute filter.
        To filter by custom attribute name and value, use the format: customAttributes=<custom-attribute-name>==<custom-attribute-value>.
        To filter by custom attribute name, use the format: customAttributes=<custom-attribute-name>.
        The filter supports the AND operator for multiple custom attribute definitions (not multiple values for a given definition). Use ; (semicolon) to separate multiple queries with AND operation.
        Note: the filter supports custom attribute values containing only the characters [a-zA-Z0-9_\-\. ]. *

      • Optional displayName?: string

        Match event versions with the given display name. *

      • eventId: string

        The ID of the parent event. *

      • Optional ids?: string[]

        Match event versions with the given IDs separated by commas. *

      • Optional version?: string

        Match event versions with the given version. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<EventVersionsResponse>

Static getEvents

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

    Token Permissions: [ event_designer:access ]

    Returns

    EventsResponse Get a list of events and the accompanying metadata.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          applicationDomainId?: string;
          applicationDomainIds?: string[];
          brokerType?: string;
          customAttributes?: string;
          ids?: string[];
          name?: string;
          pageNumber?: number;
          pageSize?: number;
          shared?: boolean;
          sort?: string;
          xContextId?: string;
      }
      • Optional applicationDomainId?: string

        Match only events in the given application domain. *

      • Optional applicationDomainIds?: string[]

        Match only events in the given application domain ids. *

      • Optional brokerType?: string

        Match only events with the given broker type *

      • Optional customAttributes?: string

        Returns the entities that match the custom attribute filter.
        To filter by custom attribute name and value, use the format: customAttributes=<custom-attribute-name>==<custom-attribute-value>.
        To filter by custom attribute name, use the format: customAttributes=<custom-attribute-name>.
        The filter supports the AND operator for multiple custom attribute definitions (not multiple values for a given definition). Use ; (semicolon) to separate multiple queries with AND operation.
        Note: the filter supports custom attribute values containing only the characters [a-zA-Z0-9_\-\. ]. *

      • Optional ids?: string[]

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

      • Optional name?: string

        Name of the event to match on. *

      • Optional pageNumber?: number

        The page number to get. *

      • Optional pageSize?: number

        The number of events to get per page. *

      • Optional shared?: boolean

        Match only with shared or unshared events. *

      • 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<EventsResponse>

Static updateEvent

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

    Token Permissions: [ event:update:* ]

    Returns

    EventResponse The updated event.

    Throws

    ApiError

    Parameters

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

        The ID of the event to update. *

      • requestBody: Event

        The event. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<EventResponse>

Static updateEventVersion

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

    Token Permissions: [ event:update:* ]

    Returns

    EventVersionResponse The updated event version.

    Throws

    ApiError

    Parameters

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

        The ID of the event version to update. *

      • requestBody: EventVersion

        The event version. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<EventVersionResponse>

Static updateEventVersionForEvent

  • Deprecated

    Update an event version *Deprecation Date: 2022-11-01
    Removal Date: 2023-12-01
    Reason: Replaced by another endpoint.

    *Use this API to update an event version. You only need to specify the fields that need to be updated.

    Returns

    EventVersionResponse The updated event version.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          eventId: string;
          id: string;
          requestBody: EventVersion;
          xContextId?: string;
      }
      • eventId: string

        The ID of the parent event. *

      • id: string

        The ID of the event version to update. *

      • requestBody: EventVersion

        The event version. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<EventVersionResponse>

Static updateEventVersionState

Static updateEventVersionStateForEvent

  • Deprecated

    Update the state of an event version *Deprecation Date: 2022-11-01
    Removal Date: 2023-12-01
    Reason: Replaced by another endpoint.

    *Use this API to update the state of event version. You only need to specify the target stateId field

    Returns

    VersionedObjectStateChangeRequest The updated state of the event version.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          eventId: string;
          id: string;
          requestBody: EventVersion;
          xContextId?: string;
      }
      • eventId: string

        The ID of the parent event. *

      • id: string

        The ID of the event version to update. *

      • requestBody: EventVersion

        The event version. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<VersionedObjectStateChangeRequest>

Static updateMsgSvcAssociationForEventVersion

Settings

Member Visibility

Theme