Class ApplicationsService

Hierarchy

ApplicationsService

Index

Constructors

Methods

createApplication createApplicationVersion deleteApplication deleteApplicationVersion getApplication getApplicationVersion getApplicationVersions getApplications getAsyncApiForApplicationVersion updateApplication updateApplicationVersion updateApplicationVersionState updateMsgSvcAssociationForAppVersion

Constructors

constructor

new ApplicationsService(): ApplicationsService
Returns ApplicationsService

Methods

`Static` createApplication

createApplication(__namedParameters: {
requestBody: Application;
xContextId?: string;
}): CancelablePromise<ApplicationResponse>
Create an application To model your event-driven architecture, applications are a fundamental building block for modelling the producers and consumers of events. Use this API to create applications and model the events they produce and consume.

Token Permissions: [ application:create:* ]

Returns
ApplicationResponse Created an application. Returns the newly saved application in the response body.

Throws
ApiError
Parameters
- __namedParameters: {
  requestBody: Application;
  xContextId?: string;
  }
  - requestBody: Application
    
    Applications have a name and live within an application domain. Events can be added to the application as produced or consumed. *
  - Optional xContextId?: string
    
    Optional context id the request is running. *
Returns CancelablePromise<ApplicationResponse>
- Defined in packages/ep-openapi-node/generated-src/services/ApplicationsService.ts:93

`Static` createApplicationVersion

createApplicationVersion(__namedParameters: {
requestBody: ApplicationVersion;
xContextId?: string;
}): CancelablePromise<ApplicationVersionResponse>
Create an application version Create an application version

Token Permissions: [ application:update:* ]

Returns
ApplicationVersionResponse Created an application version. Returns the newly saved application version in the response body.

Throws
ApiError
Parameters
- __namedParameters: {
  requestBody: ApplicationVersion;
  xContextId?: string;
  }
  - requestBody: ApplicationVersion
    
    App version request body description *
  - Optional xContextId?: string
    
    Optional context id the request is running. *
Returns CancelablePromise<ApplicationVersionResponse>
- Defined in packages/ep-openapi-node/generated-src/services/ApplicationsService.ts:303

`Static` deleteApplication

deleteApplication(__namedParameters: {
id: string;
xContextId?: string;
}): CancelablePromise<void>
Delete an application Use this API to delete an application.

Token Permissions: [ application:delete:* ]

Returns
void

Throws
ApiError
Parameters
- __namedParameters: {
  id: string;
  xContextId?: string;
  }
  - id: string
    
    The ID of the application *
  - Optional xContextId?: string
    
    Optional context id the request is running. *
Returns CancelablePromise<void>
- Defined in packages/ep-openapi-node/generated-src/services/ApplicationsService.ts:168

`Static` deleteApplicationVersion

deleteApplicationVersion(__namedParameters: {
versionId: string;
xContextId?: string;
}): CancelablePromise<void>
Delete an application version Use this API to delete an application version.

Token Permissions: [ application:update:* ]

Returns
void

Throws
ApiError
Parameters
- __namedParameters: {
  versionId: string;
  xContextId?: string;
  }
  - versionId: string
    
    The ID of the application version *
  - Optional xContextId?: string
    
    Optional context id the request is running. *
Returns CancelablePromise<void>
- Defined in packages/ep-openapi-node/generated-src/services/ApplicationsService.ts:378

`Static` getApplication

getApplication(__namedParameters: {
id: string;
xContextId?: string;
}): CancelablePromise<ApplicationResponse>
Get an application Use this API to get a single application by its ID.

Token Permissions: [ application:get:* ]

Returns
ApplicationResponse The application.

Throws
ApiError
Parameters
- __namedParameters: {
  id: string;
  xContextId?: string;
  }
  - id: string
    
    The ID of the application. *
  - Optional xContextId?: string
    
    Optional context id the request is running. *
Returns CancelablePromise<ApplicationResponse>
- Defined in packages/ep-openapi-node/generated-src/services/ApplicationsService.ts:130

`Static` getApplicationVersion

getApplicationVersion(__namedParameters: {
versionId: string;
xContextId?: string;
}): CancelablePromise<ApplicationVersionResponse>
Get an application version Use this API to get a single application version by its ID.

Token Permissions: [ application:get:* ]

Returns
ApplicationVersionResponse The application version.

Throws
ApiError
Parameters
- __namedParameters: {
  versionId: string;
  xContextId?: string;
  }
  - versionId: string
    
    The ID of the application version. *
  - Optional xContextId?: string
    
    Optional context id the request is running. *
Returns CancelablePromise<ApplicationVersionResponse>
- Defined in packages/ep-openapi-node/generated-src/services/ApplicationsService.ts:340

`Static` getApplicationVersions

getApplicationVersions(__namedParameters: {
    applicationIds?: string[];
    ids?: string[];
    messagingServiceIds?: string[];
    pageNumber?: number;
    pageSize?: number;
    xContextId?: string;
}): CancelablePromise<ApplicationVersionsResponse>
Get a list of application versions Use this API to get a list of application versions that match the given parameters.

Token Permissions: [ event_designer:access ]

Returns
ApplicationVersionsResponse Get a list of application versions and the accompanying metadata.

Throws
ApiError
Parameters
- __namedParameters: {
      applicationIds?: string[];
      ids?: string[];
      messagingServiceIds?: string[];
      pageNumber?: number;
      pageSize?: number;
      xContextId?: string;
  }
  - Optional applicationIds?: string[]
    
    Match only application versions of these application IDs, separated by commas. *
  - Optional ids?: string[]
    
    Match only application versions with the given IDs, separated by commas. *
  - Optional messagingServiceIds?: string[]
    
    Match only application versions with the given messaging service IDs, separated by commas. *
  - Optional pageNumber?: number
    
    The page number to get. *
  - Optional pageSize?: number
    
    The number of application versions to get per page. *
  - Optional xContextId?: string
    
    Optional context id the request is running. *
Returns CancelablePromise<ApplicationVersionsResponse>
- Defined in packages/ep-openapi-node/generated-src/services/ApplicationsService.ts:249

`Static` getApplications

getApplications(__namedParameters: {
    applicationDomainId?: string;
    applicationType?: string;
    customAttributes?: string;
    ids?: string[];
    name?: string;
    pageNumber?: number;
    pageSize?: number;
    sort?: string;
    xContextId?: string;
}): CancelablePromise<ApplicationsResponse>
Get a list of applications Use this API to get a list of applications that match the given parameters.

Token Permissions: [ event_designer:access ]

Returns
ApplicationsResponse Get a list of applications and the accompanying metadata.

Throws
ApiError
Parameters
- __namedParameters: {
      applicationDomainId?: string;
      applicationType?: string;
      customAttributes?: string;
      ids?: string[];
      name?: string;
      pageNumber?: number;
      pageSize?: number;
      sort?: string;
      xContextId?: string;
  }
  - Optional applicationDomainId?: string
    
    Match only applications in the given application domain. *
  - Optional applicationType?: string
    
    Match only applications with the given applicationType. *
  - 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 applications with the given IDs separated by commas. *
  - Optional name?: string
    
    Name of the application to match on. *
  - Optional pageNumber?: number
    
    The page number to get. *
  - Optional pageSize?: number
    
    The number of applications 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<ApplicationsResponse>
- Defined in packages/ep-openapi-node/generated-src/services/ApplicationsService.ts:27

`Static` getAsyncApiForApplicationVersion

getAsyncApiForApplicationVersion(__namedParameters: {
    applicationVersionId: string;
    asyncApiVersion?: "2.0.0" | "2.2.0" | "2.5.0";
    environmentOptions?: "include_declared_and_attracted_events" | "include_attracted_events_only";
    format?: "json" | "yaml";
    includedExtensions?: "all" | "parent" | "version" | "none";
    messagingServiceId?: string;
    showVersioning?: boolean;
    xContextId?: string;
}): CancelablePromise<string>
Get the AsyncAPI specification for an application version Use this API to get the AsyncAPI specification for an application version annotated with Event Portal metadata.

Token Permissions: [ application:generate_async_api:* ]

Returns
string The AsyncAPI specification for the application version.

Throws
ApiError
Parameters
- __namedParameters: {
      applicationVersionId: string;
      asyncApiVersion?: "2.0.0" | "2.2.0" | "2.5.0";
      environmentOptions?: "include_declared_and_attracted_events" | "include_attracted_events_only";
      format?: "json" | "yaml";
      includedExtensions?: "all" | "parent" | "version" | "none";
      messagingServiceId?: string;
      showVersioning?: boolean;
      xContextId?: string;
  }
  - applicationVersionId: string
    
    The ID of the application version. *
  - Optional asyncApiVersion?: "2.0.0" | "2.2.0" | "2.5.0"
    
    The version of AsyncAPI to use. *
  - Optional environmentOptions?: "include_declared_and_attracted_events" | "include_attracted_events_only"
    
    Determines whether bindings are applied to declared consumed events or published consumed events in the event mesh or both. *
  - Optional format?: "json" | "yaml"
    
    The format in which to get the AsyncAPI specification. Possible values are yaml and json. *
  - Optional includedExtensions?: "all" | "parent" | "version" | "none"
    
    The event portal database keys to include for each AsyncAPI object. *
  - Optional messagingServiceId?: string
    
    Applies bindings from consumed events that are published in this messaging service's modeled event mesh. *
  - Optional showVersioning?: boolean
    
    Include versions in each AsyncAPI object's name when only one version is present *
  - Optional xContextId?: string
    
    Optional context id the request is running. *
Returns CancelablePromise<string>
- Defined in packages/ep-openapi-node/generated-src/services/ApplicationsService.ts:553

`Static` updateApplication

updateApplication(__namedParameters: {
    id: string;
    requestBody: Application;
    xContextId?: string;
}): CancelablePromise<ApplicationResponse>
Update an application Use this API to update an application. You only need to specify the fields that need to be updated.

Token Permissions: [ application:update:* ]

Returns
ApplicationResponse The updated application.

Throws
ApiError
Parameters
- __namedParameters: {
      id: string;
      requestBody: Application;
      xContextId?: string;
  }
  - id: string
    
    The ID of the application to update. *
  - requestBody: Application
    
    The application. *
  - Optional xContextId?: string
    
    Optional context id the request is running. *
Returns CancelablePromise<ApplicationResponse>
- Defined in packages/ep-openapi-node/generated-src/services/ApplicationsService.ts:206

`Static` updateApplicationVersion

updateApplicationVersion(__namedParameters: {
    include?: string[];
    relationsBrokerType?: string;
    requestBody: ApplicationVersion;
    versionId: string;
    xContextId?: string;
}): CancelablePromise<ApplicationVersionResponse>
Update an application version Use this API to update an application version. You only need to specify the fields that need to be updated.

Token Permissions: [ application:update:* ]

Returns
ApplicationVersionResponse The updated application version.

Throws
ApiError
Parameters
- __namedParameters: {
      include?: string[];
      relationsBrokerType?: string;
      requestBody: ApplicationVersion;
      versionId: string;
      xContextId?: string;
  }
  - Optional include?: string[]
  - Optional relationsBrokerType?: string
  - requestBody: ApplicationVersion
    
    The application version. *
  - versionId: string
    
    The ID of the application version to update. *
  - Optional xContextId?: string
    
    Optional context id the request is running. *
Returns CancelablePromise<ApplicationVersionResponse>
- Defined in packages/ep-openapi-node/generated-src/services/ApplicationsService.ts:416

`Static` updateApplicationVersionState

updateApplicationVersionState(__namedParameters: {
    requestBody: VersionedObjectStateChangeRequest;
    versionId: string;
    xContextId?: string;
}): CancelablePromise<StateChangeRequestResponse>
Update the state of an application version Use this API to update the state of an application version. You only need to specify the target stateId field.

Token Permissions: [ application:update_state:* ]

Returns
StateChangeRequestResponse The updated state of the application version.

Throws
ApiError
Parameters
- __namedParameters: {
      requestBody: VersionedObjectStateChangeRequest;
      versionId: string;
      xContextId?: string;
  }
  - requestBody: VersionedObjectStateChangeRequest
    
    The state change object. *
  - versionId: string
    
    The ID of the application version to update. *
  - Optional xContextId?: string
    
    Optional context id the request is running. *
Returns CancelablePromise<StateChangeRequestResponse>
- Defined in packages/ep-openapi-node/generated-src/services/ApplicationsService.ts:467

`Static` updateMsgSvcAssociationForAppVersion

updateMsgSvcAssociationForAppVersion(__namedParameters: {
    requestBody: MessagingServiceAssociationDTO;
    versionId: string;
    xContextId?: string;
}): CancelablePromise<MessagingServiceAssociationResponse>
Replace messaging service association for an application version Use this API to replace the messaging service association for an application version.

Token Permissions: [ event_runtime:write ]

Returns
MessagingServiceAssociationResponse The updated messaging service associations.

Throws
ApiError
Parameters
- __namedParameters: {
      requestBody: MessagingServiceAssociationDTO;
      versionId: string;
      xContextId?: string;
  }
  - requestBody: MessagingServiceAssociationDTO
    
    The messaging service association object *
  - versionId: string
    
    The ID of the application version *
  - Optional xContextId?: string
    
    Optional context id the request is running. *
Returns CancelablePromise<MessagingServiceAssociationResponse>
- Defined in packages/ep-openapi-node/generated-src/services/ApplicationsService.ts:510

Class ApplicationsService

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns ApplicationsService

Methods

Static createApplication

Returns

Throws

Parameters

__namedParameters: { requestBody: Application; xContextId?: string; }

requestBody: Application

Optional xContextId?: string

Returns CancelablePromise<ApplicationResponse>

Static createApplicationVersion

Returns

Throws

Parameters

__namedParameters: { requestBody: ApplicationVersion; xContextId?: string; }

requestBody: ApplicationVersion

Optional xContextId?: string

Returns CancelablePromise<ApplicationVersionResponse>

Static deleteApplication

Returns

Throws

Parameters

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

id: string

Optional xContextId?: string

Returns CancelablePromise<void>

Static deleteApplicationVersion

Returns

Throws

Parameters

__namedParameters: { versionId: string; xContextId?: string; }

versionId: string

Optional xContextId?: string

Returns CancelablePromise<void>

Static getApplication

Returns

Throws

Parameters

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

id: string

Optional xContextId?: string

Returns CancelablePromise<ApplicationResponse>

Static getApplicationVersion

Returns

Throws

Parameters

__namedParameters: { versionId: string; xContextId?: string; }

versionId: string

Optional xContextId?: string

Returns CancelablePromise<ApplicationVersionResponse>

Static getApplicationVersions

Returns

Throws

Parameters

__namedParameters: { applicationIds?: string[]; ids?: string[]; messagingServiceIds?: string[]; pageNumber?: number; pageSize?: number; xContextId?: string; }

Optional applicationIds?: string[]

Optional ids?: string[]

Optional messagingServiceIds?: string[]

Optional pageNumber?: number

Optional pageSize?: number

Optional xContextId?: string

Returns CancelablePromise<ApplicationVersionsResponse>

Static getApplications

Returns

Throws

Parameters

__namedParameters: { applicationDomainId?: string; applicationType?: string; customAttributes?: string; ids?: string[]; name?: string; pageNumber?: number; pageSize?: number; sort?: string; xContextId?: string; }

Optional applicationDomainId?: string

Optional applicationType?: string

Optional customAttributes?: string

Optional ids?: string[]

Optional name?: string

Optional pageNumber?: number

`Static` createApplication

__namedParameters: {
requestBody: Application;
xContextId?: string;
}

`Optional` xContextId?: string

`Static` createApplicationVersion

__namedParameters: {
requestBody: ApplicationVersion;
xContextId?: string;
}

`Optional` xContextId?: string

`Static` deleteApplication

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

`Optional` xContextId?: string

`Static` deleteApplicationVersion

__namedParameters: {
versionId: string;
xContextId?: string;
}

`Optional` xContextId?: string

`Static` getApplication

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

`Optional` xContextId?: string

`Static` getApplicationVersion

__namedParameters: {
versionId: string;
xContextId?: string;
}

`Optional` xContextId?: string

`Static` getApplicationVersions

__namedParameters: {
applicationIds?: string[];
ids?: string[];
messagingServiceIds?: string[];
pageNumber?: number;
pageSize?: number;
xContextId?: string;
}

`Optional` applicationIds?: string[]

`Optional` ids?: string[]

`Optional` messagingServiceIds?: string[]

`Optional` pageNumber?: number

`Optional` pageSize?: number

`Optional` xContextId?: string

`Static` getApplications

__namedParameters: {
applicationDomainId?: string;
applicationType?: string;
customAttributes?: string;
ids?: string[];
name?: string;
pageNumber?: number;
pageSize?: number;
sort?: string;
xContextId?: string;
}

`Optional` applicationDomainId?: string

`Optional` applicationType?: string

`Optional` customAttributes?: string

`Optional` ids?: string[]

`Optional` name?: string

`Optional` pageNumber?: number

`Optional` pageSize?: number

`Optional` sort?: string

`Optional` xContextId?: string

`Static` getAsyncApiForApplicationVersion

`Optional` asyncApiVersion?: "2.0.0" | "2.2.0" | "2.5.0"

`Optional` environmentOptions?: "include_declared_and_attracted_events" | "include_attracted_events_only"

`Optional` format?: "json" | "yaml"

`Optional` includedExtensions?: "all" | "parent" | "version" | "none"

`Optional` messagingServiceId?: string

`Optional` showVersioning?: boolean

`Optional` xContextId?: string

`Static` updateApplication

__namedParameters: {
id: string;
requestBody: Application;
xContextId?: string;
}

`Optional` xContextId?: string

`Static` updateApplicationVersion

__namedParameters: {
include?: string[];
relationsBrokerType?: string;
requestBody: ApplicationVersion;
versionId: string;
xContextId?: string;
}

`Optional` include?: string[]

`Optional` relationsBrokerType?: string

`Optional` xContextId?: string

`Static` updateApplicationVersionState

__namedParameters: {
requestBody: VersionedObjectStateChangeRequest;
versionId: string;
xContextId?: string;
}

`Optional` xContextId?: string

`Static` updateMsgSvcAssociationForAppVersion

__namedParameters: {
requestBody: MessagingServiceAssociationDTO;
versionId: string;
xContextId?: string;
}

`Optional` xContextId?: string