title
description
ms.date
ms.topic
ms.assetid
author
ms.author
search.audienceType
ServiceEndpoint entity reference (Dynamics 365 Customer Engagement) | Microsoft Docs
Includes schema information and supported messages for the ServiceEndpoint entity.
08/30/2022
reference
3948cc48-07c8-7f60-0608-71c37158ad7c
KumarVivek
matp
ServiceEndpoint entity reference
Service endpoint that can be contacted.
Message
SDK class or method
Create
xref:Microsoft.Xrm.Sdk.Messages.CreateRequest or xref:Microsoft.Xrm.Sdk.IOrganizationService.Create*
Delete
xref:Microsoft.Xrm.Sdk.Messages.DeleteRequest or xref:Microsoft.Xrm.Sdk.IOrganizationService.Delete*
Retrieve
xref:Microsoft.Xrm.Sdk.Messages.RetrieveRequest or xref:Microsoft.Xrm.Sdk.IOrganizationService.Retrieve*
RetrieveMultiple
xref:Microsoft.Xrm.Sdk.Messages.RetrieveMultipleRequest or xref:Microsoft.Xrm.Sdk.IOrganizationService.RetrieveMultiple*
TriggerServiceEndpointCheck
xref:Microsoft.Crm.Sdk.Messages.TriggerServiceEndpointCheckRequest
Update
xref:Microsoft.Xrm.Sdk.Messages.UpdateRequest or xref:Microsoft.Xrm.Sdk.IOrganizationService.Update*
Property
Value
CollectionSchemaName
ServiceEndpoints
DisplayCollectionName
Service Endpoints
DisplayName
Service Endpoint
EntitySetName
serviceendpoints
IsBPFEntity
False
LogicalCollectionName
serviceendpoints
LogicalName
serviceendpoint
OwnershipType
OrganizationOwned
PrimaryIdAttribute
serviceendpointid
PrimaryNameAttribute
name
SchemaName
ServiceEndpoint
These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName .
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
Value
Label
Description
1
ACS
2
SAS Key
3
SAS Token
4
Webhook Key
5
Http Header
6
Http Query String
Property
Value
Description
Authentication Value
DisplayName
Authentication Value
FormatName
Text
IsLocalizable
False
IsValidForForm
True
IsValidForRead
False
LogicalName
authvalue
MaxLength
2048
RequiredLevel
None
Type
String
Property
Value
Description
Connection mode to contact the service endpoint.
DisplayName
Connection Mode
IsValidForForm
True
IsValidForRead
True
LogicalName
connectionmode
RequiredLevel
SystemRequired
Type
Picklist
ConnectionMode Choices/Options
Value
Label
Description
1
Normal
2
Federated
Property
Value
Description
Type of the endpoint contract.
DisplayName
Contract
IsValidForForm
True
IsValidForRead
True
LogicalName
contract
RequiredLevel
SystemRequired
Type
Picklist
Value
Label
Description
1
OneWay
2
Queue
3
Rest
4
TwoWay
5
Topic
6
Queue (Persistent)
7
Event Hub
8
Webhook
Property
Value
Description
Description of the service endpoint.
DisplayName
Description
Format
TextArea
IsLocalizable
False
IsValidForForm
True
IsValidForRead
True
LogicalName
description
MaxLength
2000
RequiredLevel
None
Type
Memo
Property
Value
Description
Version in which the form is introduced.
DisplayName
Introduced Version
FormatName
VersionNumber
IsLocalizable
False
IsValidForForm
False
IsValidForRead
True
IsValidForUpdate
False
LogicalName
introducedversion
MaxLength
48
RequiredLevel
None
Type
String
Property
Value
Description
Information that specifies whether this component can be customized.
DisplayName
Customizable
IsValidForForm
False
IsValidForRead
True
LogicalName
iscustomizable
RequiredLevel
SystemRequired
Type
ManagedProperty
Property
Value
Description
Content type of the message
DisplayName
Content type of the message
IsValidForForm
True
IsValidForRead
True
LogicalName
messageformat
RequiredLevel
None
Type
Picklist
MessageFormat Choices/Options
Value
Label
Description
1
Binary XML
2
Json
3
Text XML
Property
Value
Description
Name of Service end point.
DisplayName
Name
FormatName
Text
IsLocalizable
False
IsValidForForm
True
IsValidForRead
True
LogicalName
name
MaxLength
256
RequiredLevel
SystemRequired
Type
String
Property
Value
Description
Full service endpoint address.
DisplayName
Namespace Address
FormatName
Text
IsLocalizable
False
IsValidForForm
True
IsValidForRead
True
LogicalName
namespaceaddress
MaxLength
255
RequiredLevel
None
Type
String
Property
Value
Description
Format of Service Bus Namespace
DisplayName
Format of Service Bus Namespace
IsValidForForm
True
IsValidForRead
True
LogicalName
namespaceformat
RequiredLevel
None
Type
Picklist
NamespaceFormat Choices/Options
Value
Label
Description
1
Namespace Name
2
Namespace Address
Property
Value
Description
Path to the service endpoint.
DisplayName
Path
FormatName
Text
IsLocalizable
False
IsValidForForm
True
IsValidForRead
True
LogicalName
path
MaxLength
160
RequiredLevel
SystemRequired
Type
String
Property
Value
Description
Shared Access Key
DisplayName
Shared Access Key
FormatName
Text
IsLocalizable
False
IsValidForForm
True
IsValidForRead
False
LogicalName
saskey
MaxLength
256
RequiredLevel
None
Type
String
Property
Value
Description
Shared Access Key Name
DisplayName
Shared Access Key Name
FormatName
Text
IsLocalizable
False
IsValidForForm
True
IsValidForRead
True
LogicalName
saskeyname
MaxLength
256
RequiredLevel
None
Type
String
Property
Value
Description
Shared Access Token
DisplayName
Shared Access Token
FormatName
Text
IsLocalizable
False
IsValidForForm
True
IsValidForRead
False
LogicalName
sastoken
MaxLength
256
RequiredLevel
None
Type
String
Property
Value
Description
Unique identifier of the service endpoint.
DisplayName
IsValidForForm
False
IsValidForRead
True
IsValidForUpdate
False
LogicalName
serviceendpointid
RequiredLevel
SystemRequired
Type
Uniqueidentifier
Property
Value
Description
Namespace of the App Fabric solution.
DisplayName
Service Namespace
FormatName
Text
IsLocalizable
False
IsValidForForm
True
IsValidForRead
True
LogicalName
solutionnamespace
MaxLength
160
RequiredLevel
SystemRequired
Type
String
Property
Value
Description
Full service endpoint Url.
DisplayName
Url Address
FormatName
Text
IsLocalizable
False
IsValidForForm
True
IsValidForRead
True
LogicalName
url
MaxLength
2000
RequiredLevel
None
Type
String
Property
Value
Description
Additional user claim value type.
DisplayName
User Claim
IsValidForForm
True
IsValidForRead
True
LogicalName
userclaim
RequiredLevel
SystemRequired
Type
Picklist
UserClaim Choices/Options
Value
Label
Description
1
None
2
UserId
3
UserInfo
These attributes return false for both IsValidForCreate or IsValidForUpdate . Listed by SchemaName .
Property
Value
Description
For internal use only.
DisplayName
Component State
IsValidForForm
False
IsValidForRead
True
LogicalName
componentstate
RequiredLevel
SystemRequired
Type
Picklist
ComponentState Choices/Options
Value
Label
Description
0
Published
1
Unpublished
2
Deleted
3
Deleted Unpublished
Property
Value
Description
Unique identifier of the user who created the service endpoint.
DisplayName
Created By
IsValidForForm
True
IsValidForRead
True
LogicalName
createdby
RequiredLevel
None
Targets
systemuser
Type
Lookup
Property
Value
DateTimeBehavior
UserLocal
Description
Date and time when the service endpoint was created.
DisplayName
Created On
Format
DateAndTime
IsValidForForm
True
IsValidForRead
True
LogicalName
createdon
RequiredLevel
None
Type
DateTime
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
Targets
systemuser
Type
Lookup
Property
Value
Description
DisplayName
FormatName
Text
IsLocalizable
False
IsValidForForm
False
IsValidForRead
True
LogicalName
createdonbehalfbyname
MaxLength
100
RequiredLevel
None
Type
String
CreatedOnBehalfByYomiName
Property
Value
Description
DisplayName
FormatName
Text
IsLocalizable
False
IsValidForForm
False
IsValidForRead
True
LogicalName
createdonbehalfbyyominame
MaxLength
100
RequiredLevel
None
Type
String
Property
Value
Description
DisplayName
IsValidForForm
False
IsValidForRead
True
LogicalName
isauthvalueset
RequiredLevel
None
Type
Boolean
IsAuthValueSet Choices/Options
Value
Label
Description
1
Yes
0
No
DefaultValue : 0
Property
Value
Description
Information that specifies whether this component is managed.
DisplayName
State
IsValidForForm
False
IsValidForRead
True
LogicalName
ismanaged
RequiredLevel
SystemRequired
Type
Boolean
IsManaged Choices/Options
Value
Label
Description
1
Managed
0
Unmanaged
DefaultValue : 0
Property
Value
Description
DisplayName
IsValidForForm
False
IsValidForRead
True
LogicalName
issaskeyset
RequiredLevel
None
Type
Boolean
IsSASKeySet Choices/Options
Value
Label
Description
1
Yes
0
No
DefaultValue : 0
Property
Value
Description
DisplayName
IsValidForForm
False
IsValidForRead
True
LogicalName
issastokenset
RequiredLevel
None
Type
Boolean
IsSASTokenSet Choices/Options
Value
Label
Description
1
Yes
0
No
DefaultValue : 0
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
Targets
systemuser
Type
Lookup
Property
Value
DateTimeBehavior
UserLocal
Description
Date and time when the service endpoint was last modified.
DisplayName
Modified On
Format
DateAndTime
IsValidForForm
True
IsValidForRead
True
LogicalName
modifiedon
RequiredLevel
None
Type
DateTime
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
Targets
systemuser
Type
Lookup
Property
Value
Description
DisplayName
FormatName
Text
IsLocalizable
False
IsValidForForm
False
IsValidForRead
True
LogicalName
modifiedonbehalfbyname
MaxLength
100
RequiredLevel
None
Type
String
ModifiedOnBehalfByYomiName
Property
Value
Description
DisplayName
FormatName
Text
IsLocalizable
False
IsValidForForm
False
IsValidForRead
True
LogicalName
modifiedonbehalfbyyominame
MaxLength
100
RequiredLevel
None
Type
String
Property
Value
Description
Unique identifier of the organization with which the service endpoint is associated.
DisplayName
IsValidForForm
False
IsValidForRead
True
LogicalName
organizationid
RequiredLevel
SystemRequired
Targets
organization
Type
Lookup
Property
Value
DateTimeBehavior
UserLocal
Description
For internal use only.
DisplayName
Record Overwrite Time
Format
DateOnly
IsValidForForm
False
IsValidForRead
True
LogicalName
overwritetime
RequiredLevel
SystemRequired
Type
DateTime
Property
Value
Description
Unique identifier of the service endpoint.
DisplayName
IsValidForForm
False
IsValidForRead
True
LogicalName
serviceendpointidunique
RequiredLevel
SystemRequired
Type
Uniqueidentifier
Property
Value
Description
Unique identifier of the associated solution.
DisplayName
Solution
IsValidForForm
False
IsValidForRead
True
LogicalName
solutionid
RequiredLevel
SystemRequired
Type
Uniqueidentifier
Property
Value
Description
For internal use only.
DisplayName
Solution
IsValidForForm
False
IsValidForRead
False
LogicalName
supportingsolutionid
RequiredLevel
None
Type
Uniqueidentifier
One-To-Many Relationships
Listed by SchemaName .
serviceendpoint_sdkmessageprocessingstep
Same as the serviceendpoint_sdkmessageprocessingstep many-to-one relationship for the sdkmessageprocessingstep entity.
Property
Value
ReferencingEntity
sdkmessageprocessingstep
ReferencingAttribute
eventhandler
IsHierarchical
False
IsCustomizable
False
ReferencedEntityNavigationPropertyName
serviceendpoint_sdkmessageprocessingstep
AssociatedMenuConfiguration
Behavior: DoNotDisplay Group: Details Label: Order:
CascadeConfiguration
Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade
Many-To-One Relationships
Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related entity. Listed by SchemaName .
createdby_serviceendpoint
See the createdby_serviceendpoint one-to-many relationship for the systemuser entity.
lk_serviceendpointbase_modifiedonbehalfby
See the lk_serviceendpointbase_modifiedonbehalfby one-to-many relationship for the systemuser entity.
modifiedby_serviceendpoint
See the modifiedby_serviceendpoint one-to-many relationship for the systemuser entity.
organization_serviceendpoint
See the organization_serviceendpoint one-to-many relationship for the organization entity.
lk_serviceendpointbase_createdonbehalfby
See the lk_serviceendpointbase_createdonbehalfby one-to-many relationship for the systemuser entity.
About the Entity Reference
Web API EntityType Reference