newprocess EntityType
New Process Business Process Flow
- Entity set path:
- [organization URI]/api/data/v9.2/newprocesses
- Base type:
- crmbaseentity
- Table type:
- Standard
- Display name:
- New Process
- Primary key:
- businessprocessflowinstanceid
- 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 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| activestagestartedon | Edm.DateTimeOffset |
Date and time when current active stage is started. Display name: Active Stage Started On |
||||||||
| businessprocessflowinstanceid | Edm.Guid |
Unique identifier for New Process bpf entity instances Display name: New Process Instance Id |
||||||||
| completedon | Edm.DateTimeOffset |
Date and time when current active stage is started. Display name: Completed On |
||||||||
| createdon | Edm.DateTimeOffset |
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. Display name: Created On Read only
|
||||||||
| duration | Edm.Int32 |
Duration the business process flow was active. Display name: Duration Read only
Is computed
|
||||||||
| exchangerate | Edm.Decimal |
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. Display name: Exchange Rate Read only
|
||||||||
| importsequencenumber | Edm.Int32 |
Unique identifier of the data import or data migration that created this record. Display name: Import Sequence Number |
||||||||
| modifiedon | Edm.DateTimeOffset |
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. Display name: Modified On Read only
|
||||||||
| name | Edm.String |
Process Name. Display name: Process Name |
||||||||
| overriddencreatedon | Edm.DateTimeOffset |
Date and time that the record was migrated. Display name: Record Created On |
||||||||
| statecode | Edm.Int32 |
Shows whether the Delve action record is pending, completed, or tracking. Display name: Status
Default options
|
||||||||
| statuscode | Edm.Int32 |
Select the delve action record status. Display name: Status Reason
Default options
|
||||||||
| traversedpath | Edm.String |
Traversed Path Display name: Comma delimited string of process stage ids that represent visited stages of the Business Process Flow instance. |
||||||||
| versionnumber | Edm.Int64 |
Version number of the business process instance. 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 |
|---|---|---|
| _activestageid_value | activestageid |
Unique identifier of the active stage for the Business Process Flow instance. |
| _createdby_value | createdbyname |
Shows who created the record. |
| _createdonbehalfby_value | createdonbehalfbyname |
Shows who created the record on behalf of another user. |
| _knowledgearticleid_value | knowledgearticleid |
Unique identifier of the Knowledge Article associated to the Business Process Flow instance. |
| _modifiedby_value | modifiedbyname |
Shows who last updated the record. |
| _modifiedonbehalfby_value | modifiedonbehalfbyname |
Shows who last updated the record on behalf of another user. |
| _organizationid_value | organizationid |
Unique identifier of the organization with which the SDK message request is associated. |
| _processid_value | processid |
Unique identifier of the workflow associated to the Business Process Flow instance. |
| _transactioncurrencyid_value | transactioncurrencyid |
Choose the local currency for the record to make sure budgets are reported in the correct currency. |
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 |
|---|---|---|
| activestageid | processstage | processstage_newprocess |
| createdbyname | systemuser | lk_newprocess_createdby |
| createdonbehalfbyname | systemuser | lk_newprocess_createdonbehalfby |
| knowledgearticleid | knowledgearticle | knowledgearticle_newprocess |
| modifiedbyname | systemuser | lk_newprocess_modifiedby |
| modifiedonbehalfbyname | systemuser | lk_newprocess_modifiedonbehalfby |
| organizationid | organization | organization_newprocess |
| processid | workflow | workflow_newprocess |
| transactioncurrencyid | transactioncurrency | transactioncurrency_newprocess |
Collection-valued navigation properties
Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.
| Name | Type | Partner |
|---|---|---|
| NewProcess_ProcessSessions | processsession | regardingobjectid_newprocess |
| NewProcess_SyncErrors | syncerror | regardingobjectid_NewProcess_syncerror |
| workflowlogs_newprocess | workflowlog | NewProcess_asyncoperationid |