callbackregistration EntityType

Callback Registration that stores configuration.

Entity Set Path
[organization URI]/api/data/v9.0/callbackregistrations
Base Type
crmbaseentity
Display Name
Callback Registration
Primary Key
callbackregistrationid
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
callbackregistrationid Edm.Guid

Unique identifier of the callback registration.

createdon Edm.DateTimeOffset

Date and time when the callback registration was created.

Display Name: Created On

Read Only
entityname Edm.String

Entity Name.

Display Name: Entity Name

filterexpression Edm.String

condition represented with OData $filter syntax

Display Name: Filter Expression

filteringattributes Edm.String

Comma-separated list of attributes. If at least one of these attributes is modified, the callback url should be called.

Display Name: Filtering Attributes

message Edm.Int32

Specifies the message type

Display Name: Specifies the message type

Default 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
modifiedon Edm.DateTimeOffset

Date and time when the callback registration was last modified.

Display Name: Modified On

Read Only
name Edm.String

Name of callback registration.

Display Name: Name

postponeuntil Edm.String

delay represented with OData expression

Display Name: Postpone Until

runas Edm.Int32

Specifies the user context under which the callback will run

Display Name: RunAs

Default Options
Value Label
1 Triggering User
2 Record Owner
3 Process Owner
scope Edm.Int32

Specifies the Scope

Display Name: Specifies the scope type

Default Options
Value Label
1 User
2 BusinessUnit
3 ParentChildBusinessUnit
4 Organization
url Edm.String

Full callback registration Url.

Display Name: Url Address

version Edm.Int32

Specifies the Callback registration version type

Display Name: Specifies the Callback registration version type

Default Options
Value Label
1 V1
2 V2

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 callbackregistration_createdby

Shows who created the record.

_createdonbehalfby_value callbackregistration_createdonbehalfby

Shows who created the record on behalf of another user.

_modifiedby_value callbackregistration_modifiedby

Shows who last updated the record.

_modifiedonbehalfby_value callbackregistration_modifiedonbehalfby

Shows who last updated the record on behalf of another user.

_ownerid_value ownerid

Unique identifier of the user or team who owns the callback registration.

_owningbusinessunit_value owningbusinessunit

Unique identifier of the business unit that owns the callback registration.

_owningteam_value callbackregistration_createdby

Unique identifier of the team who owns the callback registration.

_owninguser_value callbackregistration_createdby

Unique identifier of the user who owns the callback registration.

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
callbackregistration_createdby systemuser systemuser_callbackregistration_createdby
callbackregistration_createdonbehalfby systemuser systemuser_callbackregistration_createdonbehalfby
callbackregistration_modifiedby systemuser systemuser_callbackregistration_modifiedby
callbackregistration_modifiedonbehalfby systemuser systemuser_callbackregistration_modifiedonbehalfby
ownerid principal owner_callbackregistration
owningbusinessunit businessunit businessunit_callbackregistration

See also