serviceendpoint EntityType

  • Article

 

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Description: Service endpoint that can be contacted.

Entity Set path:[organization URI]/api/data/v8.2/serviceendpoints

Base Type: crmbaseentity EntityType

Display Name: Service Endpoint

Primary Key: serviceendpointid

Primary Name Attribute: name

Properties

Lookup Properties

Single-valued navigation properties

Collection-valued navigation properties

Operations bound to serviceendpoint

Operations using the serviceendpoint entity type.

Properties

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

Name

Type

Details

authtype

Edm.Int32

Description: Specifies mode of authentication with SB

Default Options:

1 : ACS
2 : SAS Key
3 : SAS Token

Display Name: Specifies mode of authentication with SB

componentstate

Edm.Int32

Description: For internal use only.

Default Options:

0 : Published
1 : Unpublished
2 : Deleted
3 : Deleted Unpublished

Display Name: Component State

Read-only property

connectionmode

Edm.Int32

Description: Connection mode to contact the service endpoint.

Default Options:

1 : Normal
2 : Federated

Display Name: Connection Mode

contract

Edm.Int32

Description: Type of the endpoint contract.

Default Options:

1 : OneWay
2 : Queue
3 : Rest
4 : TwoWay
5 : Topic
6 : Queue (Persistent)
7 : Event Hub

Display Name: Contract

createdon

Edm.DateTimeOffset

Description: Date and time when the service endpoint was created.

Display Name: Created On

Read-only property

description

Edm.String

Description: Description of the service endpoint.

Display Name: Description

introducedversion

Edm.String

Description: Version in which the form is introduced.

Display Name: Introduced Version

iscustomizable

BooleanManagedProperty ComplexType

Description: Information that specifies whether this component can be customized.

Display Name: Customizable

ismanaged

Edm.Boolean

Description: Information that specifies whether this component is managed.

Default Options:

1 : Managed
0 : Unmanaged

Display Name: State

Read-only property

issaskeyset

Edm.Boolean

Description:

Default Options:

1 : Yes
0 : No

Read-only property

issastokenset

Edm.Boolean

Description:

Default Options:

1 : Yes
0 : No

Read-only property

messageformat

Edm.Int32

Description: Content type of the message

Default Options:

1 : Binary XML
2 : Json
3 : Text XML

Display Name: Content type of the message

modifiedon

Edm.DateTimeOffset

Description: Date and time when the service endpoint was last modified.

Display Name: Modified On

Read-only property

name

Edm.String

Description: Name of Service end point.

Display Name: Name

namespaceaddress

Edm.String

Description: Full service endpoint address.

Display Name: Namespace Address

namespaceformat

Edm.Int32

Description: Format of Service Bus Namespace

Default Options:

1 : Namespace Name
2 : Namespace Address

Display Name: Format of Service Bus Namespace

overwritetime

Edm.DateTimeOffset

Description: For internal use only.

Display Name: Record Overwrite Time

Read-only property

path

Edm.String

Description: Path to the service endpoint.

Display Name: Path

saskey

Edm.String

Description: Shared Access Key

Display Name: Shared Access Key

saskeyname

Edm.String

Description: Shared Access Key Name

Display Name: Shared Access Key Name

sastoken

Edm.String

Description: Shared Access Token

Display Name: Shared Access Token

serviceendpointid

Edm.Guid

Description: Unique identifier of the service endpoint.

serviceendpointidunique

Edm.Guid

Description: Unique identifier of the service endpoint.

Read-only property

solutionid

Edm.Guid

Description: Unique identifier of the associated solution.

Display Name: Solution

Read-only property

solutionnamespace

Edm.String

Description: Namespace of the App Fabric solution.

Display Name: Service Namespace

userclaim

Edm.Int32

Description: Additional user claim value type.

Default Options:

1 : None
2 : UserId
3 : UserInfo

Display Name: User Claim

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 EntityType

createdby_serviceendpoint

createdonbehalfby

systemuser EntityType

lk_serviceendpointbase_createdonbehalfby

modifiedby

systemuser EntityType

modifiedby_serviceendpoint

modifiedonbehalfby

systemuser EntityType

lk_serviceendpointbase_modifiedonbehalfby

organizationid

organization EntityType

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 EntityType

eventhandler_serviceendpoint

Operations bound to serviceendpoint

The following operations are bound to the serviceendpoint entity type.

Name

Bound to

TriggerServiceEndpointCheck Action

Entity

Operations using the serviceendpoint entity type.

The following operations use the serviceendpoint entity type in a parameter or return type.

Name

How used

Description

TriggerServiceEndpointCheck Action

entity Parameter

Validates the configuration of a Microsoft Azure Service Bus solution’s service endpoint.

See Also

Use the Microsoft Dynamics 365 Web API
Web API Action Reference
Web API Function Reference
Web API Query Function Reference
Web API EnumType Reference
Web API ComplexType Reference
Web API Metadata EntityType Reference

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright