Service Endpoint (ServiceEndpoint) table/entity reference

Service endpoint that can be contacted.

Messages

The following table lists the messages for the Service Endpoint (ServiceEndpoint) table. Messages represent operations that can be performed on the table. They may also be events.

Name Is Event?	Web API Operation	SDK for .NET
Create Event: False	POST /serviceendpoints See Create	Create records
Delete Event: False	DELETE /serviceendpoints(serviceendpointid) See Delete	Delete records
Retrieve Event: False	GET /serviceendpoints(serviceendpointid) See Retrieve	Retrieve records
RetrieveMultiple Event: False	GET /serviceendpoints See Query data	Query data
TriggerServiceEndpointCheck Event: True	TriggerServiceEndpointCheck	TriggerServiceEndpointCheckRequest
Update Event: False	PATCH /serviceendpoints(serviceendpointid) See Update	Update records
Upsert Event: False	PATCH /serviceendpoints(serviceendpointid) See Upsert a table row	UpsertRequest

Properties

The following table lists selected properties for the Service Endpoint (ServiceEndpoint) table.

Property	Value
DisplayName	Service Endpoint
DisplayCollectionName	Service Endpoints
SchemaName	ServiceEndpoint
CollectionSchemaName	ServiceEndpoints
EntitySetName	serviceendpoints
LogicalName	serviceendpoint
LogicalCollectionName	serviceendpoints
PrimaryIdAttribute	serviceendpointid
PrimaryNameAttribute	name
TableType	Standard
OwnershipType	OrganizationOwned

Writable columns/attributes

These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

• AuthType
• AuthValue
• ConnectionMode
• Contract
• Description
• IntroducedVersion
• IsCustomizable
• KeyVaultReferenceId
• MessageCharset
• MessageFormat
• Name
• NamespaceAddress
• NamespaceFormat
• Path
• RuntimeIntegrationProperties
• SASKey
• SASKeyName
• SASToken
• SchemaType
• ServiceEndpointId
• SolutionNamespace
• Url
• UseKeyVaultConfiguration
• UserClaim

AuthType

Property	Value
Description	Specifies mode of authentication with SB
DisplayName	Specifies mode of authentication with SB
IsValidForForm	True
IsValidForRead	True
LogicalName	authtype
RequiredLevel	None
Type	Picklist
DefaultFormValue	-1
GlobalChoiceName	serviceendpoint_authtype

AuthType Choices/Options

Value	Label
1	ACS
2	SAS Key
3	SAS Token
4	Webhook Key
5	Http Header
6	Http Query String
7	Connection String
8	Access Key

AuthValue

Property	Value
Description	Authentication Value
DisplayName	Authentication Value
IsValidForForm	True
IsValidForRead	False
LogicalName	authvalue
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	2048

ConnectionMode

Property	Value
Description	Connection mode to contact the service endpoint.
DisplayName	Connection Mode
IsValidForForm	True
IsValidForRead	True
LogicalName	connectionmode
RequiredLevel	SystemRequired
Type	Picklist
DefaultFormValue	1
GlobalChoiceName	serviceendpoint_connectionmode

ConnectionMode Choices/Options

Value	Label
1	Normal
2	Federated

Contract

Property	Value
Description	Type of the endpoint contract.
DisplayName	Contract
IsValidForForm	True
IsValidForRead	True
LogicalName	contract
RequiredLevel	SystemRequired
Type	Picklist
DefaultFormValue	1
GlobalChoiceName	serviceendpoint_contract

Contract Choices/Options

Value	Label
1	OneWay
2	Queue
3	Rest
4	TwoWay
5	Topic
6	Queue (Persistent)
7	Event Hub
8	Webhook
9	Event Grid
10	Managed Data Lake

Description

Property	Value
Description	Description of the service endpoint.
DisplayName	Description
IsValidForForm	True
IsValidForRead	True
LogicalName	description
RequiredLevel	None
Type	Memo
Format	TextArea
FormatName	TextArea
ImeMode	Auto
IsLocalizable	False
MaxLength	2000

IntroducedVersion

Property	Value
Description	Version in which the form is introduced.
DisplayName	Introduced Version
IsValidForForm	False
IsValidForRead	True
LogicalName	introducedversion
RequiredLevel	None
Type	String
Format	VersionNumber
FormatName	VersionNumber
ImeMode	Auto
IsLocalizable	False
MaxLength	48

IsCustomizable

Property	Value
Description	Information that specifies whether this component can be customized.
DisplayName	Customizable
IsValidForForm	False
IsValidForRead	True
LogicalName	iscustomizable
RequiredLevel	SystemRequired
Type	ManagedProperty

KeyVaultReferenceId

Property	Value
Description	Unique identifier for keyvaultreference associated with serviceendpoint.
DisplayName	KeyVaultReferenceId
IsValidForForm	True
IsValidForRead	True
LogicalName	keyvaultreferenceid
RequiredLevel	None
Type	Lookup
Targets	keyvaultreference

MessageCharset

Property	Value
Description	Specifies the character encoding for message content
DisplayName	Specifies the character encoding to be used for messages sent to a service endpoint
IsValidForForm	False
IsValidForRead	True
LogicalName	messagecharset
RequiredLevel	None
Type	Picklist
DefaultFormValue
GlobalChoiceName	serviceendpoint_messagecharset

MessageCharset Choices/Options

Value	Label
0	Default
1	UTF8

MessageFormat

Property	Value
Description	Content type of the message
DisplayName	Content type of the message
IsValidForForm	True
IsValidForRead	True
LogicalName	messageformat
RequiredLevel	None
Type	Picklist
DefaultFormValue
GlobalChoiceName	serviceendpoint_messageformat

MessageFormat Choices/Options

Value	Label
1	Binary XML
2	Json
3	Text XML

Name

Property	Value
Description	Name of Service end point.
DisplayName	Name
IsValidForForm	True
IsValidForRead	True
LogicalName	name
RequiredLevel	SystemRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	256

NamespaceAddress

Property	Value
Description	Full service endpoint address.
DisplayName	Namespace Address
IsValidForForm	True
IsValidForRead	True
LogicalName	namespaceaddress
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Active
IsLocalizable	False
MaxLength	255

NamespaceFormat

Property	Value
Description	Format of Service Bus Namespace
DisplayName	Format of Service Bus Namespace
IsValidForForm	True
IsValidForRead	True
LogicalName	namespaceformat
RequiredLevel	None
Type	Picklist
DefaultFormValue
GlobalChoiceName	serviceendpoint_namespaceformat

NamespaceFormat Choices/Options

Value	Label
1	Namespace Name
2	Namespace Address

Path

Property	Value
Description	Path to the service endpoint.
DisplayName	Path
IsValidForForm	True
IsValidForRead	True
LogicalName	path
RequiredLevel	SystemRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Active
IsLocalizable	False
MaxLength	160

RuntimeIntegrationProperties

Property	Value
Description	For internal use only. Holds miscellaneous properties related to runtime integration.
DisplayName	Runtime Integration Properties
IsValidForForm	False
IsValidForRead	True
LogicalName	runtimeintegrationproperties
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	512

SASKey

Property	Value
Description	Shared Access Key
DisplayName	Shared Access Key
IsValidForForm	True
IsValidForRead	False
LogicalName	saskey
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	256

SASKeyName

Property	Value
Description	Shared Access Key Name
DisplayName	Shared Access Key Name
IsValidForForm	True
IsValidForRead	True
LogicalName	saskeyname
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	256

SASToken

Property	Value
Description	Shared Access Token
DisplayName	Shared Access Token
IsValidForForm	True
IsValidForRead	False
LogicalName	sastoken
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	256

SchemaType

Property	Value
Description	Specifies schema type for event grid events
DisplayName	Specifies schema type for event grid events
IsValidForForm	False
IsValidForRead	True
LogicalName	schematype
RequiredLevel	None
Type	Picklist
DefaultFormValue
GlobalChoiceName	serviceendpoint_schematype

SchemaType Choices/Options

Value	Label
1	Event Grid
2	Cloud Events

ServiceEndpointId

Property	Value
Description	Unique identifier of the service endpoint.
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	serviceendpointid
RequiredLevel	SystemRequired
Type	Uniqueidentifier

SolutionNamespace

Property	Value
Description	Namespace of the App Fabric solution.
DisplayName	Service Namespace
IsValidForForm	True
IsValidForRead	True
LogicalName	solutionnamespace
RequiredLevel	SystemRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Active
IsLocalizable	False
MaxLength	160

Url

Property	Value
Description	Full service endpoint Url.
DisplayName	Url Address
IsValidForForm	True
IsValidForRead	True
LogicalName	url
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Active
IsLocalizable	False
MaxLength	2000

UseKeyVaultConfiguration

Property	Value
Description	Use Auth Information in KeyVault
DisplayName	Use Auth Information in KeyVault
IsValidForForm	True
IsValidForRead	True
LogicalName	usekeyvaultconfiguration
RequiredLevel	None
Type	Boolean
GlobalChoiceName	serviceendpoint_usekeyvaultconfiguration
DefaultValue	False
True Label	Yes
False Label	No

UserClaim

Property	Value
Description	Additional user claim value type.
DisplayName	User Claim
IsValidForForm	True
IsValidForRead	True
LogicalName	userclaim
RequiredLevel	SystemRequired
Type	Picklist
DefaultFormValue	1
GlobalChoiceName	serviceendpoint_userclaim

UserClaim Choices/Options

Value	Label
1	None
2	UserId
3	UserInfo

Read-only columns/attributes

These columns/attributes return false for both IsValidForCreate and IsValidForUpdate. Listed by SchemaName.

• ComponentState
• CreatedBy
• CreatedOn
• CreatedOnBehalfBy
• IsAuthValueSet
• IsManaged
• IsSASKeySet
• IsSASTokenSet
• ModifiedBy
• ModifiedOn
• ModifiedOnBehalfBy
• OrganizationId
• OverwriteTime
• ServiceEndpointIdUnique
• SolutionId
• SupportingSolutionId

ComponentState

Property	Value
Description	For internal use only.
DisplayName	Component State
IsValidForForm	False
IsValidForRead	True
LogicalName	componentstate
RequiredLevel	SystemRequired
Type	Picklist
DefaultFormValue	-1
GlobalChoiceName	componentstate

ComponentState Choices/Options

Value	Label
0	Published
1	Unpublished
2	Deleted
3	Deleted Unpublished

CreatedBy

Property	Value
Description	Unique identifier of the user who created the service endpoint.
DisplayName	Created By
IsValidForForm	True
IsValidForRead	True
LogicalName	createdby
RequiredLevel	None
Type	Lookup
Targets	systemuser

CreatedOn

Property	Value
Description	Date and time when the service endpoint was created.
DisplayName	Created On
IsValidForForm	True
IsValidForRead	True
LogicalName	createdon
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateAndTime
ImeMode	Inactive
SourceTypeMask	0

CreatedOnBehalfBy

Property	Value
Description	Unique identifier of the delegate user who created the service endpoint.
DisplayName	Created By (Delegate)
IsValidForForm	True
IsValidForRead	True
LogicalName	createdonbehalfby
RequiredLevel	None
Type	Lookup
Targets	systemuser

IsAuthValueSet

Property	Value
Description
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	isauthvalueset
RequiredLevel	None
Type	Boolean
GlobalChoiceName	isencryptedattributevalueset
DefaultValue	False
True Label	Yes
False Label	No

IsManaged

Property	Value
Description	Information that specifies whether this component is managed.
DisplayName	State
IsValidForForm	False
IsValidForRead	True
LogicalName	ismanaged
RequiredLevel	SystemRequired
Type	Boolean
GlobalChoiceName	ismanaged
DefaultValue	False
True Label	Managed
False Label	Unmanaged

IsSASKeySet

Property	Value
Description
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	issaskeyset
RequiredLevel	None
Type	Boolean
GlobalChoiceName	isencryptedattributevalueset
DefaultValue	False
True Label	Yes
False Label	No

IsSASTokenSet

Property	Value
Description
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	issastokenset
RequiredLevel	None
Type	Boolean
GlobalChoiceName	isencryptedattributevalueset
DefaultValue	False
True Label	Yes
False Label	No

ModifiedBy

Property	Value
Description	Unique identifier of the user who last modified the service endpoint.
DisplayName	Modified By
IsValidForForm	True
IsValidForRead	True
LogicalName	modifiedby
RequiredLevel	None
Type	Lookup
Targets	systemuser

ModifiedOn

Property	Value
Description	Date and time when the service endpoint was last modified.
DisplayName	Modified On
IsValidForForm	True
IsValidForRead	True
LogicalName	modifiedon
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateAndTime
ImeMode	Inactive
SourceTypeMask	0

ModifiedOnBehalfBy

Property	Value
Description	Unique identifier of the delegate user who modified the service endpoint.
DisplayName	Modified By (Delegate)
IsValidForForm	True
IsValidForRead	True
LogicalName	modifiedonbehalfby
RequiredLevel	None
Type	Lookup
Targets	systemuser

OrganizationId

Property	Value
Description	Unique identifier of the organization with which the service endpoint is associated.
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	organizationid
RequiredLevel	SystemRequired
Type	Lookup
Targets	organization

OverwriteTime

Property	Value
Description	For internal use only.
DisplayName	Record Overwrite Time
IsValidForForm	False
IsValidForRead	True
LogicalName	overwritetime
RequiredLevel	SystemRequired
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateOnly
ImeMode	Inactive
SourceTypeMask	0

ServiceEndpointIdUnique

Property	Value
Description	Unique identifier of the service endpoint.
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	serviceendpointidunique
RequiredLevel	SystemRequired
Type	Uniqueidentifier

SolutionId

Property	Value
Description	Unique identifier of the associated solution.
DisplayName	Solution
IsValidForForm	False
IsValidForRead	True
LogicalName	solutionid
RequiredLevel	SystemRequired
Type	Uniqueidentifier

SupportingSolutionId

Property	Value
Description	For internal use only.
DisplayName	Solution
IsValidForForm	False
IsValidForRead	False
LogicalName	supportingsolutionid
RequiredLevel	None
Type	Uniqueidentifier

Many-to-One relationships

These relationships are many-to-one. Listed by SchemaName.

• createdby_serviceendpoint
• keyvaultreference_ServiceEndpoint
• lk_serviceendpointbase_createdonbehalfby
• lk_serviceendpointbase_modifiedonbehalfby
• modifiedby_serviceendpoint
• organization_serviceendpoint

createdby_serviceendpoint

One-To-Many Relationship: systemuser createdby_serviceendpoint

Property	Value
ReferencedEntity	systemuser
ReferencedAttribute	systemuserid
ReferencingAttribute	createdby
ReferencingEntityNavigationPropertyName	createdby
IsHierarchical
CascadeConfiguration	Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade

keyvaultreference_ServiceEndpoint

One-To-Many Relationship: keyvaultreference keyvaultreference_ServiceEndpoint

Property	Value
ReferencedEntity	keyvaultreference
ReferencedAttribute	keyvaultreferenceid
ReferencingAttribute	keyvaultreferenceid
ReferencingEntityNavigationPropertyName	keyvaultreferenceid
IsHierarchical
CascadeConfiguration	Archive: NoCascade Assign: NoCascade Delete: RemoveLink Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade

lk_serviceendpointbase_createdonbehalfby

One-To-Many Relationship: systemuser lk_serviceendpointbase_createdonbehalfby

Property	Value
ReferencedEntity	systemuser
ReferencedAttribute	systemuserid
ReferencingAttribute	createdonbehalfby
ReferencingEntityNavigationPropertyName	createdonbehalfby
IsHierarchical
CascadeConfiguration	Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade

lk_serviceendpointbase_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_serviceendpointbase_modifiedonbehalfby

Property	Value
ReferencedEntity	systemuser
ReferencedAttribute	systemuserid
ReferencingAttribute	modifiedonbehalfby
ReferencingEntityNavigationPropertyName	modifiedonbehalfby
IsHierarchical
CascadeConfiguration	Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade

modifiedby_serviceendpoint

One-To-Many Relationship: systemuser modifiedby_serviceendpoint

Property	Value
ReferencedEntity	systemuser
ReferencedAttribute	systemuserid
ReferencingAttribute	modifiedby
ReferencingEntityNavigationPropertyName	modifiedby
IsHierarchical
CascadeConfiguration	Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade

organization_serviceendpoint

One-To-Many Relationship: organization organization_serviceendpoint

Property	Value
ReferencedEntity	organization
ReferencedAttribute	organizationid
ReferencingAttribute	organizationid
ReferencingEntityNavigationPropertyName	organizationid
IsHierarchical
CascadeConfiguration	Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade

One-to-Many relationships

These relationships are one-to-many. Listed by SchemaName.

serviceendpoint_sdkmessageprocessingstep

Many-To-One Relationship: sdkmessageprocessingstep serviceendpoint_sdkmessageprocessingstep

Property	Value
ReferencingEntity	sdkmessageprocessingstep
ReferencingAttribute	eventhandler
ReferencedEntityNavigationPropertyName	serviceendpoint_sdkmessageprocessingstep
IsCustomizable	False
AssociatedMenuConfiguration	AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000

See also

Dataverse table/entity reference
Dataverse Web API Reference
serviceendpoint