NewProcess Entity Reference

New Process Business Process Flow

Messages

Message Web API Operation SDK Assembly
Create POST [org URI]/api/data/v9.0/newprocesses
See Create
CreateRequest or
Create
Delete DELETE [org URI]/api/data/v9.0/newprocesses(businessprocessflowinstanceid)
See Delete
DeleteRequest or
Delete
Retrieve GET [org URI]/api/data/v9.0/newprocesses(businessprocessflowinstanceid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.0/newprocesses
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
SetState PATCH [org URI]/api/data/v9.0/newprocesses(businessprocessflowinstanceid)
Update statecode and statuscode properties.
SetStateRequest
Update PATCH [org URI]/api/data/v9.0/newprocesses(businessprocessflowinstanceid)
See Update
UpdateRequest or
Update

Entity Properties

Property Value
CollectionSchemaName NewProcesses
DisplayCollectionName New Process
DisplayName New Process
EntitySetName newprocesses
IsBPFEntity True
LogicalCollectionName newprocesses
LogicalName newprocess
OwnershipType OrganizationOwned
PrimaryIdAttribute businessprocessflowinstanceid
PrimaryNameAttribute name
SchemaName NewProcess

Writable attributes

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

ActiveStageId

Property Value
Description Unique identifier of the active stage for the Business Process Flow instance.
DisplayName Active Stage
IsValidForForm True
IsValidForRead True
LogicalName activestageid
RequiredLevel None
Targets processstage
Type Lookup

ActiveStageStartedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when current active stage is started.
DisplayName Active Stage Started On
Format DateOnly
IsValidForForm True
IsValidForRead True
LogicalName activestagestartedon
RequiredLevel None
Type DateTime

BusinessProcessFlowInstanceId

Property Value
Description Unique identifier for New Process bpf entity instances
DisplayName New Process Instance Id
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName businessprocessflowinstanceid
RequiredLevel SystemRequired
Type Uniqueidentifier

CompletedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when current active stage is started.
DisplayName Completed On
Format DateOnly
IsValidForForm True
IsValidForRead True
LogicalName completedon
RequiredLevel None
Type DateTime

ImportSequenceNumber

Property Value
Description Unique identifier of the data import or data migration 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

KnowledgeArticleId

Property Value
Description Unique identifier of the Knowledge Article associated to the Business Process Flow instance.
DisplayName Knowledge Article
IsValidForForm True
IsValidForRead True
LogicalName knowledgearticleid
RequiredLevel None
Targets knowledgearticle
Type Lookup

Name

Property Value
Description Process Name.
DisplayName Process Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName name
MaxLength 200
RequiredLevel ApplicationRequired
Type String

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

ProcessId

Property Value
Description Unique identifier of the workflow associated to the Business Process Flow instance.
DisplayName Process
IsValidForForm True
IsValidForRead True
LogicalName processid
RequiredLevel None
Targets workflow
Type Lookup

StateCode

Property Value
Description Shows whether the Delve action record is pending, completed, or tracking.
DisplayName Status
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State

StateCode Options

Value Label DefaultStatus InvariantName
0 Active 1 Active
1 Inactive 2 Inactive

StatusCode

Property Value
Description Select the delve action record status.
DisplayName Status Reason
IsValidForForm True
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status

StatusCode Options

Value Label State
1 Active 0
2 Finished 1
3 Aborted 1

TransactionCurrencyId

Property Value
Description Choose the local currency for the record to make sure budgets are reported in the correct currency.
DisplayName Currency
IsValidForForm True
IsValidForRead True
LogicalName transactioncurrencyid
RequiredLevel None
Targets transactioncurrency
Type Lookup

TraversedPath

Property Value
Description Traversed Path
DisplayName Comma delimited string of process stage ids that represent visited stages of the Business Process Flow instance.
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName traversedpath
MaxLength 1250
RequiredLevel None
Type String

Read-only attributes

These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

ActiveStageIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName activestageidname
MaxLength 100
RequiredLevel SystemRequired
Type String

CreatedBy

Property Value
Description Shows who created the record.
DisplayName Created By
IsValidForForm True
IsValidForRead True
LogicalName createdby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyname
MaxLength 100
RequiredLevel None
Type String

CreatedByYomiName

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 Shows the date and time when the record was created. The date and time are displayed in the time zone selected in Microsoft Dynamics CRM options.
DisplayName Created On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime

CreatedOnBehalfBy

Property Value
Description Shows who created the record on behalf of another user.
DisplayName Created By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName createdonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedOnBehalfByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

CreatedOnBehalfByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

Duration

Property Value
Description Duration the business process flow was active.
DisplayName Duration
Format Duration
IsValidForForm True
IsValidForRead True
LogicalName duration
MaxValue 2147483647
MinValue 0
RequiredLevel None
Type Integer

ExchangeRate

Property Value
Description Shows the conversion rate of the record's currency. The exchange rate is used to convert all money fields in the record from the local currency to the system's default currency.
DisplayName Exchange Rate
IsValidForForm True
IsValidForRead True
LogicalName exchangerate
MaxValue 100000000000
MinValue 0.0000000001
Precision 10
RequiredLevel None
Type Decimal

KnowledgeArticleIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName knowledgearticleidname
MaxLength 100
RequiredLevel SystemRequired
Type String

ModifiedBy

Property Value
Description Shows who last updated the record.
DisplayName Modified By
IsValidForForm True
IsValidForRead True
LogicalName modifiedby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedByYomiName

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 Shows the date and time when the record was last updated. The date and time are displayed in the time zone selected in Microsoft Dynamics CRM options.
DisplayName Modified On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime

ModifiedOnBehalfBy

Property Value
Description Shows who last updated the record on behalf of another user.
DisplayName Modified By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName modifiedonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedOnBehalfByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedOnBehalfByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

OrganizationId

Property Value
Description Unique identifier of the organization with which the SDK message request is associated.
DisplayName Organization Id
IsValidForForm False
IsValidForRead True
LogicalName organizationid
RequiredLevel SystemRequired
Targets organization
Type Lookup

OrganizationIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName organizationidname
MaxLength 100
RequiredLevel SystemRequired
Type String

ProcessIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName processidname
MaxLength 100
RequiredLevel SystemRequired
Type String

TransactionCurrencyIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName transactioncurrencyidname
MaxLength 100
RequiredLevel None
Type String

VersionNumber

Property Value
Description Version number of the business process instance.
DisplayName Version Number
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

One-To-Many Relationships

Listed by SchemaName.

NewProcess_ProcessSessions

Same as processsession entity NewProcess_ProcessSessions Many-To-One relationship.

Property Value
ReferencingEntity processsession
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName NewProcess_ProcessSessions
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 110
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_newprocess_workflowlogs

Same as workflowlog entity lk_newprocess_workflowlogs Many-To-One relationship.

Property Value
ReferencingEntity workflowlog
ReferencingAttribute asyncoperationid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName workflowlogs_newprocess
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: Cascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

NewProcess_SyncErrors

Same as syncerror entity NewProcess_SyncErrors Many-To-One relationship.

Property Value
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName NewProcess_SyncErrors
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: Cascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

Many-To-One Relationships

Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related entity. Listed by SchemaName.

lk_newprocess_activestageid

See processstage Entity lk_newprocess_activestageid One-To-Many relationship.

lk_newprocess_knowledgearticleid

See knowledgearticle Entity lk_newprocess_knowledgearticleid One-To-Many relationship.

lk_newprocess_processid

See workflow Entity lk_newprocess_processid One-To-Many relationship.

lk_newprocess_createdby

See systemuser Entity lk_newprocess_createdby One-To-Many relationship.

lk_newprocess_modifiedonbehalfby

See systemuser Entity lk_newprocess_modifiedonbehalfby One-To-Many relationship.

lk_newprocess_createdonbehalfby

See systemuser Entity lk_newprocess_createdonbehalfby One-To-Many relationship.

lk_newprocess_modifiedby

See systemuser Entity lk_newprocess_modifiedby One-To-Many relationship.

transactioncurrency_newprocess

See transactioncurrency Entity transactioncurrency_newprocess One-To-Many relationship.

organization_newprocess

See organization Entity organization_newprocess One-To-Many relationship.

See also

About the Entity Reference
Programming reference for Dynamics 365 Customer Engagement
Web API Reference
newprocess EntityType