Interface IRepositoryService

Defines a contract for Repository Management Service methods used by users.

Namespace: Nevatech.Vsb.Repository.Services

Assembly: Nevatech.Vsb.Repository.dll

Syntax

public interface IRepositoryService

Methods

CompileCode(CodeCompilationParameters)

Tests the provided C# code by compiling it into a message processing component.

Declaration

string CompileCode(CodeCompilationParameters parameters)

Parameters

Type	Name	Description
CodeCompilationParameters	parameters	Provides the code to be compiled and compilation parameters.

Returns

Type	Description
String	Compilation errors or Null, if compilation was successful.

CopyServiceAgreement(Int32)

Creates new service agreement as a copy of existing one.

Declaration

int CopyServiceAgreement(int serviceAgreementId)

Parameters

Type	Name	Description
Int32	serviceAgreementId	Database identifier of the existing service agreement that needs to be copied.

Returns

Type	Description
Int32	Identifier of the newly created service agreement.

CopyServiceAgreementWithResult(Int32)

Creates new service agreement as a copy of existing one and returns its fully populated instance.

Declaration

ServiceAgreementDefinition CopyServiceAgreementWithResult(int serviceAgreementId)

Parameters

Type	Name	Description
Int32	serviceAgreementId	Database identifier of the existing service agreement that needs to be copied.

Returns

Type	Description
ServiceAgreementDefinition	Newly created service agreement.

CopyServiceVersion(Int32)

Creates new service version as a copy of existing one under the same service.

Declaration

int CopyServiceVersion(int serviceVersionId)

Parameters

Type	Name	Description
Int32	serviceVersionId	Database identifier of the existing service version that needs to be copied.

Returns

Type	Description
Int32	Identifier of the newly created service version.

CopyServiceVersionWithResult(Int32)

Creates new service version as a copy of existing one under the same service and returns its fully populated instance.

Declaration

ServiceVersionDefinition CopyServiceVersionWithResult(int serviceVersionId)

Parameters

Type	Name	Description
Int32	serviceVersionId	Database identifier of the existing service version that needs to be copied.

Returns

Type	Description
ServiceVersionDefinition	Newly created service version.

CreateCertificate(String)

Create new X.509 certificate issued by Repository Certificate Authority.

Declaration

CertificateInfo CreateCertificate(string subjectName)

Parameters

Type	Name	Description
String	subjectName	New certificate's subject distinguished name.

Returns

Type	Description
CertificateInfo	Created X.509 certificate with its basic information.

CreateCertificate(String, Int32, String)

Create new X.509 certificate issued by Repository Certificate Authority.

Declaration

CertificateInfo CreateCertificate(string subjectName, int validDays, string password)

Parameters

Type	Name	Description
String	subjectName	New certificate's subject distinguished name.
Int32	validDays	Requested number of certificate valid days. This value can be automatically limited by Repository expirationMonths configuration value.
String	password	password for resulting PFX data.

Returns

Type	Description
CertificateInfo	Created X.509 certificate with its basic information and password protected PFX data in its RawData property.

CreateMessageContent(Int32, MessageEnvelopeVersion, String)

Saves provided sample message content to a temporary storage for a limited amount of time and returns file identifier. If content is not referenced by a MessageSample, it will be deleted after expiration.

Declaration

int CreateMessageContent(int messageId, MessageEnvelopeVersion messageVersion, string content)

Parameters

Type	Name	Description
Int32	messageId	Identifier of the message that provided content is created for.
MessageEnvelopeVersion	messageVersion	SOAP envelope version of the provided message content.
String	content	Message content to be persisted.

Returns

Type	Description
Int32	Identifier of the file storing message content.

CreateMessageContentWithResult(Int32, MessageEnvelopeVersion, String)

Saves provided sample message content to a temporary storage for a limited amount of time and returns file identifier. If content is not referenced by a MessageSample, it will be deleted after expiration.

Declaration

File CreateMessageContentWithResult(int messageId, MessageEnvelopeVersion messageVersion, string content)

Parameters

Type	Name	Description
Int32	messageId	Identifier of the message that provided content is created for.
MessageEnvelopeVersion	messageVersion	SOAP envelope version of the provided message content.
String	content	Message content to be persisted.

Returns

Type	Description
File	Newly created File object.

CreateOrUpdateAlertGroup(AlertGroupDefinition)

Creates new or updates existing alert type group with related entities and returns its database identifier.

Declaration

int CreateOrUpdateAlertGroup(AlertGroupDefinition alertGroup)

Parameters

Type	Name	Description
AlertGroupDefinition	alertGroup	Alert type group definition that needs to be created or updated.

Returns

Type	Description
Int32	Identifier of the alert type group that has been created.

CreateOrUpdateAlertGroupWithResult(AlertGroupDefinition)

Creates new or updates existing alert type group with related entities and returns its fully populated instance.

Declaration

AlertGroupDefinition CreateOrUpdateAlertGroupWithResult(AlertGroupDefinition alertGroup)

Parameters

Type	Name	Description
AlertGroupDefinition	alertGroup	Alert type group definition that needs to be created or updated.

Returns

Type	Description
AlertGroupDefinition	Provided alert type group and related entities with populated identifiers, keys, and timestamps.

CreateOrUpdateAlertHandlerType(AlertHandlerType)

Creates new or updates existing alert handler type in the database and returns its database identifier.

Declaration

int CreateOrUpdateAlertHandlerType(AlertHandlerType alertHandlerType)

Parameters

Type	Name	Description
AlertHandlerType	alertHandlerType	Alert handler type that needs to be added or updated.

Returns

Type	Description
Int32	Newly created alert handler type database identifier.

CreateOrUpdateAlertHandlerTypeWithResult(AlertHandlerType)

Creates new or updates existing alert handler type in the database and returns its fully populated instance.

Declaration

AlertHandlerType CreateOrUpdateAlertHandlerTypeWithResult(AlertHandlerType alertHandlerType)

Parameters

Type	Name	Description
AlertHandlerType	alertHandlerType	Alert handler type that needs to be added or updated.

Returns

Type	Description
AlertHandlerType	Provided alert handler type with populated identifier, key, and timestamp.

CreateOrUpdateAlertType(AlertTypeDefinition)

Creates new or updates existing alert type with related entities and returns its database identifier.

Declaration

int CreateOrUpdateAlertType(AlertTypeDefinition alertType)

Parameters

Type	Name	Description
AlertTypeDefinition	alertType	Alert type definition that needs to be created or updated.

Returns

Type	Description
Int32	Identifier of the alert type that has been created.

CreateOrUpdateAlertTypeWithResult(AlertTypeDefinition)

Creates new or updates existing alert type with related entities and returns its fully populated instance.

Declaration

AlertTypeDefinition CreateOrUpdateAlertTypeWithResult(AlertTypeDefinition alertType)

Parameters

Type	Name	Description
AlertTypeDefinition	alertType	Alert type definition that needs to be created or updated.

Returns

Type	Description
AlertTypeDefinition	Provided alert type and related entities with populated identifiers, keys, and timestamps.

CreateOrUpdateAuthorizationGroup(AuthorizationGroupDefinition)

Creates new or updates existing authorization group in the database and returns its database identifier.

Declaration

int CreateOrUpdateAuthorizationGroup(AuthorizationGroupDefinition group)

Parameters

Type	Name	Description
AuthorizationGroupDefinition	group	Authorization group that needs to be added or updated.

Returns

Type	Description
Int32	Newly created group database identifier.

CreateOrUpdateAuthorizationGroupWithResult(AuthorizationGroupDefinition)

Creates new or updates existing authorization group in the database and returns its fully populated instance.

Declaration

AuthorizationGroupDefinition CreateOrUpdateAuthorizationGroupWithResult(AuthorizationGroupDefinition group)

Parameters

Type	Name	Description
AuthorizationGroupDefinition	group	Authorization group that needs to be added or updated.

Returns

Type	Description
AuthorizationGroupDefinition	Provided authorization group with populated identifiers, keys, and timestamps.

CreateOrUpdateAuthorizationRule(AuthorizationRuleDefinition)

Creates new or updates existing authorization rule in the database and returns its database identifier.

Declaration

int CreateOrUpdateAuthorizationRule(AuthorizationRuleDefinition rule)

Parameters

Type	Name	Description
AuthorizationRuleDefinition	rule	Authorization rule that needs to be added or updated.

Returns

Type	Description
Int32	Newly created rule database identifier.

CreateOrUpdateAuthorizationRuleAssignments(Int32, Collection<AuthorizationRuleAssignment>)

Creates, updates, or deletes authorization rule assignments for the specified service version.

Declaration

void CreateOrUpdateAuthorizationRuleAssignments(int serviceVersionId, Collection<AuthorizationRuleAssignment> rules)

Parameters

Type	Name	Description
Int32	serviceVersionId	Identifier of the service version which authorization list needs to be updated.
Collection<AuthorizationRuleAssignment>	rules	Collection of all existing rule assignments for the specified service version.

CreateOrUpdateAuthorizationRuleAssignmentsWithResult(Int32, Collection<AuthorizationRuleAssignment>)

Creates, updates, or deletes authorization rule assignments for the specified service version.

Declaration

Collection<AuthorizationRuleAssignment> CreateOrUpdateAuthorizationRuleAssignmentsWithResult(int serviceVersionId, Collection<AuthorizationRuleAssignment> rules)

Parameters

Type	Name	Description
Int32	serviceVersionId	Identifier of the service version which authorization list needs to be updated.
Collection<AuthorizationRuleAssignment>	rules	Collection of all existing rule assignments for the specified service version.

Returns

Type	Description
Collection<AuthorizationRuleAssignment>	Collection of the provided rule assignments with populated identifiers, keys, and timestamps.

CreateOrUpdateAuthorizationRuleWithResult(AuthorizationRuleDefinition)

Creates new or updates existing authorization rule in the database and returns its fully populated instance.

Declaration

AuthorizationRuleDefinition CreateOrUpdateAuthorizationRuleWithResult(AuthorizationRuleDefinition rule)

Parameters

Type	Name	Description
AuthorizationRuleDefinition	rule	Authorization rule that needs to be added or updated.

Returns

Type	Description
AuthorizationRuleDefinition	Provided authorization rule with populated identifiers, keys, and timestamps.

CreateOrUpdateBehavior(Behavior)

Creates new or updates existing behavior in the database and returns its database identifier.

Declaration

int CreateOrUpdateBehavior(Behavior behavior)

Parameters

Type	Name	Description
Behavior	behavior	Endpoint or service behavior that needs to be created.

Returns

Type	Description
Int32	Newly created behavior database identifier.

CreateOrUpdateBehaviorWithResult(Behavior)

Creates new or updates existing behavior in the database and returns its fully populated instance.

Declaration

Behavior CreateOrUpdateBehaviorWithResult(Behavior behavior)

Parameters

Type	Name	Description
Behavior	behavior	Endpoint or service behavior that needs to be created.

Returns

Type	Description
Behavior	Provided behavior with populated identifier, key, and timestamps.

CreateOrUpdateBinding(Binding)

Creates new or updates existing endpoint binding in the database and returns its database identifier.

Declaration

int CreateOrUpdateBinding(Binding binding)

Parameters

Type	Name	Description
Binding	binding	Endpoint binding that needs to be added.

Returns

Type	Description
Int32	Newly created endpoint binding database identifier.

CreateOrUpdateBindingWithResult(Binding)

Creates new or updates existing endpoint binding in the database and returns its fully populated instance.

Declaration

Binding CreateOrUpdateBindingWithResult(Binding binding)

Parameters

Type	Name	Description
Binding	binding	Endpoint binding that needs to be added.

Returns

Type	Description
Binding	Provided binding with populated identifier, key, and timestamps.

CreateOrUpdateComponentType(ComponentType)

Creates new or updates existing custom message processing component type in the database and returns its database identifier.

Declaration

int CreateOrUpdateComponentType(ComponentType componentType)

Parameters

Type	Name	Description
ComponentType	componentType	Component type that needs to be added.

Returns

Type	Description
Int32	Newly created component type database identifier.

CreateOrUpdateComponentTypeWithResult(ComponentType)

Creates new or updates existing custom message processing component type in the database and returns its fully populated instance.

Declaration

ComponentType CreateOrUpdateComponentTypeWithResult(ComponentType componentType)

Parameters

Type	Name	Description
ComponentType	componentType	Component type that needs to be added.

Returns

Type	Description
ComponentType	Provided component type with populated identifier, key, and timestamp.

CreateOrUpdateConsumer(Consumer)

Creates new or updates existing consumer in the database and returns its database identifier.

Declaration

int CreateOrUpdateConsumer(Consumer consumer)

Parameters

Type	Name	Description
Consumer	consumer	Consumer that needs to be added or updated.

Returns

Type	Description
Int32	Newly created consumer's database identifier.

CreateOrUpdateConsumerWithResult(Consumer)

Creates new or updates existing consumer in the database and returns its fully populated instance.

Declaration

Consumer CreateOrUpdateConsumerWithResult(Consumer consumer)

Parameters

Type	Name	Description
Consumer	consumer	Consumer that needs to be added or updated.

Returns

Type	Description
Consumer	Provided consumer with populated identifiers, keys, and timestamps.

CreateOrUpdateCustomEntity(CustomEntityDefinition)

Creates new or updates existing custom entity in the database and returns its database identifier.

Declaration

int CreateOrUpdateCustomEntity(CustomEntityDefinition entity)

Parameters

Type	Name	Description
CustomEntityDefinition	entity	Custom entity that needs to be added or updated.

Returns

Type	Description
Int32	Newly created custom entity database identifier.

CreateOrUpdateCustomEntityWithResult(CustomEntityDefinition)

Creates new or updates existing custom entity in the database and returns its fully populated instance.

Declaration

CustomEntityDefinition CreateOrUpdateCustomEntityWithResult(CustomEntityDefinition entity)

Parameters

Type	Name	Description
CustomEntityDefinition	entity	Custom entity that needs to be added or updated.

Returns

Type	Description
CustomEntityDefinition	Provided custom entity definition with populated identifiers, keys, and timestamps.

CreateOrUpdateDataSchemas(Int32, Collection<DataSchema>)

Creates new, updates existing, or deletes missing XML schemas assigned to a service version.

Declaration

void CreateOrUpdateDataSchemas(int serviceVersionId, Collection<DataSchema> dataSchemas)

Parameters

Type	Name	Description
Int32	serviceVersionId	Identifier of the service version that schemas belong to.
Collection<DataSchema>	dataSchemas	Collection of XML schema descriptions and XSD content to be created or updated.

CreateOrUpdateDataSchemasWithResult(Int32, Collection<DataSchema>)

Creates new, updates existing, or deletes missing XML schemas assigned to a service version.

Declaration

Collection<DataSchema> CreateOrUpdateDataSchemasWithResult(int serviceVersionId, Collection<DataSchema> dataSchemas)

Parameters

Type	Name	Description
Int32	serviceVersionId	Identifier of the service version that schemas belong to.
Collection<DataSchema>	dataSchemas	Collection of XML schema descriptions and XSD content to be created or updated.

Returns

Type	Description
Collection<DataSchema>	Provided schemas with fully populated identifiers and timestamps, but no XSD content.

CreateOrUpdateExpressionType(ExpressionType)

Creates new or updates existing custom message evaluating expression type in the database and returns its database identifier.

Declaration

int CreateOrUpdateExpressionType(ExpressionType expressionType)

Parameters

Type	Name	Description
ExpressionType	expressionType	Expression type that needs to be added.

Returns

Type	Description
Int32	Newly created expression type database identifier.

CreateOrUpdateExpressionTypeWithResult(ExpressionType)

Creates new or updates existing custom message evaluating expression type in the database and returns its fully populated instance.

Declaration

ExpressionType CreateOrUpdateExpressionTypeWithResult(ExpressionType expressionType)

Parameters

Type	Name	Description
ExpressionType	expressionType	Expression type that needs to be added.

Returns

Type	Description
ExpressionType	Provided expression type with populated identifier, key, and timestamp.

CreateOrUpdateFile(File)

Creates new or updates existing file in the database.

Declaration

int CreateOrUpdateFile(File file)

Parameters

Type	Name	Description
File	file	File content and metadata.

Returns

Type	Description
Int32	Identifier of the file that has been created or updated.

CreateOrUpdateFileWithResult(File)

Creates new or updates existing file in the database and returns its fully populated metadata with no content.

Declaration

File CreateOrUpdateFileWithResult(File file)

Parameters

Type	Name	Description
File	file	File content and metadata.

Returns

Type	Description
File	Provided file's metadata with populated identifier, key, and timestamp, and cleared content.

CreateOrUpdateFolder(Folder)

Creates new or updates existing folder in the database and returns its database identifier.

Declaration

int CreateOrUpdateFolder(Folder folder)

Parameters

Type	Name	Description
Folder	folder	Folder that needs to be added.

Returns

Type	Description
Int32	New folder database identifier.

CreateOrUpdateFolderWithResult(Folder)

Creates new or updates existing folder in the database and returns its fully populated instance.

Declaration

Folder CreateOrUpdateFolderWithResult(Folder folder)

Parameters

Type	Name	Description
Folder	folder	Folder that needs to be added.

Returns

Type	Description
Folder	Provided folder with populated identifier, key, and timestamps.

CreateOrUpdateIdentity(IdentityDefinitionBase)

Creates new or updates existing public identity in the database and returns its database identifier.

Declaration

int CreateOrUpdateIdentity(IdentityDefinitionBase identity)

Parameters

Type	Name	Description
IdentityDefinitionBase	identity	Public identity that needs to be added.

Returns

Type	Description
Int32	Newly created public identity database identifier.

CreateOrUpdateIdentityWithResult(IdentityDefinitionBase)

Creates new or updates existing public identity in the database and returns its fully populated instance.

Declaration

IdentityDefinitionBase CreateOrUpdateIdentityWithResult(IdentityDefinitionBase identity)

Parameters

Type	Name	Description
IdentityDefinitionBase	identity	Public identity that needs to be added.

Returns

Type	Description
IdentityDefinitionBase	Provided public identity with populated identifier, key, and timestamps.

CreateOrUpdateNode(NodeDefinition)

Creates or update a node and all underlying entities from provided hierarchy of definition objects and returns its database identifier.

Declaration

int CreateOrUpdateNode(NodeDefinition node)

Parameters

Type	Name	Description
NodeDefinition	node	Object that provides definition of the node and its underlying entities.

Returns

Type	Description
Int32	Newly created node database identifier.

CreateOrUpdateNodeWithResult(NodeDefinition)

Creates or update a node and all underlying entities from provided hierarchy of definition objects and returns its fully populated instance.

Declaration

NodeDefinition CreateOrUpdateNodeWithResult(NodeDefinition node)

Parameters

Type	Name	Description
NodeDefinition	node	Object that provides definition of the node and its underlying entities.

Returns

Type	Description
NodeDefinition	Provided node definition with populated identifiers, keys, and timestamps.

CreateOrUpdateOrDeleteCustomAttributeTypes(EntityType, Collection<CustomAttributeType>)

Creates, updates, or deletes the custom attribute types for the specified entity type.

Declaration

void CreateOrUpdateOrDeleteCustomAttributeTypes(EntityType entityType, Collection<CustomAttributeType> customAttributeTypes)

Parameters

Type	Name	Description
EntityType	entityType	Entity type that custom attribute type are defined for.
Collection<CustomAttributeType>	customAttributeTypes	Collection of custom attribute types defined for the specified entity type. All existing types will be updated or deleted, not existing types will be created. All provided types must belong to the same entity type.

CreateOrUpdateOrDeleteCustomAttributeTypesWithResult(EntityType, Collection<CustomAttributeType>)

Creates, updates, or deletes the custom attribute types for the specified entity type. The most current types are returned.

Declaration

Collection<CustomAttributeType> CreateOrUpdateOrDeleteCustomAttributeTypesWithResult(EntityType entityType, Collection<CustomAttributeType> customAttributeTypes)

Parameters

Type	Name	Description
EntityType	entityType	Entity type that custom attribute type are defined for.
Collection<CustomAttributeType>	customAttributeTypes	Collection of custom attribute types defined for the specified entity type. All existing types will be updated or deleted, not existing types will be created. All provided types must belong to the same entity type.

Returns

Type	Description
Collection<CustomAttributeType>	Custom attribute types defined for the specified entity type.

CreateOrUpdateOrDeleteExtensibilityTypes(ExtensibilityTypes)

Creates, updates, or deletes the Sentinet custom extensibility types according to the provided data. System types cannot be updated and shall not be submitted.

Declaration

void CreateOrUpdateOrDeleteExtensibilityTypes(ExtensibilityTypes extensibilityTypes)

Parameters

Type	Name	Description
ExtensibilityTypes	extensibilityTypes	Collections of all extensibility types that have to be set in Sentinet. The existing types will either be updated or deleted to be in-sync with the provided ones. If a type does not currently exists it will be added. System types are ignored.

CreateOrUpdateOrDeleteExtensibilityTypesWithResult(ExtensibilityTypes, Boolean)

Creates, updates, or deletes the Sentinet custom extensibility types according to the provided data. System types cannot be updated and shall not be submitted. The most current extensibility types are returned.

Declaration

ExtensibilityTypes CreateOrUpdateOrDeleteExtensibilityTypesWithResult(ExtensibilityTypes extensibilityTypes, bool includeSystemTypes)

Parameters

Type	Name	Description
ExtensibilityTypes	extensibilityTypes	Collections of all extensibility types that have to be set in Sentinet. The existing types will either be updated or deleted to be in-sync with the provided ones. If a type does not currently exists it will be added. System types are ignored.
Boolean	includeSystemTypes	Flag indicating that system types should also be included in the result.

Returns

Type	Description
ExtensibilityTypes	Custom types that can be used in Sentinet extensibility points.

CreateOrUpdateOrDeleteSecurityRoles(Collection<SecurityRole>)

Creates, updates, or deletes the security roles in the provided collection. System security roles cannot be updated and shall not be submitted.

Declaration

void CreateOrUpdateOrDeleteSecurityRoles(Collection<SecurityRole> securityRoles)

Parameters

Type	Name	Description
Collection<SecurityRole>	securityRoles	Collections of all security roles that have to be set in Sentinet. The existing roles will either be updated or deleted to be in-sync with the provided ones. If a role does not currently exists it will be added. System security roles are ignored.

CreateOrUpdateOrDeleteSecurityRolesWithResult(Collection<SecurityRole>)

Creates, updates, or deletes the security roles in the provided collection. System security roles cannot be updated and shall not be submitted. The most current security roles are returned.

Declaration

Collection<SecurityRole> CreateOrUpdateOrDeleteSecurityRolesWithResult(Collection<SecurityRole> securityRoles)

Parameters

Type	Name	Description
Collection<SecurityRole>	securityRoles	Collections of all security roles that have to be set in Sentinet. The existing roles will either be updated or deleted to be in-sync with the provided ones. If a role does not currently exists it will be added. System security roles are ignored.

Returns

Type	Description
Collection<SecurityRole>	Collection of the most current security roles.

CreateOrUpdateProduct(ProductDefinition, Boolean)

Creates new or updates existing product in the database and returns its database identifier.

Declaration

int CreateOrUpdateProduct(ProductDefinition product, bool changeAccessKeyRequirements = false)

Parameters

Type	Name	Description
ProductDefinition	product	Product that needs to be added or updated.
Boolean	changeAccessKeyRequirements	Flag indicating that product service version can be updated automatically, if IsAccessKeyRequired property value does not match the product IsSubscriptionRequired property value.

Returns

Type	Description
Int32	Newly created product database identifier.

CreateOrUpdateProductWithResult(ProductDefinition, Boolean)

Creates new or updates existing product in the database and returns its fully populated instance.

Declaration

ProductDefinition CreateOrUpdateProductWithResult(ProductDefinition product, bool changeAccessKeyRequirements = false)

Parameters

Type	Name	Description
ProductDefinition	product	Product that needs to be added or updated.
Boolean	changeAccessKeyRequirements	Flag indicating that product service version can be updated automatically, if IsAccessKeyRequired property value does not match the product IsSubscriptionRequired property value.

Returns

Type	Description
ProductDefinition	Provided product definition with populated identifiers, keys, and timestamps.

CreateOrUpdateRouterType(RouterType)

Creates new or updates existing outbound message router type in the database and returns its unique identifier.

Declaration

int CreateOrUpdateRouterType(RouterType routerType)

Parameters

Type	Name	Description
RouterType	routerType	Router type that needs to be added.

Returns

Type	Description
Int32	Newly created router type unique identifier.

CreateOrUpdateRouterTypeWithResult(RouterType)

Creates new or updates existing outbound message router type in the database and returns its fully populated instance.

Declaration

RouterType CreateOrUpdateRouterTypeWithResult(RouterType routerType)

Parameters

Type	Name	Description
RouterType	routerType	Router type that needs to be added.

Returns

Type	Description
RouterType	Provided router type with populated identifier, key, and timestamps.

CreateOrUpdateSecurityRole(SecurityRole)

Creates new or updates existing security role in the database and returns its database identifier.

Declaration

int CreateOrUpdateSecurityRole(SecurityRole securityRole)

Parameters

Type	Name	Description
SecurityRole	securityRole	Security role that needs to be added.

Returns

Type	Description
Int32	Newly created security role database identifier.

CreateOrUpdateSecurityRoleWithResult(SecurityRole)

Creates new or updates existing security role in the database and returns its fully populated instance.

Declaration

SecurityRole CreateOrUpdateSecurityRoleWithResult(SecurityRole securityRole)

Parameters

Type	Name	Description
SecurityRole	securityRole	Security role that needs to be added.

Returns

Type	Description
SecurityRole	Provided security role with populated identifier, key, and timestamps.

CreateOrUpdateService(ServiceDefinition)

Creates new or updates existing physical or virtual service in the database and returns its unique identifier.

Declaration

int CreateOrUpdateService(ServiceDefinition service)

Parameters

Type	Name	Description
ServiceDefinition	service	Service that needs to be added or updated.

Returns

Type	Description
Int32	Newly created service unique identifier.

CreateOrUpdateServiceAgreement(ServiceAgreementDefinition)

Creates new or updates service level agreement and returns its database identifier.

Declaration

int CreateOrUpdateServiceAgreement(ServiceAgreementDefinition serviceAgreement)

Parameters

Type	Name	Description
ServiceAgreementDefinition	serviceAgreement	Service agreement that needs to be created or updated.

Returns

Type	Description
Int32	Identifier of the service agreement.

CreateOrUpdateServiceAgreementWithResult(ServiceAgreementDefinition)

Creates new or updates service level agreement and returns its fully populated instance.

Declaration

ServiceAgreementDefinition CreateOrUpdateServiceAgreementWithResult(ServiceAgreementDefinition serviceAgreement)

Parameters

Type	Name	Description
ServiceAgreementDefinition	serviceAgreement	Service agreement that needs to be created or updated.

Returns

Type	Description
ServiceAgreementDefinition	Provided service agreement with populated identifiers, keys, and timestamps.

CreateOrUpdateServiceVersion(ServiceVersionDefinition, Boolean, ServiceVersionCollisionAction)

Creates or updates a service version and all underlying entities from provided hierarchy of definition objects.

Declaration

int CreateOrUpdateServiceVersion(ServiceVersionDefinition serviceVersion, bool replaceDuplicateActions = false, ServiceVersionCollisionAction baseAddressCollisionAction = ServiceVersionCollisionAction.Throw)

Parameters

Type	Name	Description
ServiceVersionDefinition	serviceVersion	Object that provides definition of underlying service version entities.
Boolean	replaceDuplicateActions	Flag indicating that duplicate Action headers on the provided virtual SOAP service version can be automatically replaced with unique ones. If False then Action headers will not be modified.
ServiceVersionCollisionAction	baseAddressCollisionAction	An action to be done, if an actively hosted service version with the same base address is found during a service version activation.

Returns

Type	Description
Int32	Service version database identifier.

CreateOrUpdateServiceVersionWithResult(ServiceVersionDefinition, Boolean, ServiceVersionCollisionAction)

Creates or updates a service version and all underlying entities from provided hierarchy of definition objects and returns its fully populated instance.

Declaration

ServiceVersionDefinition CreateOrUpdateServiceVersionWithResult(ServiceVersionDefinition serviceVersion, bool replaceDuplicateActions = false, ServiceVersionCollisionAction baseAddressCollisionAction = ServiceVersionCollisionAction.Throw)

Parameters

Type	Name	Description
ServiceVersionDefinition	serviceVersion	Object that provides definition of underlying service version entities.
Boolean	replaceDuplicateActions	Flag indicating that duplicate Action headers on the provided virtual SOAP service version can be automatically replaced with unique ones. If False then Action headers will not be modified.
ServiceVersionCollisionAction	baseAddressCollisionAction	An action to be done, if an actively hosted service version with the same base address is found during a service version activation.

Returns

Type	Description
ServiceVersionDefinition	Provided service version definition with populated identifiers, keys, and timestamps.

CreateOrUpdateServiceWithResult(ServiceDefinition)

Creates new or updates existing physical or virtual service in the database and returns its fully populated instance.

Declaration

ServiceDefinition CreateOrUpdateServiceWithResult(ServiceDefinition service)

Parameters

Type	Name	Description
ServiceDefinition	service	Service that needs to be added or updated.

Returns

Type	Description
ServiceDefinition	Provided service definition with populated identifiers, keys, and timestamps.

CreateOrUpdateStaticResponseConfiguration(StaticResponseConfiguration)

Configures or re-configures a service version with ability to provide static responses to operation requests without making outbound service calls.

Declaration

void CreateOrUpdateStaticResponseConfiguration(StaticResponseConfiguration configuration)

Parameters

Type	Name	Description
StaticResponseConfiguration	configuration	Static response configuration to be applied.

CreateOrUpdateStaticResponseConfigurationWithResult(StaticResponseConfiguration)

Configures or re-configures a service version with ability to provide static responses to operation requests without making outbound service calls.

Declaration

StaticResponseConfiguration CreateOrUpdateStaticResponseConfigurationWithResult(StaticResponseConfiguration configuration)

Parameters

Type	Name	Description
StaticResponseConfiguration	configuration	Static response configuration to be applied.

Returns

Type	Description
StaticResponseConfiguration	Provided static response configuration with populated identifiers, keys, and timestamps.

CreateOrUpdateSubscription(SubscriptionDefinition, Boolean)

Creates new or updates existing subscription in the database and returns its database identifier.

Declaration

int CreateOrUpdateSubscription(SubscriptionDefinition subscription, bool allowToGenerateUniqueName = false)

Parameters

Type	Name	Description
SubscriptionDefinition	subscription	Subscription that needs to be added or updated.
Boolean	allowToGenerateUniqueName	Flag indicating that subscription name can be automatically updated to make it unique, if duplicate name already exists in the database. If False and duplicate name is found then exception will be thrown.

Returns

Type	Description
Int32	Newly created subscription's database identifier.

CreateOrUpdateSubscriptionWithResult(SubscriptionDefinition, Boolean)

Creates new or updates existing subscription in the database and returns its fully populated instance.

Declaration

SubscriptionDefinition CreateOrUpdateSubscriptionWithResult(SubscriptionDefinition subscription, bool allowToGenerateUniqueName = false)

Parameters

Type	Name	Description
SubscriptionDefinition	subscription	Subscription that needs to be added or updated.
Boolean	allowToGenerateUniqueName	Flag indicating that subscription name can be automatically updated to make it unique, if duplicate name already exists in the database. If False and duplicate name is found then exception will be thrown.

Returns

Type	Description
SubscriptionDefinition	Provided subscription with populated identifiers, keys, and timestamps.

CreateOrUpdateUser(UserDefinition)

Creates new user in the database and returns its database identifier.

Declaration

int CreateOrUpdateUser(UserDefinition user)

Parameters

Type	Name	Description
UserDefinition	user	User that needs to be added.

Returns

Type	Description
Int32	Newly created user's database identifier.

CreateOrUpdateUserWithResult(UserDefinition)

Creates new user in the database and returns its fully populated instance.

Declaration

UserDefinition CreateOrUpdateUserWithResult(UserDefinition user)

Parameters

Type	Name	Description
UserDefinition	user	User that needs to be added.

Returns

Type	Description
UserDefinition	Provided user definition with populated identifiers, keys, and timestamps.

CreateOrUpdateVirtualizationProfile(VirtualizationProfile)

When implemented by a class, creates a new or updates an existing virtualization profile and returns its database identifier.

Declaration

int CreateOrUpdateVirtualizationProfile(VirtualizationProfile profile)

Parameters

Type	Name	Description
VirtualizationProfile	profile	The virtualization profile that needs to be added or updated.

Returns

Type	Description
Int32	The virtualization profile's database identifier.

CreateOrUpdateVirtualizationProfileWithResult(VirtualizationProfile)

When implemented by a class, creates a new or updates an existing virtualization profile and returns its fully populated instance.

Declaration

VirtualizationProfile CreateOrUpdateVirtualizationProfileWithResult(VirtualizationProfile profile)

Parameters

Type	Name	Description
VirtualizationProfile	profile	The virtualization profile that needs to be added or updated.

Returns

Type	Description
VirtualizationProfile	The fully populated virtualization profile details.

CreateServiceVersionFromMetadata(Int32, ServiceVersionImportDetails, ErrorToleranceLevel, SerializerMode, Boolean)

Creates new service version and all underlying entities by importing service details from provided metadata.

Declaration

int CreateServiceVersionFromMetadata(int fileId, ServiceVersionImportDetails importDetails, ErrorToleranceLevel errorTolerance, SerializerMode serializer, bool wrappedParameters)

Parameters

Type	Name	Description
Int32	fileId	Service metadata identifier in the session store. If service version has been successfully created, the file is deleted.
ServiceVersionImportDetails	importDetails	Object that provides description on how metadata should be imported.
ErrorToleranceLevel	errorTolerance	Level of tolerance for errors and warnings appearing during the metadata import process.
SerializerMode	serializer	Type of serializer that will be used for XML types generation.
Boolean	wrappedParameters	Flag indicating that generated code will not unwrap "parameters" member of document-wrapped-literal messages.

Returns

Type	Description
Int32	Newly created service version unique identifier.

CreateServiceVersionFromMetadataWithResult(Int32, ServiceVersionImportDetails, ErrorToleranceLevel, SerializerMode, Boolean)

Creates new service version and all underlying entities by importing service details from provided metadata. Newly created service version is returned.

Declaration

ServiceVersionDefinition CreateServiceVersionFromMetadataWithResult(int fileId, ServiceVersionImportDetails importDetails, ErrorToleranceLevel errorTolerance, SerializerMode serializer, bool wrappedParameters)

Parameters

Type	Name	Description
Int32	fileId	Service metadata identifier in the session store. If service version has been successfully created, the file is deleted.
ServiceVersionImportDetails	importDetails	Object that provides description on how metadata should be imported.
ErrorToleranceLevel	errorTolerance	Level of tolerance for errors and warnings appearing during the metadata import process.
SerializerMode	serializer	Type of serializer that will be used for XML types generation.
Boolean	wrappedParameters	Flag indicating that generated code will not unwrap "parameters" member of document-wrapped-literal messages.

Returns

Type	Description
ServiceVersionDefinition	Newly created service version.

CreateServiceVersionFromProfile(VirtualizationRequest)

When implemented by a class, virtualizes a service version using the specified request

Declaration

ServiceVersionDefinition CreateServiceVersionFromProfile(VirtualizationRequest request)

Parameters

Type	Name	Description
VirtualizationRequest	request	The request object with virtualization settings.

Returns

Type	Description
ServiceVersionDefinition	The newly created virtual ServiceVersionDefinition.

CreateServiceVersionFromSwagger(Int32, Int32, ServiceVersionStatus)

Creates new service version and all underlying entities by importing service details from the provided Swagger document.

Declaration

int CreateServiceVersionFromSwagger(int fileId, int serviceId, ServiceVersionStatus status)

Parameters

Type	Name	Description
Int32	fileId	Swagger document identifier in the session store. If service version has been successfully created, the file is deleted.
Int32	serviceId	Identifier of the physical REST service that new version should belong to.
ServiceVersionStatus	status	Status of the newly created service version.

Returns

Type	Description
Int32	Newly created service version unique identifier.

CreateServiceVersionFromSwaggerWithResult(Int32, Int32, ServiceVersionStatus)

Creates new service version and all underlying entities by importing service details from the provided Swagger document. Newly created service version is returned.

Declaration

ServiceVersionDefinition CreateServiceVersionFromSwaggerWithResult(int fileId, int serviceId, ServiceVersionStatus status)

Parameters

Type	Name	Description
Int32	fileId	Swagger document identifier in the session store. If service version has been successfully created, the file is deleted.
Int32	serviceId	Identifier of the physical REST service that new version should belong to.
ServiceVersionStatus	status	Status of the newly created service version.

Returns

Type	Description
ServiceVersionDefinition	Newly created service version.

DeleteAlertGroup(Int32)

Deletes alert type group and related entities from the system.

Declaration

void DeleteAlertGroup(int id)

Parameters

Type	Name	Description
Int32	id	Identifier of the alert type group that needs to be deleted.

DeleteAlertHandlerType(Int32)

Deletes alert handler type corresponding to provided identifier from the database.

Declaration

void DeleteAlertHandlerType(int id)

Parameters

Type	Name	Description
Int32	id	Alert handler type unique identifier.

DeleteAlertType(Int32)

Deletes alert type and related entities from the system.

Declaration

void DeleteAlertType(int id)

Parameters

Type	Name	Description
Int32	id	Identifier of the alert type that needs to be deleted.

DeleteAuthorizationGroup(Int32)

Deletes authorization group corresponding to provided identifier from the database.

Declaration

void DeleteAuthorizationGroup(int groupId)

Parameters

Type	Name	Description
Int32	groupId	Authorization group unique identifier.

DeleteAuthorizationRule(Int32)

Deletes authorization rule corresponding to provided identifier from the database.

Declaration

void DeleteAuthorizationRule(int ruleId)

Parameters

Type	Name	Description
Int32	ruleId	Authorization rule unique identifier.

DeleteBehavior(Int32)

Deletes endpoint or service behavior corresponding to provided identifier from the database.

Declaration

void DeleteBehavior(int behaviorId)

Parameters

Type	Name	Description
Int32	behaviorId	Behavior's unique identifier.

DeleteBinding(Int32)

Deletes endpoint binding corresponding to provided identifier from the database.

Declaration

void DeleteBinding(int bindingId)

Parameters

Type	Name	Description
Int32	bindingId	Endpoint binding unique identifier.

DeleteComponentType(Int32)

Deletes custom message processing component type corresponding to provided identifier from the database.

Declaration

void DeleteComponentType(int componentTypeId)

Parameters

Type	Name	Description
Int32	componentTypeId	Custom message processing component type unique identifier.

DeleteConsumer(Int32)

Deletes consumer corresponding to provided identifier from the database.

Declaration

void DeleteConsumer(int consumerId)

Parameters

Type	Name	Description
Int32	consumerId	Consumer's database identifier.

DeleteCustomEntity(Int32)

Deletes custom entity corresponding to provided identifier from the database.

Declaration

void DeleteCustomEntity(int entityId)

Parameters

Type	Name	Description
Int32	entityId	Custom entity database identifier.

DeleteExpressionType(Int32)

Deletes custom message evaluating expression type corresponding to provided identifier from the database.

Declaration

void DeleteExpressionType(int expressionTypeId)

Parameters

Type	Name	Description
Int32	expressionTypeId	Custom message evaluating expression type unique identifier.

DeleteFile(Int32)

Deletes file corresponding to provided identifier from the database.

Declaration

void DeleteFile(int fileId)

Parameters

Type	Name	Description
Int32	fileId	File identifier.

Remarks

Note that file deletion is not common. Files are removed automatically when all references to the file disappear or file expires.

DeleteFolder(Int32)

Deletes folder corresponding to provided identifier from the database.

Declaration

void DeleteFolder(int folderId)

Parameters

Type	Name	Description
Int32	folderId	Folder unique identifier.

DeleteIdentity(Int32)

Deletes public identity corresponding to provided identifier from the database.

Declaration

void DeleteIdentity(int identityId)

Parameters

Type	Name	Description
Int32	identityId	Public identity unique identifier.

DeleteNode(Int32, Boolean)

Deletes node corresponding to provided identifier from the database.

Declaration

void DeleteNode(int nodeId, bool forceDelete = false)

Parameters

Type	Name	Description
Int32	nodeId	Node database identifier.
Boolean	forceDelete	Flag indicating that all hosted endpoints can also be deleted with the node. If False than node cannot be deleted, if it hosts any virtual services.

DeleteProduct(Int32)

Deletes product corresponding to provided identifier from the database.

Declaration

void DeleteProduct(int productId)

Parameters

Type	Name	Description
Int32	productId	Product database identifier.

DeleteRouterType(Int32)

Deletes outbound message router type corresponding to provided identifier from the database.

Declaration

void DeleteRouterType(int routerTypeId)

Parameters

Type	Name	Description
Int32	routerTypeId	Router type unique identifier.

DeleteSecurityRole(Int32)

Deletes security role corresponding to provided identifier from the database.

Declaration

void DeleteSecurityRole(int securityRoleId)

Parameters

Type	Name	Description
Int32	securityRoleId	Security role unique identifier.

DeleteService(Int32)

Deletes physical or virtual service corresponding to provided identifier from the database.

Declaration

void DeleteService(int serviceId)

Parameters

Type	Name	Description
Int32	serviceId	Service unique identifier.

DeleteServiceAgreement(Int32)

Deletes service agreement corresponding to provided database identifier.

Declaration

void DeleteServiceAgreement(int serviceAgreementId)

Parameters

Type	Name	Description
Int32	serviceAgreementId	Identifier of the service agreement that needs to be deleted.

DeleteServiceVersion(Int32)

Deletes service version corresponding to provided identifier from the database.

Declaration

void DeleteServiceVersion(int serviceVersionId)

Parameters

Type	Name	Description
Int32	serviceVersionId	Service version unique identifier.

DeleteSubscription(Int32)

Deletes subscription corresponding to provided identifier from the database.

Declaration

void DeleteSubscription(int subscriptionId)

Parameters

Type	Name	Description
Int32	subscriptionId	Subscription's database identifier.

DeleteUser(Int32)

Deletes user corresponding to provided identifier from the database.

Declaration

void DeleteUser(int userId)

Parameters

Type	Name	Description
Int32	userId	Identifier of the user who needs to be deleted.

DeleteVirtualizationProfile(Int32)

When implemented by a class, deletes the specified virtualization profile from the database..

Declaration

void DeleteVirtualizationProfile(int profileId)

Parameters

Type	Name	Description
Int32	profileId	The unique identifier of the profile to be deleted.

DeserializeAuthorizationExpression(String)

Deserializes and returns an authorization expression tree from provided XML string.

Declaration

AuthorizationExpressionBase DeserializeAuthorizationExpression(string source)

Parameters

Type	Name	Description
String	source	String containing the serialized to XML authorization expression tree.

Returns

Type	Description
AuthorizationExpressionBase	Deserialized from provided XML string the authorization expression tree.

DeserializeMessagePipeline(String)

Deserializes and returns the message processing pipeline from provided XML string.

Declaration

MessagePipeline DeserializeMessagePipeline(string source)

Parameters

Type	Name	Description
String	source	String containing the serialized to XML message processing pipeline.

Returns

Type	Description
MessagePipeline	Deserialized from provided XML string the message processing pipeline.

DeserializeMonitoringFilters(String)

Deserializes and returns a collection of monitoring filters from provided XML string.

Declaration

MonitoringFilterCollection DeserializeMonitoringFilters(string source)

Parameters

Type	Name	Description
String	source	String containing the serialized to XML collection of monitoring filters.

Returns

Type	Description
MonitoringFilterCollection	Deserialized from provided XML string the collection of monitoring filters.

DeserializePolicy(String)

When implemented by a class, deserializes policy description from the provided XML configuration.

Declaration

PolicyDescription DeserializePolicy(string configuration)

Parameters

Type	Name	Description
String	configuration	The configuration to deserialize.

Returns

Type	Description
PolicyDescription	The PolicyDescription created from configuration or null if configuration is not supported.

DownloadAuthorizationRuleAssignmentsReport(Int32)

Returns the Microsoft Excel Open XML report file containing collection of access rules assigned to the specified service version.

Declaration

byte[] DownloadAuthorizationRuleAssignmentsReport(int serviceVersionId)

Parameters

Type	Name	Description
Int32	serviceVersionId	Identifier of the service version which authorization rule assignments need to be returned.

Returns

Type	Description
Byte[]	Microsoft Excel Open XML report file containing collection of access rules assigned to the specified service version.

DownloadOperationsUsageReport(OperationUsageSummaryRequest)

Returns the Microsoft Excel Open XML report file containing collection of service operations along with the basic usage information.

Declaration

byte[] DownloadOperationsUsageReport(OperationUsageSummaryRequest request)

Parameters

Type	Name	Description
OperationUsageSummaryRequest	request	Parameters to be used for generating report records.

Returns

Type	Description
Byte[]	Microsoft Excel Open XML report file containing collection of service operations along with the basic usage information.

DownloadServiceVersionsUsageReport(ServiceVersionUsageSummaryRequest)

Returns the Microsoft Excel Open XML report file containing collection of services evaluated during the requested time period and ordered by specific performance metric.

Declaration

byte[] DownloadServiceVersionsUsageReport(ServiceVersionUsageSummaryRequest request)

Parameters

Type	Name	Description
ServiceVersionUsageSummaryRequest	request	Parameters to be used for generating report records.

Returns

Type	Description
Byte[]	Microsoft Excel Open XML report file containing collection of services evaluated during the requested time period and ordered by specific performance metric.

ExportEntities(Collection<LocalIdentifier>)

Exports specified entities into an XML file and returns it serialized to byte array.

Declaration

byte[] ExportEntities(Collection<LocalIdentifier> identifiers)

Parameters

Type	Name	Description
Collection<LocalIdentifier>	identifiers	Collection of local identifiers of the entities that need to be exported.

Returns

Type	Description
Byte[]	Serialized to bytes the repository import package containing exported entities.

ExportEntitiesToStream(Collection<LocalIdentifier>)

Exports specified entities into an XML file and returns it serialized to a stream.

Declaration

Stream ExportEntitiesToStream(Collection<LocalIdentifier> identifiers)

Parameters

Type	Name	Description
Collection<LocalIdentifier>	identifiers	Collection of local identifiers of the entities that need to be exported.

Returns

Type	Description
Stream	The repository import package containing exported entities that has been serialized to a stream.

FindApplications(ApplicationSearchQuery)

Returns applications matching the provided search criteria.

Declaration

Collection<Application> FindApplications(ApplicationSearchQuery query)

Parameters

Type	Name	Description
ApplicationSearchQuery	query	Parameters for a query that selects applications from the registry.

Returns

Type	Description
Collection<Application>	Collection of applications matching the provided search criteria.

FindAuthorizationGroups(AuthorizationGroupSearchQuery)

Returns collection of authorization groups matching provided search query.

Declaration

Collection<AuthorizationGroupSearchResult> FindAuthorizationGroups(AuthorizationGroupSearchQuery query)

Parameters

Type	Name	Description
AuthorizationGroupSearchQuery	query	Parameters for a query that selects authorization groups from the registry.

Returns

Type	Description
Collection<AuthorizationGroupSearchResult>	Collection of authorization groups matching provided search query.

FindAuthorizationRules(AuthorizationRuleSearchQuery)

Returns collection of authorization rules matching provided search query.

Declaration

Collection<AuthorizationRuleSearchResult> FindAuthorizationRules(AuthorizationRuleSearchQuery query)

Parameters

Type	Name	Description
AuthorizationRuleSearchQuery	query	Parameters for a query that selects authorization rules from the registry.

Returns

Type	Description
Collection<AuthorizationRuleSearchResult>	Collection of authorization rules matching provided search query.

FindBehaviors(BehaviorSearchQuery)

Returns collection of public service and endpoint behaviors matching provided search query.

Declaration

Collection<BehaviorSearchResult> FindBehaviors(BehaviorSearchQuery query)

Parameters

Type	Name	Description
BehaviorSearchQuery	query	Parameters for a query that selects public service and endpoint behaviors from the registry.

Returns

Type	Description
Collection<BehaviorSearchResult>	Collection of public service and endpoint behaviors matching provided search query.

FindBindings(BindingSearchQuery)

Returns collection of public bindings matching provided search query.

Declaration

Collection<BindingSearchResult> FindBindings(BindingSearchQuery query)

Parameters

Type	Name	Description
BindingSearchQuery	query	Parameters for a query that selects public bindings from the registry.

Returns

Type	Description
Collection<BindingSearchResult>	Collection of public bindings matching provided search query.

FindConsumers(ConsumerSearchQuery)

Returns consumers matching the provided search criteria. Consumer description field is NOT populated.

Declaration

Collection<Consumer> FindConsumers(ConsumerSearchQuery query)

Parameters

Type	Name	Description
ConsumerSearchQuery	query	Parameters for a query that selects consumers from the registry.

Returns

Type	Description
Collection<Consumer>	Collection of consumers matching the provided search criteria.

FindConsumerUsers(ConsumerUserSearchQuery)

Returns Developer Portal users matching the provided search criteria.

Declaration

Collection<User> FindConsumerUsers(ConsumerUserSearchQuery query)

Parameters

Type	Name	Description
ConsumerUserSearchQuery	query	Parameters for a query that selects users from the registry.

Returns

Type	Description
Collection<User>	Collection of Developer Portal users matching the provided search criteria.

FindCustomEntities(CustomEntitySearchQuery)

Returns collection of custom entity descriptions matching provided search query.

Declaration

Collection<SearchResult> FindCustomEntities(CustomEntitySearchQuery query)

Parameters

Type	Name	Description
CustomEntitySearchQuery	query	Parameters for a query that selects custom entities from the registry.

Returns

Type	Description
Collection<SearchResult>	Collection of custom entity descriptions matching provided search query.

FindEndpoints(EndpointSearchQuery)

Returns collection of endpoint descriptions matching provided search query.

Declaration

Collection<EndpointSearchResult> FindEndpoints(EndpointSearchQuery query)

Parameters

Type	Name	Description
EndpointSearchQuery	query	Parameters for a query that selects service endpoints from the registry.

Returns

Type	Description
Collection<EndpointSearchResult>	Collection of endpoint descriptions matching provided search query.

FindEntities(Collection<Guid>)

Returns collection of entities corresponding to provided unique keys.

Declaration

Collection<EntityInfo> FindEntities(Collection<Guid> keys)

Parameters

Type	Name	Description
Collection<Guid>	keys	Collection of keys corresponding to entities that need to be returned.

Returns

Type	Description
Collection<EntityInfo>	Collection of entities corresponding to provided unique keys.

FindEntity(Int32, EntityType)

Returns the entity of the specified type and having the provided identifier.

Declaration

SearchResult FindEntity(int entityId, EntityType entityType)

Parameters

Type	Name	Description
Int32	entityId	Identifier of the entity to be found.
EntityType	entityType	Type of the entity to be found.

Returns

Type	Description
SearchResult	Basic information about the requested entity, or Null if entity was not found.

FindFolders(SearchQuery)

Returns collection of folders matching provided search query.

Declaration

Collection<SearchResult> FindFolders(SearchQuery query)

Parameters

Type	Name	Description
SearchQuery	query	Parameters for a query that selects folders from the registry.

Returns

Type	Description
Collection<SearchResult>	Collection of folders matching provided search query.

FindIdentities(IdentitySearchQuery)

Returns collection of public identities matching the provided search query.

Declaration

Collection<IdentitySearchResult> FindIdentities(IdentitySearchQuery query)

Parameters

Type	Name	Description
IdentitySearchQuery	query	Parameters for a query that selects public identities from the registry.

Returns

Type	Description
Collection<IdentitySearchResult>	Collection of public identities matching provided search query.

FindNodes(NodeSearchQuery)

Returns collection of nodes matching provided search query.

Declaration

Collection<SearchResult> FindNodes(NodeSearchQuery query)

Parameters

Type	Name	Description
NodeSearchQuery	query	Parameters for a query that selects nodes from the registry.

Returns

Type	Description
Collection<SearchResult>	Collection of nodes matching provided search query.

FindProducts(ProductSearchQuery)

Returns products matching the provided search criteria. Product description field is NOT populated.

Declaration

Collection<Product> FindProducts(ProductSearchQuery query)

Parameters

Type	Name	Description
ProductSearchQuery	query	Parameters for a query that selects products from the registry.

Returns

Type	Description
Collection<Product>	Collection of products matching the provided search criteria. Description property is NOT populated in the result.

FindServiceAgreements(ServiceAgreementSearchQuery)

Returns collection of service agreements matching provided search query.

Declaration

Collection<ServiceAgreementSearchResult> FindServiceAgreements(ServiceAgreementSearchQuery query)

Parameters

Type	Name	Description
ServiceAgreementSearchQuery	query	Parameters for a query that selects service agreements from the registry.

Returns

Type	Description
Collection<ServiceAgreementSearchResult>	Collection of service agreements matching provided search query.

FindServices(ServiceSearchQuery)

Returns collection of service descriptions matching provided search query.

Declaration

Collection<ServiceSearchResult> FindServices(ServiceSearchQuery query)

Parameters

Type	Name	Description
ServiceSearchQuery	query	Parameters for a query that selects services from the registry.

Returns

Type	Description
Collection<ServiceSearchResult>	Collection of service descriptions matching provided search query.

FindServiceVersions(ServiceVersionSearchQuery)

Returns collection of service version descriptions matching provided search query.

Declaration

Collection<ServiceVersionSearchResult> FindServiceVersions(ServiceVersionSearchQuery query)

Parameters

Type	Name	Description
ServiceVersionSearchQuery	query	Parameters for a query that selects service versions from the registry.

Returns

Type	Description
Collection<ServiceVersionSearchResult>	Collection of service version descriptions matching provided search query.

FindSubscriptions(SubscriptionSearchQuery)

Returns collection of subscriptions matching the provided search criteria.

Declaration

Collection<Subscription> FindSubscriptions(SubscriptionSearchQuery query)

Parameters

Type	Name	Description
SubscriptionSearchQuery	query	Parameters for a query that selects subscriptions from the registry.

Returns

Type	Description
Collection<Subscription>	Collection of subscriptions matching the provided search criteria.

FindUsers(UserSearchQuery)

Returns collection of Sentinet users matching provided search query.

Declaration

Collection<UserSearchResult> FindUsers(UserSearchQuery query)

Parameters

Type	Name	Description
UserSearchQuery	query	Parameters for a query that selects users from the registry.

Returns

Type	Description
Collection<UserSearchResult>	Collection of Sentinet users matching provided search query.

GenerateMessageContent(Int32, MessageGenerationSettings)

Generates a sample message content for requested service message.

Declaration

MessageContent GenerateMessageContent(int messageId, MessageGenerationSettings settings)

Parameters

Type	Name	Description
Int32	messageId	Identifier of the message which sample needs to be generated.
MessageGenerationSettings	settings	Parameters to be used for message generation.

Returns

Type	Description
MessageContent	Generated sample message content.

GenerateMessageSchema(Int32)

Generates XSD schema for requested service message. This method can only be called for strongly-typed request or response messages (SOAP, no faults).

Declaration

MessageSchema GenerateMessageSchema(int messageId)

Parameters

Type	Name	Description
Int32	messageId	Identifier of the message which schema needs to be generated.

Returns

Type	Description
MessageSchema	Generated XSD schema describing the requested service message.

GenerateSecret(SecretType, Int32)

Randomly generates a secret of the specified length.

Declaration

string GenerateSecret(SecretType secretType, int length)

Parameters

Type	Name	Description
SecretType	secretType	Type of the generated secret. Binary secret is returned as a base64-encoded string.
Int32	length	For binary secret: the number of generated bytes. For password: the password length in chars. For token: the number of characters.

Returns

Type	Description
String	Password or base64-encoded binary secret.

GetActivities(MonitoringActivitiesRequest)

Returns collection of monitoring activities satisfying provided query parameters.

Declaration

Collection<MonitoringActivity> GetActivities(MonitoringActivitiesRequest request)

Parameters

Type	Name	Description
MonitoringActivitiesRequest	request	Provides search and sort parameters.

Returns

Type	Description
Collection<MonitoringActivity>	Collection of activities satisfying provided query parameters.

GetAlertGroup(Int32)

Returns alert type group and related entities corresponding to provided identifier.

Declaration

AlertGroupDefinition GetAlertGroup(int id)

Parameters

Type	Name	Description
Int32	id	Identifier of the alert type group which needs to be retrieved.

Returns

Type	Description
AlertGroupDefinition	Alert type group and related entities corresponding to provided identifier.

GetAlertGroups()

Returns collection of all existing alert groups.

Declaration

Collection<AlertGroup> GetAlertGroups()

Returns

Type	Description
Collection<AlertGroup>	Collection of all existing alert groups.

GetAlertHandlerType(Int32)

Returns alert handler type corresponding to the provided identifier.

Declaration

AlertHandlerType GetAlertHandlerType(int id)

Parameters

Type	Name	Description
Int32	id	Alert handler type unique identifier.

Returns

Type	Description
AlertHandlerType	Alert handler type corresponding to provided identifier.

GetAlertHandlerTypes()

Returns collection of all alert handler types registered in the system.

Declaration

Collection<AlertHandlerType> GetAlertHandlerTypes()

Returns

Type	Description
Collection<AlertHandlerType>	Collection of all alert handler types registered in the system.

GetAlerts(AlertRequest)

Returns alerts satisfying the provided search criteria.

Declaration

Collection<Alert> GetAlerts(AlertRequest request)

Parameters

Type	Name	Description
AlertRequest	request	Defines search parameters, sort parameters, and paging options.

Returns

Type	Description
Collection<Alert>	Collection of alerts satisfying the provided search criteria.

GetAlertSourceTypes()

Returns collection of all alert sources registered in the system.

Declaration

Collection<AlertSourceType> GetAlertSourceTypes()

Returns

Type	Description
Collection<AlertSourceType>	Collection of all alert sources registered in the system.

GetAlertSummary(AlertSummaryRequest)

Returns alerts statistics according to the specified time resolution.

Declaration

Collection<AlertSummary> GetAlertSummary(AlertSummaryRequest request)

Parameters

Type	Name	Description
AlertSummaryRequest	request	Defines filter parameters.

Returns

Type	Description
Collection<AlertSummary>	Collection of aggregated alert's measures calculated within requested time period.

GetAlertType(Guid)

Returns alert type and related entities corresponding to provided unique identifier.

Declaration

AlertTypeDefinition GetAlertType(Guid key)

Parameters

Type	Name	Description
Guid	key	Unique identifier of the alert type which needs to be retrieved.

Returns

Type	Description
AlertTypeDefinition	Alert type and related entities corresponding to provided identifier.

GetAlertType(Int32)

Returns alert type and related entities corresponding to provided database identifier.

Declaration

AlertTypeDefinition GetAlertType(int id)

Parameters

Type	Name	Description
Int32	id	Identifier of the alert type which needs to be retrieved.

Returns

Type	Description
AlertTypeDefinition	Alert type and related entities corresponding to provided identifier.

GetAlertTypes(AlertTypesRequest)

Returns collection of alert types satisfying provided request.

Declaration

Collection<AlertType> GetAlertTypes(AlertTypesRequest request)

Parameters

Type	Name	Description
AlertTypesRequest	request	Query parameters used to select and filter alert types.

Returns

Type	Description
Collection<AlertType>	Collection of alert types satisfying provided request.

GetAuthorizationClaimTypes()

Returns collection of well-known claim types sorted by claim type definition string.

Declaration

Collection<AuthorizationClaimType> GetAuthorizationClaimTypes()

Returns

Type	Description
Collection<AuthorizationClaimType>	Collection of well-known claim types.

GetAuthorizationGroup(Int32)

Returns authorization group corresponding to provided identifier.

Declaration

AuthorizationGroupDefinition GetAuthorizationGroup(int groupId)

Parameters

Type	Name	Description
Int32	groupId	Authorization group unique identifier.

Returns

Type	Description
AuthorizationGroupDefinition	Authorization group corresponding to provided identifier.

GetAuthorizationGroupsSummary(Nullable<Int32>)

Returns summary for the authorization groups belonging to the specified folder.

Declaration

AuthorizationGroupsSummary GetAuthorizationGroupsSummary(int? folderId)

Parameters

Type	Name	Description
Nullable<Int32>	folderId	Identifier of the folder that groups belong to.

Returns

Type	Description
AuthorizationGroupsSummary	Summary for the authorization groups belonging to the specified folder.

GetAuthorizationRule(Int32)

Returns authorization rule corresponding to provided identifier.

Declaration

AuthorizationRuleDefinition GetAuthorizationRule(int ruleId)

Parameters

Type	Name	Description
Int32	ruleId	Authorization rule unique identifier.

Returns

Type	Description
AuthorizationRuleDefinition	Authorization rule corresponding to provided identifier.

GetAuthorizationRuleAssignments(Int32)

Returns collection of authorization rule assignments attached to the specified service version.

Declaration

Collection<AuthorizationRuleAssignment> GetAuthorizationRuleAssignments(int serviceVersionId)

Parameters

Type	Name	Description
Int32	serviceVersionId	Identifier of the service version which authorization rule assignments need to be returned.

Returns

Type	Description
Collection<AuthorizationRuleAssignment>	Collection of authorization rule assignments attached to the specified service version.

GetAuthorizationRulesSummary(Nullable<Int32>)

Returns summary for the authorization rules belonging to the specified folder.

Declaration

AuthorizationRulesSummary GetAuthorizationRulesSummary(int? folderId)

Parameters

Type	Name	Description
Nullable<Int32>	folderId	Identifier of the folder that services belong to.

Returns

Type	Description
AuthorizationRulesSummary	Summary for the authorization rules belonging to the specified folder.

GetBehavior(Int32)

Returns endpoint or service behavior corresponding to provided identifier.

Declaration

Behavior GetBehavior(int behaviorId)

Parameters

Type	Name	Description
Int32	behaviorId	Behavior's unique identifier.

Returns

Type	Description
Behavior	Behavior corresponding to provided identifier.

GetBehaviorsSummary(Nullable<Int32>)

Returns summary for the public behaviors belonging to the specified folder.

Declaration

BehaviorsSummary GetBehaviorsSummary(int? folderId)

Parameters

Type	Name	Description
Nullable<Int32>	folderId	Identifier of the folder that behaviors belong to.

Returns

Type	Description
BehaviorsSummary	Summary for the public behaviors belonging to the specified folder.

GetBinding(Int32)

Returns endpoint binding corresponding to provided identifier.

Declaration

Binding GetBinding(int bindingId)

Parameters

Type	Name	Description
Int32	bindingId	Endpoint binding unique identifier.

Returns

Type	Description
Binding	Endpoint binding corresponding to provided identifier.

GetBindingsSummary(Nullable<Int32>)

Returns summary for the public bindings belonging to the specified folder.

Declaration

BindingsSummary GetBindingsSummary(int? folderId)

Parameters

Type	Name	Description
Nullable<Int32>	folderId	Identifier of the folder that bindings belong to.

Returns

Type	Description
BindingsSummary	Summary for the public bindings belonging to the specified folder.

GetCertificateAuthorities()

Returns X.509 certificates belonging to Certificate Authorities that have to be trusted by service providers and consumers.

Declaration

Collection<CertificateInfo> GetCertificateAuthorities()

Returns

Type	Description
Collection<CertificateInfo>	X.509 certificates belonging to Certificate Authorities.

GetCertificateInfo(Byte[], String)

Returns basic information about provided X.509 certificate.

Declaration

CertificateInfo GetCertificateInfo(byte[] rawData, string password)

Parameters

Type	Name	Description
Byte[]	rawData	Serialized to bytes certificate (raw data from the .CER and .PFX files are also supported).
String	password	Password used to decrypt the certificate.

Returns

Type	Description
CertificateInfo	Basic information about provided X.509 certificate.

GetChangeRecord(Int32)

Returns collection of fields (properties) updated on the specified record (entity).

Declaration

ChangeRecordDefinition GetChangeRecord(int changeRecordId)

Parameters

Type	Name	Description
Int32	changeRecordId	Identifier of the change record which fields need to be returned.

Returns

Type	Description
ChangeRecordDefinition	An object containing the change record and collection of changed fields belonging to it.

GetChangeRecords(DateTime, Nullable<DateTime>, Nullable<Int32>, EntityType[], ChangeTypes, String)

Returns collection of change records occured in the specified folder and its sub-folders.

Declaration

Collection<ChangeRecord> GetChangeRecords(DateTime startDateTime, DateTime? endDateTime = default(DateTime? ), int? folderId = default(int? ), EntityType[] entityTypes = null, ChangeTypes changeTypes = ChangeTypes.Created | ChangeTypes.Updated | ChangeTypes.Deleted | ChangeTypes.All, string searchTerm = null)

Parameters

Type	Name	Description
DateTime	startDateTime	Start date and time of the period to look for the changes.
Nullable<DateTime>	endDateTime	End date and time of the period to look for the changes. If not specified then all changes up to the current time is returned.
Nullable<Int32>	folderId	Identifier of the top folder to look for the changes.
EntityType[]	entityTypes	Collection of major entity types which changes need to be returned. If empty or Null then changes of all entities are returned.
ChangeTypes	changeTypes	Change types (created, updated, deleted) to be returned.
String	searchTerm	Entity name search term (may have wildcards).

Returns

Type	Description
Collection<ChangeRecord>	Collection of change records occured in the specified folder and its sub-folders.

GetChangeRecords(Int32, EntityType, DateTime, Nullable<DateTime>, ChangeTypes, String)

Returns collection of change records belonging to the specified major entity.

Declaration

Collection<ChangeRecord> GetChangeRecords(int entityId, EntityType entityType, DateTime startDateTime, DateTime? endDateTime = default(DateTime? ), ChangeTypes changeTypes = ChangeTypes.Created | ChangeTypes.Updated | ChangeTypes.Deleted | ChangeTypes.All, string searchTerm = null)

Parameters

Type	Name	Description
Int32	entityId	Identifier of the major entity that change records must belong to.
EntityType	entityType	Major entity type.
DateTime	startDateTime	Start date and time of the period to look for the changes.
Nullable<DateTime>	endDateTime	End date and time of the period to look for the changes. If not specified then all changes up to the current time is returned.
ChangeTypes	changeTypes	Change types (created, updated, deleted) to be returned.
String	searchTerm	Entity name search term (may have wildcards).

Returns

Type	Description
Collection<ChangeRecord>	Collection of change records belonging to the specified major entity.

GetChangeSet(Int32)

Returns collection of change records belonging to the specified change set.

Declaration

ChangeSetDefinition GetChangeSet(int changeSetId)

Parameters

Type	Name	Description
Int32	changeSetId	Identifier of the change set which records need to be returned.

Returns

Type	Description
ChangeSetDefinition	An object containing the change set and collection of change records belonging to it.

GetChangeSets(DateTime, Nullable<DateTime>, Nullable<Int32>)

Returns collection of change sets occured between requested dates and initiated by the specified user.

Declaration

Collection<ChangeSet> GetChangeSets(DateTime startDateTime, DateTime? endDateTime, int? userId)

Parameters

Type	Name	Description
DateTime	startDateTime	Start date and time of the period to look for the changes.
Nullable<DateTime>	endDateTime	End date and time of the period to look for the changes. If not specified then all changes up to the current time is returned.
Nullable<Int32>	userId	Identifier of the user who initiated the changes. If not specified then changes made by all users are returned.

Returns

Type	Description
Collection<ChangeSet>	Collection of change sets occured between requested dates and initiated by the specified user.

GetComponentType(Int32)

Returns custom message processing component type corresponding to the provided identifier.

Declaration

ComponentType GetComponentType(int componentTypeId)

Parameters

Type	Name	Description
Int32	componentTypeId	Custom message processing component type unique identifier.

Returns

Type	Description
ComponentType	Custom message processing component type corresponding to provided identifier.

GetComponentTypes()

Returns collection of all custom message processing component types in the system.

Declaration

Collection<ComponentType> GetComponentTypes()

Returns

Type	Description
Collection<ComponentType>	Collection of all custom message processing component types in the system.

GetConsumer(Int32)

Returns the consumer corresponding to provided identifier.

Declaration

Consumer GetConsumer(int consumerId)

Parameters

Type	Name	Description
Int32	consumerId	Consumer database identifier.

Returns

Type	Description
Consumer	Consumer corresponding to provided identifier.

GetConsumersUsageReport(UsageSummaryRequest)

Returns collection of consumers evaluated during the requested time period and ordered by specific performance metric.

Declaration

UsageReport<ConsumerUsageSummary> GetConsumersUsageReport(UsageSummaryRequest request)

Parameters

Type	Name	Description
UsageSummaryRequest	request	Parameters to be used for generating report records.

Returns

Type	Description
UsageReport<ConsumerUsageSummary>	Collection of consumers evaluated during the requested time period and ordered by specific performance metric.

GetCustomAttributeTypes(EntityType)

Returns custom attribute types defined for the specified entity type.

Declaration

Collection<CustomAttributeType> GetCustomAttributeTypes(EntityType entityType)

Parameters

Type	Name	Description
EntityType	entityType	Entity type that custom attribute type are defined for.

Returns

Type	Description
Collection<CustomAttributeType>	Custom attribute types defined for the specified entity type.

GetCustomEntitiesSummary(Nullable<Int32>)

Returns summary for the custom entities belonging to the specified folder.

Declaration

CustomEntitiesSummary GetCustomEntitiesSummary(int? folderId)

Parameters

Type	Name	Description
Nullable<Int32>	folderId	Identifier of the folder that custom entities belong to.

Returns

Type	Description
CustomEntitiesSummary	Summary for the custom entities belonging to the specified folder.

GetCustomEntity(Int32)

Returns custom entity corresponding to provided identifier.

Declaration

CustomEntityDefinition GetCustomEntity(int entityId)

Parameters

Type	Name	Description
Int32	entityId	Custom entity database identifier.

Returns

Type	Description
CustomEntityDefinition	Custom entity corresponding to provided identifier.

GetDataSchemaElements(Int32)

Returns collection of global XML elements defined in XML schemas attached to the specified service version.

Declaration

Collection<QualifiedName> GetDataSchemaElements(int serviceVersionId)

Parameters

Type	Name	Description
Int32	serviceVersionId	Identifier of the service version which schemas need to be examined.

Returns

Type	Description
Collection<QualifiedName>	Collection of global XML elements defined in XML schemas attached to the specified service version.

GetDataSchemas(Int32)

Returns XML schemas with XSD content related to the specified service version.

Declaration

Collection<DataSchema> GetDataSchemas(int serviceVersionId)

Parameters

Type	Name	Description
Int32	serviceVersionId	Identifier of the service version which schemas need to be retrieved.

Returns

Type	Description
Collection<DataSchema>	Collection of XML schemas with XSD content related to the specified service version.

GetDefaultNodeConfiguration()

Returns default web.config file for a node's application folder.

Declaration

string GetDefaultNodeConfiguration()

Returns

Type	Description
String	Default web.config file for a node's application folder.

GetDependencies(Collection<LocalIdentifier>, Boolean, Int32, Int32)

Returns the cross-dependency map for the specified entities together with entities they depend on.

Declaration

DependencyPackage GetDependencies(Collection<LocalIdentifier> identifiers, bool includeDeclarativeDependencies, int maxDownstreamLevels, int maxUpstreamLevels)

Parameters

Type	Name	Description
Collection<LocalIdentifier>	identifiers	Collection of local identifiers of the objects having dependencies that need to be returned.
Boolean	includeDeclarativeDependencies	Flag indicating that declarative dependencies need to be returned as well. If false then only natural dependencies are returned.
Int32	maxDownstreamLevels	Maximum number or levels in the downstream hierarchy (this entity depends upon) to be added for a specific entity.
Int32	maxUpstreamLevels	Maximum number or levels in the upstream hierarchy (entities depending on this entity) to be added for a specific entity.

Returns

Type	Description
DependencyPackage	The package containing cross-dependency map for the specified entities together with entities they depend on.

Remarks

This method allows to retrieve major entities dependent from a specific entity (use the entity), and also major entities that specific entity depends on (uses those entities).

• Natural and declarative dependencies are supported with ability to retrieve just natural dependencies.
• Folder entities and Service entities are treated specially. When folder is added to the package then all parent folders are added as well (ignoring the setting for the maximum downstream levels). If any entity, which resides in a folder, is added to the package then all parent folders are added as well (again ignoring the setting for the maximum downstream levels). If ServiceVersion is added to the package then parent service entity is added also.
• If multiple entities are passed to the method then it is highly NOT recommended to set both maxDownstreamLevels and maxUpstreamLevels parameters to non-zero values. In such cases set either one of these parameters to MaxValue and keep another as zero. Otherwise there is chance of inconsistent reporting, if exported entities have cross dependencies.

GetDownstreamServiceSubtrees(Int32)

Returns collection of services and their service versions virtualized by specified virtual service.

Declaration

Collection<ServiceSubtree> GetDownstreamServiceSubtrees(int serviceVersionId)

Parameters

Type	Name	Description
Int32	serviceVersionId	Identifier of the virtual service version which downstream services need to be retrieved.

Returns

Type	Description
Collection<ServiceSubtree>	Collection of services and their service versions virtualized by specified virtual service.

GetEndpoint(Guid)

Returns the endpoint and hierarchy of all related object corresponding to provided unique identifier.

Declaration

EndpointDefinition GetEndpoint(Guid endpointKey)

Parameters

Type	Name	Description
Guid	endpointKey	Endpoint unique identifier.

Returns

Type	Description
EndpointDefinition	The endpoint and hierarchy of all related object corresponding to provided unique identifier.

GetEndpoint(Int32)

Returns the endpoint and hierarchy of all related object corresponding to provided identifier.

Declaration

EndpointDefinition GetEndpoint(int endpointId)

Parameters

Type	Name	Description
Int32	endpointId	Endpoint database identifier.

Returns

Type	Description
EndpointDefinition	The endpoint and hierarchy of all related object corresponding to provided identifier.

GetExpressionType(Int32)

Returns custom message evaluating expression type corresponding to the provided identifier.

Declaration

ExpressionType GetExpressionType(int expressionTypeId)

Parameters

Type	Name	Description
Int32	expressionTypeId	Custom message evaluating expression type unique identifier.

Returns

Type	Description
ExpressionType	Custom message evaluating expression type corresponding to provided identifier.

GetExpressionTypes()

Returns collection of all custom message evaluating expression types in the system.

Declaration

Collection<ExpressionType> GetExpressionTypes()

Returns

Type	Description
Collection<ExpressionType>	Collection of all custom message evaluating expression types in the system.

GetExtensibilityTypes(Boolean)

Returns all custom types that can be used in Sentinet extensibility points.

Declaration

ExtensibilityTypes GetExtensibilityTypes(bool includeSystemTypes)

Parameters

Type	Name	Description
Boolean	includeSystemTypes	Flag indicating that system types should also be included in the result.

Returns

Type	Description
ExtensibilityTypes	Custom types that can be used in Sentinet extensibility points.

GetFile(Int32)

Returns file corresponding to provided identifier.

Declaration

File GetFile(int fileId)

Parameters

Type	Name	Description
Int32	fileId	File identifier.

Returns

Type	Description
File	File corresponding to provided identifier.

GetFolder(Int32)

Returns folder corresponding to provided identifier.

Declaration

Folder GetFolder(int folderId)

Parameters

Type	Name	Description
Int32	folderId	Folder unique identifier.

Returns

Type	Description
Folder	Folder corresponding to provided database identifier.

GetFolderSubtree(Nullable<Int32>, Boolean, FolderEntityTypes)

Returns child entities (services, nodes, bindings, and sub-folders) located under specified folder.

Declaration

FolderSubtree GetFolderSubtree(int? folderId, bool expandSubfolders, FolderEntityTypes entities)

Parameters

Type	Name	Description
Nullable<Int32>	folderId	Database identifier of the folder which child entities should be retrieved. If Null, then root entities will be retrieved.
Boolean	expandSubfolders	If True, then all entities in all sub-folders will also be populated. If False, then entities in specified folder will be populated.
FolderEntityTypes	entities	Folder entity type(s) that have to be returned.

Returns

Type	Description
FolderSubtree	Child entities (services, nodes, bindings, and sub-folders) located under specified folder.

GetFolderSummary(Nullable<Int32>)

Returns folder corresponding to provided identifier with summary objects describing its own entities and entities in all its sub-folders.

Declaration

FolderSummary GetFolderSummary(int? folderId)

Parameters

Type	Name	Description
Nullable<Int32>	folderId	Identifier of the folder that needs to be retrieved.

Returns

Type	Description
FolderSummary	Folder summary corresponding to provided identifier.

GetIdentitiesSummary(Nullable<Int32>)

Returns summary for the public identities belonging to the specified folder.

Declaration

IdentitiesSummary GetIdentitiesSummary(int? folderId)

Parameters

Type	Name	Description
Nullable<Int32>	folderId	Identifier of the folder that identities belong to.

Returns

Type	Description
IdentitiesSummary	Summary for the public identities belonging to the specified folder.

GetIdentity(Int32)

Returns public identity corresponding to provided identifier.

Declaration

IdentityDefinitionBase GetIdentity(int identityId)

Parameters

Type	Name	Description
Int32	identityId	Public identity unique identifier.

Returns

Type	Description
IdentityDefinitionBase	Public identity corresponding to provided identifier.

GetNode(Guid)

Returns the node corresponding to provided key with its underlying objects.

Declaration

NodeDefinition GetNode(Guid nodeKey)

Parameters

Type	Name	Description
Guid	nodeKey	Node unique identifier.

Returns

Type	Description
NodeDefinition	Fully populated hierarchy of objects composing the node.

GetNode(Int32)

Returns the node corresponding to provided identifier with its underlying objects.

Declaration

NodeDefinition GetNode(int nodeId)

Parameters

Type	Name	Description
Int32	nodeId	Node's database identifier.

Returns

Type	Description
NodeDefinition	Fully populated hierarchy of objects composing the node.

GetNodeEndpoints(Int32)

Returns collection of endpoints hosted by the specified node.

Declaration

Collection<EndpointSummary> GetNodeEndpoints(int nodeId)

Parameters

Type	Name	Description
Int32	nodeId	Identifier of the node which endpoints need to be retrieved.

Returns

Type	Description
Collection<EndpointSummary>	Collection of inbound endpoints hosted by the specified node.

GetNodesSummary(Nullable<Int32>)

Returns summary for the nodes belonging to the specified folder.

Declaration

NodesSummary GetNodesSummary(int? folderId)

Parameters

Type	Name	Description
Nullable<Int32>	folderId	Identifier of the folder that nodes belong to.

Returns

Type	Description
NodesSummary	Summary for the nodes belonging to the specified folder.

GetOperation(Int32)

Returns hierarchy of child objects corresponding to requested operation.

Declaration

OperationDefinition GetOperation(int operationId)

Parameters

Type	Name	Description
Int32	operationId	Database identifier of the operation which object graph needs to be retrieved.

Returns

Type	Description
OperationDefinition	Hierarchy of child objects corresponding to requested operation.

GetOperationsUsageReport(OperationUsageSummaryRequest)

Returns collection of service operations along with the basic usage information.

Declaration

UsageReport<OperationUsageSummary> GetOperationsUsageReport(OperationUsageSummaryRequest request)

Parameters

Type	Name	Description
OperationUsageSummaryRequest	request	Parameters to be used for generating report records.

Returns

Type	Description
UsageReport<OperationUsageSummary>	Returns collection of service operations evaluated during the requested time period along with the basic usage information.

GetPortalNotificationConfiguration()

Returns simplified Developer Portal notification configuration.

Declaration

PortalNotificationConfiguration GetPortalNotificationConfiguration()

Returns

Type	Description
PortalNotificationConfiguration	Alert handler's configuration that enables or disables sending automated email messages to Developer Portal administrators in response to pre-defined events.

GetPortalSummary()

Returns Developer Portal summary.

Declaration

PortalSummary GetPortalSummary()

Returns

Type	Description
PortalSummary	Developer Portal summary.

GetProduct(Int32)

Returns the product corresponding to provided identifier.

Declaration

ProductDefinition GetProduct(int productId)

Parameters

Type	Name	Description
Int32	productId	Product database identifier.

Returns

Type	Description
ProductDefinition	Product corresponding to provided identifier.

GetProductsUsageReport(UsageSummaryRequest)

Returns collection of products evaluated during the requested time period and ordered by specific performance metric.

Declaration

UsageReport<ProductUsageSummary> GetProductsUsageReport(UsageSummaryRequest request)

Parameters

Type	Name	Description
UsageSummaryRequest	request	Parameters to be used for generating report records.

Returns

Type	Description
UsageReport<ProductUsageSummary>	Collection of products evaluated during the requested time period and ordered by specific performance metric.

GetRouterType(Int32)

Returns outbound message router type corresponding to provided identifier.

Declaration

RouterType GetRouterType(int routerTypeId)

Parameters

Type	Name	Description
Int32	routerTypeId	Router type unique identifier.

Returns

Type	Description
RouterType	Router type corresponding to provided identifier.

GetRouterTypes()

Returns collection of all outbound message router types in the system.

Declaration

Collection<RouterType> GetRouterTypes()

Returns

Type	Description
Collection<RouterType>	Collection of all outbound message router types in the system.

GetSecurityRole(Int32)

Returns security role corresponding to provided identifier.

Declaration

SecurityRole GetSecurityRole(int securityRoleId)

Parameters

Type	Name	Description
Int32	securityRoleId	Security role unique identifier.

Returns

Type	Description
SecurityRole	Security role corresponding to provided identifier.

GetSecurityRoleNames()

Returns collection of all security role names.

Declaration

Collection<Subtree> GetSecurityRoleNames()

Returns

Type	Description
Collection<Subtree>	Collection of all security role names.

GetSecurityRoles()

Returns collection of all security roles in the system.

Declaration

Collection<SecurityRole> GetSecurityRoles()

Returns

Type	Description
Collection<SecurityRole>	Collection of all security roles in the system.

GetService(Int32)

Returns physical or virtual service corresponding to provided identifier.

Declaration

ServiceDefinition GetService(int serviceId)

Parameters

Type	Name	Description
Int32	serviceId	Service unique identifier.

Returns

Type	Description
ServiceDefinition	Service corresponding to provided identifier.

GetServiceAgreement(Int32)

Returns service level agreement corresponding to the specified database identifier.

Declaration

ServiceAgreementDefinition GetServiceAgreement(int serviceAgreementId)

Parameters

Type	Name	Description
Int32	serviceAgreementId	Identifier of the service agreement that needs to be returned.

Returns

Type	Description
ServiceAgreementDefinition	Service agreement corresponding to the specified database identifier.

GetServiceAgreementReadings(Int32[], DateTime, Nullable<DateTime>, MetricReadingSortField, SortOrder)

Returns collection of service agreement metric readings done during the specified time interval.

Declaration

Collection<MetricReading> GetServiceAgreementReadings(int[] metricIds, DateTime startDateTime, DateTime? endDateTime, MetricReadingSortField sortField, SortOrder sortOrder)

Parameters

Type	Name	Description
Int32[]	metricIds	Array of service agreement metric identifiers. At least one metric must be provided. At most 10 metrics can be provided.
DateTime	startDateTime	The earliest date/time of metric measurements (must be provided in the time zone of the corresponding service agreement).
Nullable<DateTime>	endDateTime	The most recent date/time of metric measurements (must be provided in the time zone of the corresponding service agreement). If not specified, all readings done after startDateTime will be returned.
MetricReadingSortField	sortField	Field to be used for sorting the result.
SortOrder	sortOrder	The result sorting order: ascending or descending.

Returns

Type	Description
Collection<MetricReading>	Collection of service agreement metric readings done during the specified time interval.

GetServiceAgreementReadingsSummary(Int32[], DateTime, Nullable<DateTime>, TimeUnit, Int32)

Returns collection of service agreement metric readings aggregated by the time intervals of the requested length.

Declaration

Collection<MetricReadingSummary> GetServiceAgreementReadingsSummary(int[] metricIds, DateTime startDateTime, DateTime? endDateTime, TimeUnit timeUnit, int timeResolution)

Parameters

Type	Name	Description
Int32[]	metricIds	Array of service agreement metric identifiers. At least one metric must be provided. At most 10 metrics can be provided.
DateTime	startDateTime	The earliest date/time of metric measurements (must be provided in the time zone of the corresponding service agreement). Note that the actual start date/time will be aligned on the boundary of the very first time interval.
Nullable<DateTime>	endDateTime	The most recent date/time of metric measurements (must be provided in the time zone of the corresponding service agreement). Note that the actual end date/time will be aligned on the boundary of the last time interval. If not specified, all readings done after startDateTime will be returned.
TimeUnit	timeUnit	The aggregation interval time unit.
Int32	timeResolution	The length of the aggregation interval (defined in time units specified in timeUnit parameter).

Returns

Type	Description
Collection<MetricReadingSummary>	Collection of service agreement metric readings aggregated by the time intervals of the requested length.

GetServiceAgreementSummary(Nullable<Int32>)

Returns summary for the service agreements belonging to the specified folder.

Declaration

ServiceAgreementsSummary GetServiceAgreementSummary(int? folderId)

Parameters

Type	Name	Description
Nullable<Int32>	folderId	Identifier of the folder that service agreements belong to.

Returns

Type	Description
ServiceAgreementsSummary	Summary for the service agreements belonging to the specified folder.

GetServiceAgreementViolations(ServiceAgreementViolationsRequest)

Returns collection of service agreement violations satisfying the provided search criteria.

Declaration

Collection<ServiceAgreementViolation> GetServiceAgreementViolations(ServiceAgreementViolationsRequest request)

Parameters

Type	Name	Description
ServiceAgreementViolationsRequest	request	Search criteria for selecting service agreement violations.

Returns

Type	Description
Collection<ServiceAgreementViolation>	Collection of service agreement violations satisfying provided search criteria.

GetServiceAgreementViolationsSummary(ServiceAgreementViolationSummaryRequest)

Returns collection of service agreement violation counts aggregated into the requested time intervals for the specified metrics.

Declaration

Collection<ServiceAgreementViolationSummary> GetServiceAgreementViolationsSummary(ServiceAgreementViolationSummaryRequest request)

Parameters

Type	Name	Description
ServiceAgreementViolationSummaryRequest	request	Provides parameters for selection and aggregation of the service agreement violations.

Returns

Type	Description
Collection<ServiceAgreementViolationSummary>	Collection of service agreement violation counts aggregated into the requested time intervals for the specified metrics.

GetServicesSummary(Nullable<Int32>, Nullable<Boolean>)

Returns summary for the services belonging to the specified folder.

Declaration

ServicesSummary GetServicesSummary(int? folderId, bool? isVirtual)

Parameters

Type	Name	Description
Nullable<Int32>	folderId	Identifier of the folder that services belong to.
Nullable<Boolean>	isVirtual	Flag indicating that only virtual services should be considered. If set to False, then only physical services will be considered. If not set, all services are considered.

Returns

Type	Description
ServicesSummary	Summary for the services belonging to the specified folder.

GetServiceSubtree(Int32, Boolean)

Returns child entities (service versions, contracts, endpoints, operations, etc) related to provided service.

Declaration

ServiceSubtree GetServiceSubtree(int serviceId, bool expandServiceVersions)

Parameters

Type	Name	Description
Int32	serviceId	Database identifier of the service which child entities need to be retrieved.
Boolean	expandServiceVersions	Flag indicating that child entities of the service versions and their children need to be populated. If False, only service versions properties are populated.

Returns

Type	Description
ServiceSubtree	Child entities (service versions, contracts, endpoints, operations, etc) related to provided service.

GetServiceVersion(Int32)

Returns hierarchy of objects composing the service version corresponding to provided identifier.

Declaration

ServiceVersionDefinition GetServiceVersion(int serviceVersionId)

Parameters

Type	Name	Description
Int32	serviceVersionId	Service version unique identifier.

Returns

Type	Description
ServiceVersionDefinition	Fully populated hierarchy of objects composing the service version.

GetServiceVersionSubtree(Int32)

Returns child entities (contracts, endpoints, operations, etc) related to provided service version.

Declaration

ServiceVersionSubtree GetServiceVersionSubtree(int serviceVersionId)

Parameters

Type	Name	Description
Int32	serviceVersionId	Database identifier of the service version which child entities should be retrieved.

Returns

Type	Description
ServiceVersionSubtree	Child entities (contracts, endpoints, operations, etc) related to provided service version.

GetServiceVersionsUsageReport(ServiceVersionUsageSummaryRequest)

Returns collection of services evaluated during the requested time period and ordered by specific performance metric.

Declaration

UsageReport<ServiceVersionUsageSummary> GetServiceVersionsUsageReport(ServiceVersionUsageSummaryRequest request)

Parameters

Type	Name	Description
ServiceVersionUsageSummaryRequest	request	Parameters to be used for generating report records.

Returns

Type	Description
UsageReport<ServiceVersionUsageSummary>	Collection of services evaluated during the requested time period and ordered by specific performance metric.

GetStaticResponseConfiguration(Int32)

Returns service version configuration related to providing static responses without making outbound service calls.

Declaration

StaticResponseConfiguration GetStaticResponseConfiguration(int serviceVersionId)

Parameters

Type	Name	Description
Int32	serviceVersionId	Identifier of the service version which configuration needs to be returned.

Returns

Type	Description
StaticResponseConfiguration	Static response configuration for the requested service version.

GetSubscription(Int32)

Returns the subscription corresponding to provided identifier.

Declaration

SubscriptionDefinition GetSubscription(int subscriptionId)

Parameters

Type	Name	Description
Int32	subscriptionId	Subscription database identifier.

Returns

Type	Description
SubscriptionDefinition	Subscription corresponding to provided identifier.

GetSubscriptionsCount(Nullable<SubscriptionStatus>)

Returns the number of subscriptions with the requested SubscriptionStatus. This is a lightweight operation that can be used for polling.

Declaration

int GetSubscriptionsCount(SubscriptionStatus? status)

Parameters

Type	Name	Description
Nullable<SubscriptionStatus>	status	Status of the subscriptions that need to be counted. If not specified then all subscriptions will be counted.

Returns

Type	Description
Int32	Number of subscriptions with the requested SubscriptionStatus.

GetSubscriptionsUsageReport(UsageSummaryRequest)

Returns collection of consumers evaluated during the requested time period and ordered by specific performance metric.

Declaration

UsageReport<SubscriptionUsageSummary> GetSubscriptionsUsageReport(UsageSummaryRequest request)

Parameters

Type	Name	Description
UsageSummaryRequest	request	Parameters to be used for generating report records.

Returns

Type	Description
UsageReport<SubscriptionUsageSummary>	Collection of consumers evaluated during the requested time period and ordered by specific performance metric.

GetSystemInfo()

Returns security-related information about currently logged user as well as current application configuration settings.

Declaration

SystemInfo GetSystemInfo()

Returns

Type	Description
SystemInfo	Security-related information about currently logged user and system configuration settings.

GetSystemTimeZones()

Returns collection of all time zones known by the server.

Declaration

Collection<TimeZoneInfo> GetSystemTimeZones()

Returns

Type	Description
Collection<TimeZoneInfo>	Collection of all time zones known by the server.

GetTransactionDetails(Int64)

Returns full information about endpoint transaction specified by provided database identifier.

Declaration

MonitoringTransactionDetails GetTransactionDetails(long monitoringTransactionId)

Parameters

Type	Name	Description
Int64	monitoringTransactionId	Database identifier of the transaction which details needs to be returned.

Returns

Type	Description
MonitoringTransactionDetails	Full information about endpoint transaction specified by provided database identifier.

GetTransactionHeaders(TransactionHeadersRequest)

Returns collection of transactions recorded in the specified time interval with basic information about transaction.

Declaration

Collection<MonitoringTransactionHeader> GetTransactionHeaders(TransactionHeadersRequest request)

Parameters

Type	Name	Description
TransactionHeadersRequest	request	Defines search parameters, sort parameters, and paging options.

Returns

Type	Description
Collection<MonitoringTransactionHeader>	Collection of transactions recorded in the specified time interval with basic information about transaction.

GetTransactionHeaders(Int64)

Returns collection of endpoint transactions (inbound and outbound) which have the same transaction Id as the transaction identified by provided database identifier.

Declaration

Collection<MonitoringTransactionHeader> GetTransactionHeaders(long monitoringTransactionId)

Parameters

Type	Name	Description
Int64	monitoringTransactionId	Database identifier of the transaction which transaction Id should be used to find related transaction records.

Returns

Type	Description
Collection<MonitoringTransactionHeader>	Collection of endpoint transactions (inbound and outbound) which have the same transaction Id as the transaction identified by provided database identifier.

GetTransactionSummary(TransactionSummaryRequest)

Returns requested transaction statistics according to the specified time resolution.

Declaration

Collection<MonitoringTransactionSummary> GetTransactionSummary(TransactionSummaryRequest request)

Parameters

Type	Name	Description
TransactionSummaryRequest	request	Defines filter parameters.

Returns

Type	Description
Collection<MonitoringTransactionSummary>	Collection of aggregated transaction measures calculated within requested time period.

GetTransactionTrace(Guid, Int32)

Returns trace logs associated with the specified business transactions recorded inside the specified virtual service.

Declaration

MonitoringTransactionTrace GetTransactionTrace(Guid transactionId, int serviceVersionId)

Parameters

Type	Name	Description
Guid	transactionId	Identifier of the transaction.
Int32	serviceVersionId	Identifier of the service version that processed that transaction.

Returns

Type	Description
MonitoringTransactionTrace	Trace logs associated with the specified business transactions recorded inside the specified virtual service.

GetUser(Int32)

Returns user corresponding to provided identifier.

Declaration

UserDefinition GetUser(int userId)

Parameters

Type	Name	Description
Int32	userId	Identifier of the user who needs to be retrieved.

Returns

Type	Description
UserDefinition	User corresponding to provided identifier.

GetUserSessions(UserSessionsRequest)

Returns collection of user sessions satisfying provided search parameters.

Declaration

Collection<UserSession> GetUserSessions(UserSessionsRequest request)

Parameters

Type	Name	Description
UserSessionsRequest	request	Object providing search parameters and sorting order.

Returns

Type	Description
Collection<UserSession>	Collection of user sessions satisfying provided search parameters.

GetUsersSummary(Nullable<Int32>)

Returns summary for the users in security roles that belong to the specified folder.

Declaration

Collection<SecurityRoleSummary> GetUsersSummary(int? folderId)

Parameters

Type	Name	Description
Nullable<Int32>	folderId	Identifier of the folder that users belong to.

Returns

Type	Description
Collection<SecurityRoleSummary>	Summary for the users in security roles that belong to the specified folder.

GetVirtualizationProfile(Int32)

When implemented by a class, gets the virtualization profile details.

Declaration

VirtualizationProfile GetVirtualizationProfile(int profileId)

Parameters

Type	Name	Description
Int32	profileId	Virtualization profile unique identifier.

Returns

Type	Description
VirtualizationProfile	The fully populated virtualization profile with all reference ids resolved.

GetVirtualizationProfiles()

When implemented by a class, gets the collection of configured virtualization profiles.

Declaration

Collection<VirtualizationProfile> GetVirtualizationProfiles()

Returns

Type	Description
Collection<VirtualizationProfile>	The collection of configured virtualization profiles.

ImportEntities(Int32, Collection<LocalIdentifier>, Boolean)

Imports specified entities from a repository import package stored in the service session storage into the local repository.

Declaration

void ImportEntities(int fileId, Collection<LocalIdentifier> identifiers, bool verifyOnly)

Parameters

Type	Name	Description
Int32	fileId	The repository import file identifier in the service session storage.
Collection<LocalIdentifier>	identifiers	Collection of local identifiers of the entities that need to be imported.
Boolean	verifyOnly	Flag indicating that changes should not actually be committed to the database, but rather it is just to ensure that entities can be successfully imported. If False then entities are imported and committed to the database.

ImportMetadata(ClientEndpointConfiguration, SerializerMode, Boolean)

Retrieves service metadata from provided Metadata Exchange endpoint, persists downloaded service metadata in the session store, parses it, and returns details about the containing services, contracts, and endpoints.

Declaration

MetadataInfo ImportMetadata(ClientEndpointConfiguration clientEndpoint, SerializerMode serializer, bool transformToDocumentStyle)

Parameters

Type	Name	Description
ClientEndpointConfiguration	clientEndpoint	Configuration of the endpoint to be used for retrieving service metadata.
SerializerMode	serializer	Type of serializer that will be used for XML types generation.
Boolean	transformToDocumentStyle	Flag indicating that RPC-styled operations need to be transformed to Document-styled operations before importing.

Returns

Type	Description
MetadataInfo	Object providing description of the services and their underlying entities located in the metadata.

ImportMetadata(Collection<String>, SerializerMode, Boolean)

Creates service metadata from provided collection of WSDL documents and XML schemas, persists metadata in the session store, parses it, and returns details about the containing services, contracts, and endpoints.

Declaration

MetadataInfo ImportMetadata(Collection<string> documents, SerializerMode serializer, bool transformToDocumentStyle)

Parameters

Type	Name	Description
Collection<String>	documents	Collection of strings containing WSDL documents or XML schemas.
SerializerMode	serializer	Type of serializer that will be used for XML types generation.
Boolean	transformToDocumentStyle	Flag indicating that RPC-styled operations need to be transformed to Document-styled operations before importing.

Returns

Type	Description
MetadataInfo	Object providing description of the services and their underlying entities located in the metadata.

ImportMetadata(String, SerializerMode, Boolean)

Reads service metadata from a string representing metadata set, persists it in the session store, parses it, and returns details about the containing services, contracts, and endpoints.

Declaration

MetadataInfo ImportMetadata(string metadataSet, SerializerMode serializer, bool transformToDocumentStyle)

Parameters

Type	Name	Description
String	metadataSet	String containing serialized to XML MetadataSet.
SerializerMode	serializer	Type of serializer that will be used for XML types generation.
Boolean	transformToDocumentStyle	Flag indicating that RPC-styled operations need to be transformed to Document-styled operations before importing.

Returns

Type	Description
MetadataInfo	Object providing description of the services and their underlying entities located in the metadata.

ImportMetadata(Uri, String, String, String, SerializerMode, Boolean)

Retrieves service metadata using HTTP GET method on provided metadata URL, persists downloaded service metadata in the session store, parses it, and returns details about the containing services, contracts, and endpoints.

Declaration

MetadataInfo ImportMetadata(Uri address, string userName, string password, string domain, SerializerMode serializer, bool transformToDocumentStyle)

Parameters

Type	Name	Description
Uri	address	URL to service metadata available thrown HTTP GET request.
String	userName	User name credential to use while accessing provided address. If Null or empty, no credentials will be sent.
String	password	Password credential to use while accessing provided address.
String	domain	User domain credential to use while accessing provided address.
SerializerMode	serializer	Type of serializer that will be used for XML types generation.
Boolean	transformToDocumentStyle	Flag indicating that RPC-styled operations need to be transformed to Document-styled operations before importing.

Returns

Type	Description
MetadataInfo	Object providing description of the services and their underlying entities located in the metadata.

ImportRepositoryPackage(Byte[])

Uploads provided repository package and stores it in the service session storage.

Declaration

RepositoryPackageInfo ImportRepositoryPackage(byte[] package)

Parameters

Type	Name	Description
Byte[]	package	Serialized to bytes the repository import package containing entities to be imported.

Returns

Type	Description
RepositoryPackageInfo	An object providing basic information about the package and its content.

ImportRepositoryPackageFromStream(Stream)

Uploads provided repository package and stores it in the service session storage.

Declaration

RepositoryPackageInfo ImportRepositoryPackageFromStream(Stream package)

Parameters

Type	Name	Description
Stream	package	Stream containing the serialized repository import package with entities to be imported.

Returns

Type	Description
RepositoryPackageInfo	An object providing basic information about the package and its content.

ImportSwagger(String)

Persists provided Swagger document in the session store, parses it, and returns details about the containing operations and endpoints.

Declaration

RestMetadataInfo ImportSwagger(string document)

Parameters

Type	Name	Description
String	document	String containing a Swagger document.

Returns

Type	Description
RestMetadataInfo	Object providing description of the service and their underlying entities located in the Swagger document.

ImportSwagger(Uri, String, String, String)

Retrieves Swagger document from provided URL, persists it in the session store, parses it, and returns details about the containing operations and endpoints.

Declaration

RestMetadataInfo ImportSwagger(Uri address, string userName, string password, string domain)

Parameters

Type	Name	Description
Uri	address	URL to Swagger document available thrown HTTP GET request.
String	userName	User name credential to use while accessing provided address. If Null or empty, no credentials will be sent.
String	password	Password credential to use while accessing provided address.
String	domain	User domain credential to use while accessing provided address.

Returns

Type	Description
RestMetadataInfo	Object providing description of the service and their underlying entities located in the Swagger document.

LogOn(LogOnCredentials)

Provides ability to authenticate user and issue authentication cookie to be used with ASP.NET Forms Authentication.

Declaration

bool LogOn(LogOnCredentials credentials)

Parameters

Type	Name	Description
LogOnCredentials	credentials	User name and password to be used for authentication.

Returns

Type	Description
Boolean	True, if user has been successfully authenticated and authentication cookie has been issued. False, otherwise.

LogOn(String, String)

Provides ability to authenticate user and issue authentication cookie to be used with ASP.NET Forms Authentication.

Declaration

[Obsolete("Use LogOnWithCredentials method that uses POST to submit credentials to the server.")]
bool LogOn(string userName, string password)

Parameters

Type	Name	Description
String	userName	User name of the user that needs to be authenticated.
String	password	Password of the user that needs to be authenticated.

Returns

Type	Description
Boolean	True, if user has been successfully authenticated and authentication cookie has been issued. False, otherwise.

MatchRelativeUri(String, String, String)

Tests provided URI matching template with the specified relative URI. If match succeeds, the result can be optionally used to construct another URI with the specified URI binding template.

Declaration

MatchRelativeUriResult MatchRelativeUri(string relativeUri, string matchingTemplate, string bindingTemplate)

Parameters

Type	Name	Description
String	relativeUri	String representing a relative URI that will be used to test the URI matching template. For example, "/a/test?c=1&d=2".
String	matchingTemplate	URI template to be used for matching relative URI. For example, "/a/{b}?c={c=d}".
String	bindingTemplate	Optional URI template to be used for constructing relative URI from the result of the matching original URI by the matching template. For example, "/z/{c}?y={b}".

Returns

Type	Description
MatchRelativeUriResult	The result of matching the provided template with the specified relative URI.

MoveFolderEntities(Nullable<Int32>, Nullable<Int32>, FolderEntityTypes)

Moves all repository entities of the specified type(s) (services, bindings, rules, users, etc) from one folder to another.

Declaration

void MoveFolderEntities(int? sourceFolderId, int? targetFolderId, FolderEntityTypes entities)

Parameters

Type	Name	Description
Nullable<Int32>	sourceFolderId	Identifier of the folder to move entities from.
Nullable<Int32>	targetFolderId	Identifier of the folder where entities need to be moved to.
FolderEntityTypes	entities	Type(s) of the entities to be moved (services, bindings, rules, users, etc).

MoveFolderEntity(Int32, FolderEntityTypes, Nullable<Int32>)

Moves a repository entity (service, binding, rule, user, etc) to the specified folder.

Declaration

void MoveFolderEntity(int entityId, FolderEntityTypes entityType, int? targetFolderId)

Parameters

Type	Name	Description
Int32	entityId	Identifier of the entity to be moved.
FolderEntityTypes	entityType	Type of the entity to be moved (service, binding, rule, user, etc).
Nullable<Int32>	targetFolderId	Identifier of the folder where entity needs to be moved to.

RenderLiquidTemplate(LiquidTemplateParameters)

Tests the provided Liquid template by rendering it with the specified content.

Declaration

string RenderLiquidTemplate(LiquidTemplateParameters parameters)

Parameters

Type	Name	Description
LiquidTemplateParameters	parameters	Provided the template and the content to be rendered.

Returns

Type	Description
String	Fully rendered Liquid template.

SerializeAuthorizationExpression(AuthorizationExpressionBase)

Serializes provided authorization expression tree to XML string.

Declaration

string SerializeAuthorizationExpression(AuthorizationExpressionBase expression)

Parameters

Type	Name	Description
AuthorizationExpressionBase	expression	Authorization expression tree to be serialized to XML.

Returns

Type	Description
String	String containing the serialized to XML authorization expression tree.

SerializeMessagePipeline(MessagePipeline)

Serializes provided message processing pipeline to XML string.

Declaration

string SerializeMessagePipeline(MessagePipeline pipeline)

Parameters

Type	Name	Description
MessagePipeline	pipeline	Message processing pipeline to be serialized to XML.

Returns

Type	Description
String	String containing the serialized to XML message processing pipeline.

SerializeMonitoringFilters(MonitoringFilterCollection)

Serializes the provided collection of monitoring filters to XML string.

Declaration

string SerializeMonitoringFilters(MonitoringFilterCollection filters)

Parameters

Type	Name	Description
MonitoringFilterCollection	filters	Collection of monitoring filters to be serialized to XML.

Returns

Type	Description
String	String containing the serialized to XML collection of monitoring filters.

SerializePolicy(PolicyDescription)

Serializes the specified policy description as XML configuration string.

Declaration

string SerializePolicy(PolicyDescription policyDescription)

Parameters

Type	Name	Description
PolicyDescription	policyDescription	The policy description to serialize.

Returns

Type	Description
String	The policy definition serialized as XML string.

SignCertificateRequest(String)

Signs provided X.509 certificate signing request (CSR) using Repository Certificate Authority certificate.

Declaration

string SignCertificateRequest(string request)

Parameters

Type	Name	Description
String	request	Base64-encoded certificate's signing request that needs to be signed.

Returns

Type	Description
String	Base64-encoded signed request that needs to be merged with the requester's private key.

UpdatePortalNotificationConfiguration(PortalNotificationConfiguration)

Updates the Developer Portal notification settings according to the provided simplified configuration.

Declaration

void UpdatePortalNotificationConfiguration(PortalNotificationConfiguration configuration)

Parameters

Type	Name	Description
PortalNotificationConfiguration	configuration	Alert handler's configuration that enables or disables sending automated email messages to Developer Portal administrators in response to pre-defined events.

UpdateServiceVersionFromMetadataWithResult(Int32, ServiceVersionUpdateDetails, ErrorToleranceLevel, SerializerMode, Boolean)

Updates an existing physical SOAP service version and all underlying entities from provided metadata. Updated service version is returned.

Declaration

ServiceVersionDefinition UpdateServiceVersionFromMetadataWithResult(int fileId, ServiceVersionUpdateDetails importDetails, ErrorToleranceLevel errorTolerance, SerializerMode serializer, bool wrappedParameters)

Parameters

Type	Name	Description
Int32	fileId	Service metadata identifier in the session store. If service version has been successfully updated, the file is deleted.
ServiceVersionUpdateDetails	importDetails	Object that provides description on how metadata should be imported as well as other import options.
ErrorToleranceLevel	errorTolerance	Level of tolerance for errors and warnings appearing during the metadata import process.
SerializerMode	serializer	Type of serializer that will be used for XML types generation.
Boolean	wrappedParameters	Flag indicating that generated code will not unwrap "parameters" member of document-wrapped-literal messages.

Returns

Type	Description
ServiceVersionDefinition

UpdateServiceVersionFromSwaggerWithResult(Int32, Int32, ServiceVersionUpdateOptions)

Updates an existing physical RESTful service version and all underlying entities from provided Swagger document. Updated service version is returned.

Declaration

ServiceVersionDefinition UpdateServiceVersionFromSwaggerWithResult(int fileId, int serviceVersionId, ServiceVersionUpdateOptions options)

Parameters

Type	Name	Description
Int32	fileId	Swagger document identifier in the session store. If service version has been successfully updated, the file is deleted.
Int32	serviceVersionId	Identifier of the physical REST service version that needs to be updated.
ServiceVersionUpdateOptions	options	Additional options to be applied.

Returns

Type	Description
ServiceVersionDefinition	Updated service version.