Background Operation (backgroundoperation) table/entity reference

Artigo
11/09/2024

Messages

The following table lists the messages for the Background Operation (backgroundoperation) 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
`Create` Event: True	`POST` /backgroundoperations See Create	Create records
`CreateMultiple` Event: True	CreateMultiple	CreateMultipleRequest
`Delete` Event: True	`DELETE` /backgroundoperations(backgroundoperationid) See Delete	Delete records
`DeleteMultiple` Event: True	DeleteMultiple	Learn to use messages with the SDK for .NET
`Retrieve` Event: True	`GET` /backgroundoperations(backgroundoperationid) See Retrieve	Retrieve records
`RetrieveEntityChanges` Event: True		RetrieveEntityChangesRequest
`RetrieveMultiple` Event: True	`GET` /backgroundoperations See Query data	Query data
`Update` Event: True	`PATCH` /backgroundoperations(backgroundoperationid) See Update	Update records
`UpdateMultiple` Event: True	UpdateMultiple	UpdateMultipleRequest
`Upsert` Event: True	`PATCH` /backgroundoperations(backgroundoperationid) See Upsert a table row	UpsertRequest
`UpsertMultiple` Event: True	UpsertMultiple	UpsertMultipleRequest

Properties

The following table lists selected properties for the Background Operation (backgroundoperation) table.

Property	Value
DisplayName	Background Operation
DisplayCollectionName	Background Operations
SchemaName	`backgroundoperation`
CollectionSchemaName	`backgroundoperations`
EntitySetName	`backgroundoperations`
LogicalName	`backgroundoperation`
LogicalCollectionName	`backgroundoperations`
PrimaryIdAttribute	`backgroundoperationid`
PrimaryNameAttribute	`name`
TableType	`Elastic`
OwnershipType	`OrganizationOwned`

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
LogicalName	`backgroundoperationid`
RequiredLevel	SystemRequired
Type	Uniqueidentifier

DisplayName

Property	Value
Description	The is display name of background operation.
DisplayName	DisplayName
IsValidForForm	True
IsValidForRead	True
LogicalName	`displayname`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	512

EndTime

Property	Value
Description	The date time when background operation finished execution.
DisplayName	End Time
IsValidForForm	True
IsValidForRead	True
LogicalName	`endtime`
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateAndTime
ImeMode	Auto
SourceTypeMask	0

ErrorCode

Property	Value
Description	The error code of error for background operation in case of failure.
DisplayName	Error Code
IsValidForForm	True
IsValidForRead	True
LogicalName	`errorcode`
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	-2147483648

ErrorMessage

Property	Value
Description	The error message of error for background operation in case of failure.
DisplayName	Error Message
IsValidForForm	True
IsValidForRead	True
LogicalName	`errormessage`
RequiredLevel	None
Type	Memo
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	1048576

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

InputParameters

Property	Value
Description	The input parameters that were supplied to start background operation.
DisplayName	Input Parameters
IsValidForForm	True
IsValidForRead	True
LogicalName	`inputparameters`
RequiredLevel	None
Type	Memo
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	1048576

Name

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

OutputParameters

Property	Value
Description	The response of background operation.
DisplayName	Output Parameters
IsValidForForm	True
IsValidForRead	True
LogicalName	`outputparameters`
RequiredLevel	None
Type	Memo
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	1048576

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

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

Priority

Property	Value
Description	The priority of background operation execution.
DisplayName	Priority
IsValidForForm	True
IsValidForRead	True
LogicalName	`priority`
RequiredLevel	None
Type	Integer
MaxValue	10
MinValue	0

RetryCount

Property	Value
Description	The number of times background operation was retried.
DisplayName	Retry Count
IsValidForForm	True
IsValidForRead	True
LogicalName	`retrycount`
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	0

RunAs

Property	Value
Description	The identity of user which was used to execute background operation.
DisplayName	Run As
IsValidForForm	True
IsValidForRead	True
LogicalName	`runas`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	40

StartTime

Property	Value
Description	The date time when background operation started execution.
DisplayName	Start Time
IsValidForForm	True
IsValidForRead	True
LogicalName	`starttime`
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateAndTime
ImeMode	Auto
SourceTypeMask	0

StateCode

Property	Value
Description	The status of background operation.
DisplayName	Status
IsValidForForm	True
IsValidForRead	True
LogicalName	`backgroundoperationstatecode`
RequiredLevel	ApplicationRequired
Type	Picklist
DefaultFormValue	0
GlobalChoiceName	`backgroundoperation_statecode`

StateCode Choices/Options

Value	Label
0	Ready
2	Locked
3	Completed

StatusCode

Property	Value
Description	The status reason for background operation.
DisplayName	Status Reason
IsValidForForm	True
IsValidForRead	True
LogicalName	`backgroundoperationstatuscode`
RequiredLevel	ApplicationRequired
Type	Picklist
DefaultFormValue	0
GlobalChoiceName	`backgroundoperation_statuscode`

StatusCode Choices/Options

Value	Label
0	Waiting For Resources
20	In Progress
22	Canceling
30	Succeeded
31	Failed
32	Canceled

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

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.

lk_backgroundoperation_createdby
lk_backgroundoperation_createdonbehalfby
lk_backgroundoperation_modifiedby
lk_backgroundoperation_modifiedonbehalfby

lk_backgroundoperation_createdby

One-To-Many Relationship: systemuser lk_backgroundoperation_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_backgroundoperation_createdonbehalfby

One-To-Many Relationship: systemuser lk_backgroundoperation_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_backgroundoperation_modifiedby

One-To-Many Relationship: systemuser lk_backgroundoperation_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_backgroundoperation_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_backgroundoperation_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`

Compartilhar via