backgroundoperation EntityType
- Entity set path:
- [organization URI]/api/data/v9.2/backgroundoperations
- Base type:
- crmbaseentity
- Display name:
- Background Operation
- Primary key:
- backgroundoperationid
- Primary key attribute:
- 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 | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| backgroundoperationid | Edm.Guid |
Unique identifier for entity instances Display name: Background Operation |
||||||||||||||
| backgroundoperationstatecode | Edm.Int32 |
The status of background operation. Display name: Status
Default options
|
||||||||||||||
| backgroundoperationstatuscode | Edm.Int32 |
The status reason for background operation. Display name: Status Reason
Default options
|
||||||||||||||
| createdon | Edm.DateTimeOffset |
Date and time when the record was created. Display name: Created On Read only
|
||||||||||||||
| displayname | Edm.String |
The is display name of background operation. Display name: DisplayName |
||||||||||||||
| endtime | Edm.DateTimeOffset |
The date time when background operation finished execution. Display name: End Time |
||||||||||||||
| errorcode | Edm.Int32 |
The error code of error for background operation in case of failure. Display name: Error Code |
||||||||||||||
| errormessage | Edm.String |
The error message of error for background operation in case of failure. Display name: Error Message |
||||||||||||||
| importsequencenumber | Edm.Int32 |
Sequence number of the import that created this record. Display name: Import Sequence Number |
||||||||||||||
| inputparameters | Edm.String |
The input parameters that were supplied to start background operation. Display name: Input Parameters |
||||||||||||||
| modifiedon | Edm.DateTimeOffset |
Date and time when the record was modified. Display name: Modified On Read only
|
||||||||||||||
| name | Edm.String |
The name of the background operation. Display name: Name |
||||||||||||||
| outputparameters | Edm.String |
The response of background operation. Display name: Output Parameters |
||||||||||||||
| 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 |
||||||||||||||
| priority | Edm.Int32 |
The priority of background operation execution. Display name: Priority |
||||||||||||||
| retrycount | Edm.Int32 |
The number of times background operation was retried. Display name: Retry Count |
||||||||||||||
| runas | Edm.String |
The identity of user which was used to execute background operation. Display name: Run As |
||||||||||||||
| starttime | Edm.DateTimeOffset |
The date time when background operation started execution. Display name: Start Time |
||||||||||||||
| 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. |
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_backgroundoperation_createdby |
| createdonbehalfby | systemuser | lk_backgroundoperation_createdonbehalfby |
| modifiedby | systemuser | lk_backgroundoperation_modifiedby |
| modifiedonbehalfby | systemuser | lk_backgroundoperation_modifiedonbehalfby |
Operations
The following operations can be used with the backgroundoperation entity type.
| Name | Binding |
|---|---|
| CreateMultiple | Not Bound |
| DeleteMultiple | Not Bound |
| UpdateMultiple | Not Bound |
| UpsertMultiple | Not Bound |