backgroundoperation table/entity reference
Note
Unsure about table vs. entity? See Developers: Understand terminology in Microsoft Dataverse.
Added by: msft_BackgroundJobs Solution
Messages
Message | Web API Operation | SDK class or method |
---|---|---|
Create | POST /backgroundoperations See Create |
CreateRequest or Create |
CreateMultiple | CreateMultipleRequest | |
Delete | DELETE /backgroundoperations(backgroundoperationid) See Delete |
DeleteRequest or Delete |
Retrieve | GET /backgroundoperations(backgroundoperationid) See Retrieve |
RetrieveRequest or Retrieve |
RetrieveEntityChanges | RetrieveEntityChangesRequest | |
RetrieveMultiple | GET /backgroundoperations See Query Data |
RetrieveMultipleRequest or RetrieveMultiple |
Update | PATCH /backgroundoperations(backgroundoperationid) See Update |
UpdateRequest or Update |
UpdateMultiple | UpdateMultipleRequest | |
Upsert | UpsertRequest | |
UpsertMultiple | UpsertMultipleRequest |
Properties
Property | Value |
---|---|
CollectionSchemaName | backgroundoperations |
DisplayCollectionName | Background Operations |
DisplayName | Background Operation |
EntitySetName | backgroundoperations |
IsBPFEntity | False |
LogicalCollectionName | backgroundoperations |
LogicalName | backgroundoperation |
OwnershipType | OrganizationOwned |
PrimaryIdAttribute | backgroundoperationid |
PrimaryNameAttribute | name |
SchemaName | backgroundoperation |
Writable columns/attributes
These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
- backgroundoperationId
- DisplayName
- EndTime
- ErrorCode
- ErrorMessage
- ImportSequenceNumber
- InputParameters
- Name
- OutputParameters
- OverriddenCreatedOn
- PartitionId
- Priority
- RetryCount
- RunAs
- StartTime
- StateCode
- StatusCode
- TTLInSeconds
backgroundoperationId
Property | Value |
---|---|
Description | Unique identifier for entity instances |
DisplayName | Background Operation |
IsValidForForm | False |
IsValidForRead | True |
IsValidForUpdate | False |
LogicalName | backgroundoperationid |
RequiredLevel | SystemRequired |
Type | Uniqueidentifier |
DisplayName
Property | Value |
---|---|
Description | The is display name of background operation. |
DisplayName | DisplayName |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
IsValidForUpdate | False |
LogicalName | displayname |
MaxLength | 512 |
RequiredLevel | None |
Type | String |
EndTime
Property | Value |
---|---|
DateTimeBehavior | UserLocal |
Description | The date time when background operation finished execution. |
DisplayName | End Time |
Format | DateAndTime |
IsValidForCreate | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | endtime |
RequiredLevel | None |
Type | DateTime |
ErrorCode
Property | Value |
---|---|
Description | The error code of error for background operation in case of failure. |
DisplayName | Error Code |
Format | None |
IsValidForCreate | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | errorcode |
MaxValue | 2147483647 |
MinValue | -2147483648 |
RequiredLevel | None |
Type | Integer |
ErrorMessage
Property | Value |
---|---|
Description | The error message of error for background operation in case of failure. |
DisplayName | Error Message |
Format | Text |
IsLocalizable | False |
IsValidForCreate | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | errormessage |
MaxLength | 1048576 |
RequiredLevel | None |
Type | Memo |
ImportSequenceNumber
Property | Value |
---|---|
Description | Sequence number of the import that created this record. |
DisplayName | Import Sequence Number |
Format | None |
IsValidForForm | False |
IsValidForRead | True |
IsValidForUpdate | False |
LogicalName | importsequencenumber |
MaxValue | 2147483647 |
MinValue | -2147483648 |
RequiredLevel | None |
Type | Integer |
InputParameters
Property | Value |
---|---|
Description | The input parameters that were supplied to start background operation. |
DisplayName | Input Parameters |
Format | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | inputparameters |
MaxLength | 1048576 |
RequiredLevel | None |
Type | Memo |
Name
Property | Value |
---|---|
Description | The name of the background operation. |
DisplayName | Name |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
IsValidForUpdate | False |
LogicalName | name |
MaxLength | 512 |
RequiredLevel | ApplicationRequired |
Type | String |
OutputParameters
Property | Value |
---|---|
Description | The response of background operation. |
DisplayName | Output Parameters |
Format | Text |
IsLocalizable | False |
IsValidForCreate | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | outputparameters |
MaxLength | 1048576 |
RequiredLevel | None |
Type | Memo |
OverriddenCreatedOn
Property | Value |
---|---|
DateTimeBehavior | UserLocal |
Description | Date and time that the record was migrated. |
DisplayName | Record Created On |
Format | DateOnly |
IsValidForForm | False |
IsValidForRead | True |
IsValidForUpdate | False |
LogicalName | overriddencreatedon |
RequiredLevel | None |
Type | DateTime |
PartitionId
Property | Value |
---|---|
Description | Logical partition id. A logical partition consists of a set of records with same partition id. |
DisplayName | Partition Id |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
IsValidForUpdate | False |
LogicalName | partitionid |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
Priority
Property | Value |
---|---|
Description | The priority of background operation execution. |
DisplayName | Priority |
Format | None |
IsValidForForm | True |
IsValidForRead | True |
IsValidForUpdate | False |
LogicalName | priority |
MaxValue | 10 |
MinValue | 0 |
RequiredLevel | None |
Type | Integer |
RetryCount
Property | Value |
---|---|
Description | The number of times background operation was retried. |
DisplayName | Retry Count |
Format | None |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | retrycount |
MaxValue | 2147483647 |
MinValue | 0 |
RequiredLevel | None |
Type | Integer |
RunAs
Property | Value |
---|---|
Description | The identity of user which was used to execute background operation. |
DisplayName | Run As |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
IsValidForUpdate | False |
LogicalName | runas |
MaxLength | 40 |
RequiredLevel | None |
Type | String |
StartTime
Property | Value |
---|---|
DateTimeBehavior | UserLocal |
Description | The date time when background operation started execution. |
DisplayName | Start Time |
Format | DateAndTime |
IsValidForCreate | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | starttime |
RequiredLevel | None |
Type | DateTime |
StateCode
Property | Value |
---|---|
Description | The status of background operation. |
DisplayName | Status |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | backgroundoperationstatecode |
RequiredLevel | ApplicationRequired |
Type | Picklist |
StateCode Choices/Options
Value | Label | Description |
---|---|---|
0 | Ready | Ready |
2 | Locked | Locked |
3 | Completed | Completed |
StatusCode
Property | Value |
---|---|
Description | The status reason for background operation. |
DisplayName | Status Reason |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | backgroundoperationstatuscode |
RequiredLevel | ApplicationRequired |
Type | Picklist |
StatusCode Choices/Options
Value | Label | Description |
---|---|---|
0 | Waiting For Resources | Waiting For Resources |
20 | In Progress | In Progress |
22 | Canceling | Canceling |
30 | Succeeded | Succeeded |
31 | Failed | Failed |
32 | Canceled | Canceled |
TTLInSeconds
Property | Value |
---|---|
Description | Time to live in seconds. |
DisplayName | Time to live |
Format | None |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | ttlinseconds |
MaxValue | 2147483647 |
MinValue | 1 |
RequiredLevel | None |
Type | Integer |
Read-only columns/attributes
These columns/attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.
- CreatedBy
- CreatedByName
- CreatedByYomiName
- CreatedOn
- CreatedOnBehalfBy
- CreatedOnBehalfByName
- CreatedOnBehalfByYomiName
- ModifiedBy
- ModifiedByName
- ModifiedByYomiName
- ModifiedOn
- ModifiedOnBehalfBy
- ModifiedOnBehalfByName
- ModifiedOnBehalfByYomiName
- VersionNumber
CreatedBy
Added by: Active Solution Solution
Property | Value |
---|---|
Description | Unique identifier of the user who created the record. |
DisplayName | Created By |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | createdby |
RequiredLevel | None |
Targets | systemuser |
Type | Lookup |
CreatedByName
Added by: Active Solution Solution
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | createdbyname |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
CreatedByYomiName
Added by: Active Solution Solution
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | createdbyyominame |
MaxLength | 100 |
RequiredLevel | SystemRequired |
Type | String |
CreatedOn
Property | Value |
---|---|
DateTimeBehavior | UserLocal |
Description | Date and time when the record was created. |
DisplayName | Created On |
Format | DateAndTime |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | createdon |
RequiredLevel | None |
Type | DateTime |
CreatedOnBehalfBy
Added by: Active Solution Solution
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 |
Targets | systemuser |
Type | Lookup |
CreatedOnBehalfByName
Added by: Active Solution Solution
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | createdonbehalfbyname |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
CreatedOnBehalfByYomiName
Added by: Active Solution Solution
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | createdonbehalfbyyominame |
MaxLength | 100 |
RequiredLevel | SystemRequired |
Type | String |
ModifiedBy
Added by: Active Solution Solution
Property | Value |
---|---|
Description | Unique identifier of the user who modified the record. |
DisplayName | Modified By |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | modifiedby |
RequiredLevel | None |
Targets | systemuser |
Type | Lookup |
ModifiedByName
Added by: Active Solution Solution
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | modifiedbyname |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
ModifiedByYomiName
Added by: Active Solution Solution
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | modifiedbyyominame |
MaxLength | 100 |
RequiredLevel | SystemRequired |
Type | String |
ModifiedOn
Property | Value |
---|---|
DateTimeBehavior | UserLocal |
Description | Date and time when the record was modified. |
DisplayName | Modified On |
Format | DateAndTime |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | modifiedon |
RequiredLevel | None |
Type | DateTime |
ModifiedOnBehalfBy
Added by: Active Solution Solution
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 |
Targets | systemuser |
Type | Lookup |
ModifiedOnBehalfByName
Added by: Active Solution Solution
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | modifiedonbehalfbyname |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
ModifiedOnBehalfByYomiName
Added by: Active Solution Solution
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | modifiedonbehalfbyyominame |
MaxLength | 100 |
RequiredLevel | SystemRequired |
Type | String |
VersionNumber
Added by: Active Solution Solution
Property | Value |
---|---|
Description | Version Number |
DisplayName | Version Number |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | versionnumber |
MaxValue | 9223372036854775807 |
MinValue | -9223372036854775808 |
RequiredLevel | None |
Type | BigInt |
Many-To-One Relationships
Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related table. Listed by SchemaName.
- lk_backgroundoperation_createdby
- lk_backgroundoperation_createdonbehalfby
- lk_backgroundoperation_modifiedby
- lk_backgroundoperation_modifiedonbehalfby
lk_backgroundoperation_createdby
Added by: System Solution Solution
See the lk_backgroundoperation_createdby one-to-many relationship for the systemuser table/entity.
lk_backgroundoperation_createdonbehalfby
Added by: System Solution Solution
See the lk_backgroundoperation_createdonbehalfby one-to-many relationship for the systemuser table/entity.
lk_backgroundoperation_modifiedby
Added by: System Solution Solution
See the lk_backgroundoperation_modifiedby one-to-many relationship for the systemuser table/entity.
lk_backgroundoperation_modifiedonbehalfby
Added by: System Solution Solution
See the lk_backgroundoperation_modifiedonbehalfby one-to-many relationship for the systemuser table/entity.
See also
Dataverse table/entity reference
Web API Reference
backgroundoperation EntityType
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for