NL2SQ Registration Information (nlsqregistration) table/entity reference

Artikel
11/09/2024

Org registration status, AllowedEntity list, and registration error message.

Messages

The following table lists the messages for the NL2SQ Registration Information (nlsqregistration) table. Messages represent operations that can be performed on the table. They may also be events.

Name Is Event?	Web API Operation	SDK for .NET
`Assign` Event: True	`PATCH` /nlsqregistrations(nlsqregistrationid) Update the `ownerid` property.	AssignRequest
`Create` Event: True	`POST` /nlsqregistrations See Create	Create records
`CreateMultiple` Event: True	CreateMultiple	CreateMultipleRequest
`Delete` Event: True	`DELETE` /nlsqregistrations(nlsqregistrationid) See Delete	Delete records
`DeleteMultiple` Event: True	DeleteMultiple	Learn to use messages with the SDK for .NET
`Retrieve` Event: True	`GET` /nlsqregistrations(nlsqregistrationid) See Retrieve	Retrieve records
`RetrieveEntityChanges` Event: True		RetrieveEntityChangesRequest
`RetrieveMultiple` Event: True	`GET` /nlsqregistrations See Query data	Query data
`RetrievePrincipalAccess` Event: True	RetrievePrincipalAccess	RetrievePrincipalAccessRequest
`Update` Event: True	`PATCH` /nlsqregistrations(nlsqregistrationid) See Update	Update records
`UpdateMultiple` Event: True	UpdateMultiple	UpdateMultipleRequest
`Upsert` Event: True	`PATCH` /nlsqregistrations(nlsqregistrationid) See Upsert a table row	UpsertRequest
`UpsertMultiple` Event: True	UpsertMultiple	UpsertMultipleRequest

Events

The following table lists the events for the NL2SQ Registration Information (nlsqregistration) table. Events are messages that exist so that you can subscribe to them. Unless you added the event, you shouldn't invoke the message, only subscribe to it.

Name	Web API Operation	SDK for .NET
`BulkRetain`	BulkRetain	Learn to use messages with the SDK for .NET
`PurgeRetainedContent`	PurgeRetainedContent	Learn to use messages with the SDK for .NET
`Retain`	Retain	Learn to use messages with the SDK for .NET
`RollbackRetain`	RollbackRetain	Learn to use messages with the SDK for .NET
`ValidateRetentionConfig`	ValidateRetentionConfig	Learn to use messages with the SDK for .NET

Properties

The following table lists selected properties for the NL2SQ Registration Information (nlsqregistration) table.

Property	Value
DisplayName	NL2SQ Registration Information
DisplayCollectionName	NL2SQ Registration Information
SchemaName	`nlsqregistration`
CollectionSchemaName	`nlsqregistrations`
EntitySetName	`nlsqregistrations`
LogicalName	`nlsqregistration`
LogicalCollectionName	`nlsqregistrations`
PrimaryIdAttribute	`nlsqregistrationid`
PrimaryNameAttribute	`name`
TableType	`Elastic`
OwnershipType	`UserOwned`

Writable columns/attributes

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

AllowedEntityList
EntityList
ErrorMessage
ImportSequenceNumber
Name
nlsqregistrationId
ObjectId
ObjectPartitionId
ObjectType
ObjectTypeDisplayName
ObjectTypeId
OverriddenCreatedOn
OwnerId
OwnerIdType
PartitionId
RegistrationStatus
TTLInSeconds

AllowedEntityList

Property	Value
Description	The NL2SQ service allowed entity list to be fetched for this organization. (Deprecated)
DisplayName	AllowedEntityList
IsValidForForm	True
IsValidForRead	True
LogicalName	`allowedentitylist`
RequiredLevel	ApplicationRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

EntityList

Property	Value
Description	The NL2SQ service allowed entity list to be fetched for this organization.
DisplayName	EntityList
IsValidForForm	True
IsValidForRead	True
LogicalName	`entitylist`
RequiredLevel	ApplicationRequired
Type	Memo
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	50000

ErrorMessage

Property	Value
Description	The NL2SQ service registration failure error message for this organization.
DisplayName	ErrorMessage
IsValidForForm	True
IsValidForRead	True
LogicalName	`errormessage`
RequiredLevel	ApplicationRequired
Type	Memo
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	20000

ImportSequenceNumber

Property	Value
Description	Sequence number of the import that created this record.
DisplayName	Import Sequence Number
IsValidForForm	False
IsValidForRead	True
LogicalName	`importsequencenumber`
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	-2147483648

Name

Property	Value
Description	The name of the custom entity.
DisplayName	Name
IsValidForForm	True
IsValidForRead	True
LogicalName	`name`
RequiredLevel	ApplicationRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

nlsqregistrationId

Property	Value
Description	Unique identifier for nlsqregistration instances
DisplayName	NL2SQ Registration Information Id
IsValidForForm	False
IsValidForRead	True
LogicalName	`nlsqregistrationid`
RequiredLevel	SystemRequired
Type	Uniqueidentifier

ObjectId

Property	Value
Description	Object instance Identifier
DisplayName	Object Identifier
IsValidForForm	True
IsValidForRead	True
LogicalName	`objectid`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

ObjectPartitionId

Property	Value
Description	Logical object partition id to be used by an elastic table row.
DisplayName	Object Partition Id
IsValidForForm	True
IsValidForRead	True
LogicalName	`objectpartitionid`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

ObjectType

Property	Value
Description	Identifies the type of entity
DisplayName	Object Type
IsValidForForm	True
IsValidForRead	True
LogicalName	`objecttype`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	200

ObjectTypeDisplayName

Property	Value
Description	Friendly name for the object
DisplayName	Object Type Display Name
IsValidForForm	True
IsValidForRead	True
LogicalName	`objecttypedisplayname`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	200

ObjectTypeId

Property	Value
Description	Object Type Identifier (OTC)
DisplayName	Object Type Identifier
IsValidForForm	True
IsValidForRead	True
LogicalName	`objecttypeid`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	200

OverriddenCreatedOn

Property	Value
Description	Date and time that the record was migrated.
DisplayName	Record Created On
IsValidForForm	False
IsValidForRead	True
LogicalName	`overriddencreatedon`
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateOnly
ImeMode	Inactive
SourceTypeMask	0

OwnerId

Property	Value
Description	Owner Id
DisplayName	Owner
IsValidForForm	True
IsValidForRead	True
LogicalName	`ownerid`
RequiredLevel	SystemRequired
Type	Owner
Targets	systemuser, team

OwnerIdType

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

PartitionId

Property	Value
Description	Logical partition id. A logical partition consists of a set of records with same partition id.
DisplayName	Partition Id
IsValidForForm	True
IsValidForRead	True
LogicalName	`partitionid`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

RegistrationStatus

Property	Value
Description	The NL2SQ service registration status for this organization. Default is NotRegistered
DisplayName	Registration Status
IsValidForForm	True
IsValidForRead	True
LogicalName	`registrationstatus`
RequiredLevel	ApplicationRequired
Type	Picklist
DefaultFormValue
GlobalChoiceName	`registrationstatustype`

RegistrationStatus Choices/Options

Value	Label
0	NotRegistered
1	Registered
2	InProgress
3	Failed

TTLInSeconds

Property	Value
Description	Time to live in seconds.
DisplayName	Time to live
IsValidForForm	True
IsValidForRead	True
LogicalName	`ttlinseconds`
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	1

Read-only columns/attributes

These columns/attributes return false for both IsValidForCreate and IsValidForUpdate. Listed by SchemaName.

CreatedBy
CreatedOn
CreatedOnBehalfBy
ModifiedBy
ModifiedOn
ModifiedOnBehalfBy
OwnerIdName
OwnerIdYomiName
OwningBusinessUnit
OwningTeam
OwningUser
VersionNumber

CreatedBy

Property	Value
Description	Unique identifier of the user who created the record.
DisplayName	Created By
IsValidForForm	True
IsValidForRead	True
LogicalName	`createdby`
RequiredLevel	None
Type	Lookup
Targets	systemuser

CreatedOn

Property	Value
Description	Date and time when the record was created.
DisplayName	Created On
IsValidForForm	True
IsValidForRead	True
LogicalName	`createdon`
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateAndTime
ImeMode	Inactive
SourceTypeMask	0

CreatedOnBehalfBy

Property	Value
Description	Unique identifier of the delegate user who created the record.
DisplayName	Created By (Delegate)
IsValidForForm	True
IsValidForRead	True
LogicalName	`createdonbehalfby`
RequiredLevel	None
Type	Lookup
Targets	systemuser

ModifiedBy

Property	Value
Description	Unique identifier of the user who modified the record.
DisplayName	Modified By
IsValidForForm	True
IsValidForRead	True
LogicalName	`modifiedby`
RequiredLevel	None
Type	Lookup
Targets	systemuser

ModifiedOn

Property	Value
Description	Date and time when the record was modified.
DisplayName	Modified On
IsValidForForm	True
IsValidForRead	True
LogicalName	`modifiedon`
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateAndTime
ImeMode	Inactive
SourceTypeMask	0

ModifiedOnBehalfBy

Property	Value
Description	Unique identifier of the delegate user who modified the record.
DisplayName	Modified By (Delegate)
IsValidForForm	True
IsValidForRead	True
LogicalName	`modifiedonbehalfby`
RequiredLevel	None
Type	Lookup
Targets	systemuser

OwnerIdName

Property	Value
Description	Name of the owner
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	`owneridname`
RequiredLevel	SystemRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

OwnerIdYomiName

Property	Value
Description	Yomi name of the owner
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	`owneridyominame`
RequiredLevel	SystemRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

OwningBusinessUnit

Property	Value
Description	Unique identifier for the business unit that owns the record
DisplayName	Owning Business Unit
IsValidForForm	True
IsValidForRead	True
LogicalName	`owningbusinessunit`
RequiredLevel	SystemRequired
Type	Lookup
Targets	businessunit

OwningTeam

Property	Value
Description	Unique identifier for the team that owns the record.
DisplayName	Owning Team
IsValidForForm	False
IsValidForRead	True
LogicalName	`owningteam`
RequiredLevel	None
Type	Lookup
Targets	team

OwningUser

Property	Value
Description	Unique identifier for the user that owns the record.
DisplayName	Owning User
IsValidForForm	False
IsValidForRead	True
LogicalName	`owninguser`
RequiredLevel	None
Type	Lookup
Targets	systemuser

VersionNumber

Property	Value
Description	Version Number
DisplayName	Version Number
IsValidForForm	False
IsValidForRead	True
LogicalName	`versionnumber`
RequiredLevel	None
Type	BigInt
MaxValue	9223372036854775807
MinValue	-9223372036854775808

Many-to-One relationships

These relationships are many-to-one. Listed by SchemaName.

business_unit_nlsqregistration
lk_nlsqregistration_createdby
lk_nlsqregistration_createdonbehalfby
lk_nlsqregistration_modifiedby
lk_nlsqregistration_modifiedonbehalfby
owner_nlsqregistration
team_nlsqregistration
user_nlsqregistration

business_unit_nlsqregistration

One-To-Many Relationship: businessunit business_unit_nlsqregistration

Property	Value
ReferencedEntity	`businessunit`
ReferencedAttribute	`businessunitid`
ReferencingAttribute	`owningbusinessunit`
ReferencingEntityNavigationPropertyName	`owningbusinessunit`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

lk_nlsqregistration_createdby

One-To-Many Relationship: systemuser lk_nlsqregistration_createdby

Property	Value
ReferencedEntity	`systemuser`
ReferencedAttribute	`systemuserid`
ReferencingAttribute	`createdby`
ReferencingEntityNavigationPropertyName	`createdby`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

lk_nlsqregistration_createdonbehalfby

One-To-Many Relationship: systemuser lk_nlsqregistration_createdonbehalfby

Property	Value
ReferencedEntity	`systemuser`
ReferencedAttribute	`systemuserid`
ReferencingAttribute	`createdonbehalfby`
ReferencingEntityNavigationPropertyName	`createdonbehalfby`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

lk_nlsqregistration_modifiedby

One-To-Many Relationship: systemuser lk_nlsqregistration_modifiedby

Property	Value
ReferencedEntity	`systemuser`
ReferencedAttribute	`systemuserid`
ReferencingAttribute	`modifiedby`
ReferencingEntityNavigationPropertyName	`modifiedby`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

lk_nlsqregistration_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_nlsqregistration_modifiedonbehalfby

Property	Value
ReferencedEntity	`systemuser`
ReferencedAttribute	`systemuserid`
ReferencingAttribute	`modifiedonbehalfby`
ReferencingEntityNavigationPropertyName	`modifiedonbehalfby`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

owner_nlsqregistration

One-To-Many Relationship: owner owner_nlsqregistration

Property	Value
ReferencedEntity	`owner`
ReferencedAttribute	`ownerid`
ReferencingAttribute	`ownerid`
ReferencingEntityNavigationPropertyName	`ownerid`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

team_nlsqregistration

One-To-Many Relationship: team team_nlsqregistration

Property	Value
ReferencedEntity	`team`
ReferencedAttribute	`teamid`
ReferencingAttribute	`owningteam`
ReferencingEntityNavigationPropertyName	`owningteam`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

user_nlsqregistration

One-To-Many Relationship: systemuser user_nlsqregistration

Property	Value
ReferencedEntity	`systemuser`
ReferencedAttribute	`systemuserid`
ReferencingAttribute	`owninguser`
ReferencingEntityNavigationPropertyName	`owninguser`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

Dela via