CallbackRegistration Entity Reference

Callback Registration that stores configuration.

Messages

Message Web API Operation SDK Assembly
Create POST [org URI]/api/data/v9.0/callbackregistrations
See Create
CreateRequest or
Create
Delete DELETE [org URI]/api/data/v9.0/callbackregistrations(callbackregistrationid)
See Delete
DeleteRequest or
Delete
Retrieve GET [org URI]/api/data/v9.0/callbackregistrations(callbackregistrationid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.0/callbackregistrations
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
Update PATCH [org URI]/api/data/v9.0/callbackregistrations(callbackregistrationid)
See Update
UpdateRequest or
Update

Entity Properties

Property Value
CollectionSchemaName CallbackRegistrations
DisplayCollectionName Callback Registrations
DisplayName Callback Registration
EntitySetName callbackregistrations
IsBPFEntity False
LogicalCollectionName callbackregistrations
LogicalName callbackregistration
OwnershipType UserOwned
PrimaryIdAttribute callbackregistrationid
PrimaryNameAttribute name
SchemaName CallbackRegistration

Writable attributes

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

CallbackRegistrationId

Property Value
Description Unique identifier of the callback registration.
DisplayName
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName callbackregistrationid
RequiredLevel SystemRequired
Type Uniqueidentifier

EntityName

Property Value
Description Entity Name.
DisplayName Entity Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName entityname
MaxLength 255
RequiredLevel SystemRequired
Type String

FilterExpression

Property Value
Description condition represented with OData $filter syntax
DisplayName Filter Expression
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName filterexpression
MaxLength 100000
RequiredLevel None
Type String

FilteringAttributes

Property Value
Description Comma-separated list of attributes. If at least one of these attributes is modified, the callback url should be called.
DisplayName Filtering Attributes
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName filteringattributes
MaxLength 100000
RequiredLevel None
Type String

Message

Property Value
Description Specifies the message type
DisplayName Specifies the message type
IsValidForForm True
IsValidForRead True
LogicalName message
RequiredLevel SystemRequired
Type Picklist

Message Options

Value Label
1 Create
2 Delete
3 Update
4 Create or Update
5 Create or Delete
6 Update or Delete
7 Create or Update or Delete

Name

Property Value
Description Name of callback registration.
DisplayName Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName name
MaxLength 256
RequiredLevel SystemRequired
Type String

OwnerId

Property Value
Description Unique identifier of the user or team who owns the callback registration.
DisplayName Owner
IsValidForForm True
IsValidForRead True
LogicalName ownerid
RequiredLevel SystemRequired
Targets systemuser
Type Owner

OwnerIdType

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName owneridtype
RequiredLevel SystemRequired
Type EntityName

PostponeUntil

Property Value
Description delay represented with OData expression
DisplayName Postpone Until
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName postponeuntil
MaxLength 100000
RequiredLevel None
Type String

Scope

Property Value
Description Specifies the Scope
DisplayName Specifies the scope type
IsValidForForm True
IsValidForRead True
LogicalName scope
RequiredLevel SystemRequired
Type Picklist

Scope Options

Value Label
1 User
2 BusinessUnit
3 ParentChildBusinessUnit
4 Organization

Url

Property Value
Description Full callback registration Url.
DisplayName Url Address
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead False
LogicalName url
MaxLength 2000
RequiredLevel SystemRequired
Type String

Version

Property Value
Description Specifies the Callback registration version type
DisplayName Specifies the Callback registration version type
IsValidForForm True
IsValidForRead True
LogicalName version
RequiredLevel SystemRequired
Type Picklist

Version Options

Value Label
1 V1

Read-only attributes

These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

CreatedBy

Property Value
Description Shows who created the record.
DisplayName Created By
IsValidForForm False
IsValidForRead True
LogicalName createdby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyname
MaxLength 100
RequiredLevel None
Type String

CreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the callback registration was created.
DisplayName Created On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime

CreatedOnBehalfBy

Property Value
Description Shows who created the record on behalf of another user.
DisplayName Created By (Delegate)
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedOnBehalfByName

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

ModifiedBy

Property Value
Description Shows who last updated the record.
DisplayName Modified By
IsValidForForm False
IsValidForRead True
LogicalName modifiedby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the callback registration was last modified.
DisplayName Modified On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime

ModifiedOnBehalfBy

Property Value
Description Shows who last updated the record on behalf of another user.
DisplayName Modified By (Delegate)
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedOnBehalfByName

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

OwnerIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName owneridname
MaxLength 100
RequiredLevel SystemRequired
Type String

OwningBusinessUnit

Property Value
Description Unique identifier of the business unit that owns the callback registration.
DisplayName Owning Business Unit
IsValidForForm True
IsValidForRead True
LogicalName owningbusinessunit
RequiredLevel None
Targets businessunit
Type Lookup

OwningBusinessUnitName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName owningbusinessunitname
MaxLength 100
RequiredLevel None
Type String

OwningTeam

Property Value
Description Unique identifier of the team who owns the callback registration.
DisplayName Owning Team
IsValidForForm False
IsValidForRead True
LogicalName owningteam
RequiredLevel None
Targets team
Type Lookup

OwningUser

Property Value
Description Unique identifier of the user who owns the callback registration.
DisplayName Owning User
IsValidForForm False
IsValidForRead True
LogicalName owninguser
RequiredLevel None
Targets systemuser
Type Lookup

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.

lk_callbackregistration_modifiedonbehalfby

See systemuser Entity lk_callbackregistration_modifiedonbehalfby One-To-Many relationship.

lk_callbackregistration_modifiedby

See systemuser Entity lk_callbackregistration_modifiedby One-To-Many relationship.

lk_callbackregistration_createdby

See systemuser Entity lk_callbackregistration_createdby One-To-Many relationship.

businessunit_callbackregistration

See businessunit Entity businessunit_callbackregistration One-To-Many relationship.

lk_callbackregistration_createdonbehalfby

See systemuser Entity lk_callbackregistration_createdonbehalfby One-To-Many relationship.

See also

About the Entity Reference
Web API Reference
Microsoft.Dynamics.CRM.callbackregistration