• Preparing search index...
  • The search index is not available
Solace Tools - v2.28.0
  • Solace Tools - v2.28.0
  • Event Portal OpenAPI Node
  • request

Function request

  • request<T>(config: OpenAPIConfig, options: ApiRequestOptions): CancelablePromise<T>
  • Request method

    Returns

    CancelablePromise

    Throws

    ApiError

    Type Parameters

    • T

    Parameters

    • config: OpenAPIConfig

      The OpenAPI configuration object

    • options: ApiRequestOptions

      The request options from the service

    Returns CancelablePromise<T>

    • Defined in packages/ep-openapi-node/generated-src/core/request.ts:279

Settings

Member Visibility

Theme

Modules

  • Solace Tools - v2.28.0
    • Event Portal APIM OpenAPI Node - v0.9.0
      • APIParameter
      • EventApiProduct
      • GuaranteedMessagingInformation
      • SolaceClassOfServicePolicy
      • Webhook
    • Event Portal AsyncAPI - v0.59.0
    • Event Portal OpenAPI Node - v3.0.0
      • Address
      • AddressLevel
      • Application
      • ApplicationConfigurationPushJob
      • ApplicationDeployment
      • AuditCommandDTO
      • AuditImportDTO
      • AuditImportJobMetadata
      • AuditJob
      • AuditResultStatsRequestDTO
      • Configuration
      • CustomAttributeDefinition
      • CustomAttributeFrontEndDTO
      • DeliveryDescriptor
      • DesignerMappingDTO
      • Environment
      • EventApi
      • EventApiProduct
      • EventApiProductRegistration
      • EventApiProductVersion
      • EventBrokerScanDataUploadDetails
      • EventManagementAgent
      • EventMesh
      • EventVersion
      • EventVersionFrontend
      • JobAdministrationDTO
      • JobBO
      • JobDTO
      • LoadSampleOperationDTO
      • MessagingService
      • MessagingServiceFrontEndDTO
      • MessagingServiceRemoveAssociation
      • MessagingServiceScanData
      • OperationDTO
      • OrgDTO
      • PreviewEntityConfigurationDTO
      • RuntimeAgentFrontEndDTO
      • RuntimeEntityConfiguration
      • RuntimeImportAllDTO
      • RuntimeImportFiltersDTO
      • RuntimeMappingDTO
      • SchemaRegistry
      • SolaceClassOfServicePolicy
      • SuggestedAddressLevelDTO
      • SuggestionApiInputDTO
      • TargetEntitiesRequestDTO
      • resourceConnectionDetails
    • Event Portal Runtime OpenAPI Node - v1.1.0
      • ApplicationConfigurationPushJob
      • AuditCommandDTO
      • AuditJob
      • DesignerMappingDTO
      • Environment
      • EventBrokerScanDataUploadDetails
      • EventManagementAgent
      • EventMesh
      • MessagingService
      • MessagingServiceRemoveAssociation
      • MessagingServiceScanData
      • RuntimeEntityConfiguration
      • RuntimeMappingDTO
      • SchemaRegistry
      • resourceConnectionDetails
    • Event Portal SDK - v0.63.0
    • Event Portal V1 OpenAPI Node - v0.1.4
      • Application
      • DomainImportConflict
      • EndpointDTO
      • Event
      • EventSchema
      • KafkaConnectorDTO
      • SolaceConnectorDTO
      • VirtualBroker
    • SempV2 Config OpenAPI Node - v1.1.0
      • AboutUser
      • AboutUserMsgVpn
      • Broker
      • DmrCluster
      • DmrClusterCertMatchingRuleCondition
      • DmrClusterLink
      • MsgVpn
      • MsgVpnAclProfile
      • MsgVpnAclProfilePublishException
      • MsgVpnAclProfilePublishTopicException
      • MsgVpnAclProfileSubscribeException
      • MsgVpnAclProfileSubscribeShareNameException
      • MsgVpnAclProfileSubscribeTopicException
      • MsgVpnAuthenticationOauthProfile
      • MsgVpnAuthenticationOauthProvider
      • MsgVpnBridge
      • MsgVpnBridgeRemoteMsgVpn
      • MsgVpnBridgeRemoteSubscription
      • MsgVpnBridgeTlsTrustedCommonName
      • MsgVpnCertMatchingRuleCondition
      • MsgVpnClientProfile
      • MsgVpnDistributedCache
      • MsgVpnJndiConnectionFactory
      • MsgVpnMqttSession
      • MsgVpnMqttSessionSubscription
      • MsgVpnQueue
      • MsgVpnQueueTemplate
      • MsgVpnReplicatedTopic
      • MsgVpnRestDeliveryPointQueueBinding
      • MsgVpnRestDeliveryPointRestConsumer
      • MsgVpnTopicEndpoint
      • MsgVpnTopicEndpointTemplate
      • OauthProfile
      • OauthProfileAccessLevelGroup
      • OauthProfileAccessLevelGroupMsgVpnAccessLevelException
      • OauthProfileDefaultMsgVpnAccessLevelException
  • ResourceType
  • ApiError
  • ApplicationDomainOperationsService
  • ApplicationDomainsService
  • ApplicationsService
  • AuditResultsService
  • BffApplicationVersionsFrontendService
  • CancelError
  • CancelablePromise
  • ConfigurationTypesService
  • ConfigurationsService
  • ConsumersService
  • CustomAttributeDefinitionsService
  • EnumsService
  • EnvironmentsService
  • EventApIsService
  • EventApiProductsService
  • EventManagementAgentsService
  • EventMeshesService
  • EventsService
  • MessagingServiceScanDataService
  • MessagingServiceScanLogsService
  • MessagingServiceScansService
  • MessagingServicesService
  • SchemasService
  • StatesService
  • TopicDomainsService
  • OnCancel
  • Address
  • AddressLevel
  • AddressSpace
  • AddressSpaceResponse
  • AddressSpacesResponse
  • ApiRequestOptions
  • ApiResult
  • Application
  • ApplicationChangeRequestPreviewResponse
  • ApplicationConfigPushJobResponse
  • ApplicationConfigurationPushJob
  • ApplicationDeployment
  • ApplicationDeploymentPreviewDTO
  • ApplicationDomain
  • ApplicationDomainExportDTO
  • ApplicationDomainImportDTO
  • ApplicationDomainResponse
  • ApplicationDomainStats
  • ApplicationDomainsResponse
  • ApplicationRegistration
  • ApplicationRegistrationResponse
  • ApplicationRegistrationsResponse
  • ApplicationResponse
  • ApplicationVersion
  • ApplicationVersionFrontendDTO
  • ApplicationVersionFrontendResponse
  • ApplicationVersionResponse
  • ApplicationVersionsFrontendResponse
  • ApplicationVersionsResponse
  • ApplicationsResponse
  • AssociatedEntity
  • AttractedEventVersionTuple
  • AttractingApplicationVersionTuple
  • Audit
  • AuditCommandDTO
  • AuditDetail
  • AuditDetailResponse
  • AuditImportDTO
  • AuditImportJobMetadata
  • AuditImportJobsMetadataResponse
  • AuditJob
  • AuditJobResponse
  • AuditRelationDTO
  • AuditResult
  • AuditResultDetail
  • AuditResultDetailResponse
  • AuditResultStatsDTO
  • AuditResultStatsRequestDTO
  • AuditResultsResponse
  • AuditsResponse
  • BulkAuditImportDTO
  • ChangeAppDomainEntitiesDTO
  • Configuration
  • ConfigurationResponse
  • ConfigurationType
  • ConfigurationTypeResponse
  • ConfigurationTypesResponse
  • ConfigurationsResponse
  • Consumer
  • ConsumerResponse
  • ConsumersResponse
  • CustomAttribute
  • CustomAttributeDefinition
  • CustomAttributeDefinitionResponse
  • CustomAttributeDefinitionsResponse
  • CustomAttributeFrontEndDTO
  • CustomAttributesFrontEndResponse
  • DeliveryDescriptor
  • DesignerMappingDTO
  • EPResponseSetString
  • Entitlement
  • EntityType
  • EntityTypesResponse
  • Environment
  • EnvironmentResponse
  • EnvironmentsResponse
  • EpUserEntitlements
  • EpUserEntitlementsResponse
  • ErrorResponse
  • Event
  • EventApi
  • EventApiProduct
  • EventApiProductRegistration
  • EventApiProductRegistrationResponse
  • EventApiProductRegistrationsResponse
  • EventApiProductResponse
  • EventApiProductVersion
  • EventApiProductVersionResponse
  • EventApiProductVersionsResponse
  • EventApiProductsResponse
  • EventApiResponse
  • EventApiVersion
  • EventApiVersionResponse
  • EventApiVersionsResponse
  • EventApisResponse
  • EventBrokerDataCollectionUploadResponse
  • EventBrokerScanData
  • EventBrokerScanDataUploadDetails
  • EventManagementAgent
  • EventManagementAgentRegion
  • EventManagementAgentRegionsResponse
  • EventManagementAgentResponse
  • EventManagementAgentRunCommand
  • EventManagementAgentRunCommandResponse
  • EventManagementAgentsResponse
  • EventMesh
  • EventMeshFrontEndDTO
  • EventMeshFrontEndResponse
  • EventMeshResponse
  • EventMeshesFrontEndResponse
  • EventMeshesResponse
  • EventResponse
  • EventV2KpiMetric
  • EventV2KpiMetricResponse
  • EventVersion
  • EventVersionFrontend
  • EventVersionResponse
  • EventVersionsFrontendResponse
  • EventVersionsResponse
  • EventsResponse
  • Filter
  • GatewayMessagingService
  • GatewayMessagingServiceResponse
  • GraphEdgeDTO
  • GraphModelDTO
  • GraphModelResponse
  • GraphModelsResponse
  • GraphNodeDTO
  • GraphNodeExtendedAttributeDTO
  • GraphNodePosition
  • GraphNodeReferenceDTO
  • GraphNodeResponse
  • GraphNodeWrapperDTO
  • GraphNodesResponse
  • Headers
  • ImportActionPreviewResultDTO
  • InvalidNonStateReference
  • InvalidStateReference
  • JobAdministrationDTO
  • JobBO
  • JobDTO
  • JobType
  • JsonNode
  • KafkaConsumerGroupAuditResultSetDTO
  • KafkaConsumerGroupAuditResultSetResponse
  • KafkaConsumerGroupAuditResultSetsResponse
  • KafkaTopicAuditResultSet
  • KafkaTopicAuditResultSetResponse
  • KafkaTopicAuditResultSetsResponse
  • KafkaTopicSchemaParentRelationAuditResultSet
  • KafkaTopicSchemaVersionRelationAuditResultSet
  • KpiEventReuseMetricDTO
  • KpiMetrics
  • KpiMetricsResponse
  • LoadSampleOperationDTO
  • MergeApplicationVersionsDTO
  • MessagingService
  • MessagingServiceAssociationDTO
  • MessagingServiceAssociationResponse
  • MessagingServiceAuthentication
  • MessagingServiceConnection
  • MessagingServiceCredentials
  • MessagingServiceFrontEndDTO
  • MessagingServiceInfoDTO
  • MessagingServiceOperation
  • MessagingServiceOperationResponse
  • MessagingServiceRemoveAssociation
  • MessagingServiceResponse
  • MessagingServiceScan
  • MessagingServiceScanData
  • MessagingServiceScanDataListResponse
  • MessagingServiceScanDataResponse
  • MessagingServiceScanLog
  • MessagingServiceScanLogListResponse
  • MessagingServiceScanResponse
  • MessagingServiceScansResponse
  • MessagingServicesInfoResponse
  • MessagingServicesResponse
  • OpenAPIConfig
  • OperationDTO
  • OperationResponse
  • OrgDTO
  • OrgStats
  • OrgsResponse
  • Pagination
  • Plan
  • PreviewEntityConfigurationDTO
  • Resolver
  • ResourceConnectionResponse
  • ResourceCredentialOperationsBO
  • ResourceCredentialPropertiesBO
  • ResponseAuditResultStatsDTO
  • ResponseJobDTO
  • ResponseOrgDTO
  • ResponseRuntimeImportAllResponseDTO
  • RuntimeAgentFrontEndDTO
  • RuntimeAgentOperationDTO
  • RuntimeAgentOperationResponse
  • RuntimeAgentRegionInternalDTO
  • RuntimeAgentRegionInternalResponse
  • RuntimeAgentRegionInternalsResponse
  • RuntimeEntityConfiguration
  • RuntimeImportAllDTO
  • RuntimeImportAllResponseDTO
  • RuntimeImportFiltersDTO
  • RuntimeImportPreviewDTO
  • RuntimeMappingDTO
  • SchemaImportPreviewDTO
  • SchemaImportPreviewResponse
  • SchemaObject
  • SchemaRegistriesResponse
  • SchemaRegistry
  • SchemaRegistryResponse
  • SchemaResponse
  • SchemaVersion
  • SchemaVersionFrontEnd
  • SchemaVersionReferenceDTO
  • SchemaVersionResponse
  • SchemaVersionsFrontEndResponse
  • SchemaVersionsResponse
  • SchemasResponse
  • SolaceClassOfServicePolicy
  • SolaceMessagingService
  • SolaceQueueAggregateResponse
  • SolaceQueueAuditResultSetDTO
  • SolaceQueueAuditResultSetsResponse
  • StateChangeRequestResponse
  • StateDTO
  • StatesResponse
  • StitchedEventVersionIdResultDTO
  • Subscription
  • SubscriptionStitchingEvalRequestDTO
  • SuggestedAddressLevelDTO
  • SuggestionApiInputDTO
  • Tag
  • TagAssociationsObject
  • TagEntityAssociationsObject
  • TagResponse
  • TargetEntitiesRequestDTO
  • ToggleInfoDTO
  • ToggleOrgInfoDTO
  • ToggleOrgInfoListResponse
  • ToggleOverrideDTO
  • ToggleOverrideListResponse
  • ToggleStatusDTO
  • ToggleStatusListResponse
  • TogglesInfoResponse
  • TopicAddressEnum
  • TopicAddressEnumResponse
  • TopicAddressEnumValue
  • TopicAddressEnumVersion
  • TopicAddressEnumVersionResponse
  • TopicAddressEnumVersionsResponse
  • TopicAddressEnumsResponse
  • TopicAddressResourceDTO
  • TopicAddressResourceResponse
  • TopicAddressResourcesResponse
  • TopicAggregateImportPreviewDTO
  • TopicAggregateImportPreviewResponse
  • TopicDomain
  • TopicDomainAnalysisDTO
  • TopicDomainResponse
  • TopicDomainsResponse
  • TopicFilter
  • VersionedObjectStateChangeRequest
  • meta
  • resourceAuthenticationDetails
  • resourceAuthenticationProperties
  • resourceConnectionDetails
  • resourceConnectionProperties
  • resourceCredentialDetails
  • tagsResponse
  • $Address
  • $AddressLevel
  • $AddressSpace
  • $AddressSpaceResponse
  • $AddressSpacesResponse
  • $Application
  • $ApplicationChangeRequestPreviewResponse
  • $ApplicationConfigPushJobResponse
  • $ApplicationConfigurationPushJob
  • $ApplicationDeployment
  • $ApplicationDeploymentPreviewDTO
  • $ApplicationDomain
  • $ApplicationDomainExportDTO
  • $ApplicationDomainImportDTO
  • $ApplicationDomainResponse
  • $ApplicationDomainStats
  • $ApplicationDomainsResponse
  • $ApplicationRegistration
  • $ApplicationRegistrationResponse
  • $ApplicationRegistrationsResponse
  • $ApplicationResponse
  • $ApplicationVersion
  • $ApplicationVersionFrontendDTO
  • $ApplicationVersionFrontendResponse
  • $ApplicationVersionResponse
  • $ApplicationVersionsFrontendResponse
  • $ApplicationVersionsResponse
  • $ApplicationsResponse
  • $AssociatedEntity
  • $AttractedEventVersionTuple
  • $AttractingApplicationVersionTuple
  • $Audit
  • $AuditCommandDTO
  • $AuditDetail
  • $AuditDetailResponse
  • $AuditImportDTO
  • $AuditImportJobMetadata
  • $AuditImportJobsMetadataResponse
  • $AuditJob
  • $AuditJobResponse
  • $AuditRelationDTO
  • $AuditResult
  • $AuditResultDetail
  • $AuditResultDetailResponse
  • $AuditResultStatsDTO
  • $AuditResultStatsRequestDTO
  • $AuditResultsResponse
  • $AuditsResponse
  • $BulkAuditImportDTO
  • $ChangeAppDomainEntitiesDTO
  • $Configuration
  • $ConfigurationResponse
  • $ConfigurationType
  • $ConfigurationTypeResponse
  • $ConfigurationTypesResponse
  • $ConfigurationsResponse
  • $Consumer
  • $ConsumerResponse
  • $ConsumersResponse
  • $CustomAttribute
  • $CustomAttributeDefinition
  • $CustomAttributeDefinitionResponse
  • $CustomAttributeDefinitionsResponse
  • $CustomAttributeFrontEndDTO
  • $CustomAttributesFrontEndResponse
  • $DeliveryDescriptor
  • $DesignerMappingDTO
  • $EPResponseSetString
  • $Entitlement
  • $EntityType
  • $EntityTypesResponse
  • $Environment
  • $EnvironmentResponse
  • $EnvironmentsResponse
  • $EpUserEntitlements
  • $EpUserEntitlementsResponse
  • $ErrorResponse
  • $Event
  • $EventApi
  • $EventApiProduct
  • $EventApiProductRegistration
  • $EventApiProductRegistrationResponse
  • $EventApiProductRegistrationsResponse
  • $EventApiProductResponse
  • $EventApiProductVersion
  • $EventApiProductVersionResponse
  • $EventApiProductVersionsResponse
  • $EventApiProductsResponse
  • $EventApiResponse
  • $EventApiVersion
  • $EventApiVersionResponse
  • $EventApiVersionsResponse
  • $EventApisResponse
  • $EventBrokerDataCollectionUploadResponse
  • $EventBrokerScanData
  • $EventBrokerScanDataUploadDetails
  • $EventManagementAgent
  • $EventManagementAgentRegion
  • $EventManagementAgentRegionsResponse
  • $EventManagementAgentResponse
  • $EventManagementAgentRunCommand
  • $EventManagementAgentRunCommandResponse
  • $EventManagementAgentsResponse
  • $EventMesh
  • $EventMeshFrontEndDTO
  • $EventMeshFrontEndResponse
  • $EventMeshResponse
  • $EventMeshesFrontEndResponse
  • $EventMeshesResponse
  • $EventResponse
  • $EventV2KpiMetric
  • $EventV2KpiMetricResponse
  • $EventVersion
  • $EventVersionFrontend
  • $EventVersionResponse
  • $EventVersionsFrontendResponse
  • $EventVersionsResponse
  • $EventsResponse
  • $Filter
  • $GatewayMessagingService
  • $GatewayMessagingServiceResponse
  • $GraphEdgeDTO
  • $GraphModelDTO
  • $GraphModelResponse
  • $GraphModelsResponse
  • $GraphNodeDTO
  • $GraphNodeExtendedAttributeDTO
  • $GraphNodePosition
  • $GraphNodeReferenceDTO
  • $GraphNodeResponse
  • $GraphNodeWrapperDTO
  • $GraphNodesResponse
  • $ImportActionPreviewResultDTO
  • $InvalidNonStateReference
  • $InvalidStateReference
  • $JobAdministrationDTO
  • $JobBO
  • $JobDTO
  • $JobType
  • $JsonNode
  • $KafkaConsumerGroupAuditResultSetDTO
  • $KafkaConsumerGroupAuditResultSetResponse
  • $KafkaConsumerGroupAuditResultSetsResponse
  • $KafkaTopicAuditResultSet
  • $KafkaTopicAuditResultSetResponse
  • $KafkaTopicAuditResultSetsResponse
  • $KafkaTopicSchemaParentRelationAuditResultSet
  • $KafkaTopicSchemaVersionRelationAuditResultSet
  • $KpiEventReuseMetricDTO
  • $KpiMetrics
  • $KpiMetricsResponse
  • $LoadSampleOperationDTO
  • $MergeApplicationVersionsDTO
  • $MessagingService
  • $MessagingServiceAssociationDTO
  • $MessagingServiceAssociationResponse
  • $MessagingServiceAuthentication
  • $MessagingServiceConnection
  • $MessagingServiceCredentials
  • $MessagingServiceFrontEndDTO
  • $MessagingServiceInfoDTO
  • $MessagingServiceOperation
  • $MessagingServiceOperationResponse
  • $MessagingServiceRemoveAssociation
  • $MessagingServiceResponse
  • $MessagingServiceScan
  • $MessagingServiceScanData
  • $MessagingServiceScanDataListResponse
  • $MessagingServiceScanDataResponse
  • $MessagingServiceScanLog
  • $MessagingServiceScanLogListResponse
  • $MessagingServiceScanResponse
  • $MessagingServiceScansResponse
  • $MessagingServicesInfoResponse
  • $MessagingServicesResponse
  • $OperationDTO
  • $OperationResponse
  • $OrgDTO
  • $OrgStats
  • $OrgsResponse
  • $Pagination
  • $Plan
  • $PreviewEntityConfigurationDTO
  • $ResourceConnectionResponse
  • $ResourceCredentialOperationsBO
  • $ResourceCredentialPropertiesBO
  • $ResourceType
  • $ResponseAuditResultStatsDTO
  • $ResponseJobDTO
  • $ResponseOrgDTO
  • $ResponseRuntimeImportAllResponseDTO
  • $RuntimeAgentFrontEndDTO
  • $RuntimeAgentOperationDTO
  • $RuntimeAgentOperationResponse
  • $RuntimeAgentRegionInternalDTO
  • $RuntimeAgentRegionInternalResponse
  • $RuntimeAgentRegionInternalsResponse
  • $RuntimeEntityConfiguration
  • $RuntimeImportAllDTO
  • $RuntimeImportAllResponseDTO
  • $RuntimeImportFiltersDTO
  • $RuntimeImportPreviewDTO
  • $RuntimeMappingDTO
  • $SchemaImportPreviewDTO
  • $SchemaImportPreviewResponse
  • $SchemaObject
  • $SchemaRegistriesResponse
  • $SchemaRegistry
  • $SchemaRegistryResponse
  • $SchemaResponse
  • $SchemaVersion
  • $SchemaVersionFrontEnd
  • $SchemaVersionReferenceDTO
  • $SchemaVersionResponse
  • $SchemaVersionsFrontEndResponse
  • $SchemaVersionsResponse
  • $SchemasResponse
  • $SolaceClassOfServicePolicy
  • $SolaceMessagingService
  • $SolaceQueueAggregateResponse
  • $SolaceQueueAuditResultSetDTO
  • $SolaceQueueAuditResultSetsResponse
  • $StateChangeRequestResponse
  • $StateDTO
  • $StatesResponse
  • $StitchedEventVersionIdResultDTO
  • $Subscription
  • $SubscriptionStitchingEvalRequestDTO
  • $SuggestedAddressLevelDTO
  • $SuggestionApiInputDTO
  • $Tag
  • $TagAssociationsObject
  • $TagEntityAssociationsObject
  • $TagResponse
  • $TargetEntitiesRequestDTO
  • $ToggleInfoDTO
  • $ToggleOrgInfoDTO
  • $ToggleOrgInfoListResponse
  • $ToggleOverrideDTO
  • $ToggleOverrideListResponse
  • $ToggleStatusDTO
  • $ToggleStatusListResponse
  • $TogglesInfoResponse
  • $TopicAddressEnum
  • $TopicAddressEnumResponse
  • $TopicAddressEnumValue
  • $TopicAddressEnumVersion
  • $TopicAddressEnumVersionResponse
  • $TopicAddressEnumVersionsResponse
  • $TopicAddressEnumsResponse
  • $TopicAddressResourceDTO
  • $TopicAddressResourceResponse
  • $TopicAddressResourcesResponse
  • $TopicAggregateImportPreviewDTO
  • $TopicAggregateImportPreviewResponse
  • $TopicDomain
  • $TopicDomainAnalysisDTO
  • $TopicDomainResponse
  • $TopicDomainsResponse
  • $TopicFilter
  • $VersionedObjectStateChangeRequest
  • $meta
  • $resourceAuthenticationDetails
  • $resourceAuthenticationProperties
  • $resourceConnectionDetails
  • $resourceConnectionProperties
  • $resourceCredentialDetails
  • $tagsResponse
  • OpenAPI
  • request