botcomponent EntityType

Holds key authoring components of a Chatbot such a topics, entities, variables, etc.

Entity Set Path
[organization URI]/api/data/v9.0/botcomponents
Base Type
crmbaseentity
Display Name
Chatbot subcomponent
Primary Key
botcomponentid
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
accentcolor Edm.String

Accent Color for this re-usable subcomponent

Display Name: Accent Color

botcomponentid Edm.Guid

Unique identifier for entity instances

Display Name: BotComponent

category Edm.String

The category of Chatbot subcomponent.

Display Name: Category

componentidunique Edm.Guid

For internal use only.

Display Name: Row id unique

Read Only
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
componenttype Edm.Int32

The sub type of Chatbot subcomponent.

Display Name: ComponentType

Default Options
Value Label
0 Topic
1 Skill
2 Bot variable
3 Bot entity
4 Dialog
6 Language understanding
7 Language generation
5 Trigger
8 Dialog schema
9 Object Model Dialog
10 Object Model Trigger
11 Object Model custom entity
12 Object Model global variable
13 Object Model skill
content Edm.String

The content or metadata of the Bot Component that defines its structure and properties.

Display Name: Content

createdon Edm.DateTimeOffset

Date and time when the record was created.

Display Name: Created On

Read Only
data Edm.String

The content of the Bot Component in OBI format

Display Name: Obi Data

description Edm.String

Contains searchable text for the bot component

Display Name: Description

helplink Edm.String

Link to learn More about this subcomponent

Display Name: Help Link

iconurl Edm.String

Icon Url for this subcomponent

Display Name: Icon Url

importsequencenumber Edm.Int32

Sequence number of the import that created this record.

Display Name: Import Sequence Number

iscustomizable BooleanManagedProperty

For internal use only.

Display Name: Is Customizable

ismanaged Edm.Boolean

Indicates whether the solution component is part of a managed solution.

Display Name: Is Managed

Read Only
Default Options
Value Label
1 Managed
0 Unmanaged
language Edm.Int32

Language of the chatbot subcomponent

Display Name: Language

Default Options
Value Label
1033 English
1034 Spanish
1046 Portuguese (Brazilian)
1036 French
1043 Dutch
1044 Norwegian
1030 Danish
1053 Swedish
1040 Italian
1031 German
2052 Chinese (Simplified)
1028 Chinese (Traditional)
1025 Arabic
1041 Japanese
1042 Korean
1081 Hindi
1057 Indonesian
1049 Russian
1045 Polish
1055 Turkish
1054 Thai
1035 Finnish
1032 Greek
1029 Czech
modifiedon Edm.DateTimeOffset

Date and time when the record was modified.

Display Name: Modified On

Read Only
name Edm.String

The name of the custom entity.

Display Name: Name

overriddencreatedon Edm.DateTimeOffset

Date and time that the record was migrated.

Display Name: Record Created On

overwritetime Edm.DateTimeOffset

For internal use only.

Display Name: Record Overwrite Time

Read Only
reusepolicy Edm.Int32

Reuse Policy for the chatbot subcomponent

Display Name: Reuse Policy

Default Options
Value Label
0 None
1 Private
2 Public
schemaname Edm.String

Display Name: SchemaName

solutionid Edm.Guid

Unique identifier of the associated solution.

Display Name: Solution

Read Only
statecode Edm.Int32

Status of the BotComponent

Display Name: Status

Default Options
Value Label
0 Active
1 Inactive
statuscode Edm.Int32

Reason for the status of the BotComponent

Display Name: Status Reason

Default Options
Value Label
1 Active
2 Inactive
timezoneruleversionnumber Edm.Int32

For internal use only.

Display Name: Time Zone Rule Version Number

utcconversiontimezonecode Edm.Int32

Time zone code that was in use when the record was created.

Display Name: UTC Conversion Time Zone Code

versionnumber Edm.Int64

Version Number

Display Name: Version Number

Read Only

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 record.

_createdonbehalfby_value createdonbehalfby

Unique identifier of the delegate user who created the record.

_modifiedby_value modifiedby

Unique identifier of the user who modified the record.

_modifiedonbehalfby_value modifiedonbehalfby

Unique identifier of the delegate user who modified the record.

_ownerid_value ownerid

Owner Id

_owningbusinessunit_value owningbusinessunit

Unique identifier for the business unit that owns the record

_owningteam_value owningteam

Unique identifier for the team that owns the record.

_owninguser_value owninguser

Unique identifier for the user that owns the record.

_parentbotcomponentid_value ParentBotComponentId

Unique identifier for Chatbot subcomponent associated with Chatbot subcomponent.

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 lk_botcomponent_createdby
createdonbehalfby systemuser lk_botcomponent_createdonbehalfby
modifiedby systemuser lk_botcomponent_modifiedby
modifiedonbehalfby systemuser lk_botcomponent_modifiedonbehalfby
ownerid principal owner_botcomponent
owningbusinessunit businessunit business_unit_botcomponent
owningteam team team_botcomponent
owninguser systemuser user_botcomponent
ParentBotComponentId botcomponent botcomponent_parent_botcomponent

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
bot_botcomponent bot bot_botcomponent
botcomponent_AsyncOperations asyncoperation regardingobjectid_botcomponent
botcomponent_botcomponent botcomponent botcomponent_botcomponent_referenced
botcomponent_botcomponent_referenced botcomponent botcomponent_botcomponent
botcomponent_BulkDeleteFailures bulkdeletefailure regardingobjectid_botcomponent
botcomponent_environmentvariabledefinition environmentvariabledefinition botcomponent_environmentvariabledefinition
botcomponent_MailboxTrackingFolders mailboxtrackingfolder regardingobjectid_botcomponent
botcomponent_parent_botcomponent botcomponent ParentBotComponentId
botcomponent_PrincipalObjectAttributeAccesses principalobjectattributeaccess objectid_botcomponent
botcomponent_ProcessSession processsession regardingobjectid_botcomponent
botcomponent_SyncErrors syncerror regardingobjectid_botcomponent
botcomponent_workflow workflow botcomponent_workflow

Operations

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

Name Binding
GrantAccess Not Bound
IsValidStateTransition Not Bound
ModifyAccess Not Bound
RetrievePrincipalAccess Not Bound
RetrieveSharedPrincipalsAndAccess Not Bound
RevokeAccess Not Bound

Solutions

The following solutions include the botcomponent entity type.

Name Description
Power Virtual Agents For internal use, by the Power Virtual Agents services only.

See also