Share via

botcomponent EntityType

  • Reference
Namespace:
Microsoft.Dynamics.CRM

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

Entity set path: 
[organization URI]/api/data/v9.2/botcomponents
Base type: 
crmbaseentity
Table type: 
Standard
Display name: 
Copilot component
Primary key: 
botcomponentid
Primary name column: 
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 component

Display name: Accent Color
botcomponentid Edm.Guid

Unique identifier for entity instances

Display name: BotComponent
category Edm.String

The category of Copilot component.

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
Values Label
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished
componenttype Edm.Int32

The sub type of Copilot component.

Display name: ComponentType

Default options
Values 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 Topic (V2)
10 Bot translations (V2)
11 Bot entity (V2)
12 Bot variable (V2)
13 Skill (V2)
14 Bot File Attachment
15 Custom GPT
16 Knowledge Source
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
filedata Edm.Binary

This is a file type attribute to store File attachments.

Display name: filedata

Read only
filedata_name Edm.String
Read only
helplink Edm.String

Link to learn More about this component

Display name: Help Link
iconurl Edm.String

Icon Url for this component

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
Values Label
1 Managed
0 Unmanaged
language Edm.Int32

Language of the copilot component

Display name: Language

Default options
Values 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
2057 English (United Kingdom)
3084 French (Canada)
21514 Spanish (United States)
3081 English (Australia)
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 copilot component

Display name: Reuse Policy

Default options
Values 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
Values Label
0 Active
1 Inactive
statuscode Edm.Int32

Reason for the status of the BotComponent

Display name: Status Reason

Default options
Values 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 Lookup property data.

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.
_parentbotcomponentcollectionid_value ParentBotComponentCollectionId

Unique identifier for Copilot component collection associated with Copilot component.
_parentbotcomponentid_value ParentBotComponentId

Unique identifier for Copilot component associated with Copilot component.
_parentbotid_value parentbotid

Unique identifier for Bot associated with the Component.

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
ParentBotComponentCollectionId botcomponentcollection botcomponent_parent_botcomponentcollection
ParentBotComponentId botcomponent botcomponent_parent_botcomponent
parentbotid bot botcomponent_parent_bot

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_aipluginoperation aipluginoperation botcomponent_aipluginoperation
botcomponent_AsyncOperations asyncoperation regardingobjectid_botcomponent
botcomponent_botcomponent botcomponent botcomponent_botcomponent_referenced
botcomponent_botcomponent_referenced botcomponent botcomponent_botcomponent
botcomponent_BulkDeleteFailures bulkdeletefailure regardingobjectid_botcomponent
botcomponent_connectionreference connectionreference botcomponent_connectionreference
botcomponent_dvtablesearch dvtablesearch botcomponent_dvtablesearch
botcomponent_environmentvariabledefinition environmentvariabledefinition botcomponent_environmentvariabledefinition
botcomponent_FileAttachments fileattachment objectid_botcomponent
botcomponent_MailboxTrackingFolders mailboxtrackingfolder regardingobjectid_botcomponent
botcomponent_msdyn_aimodel msdyn_aimodel botcomponent_msdyn_aimodel
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
CreateMultiple Not Bound
DeleteMultiple Not Bound
GrantAccess Not Bound
IsValidStateTransition Not Bound
ModifyAccess Not Bound
RetrievePrincipalAccess Not Bound
RetrieveSharedPrincipalsAndAccess Not Bound
RevokeAccess Not Bound
UpdateMultiple Not Bound

See also