serviceendpoint EntityType

Service endpoint that can be contacted.

Entity Set Path
[organization URI]/api/data/v9.0/serviceendpoints
Base Type
crmbaseentity
Display Name
Service Endpoint
Primary Key
serviceendpointid
Primary Key Attribute
name
Operations Supported
POST GET PATCH DELETE

Properties

Properties represent fields of data stored in the entity.Some properties are read-only.

Name Type Details
authtype Edm.Int32

Specifies mode of authentication with SB

Display Name: Specifies mode of authentication with SB

Default Options
Value Label
1 ACS
2 SAS Key
3 SAS Token
4 Webhook Key
5 Http Header
6 Http Query String
authvalue Edm.String

Authentication Value

Display Name: Authentication Value

componentstate Edm.Int32

For internal use only.

Display Name: Component State

Read Only
Default Options
Value Label
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished
connectionmode Edm.Int32

Connection mode to contact the service endpoint.

Display Name: Connection Mode

Default Options
Value Label
1 Normal
2 Federated
contract Edm.Int32

Type of the endpoint contract.

Display Name: Contract

Default Options
Value Label
1 OneWay
2 Queue
3 Rest
4 TwoWay
5 Topic
6 Queue (Persistent)
7 Event Hub
8 Webhook
createdon Edm.DateTimeOffset

Date and time when the service endpoint was created.

Display Name: Created On

Read Only
description Edm.String

Description of the service endpoint.

Display Name: Description

introducedversion Edm.String

Version in which the form is introduced.

Display Name: Introduced Version

isauthvalueset Edm.Boolean
Read Only
Default Options
Value Label
1 Yes
0 No
iscustomizable BooleanManagedProperty

Information that specifies whether this component can be customized.

Display Name: Customizable

ismanaged Edm.Boolean

Information that specifies whether this component is managed.

Display Name: State

Read Only
Default Options
Value Label
1 Managed
0 Unmanaged
issaskeyset Edm.Boolean
Read Only
Default Options
Value Label
1 Yes
0 No
issastokenset Edm.Boolean
Read Only
Default Options
Value Label
1 Yes
0 No
messageformat Edm.Int32

Content type of the message

Display Name: Content type of the message

Default Options
Value Label
1 Binary XML
2 Json
3 Text XML
modifiedon Edm.DateTimeOffset

Date and time when the service endpoint was last modified.

Display Name: Modified On

Read Only
name Edm.String

Name of Service end point.

Display Name: Name

namespaceaddress Edm.String

Full service endpoint address.

Display Name: Namespace Address

namespaceformat Edm.Int32

Format of Service Bus Namespace

Display Name: Format of Service Bus Namespace

Default Options
Value Label
1 Namespace Name
2 Namespace Address
overwritetime Edm.DateTimeOffset

For internal use only.

Display Name: Record Overwrite Time

Read Only
path Edm.String

Path to the service endpoint.

Display Name: Path

saskey Edm.String

Shared Access Key

Display Name: Shared Access Key

saskeyname Edm.String

Shared Access Key Name

Display Name: Shared Access Key Name

sastoken Edm.String

Shared Access Token

Display Name: Shared Access Token

serviceendpointid Edm.Guid

Unique identifier of the service endpoint.

serviceendpointidunique Edm.Guid

Unique identifier of the service endpoint.

Read Only
solutionid Edm.Guid

Unique identifier of the associated solution.

Display Name: Solution

Read Only
solutionnamespace Edm.String

Namespace of the App Fabric solution.

Display Name: Service Namespace

url Edm.String

Full service endpoint Url.

Display Name: Url Address

userclaim Edm.Int32

Additional user claim value type.

Display Name: User Claim

Default Options
Value Label
1 None
2 UserId
3 UserInfo

Lookup Properties

Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Retrieve data about lookup properties.

Name Single-valued navigation property Description
_createdby_value createdby

Unique identifier of the user who created the service endpoint.

_createdonbehalfby_value createdonbehalfby

Unique identifier of the delegate user who created the service endpoint.

_modifiedby_value modifiedby

Unique identifier of the user who last modified the service endpoint.

_modifiedonbehalfby_value modifiedonbehalfby

Unique identifier of the delegate user who modified the service endpoint.

_organizationid_value organizationid

Unique identifier of the organization with which the service endpoint is associated.

Single-valued navigation properties

Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.

Name Type Partner
createdby systemuser createdby_serviceendpoint
createdonbehalfby systemuser lk_serviceendpointbase_createdonbehalfby
modifiedby systemuser modifiedby_serviceendpoint
modifiedonbehalfby systemuser lk_serviceendpointbase_modifiedonbehalfby
organizationid organization organization_serviceendpoint

Collection-valued navigation properties

Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.

Name Type Partner
serviceendpoint_sdkmessageprocessingstep sdkmessageprocessingstep eventhandler_serviceendpoint

Operations

The following operations can be used with the serviceendpoint entity type.

Name Binding
TriggerServiceEndpointCheck Entity

Solutions

The following solutions include the serviceendpoint entity type.

Name Description
System Solution Internal CRM System Solution

See also