nlsqregistration EntityType
Org registration status, AllowedEntity list, and registration error message.
- Entity set path:
- [organization URI]/api/data/v9.2/nlsqregistrations
- Base type:
- crmbaseentity
- Table type:
- Elastic
- Display name:
- NL2SQ Registration Information
- Primary key:
- nlsqregistrationid
- 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 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| allowedentitylist | Edm.String |
The NL2SQ service allowed entity list to be fetched for this organization. (Deprecated) Display name: AllowedEntityList |
||||||||||
| createdon | Edm.DateTimeOffset |
Date and time when the record was created. Display name: Created On Read only
|
||||||||||
| entitylist | Edm.String |
The NL2SQ service allowed entity list to be fetched for this organization. Display name: EntityList |
||||||||||
| errormessage | Edm.String |
The NL2SQ service registration failure error message for this organization. Display name: ErrorMessage |
||||||||||
| importsequencenumber | Edm.Int32 |
Sequence number of the import that created this record. Display name: Import Sequence Number |
||||||||||
| 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 |
||||||||||
| nlsqregistrationid | Edm.Guid |
Unique identifier for nlsqregistration instances Display name: NL2SQ Registration Information Id |
||||||||||
| objectid | Edm.String |
Object instance Identifier Display name: Object Identifier |
||||||||||
| objectpartitionid | Edm.String |
Logical object partition id to be used by an elastic table row. Display name: Object Partition Id |
||||||||||
| objecttype | Edm.String |
Identifies the type of entity Display name: Object Type |
||||||||||
| objecttypedisplayname | Edm.String |
Friendly name for the object Display name: Object Type Display Name |
||||||||||
| objecttypeid | Edm.String |
Object Type Identifier (OTC) Display name: Object Type Identifier |
||||||||||
| overriddencreatedon | Edm.DateTimeOffset |
Date and time that the record was migrated. Display name: Record Created On |
||||||||||
| partitionid | Edm.String |
Logical partition id. A logical partition consists of a set of records with same partition id. Display name: Partition Id |
||||||||||
| registrationstatus | Edm.Int32 |
The NL2SQ service registration status for this organization. Default is NotRegistered Display name: Registration Status
Default options
|
||||||||||
| ttlinseconds | Edm.Int32 |
Time to live in seconds. Display name: Time to live |
||||||||||
| 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. |
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_nlsqregistration_createdby |
| createdonbehalfby | systemuser | lk_nlsqregistration_createdonbehalfby |
| modifiedby | systemuser | lk_nlsqregistration_modifiedby |
| modifiedonbehalfby | systemuser | lk_nlsqregistration_modifiedonbehalfby |
| ownerid | principal | owner_nlsqregistration |
| owningbusinessunit | businessunit | business_unit_nlsqregistration |
| owningteam | team | team_nlsqregistration |
| owninguser | systemuser | user_nlsqregistration |
Operations
The following operations can be used with the nlsqregistration entity type.
| Name | Binding |
|---|---|
| BulkRetain | Not Bound |
| CreateMultiple | Not Bound |
| DeleteMultiple | Not Bound |
| PurgeRetainedContent | Not Bound |
| Retain | Not Bound |
| RetrievePrincipalAccess | Not Bound |
| RollbackRetain | Not Bound |
| UpdateMultiple | Not Bound |
| UpsertMultiple | Not Bound |
| ValidateRetentionConfig | Not Bound |