flowmachinegroup EntityType
- Entity set path:
- [organization URI]/api/data/v9.2/flowmachinegroups
- Base type:
- crmbaseentity
- Display name:
- Flow Machine Group
- Primary key:
- flowmachinegroupid
- 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 | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| componentidunique | Edm.Guid |
For internal use only. Display name: Row id unique Read only
|
||||||||||||||||
| componentstate | Edm.Int32 |
For internal use only. Display name: Component State Read only
Default options
|
||||||||||||||||
| createdon | Edm.DateTimeOffset |
Date and time when the record was created. Display name: Created On Read only
|
||||||||||||||||
| description | Edm.String |
Description of this Group of Flow Machine Display name: Description |
||||||||||||||||
| disconnectionplannedon | Edm.DateTimeOffset |
If set, the date on which the machines of the group will be disconnected. Display name: Disconnection planned on |
||||||||||||||||
| domainsetting | Edm.Int32 |
Setting for domain joining of machines in this group. Display name: Domain setting
Default options
|
||||||||||||||||
| flowgrouptype | Edm.Int32 |
Internal Use Only. Display name: Flow Group Type
Default options
|
||||||||||||||||
| flowmachinegroupid | Edm.Guid |
Unique identifier for entity instances Display name: Flow Machine Group Read only
|
||||||||||||||||
| groupmetadata | Edm.String |
Internal Use Only. Display name: Group Metadata |
||||||||||||||||
| importsequencenumber | Edm.Int32 |
Sequence number of the import that created this record. Display name: Import Sequence Number |
||||||||||||||||
| iscustomizable | BooleanManagedProperty |
For internal use only. Display name: Is Customizable |
||||||||||||||||
| ismanaged | Edm.Boolean |
Indicates whether the solution component is part of a managed solution. Display name: Is Managed Read only
Default options
|
||||||||||||||||
| keycreationdate | Edm.DateTimeOffset |
Creation date for group's primary key. Display name: Key Creation Date |
||||||||||||||||
| keyexpirygraceperiod | Edm.Int32 |
Grace period for machines and connections to update before a certificate rotation. In minutes. Display name: Group Key Expiry Grace Period |
||||||||||||||||
| keyvalidityperiod | Edm.Int32 |
Display name: Group Key Validity Period |
||||||||||||||||
| lastrundate | Edm.DateTimeOffset |
Last date at which a run has targeted the group. Display name: Last run date |
||||||||||||||||
| managementtype | Edm.Int32 |
Management Type. Display name: Management Type
Default options
|
||||||||||||||||
| maxmanagedmachinecount | Edm.Int32 |
Maximum managed machine count. Only for use in managed machine groups. Display name: Maximum managed machine count |
||||||||||||||||
| modifiedon | Edm.DateTimeOffset |
Date and time when the record was modified. Display name: Modified On Read only
|
||||||||||||||||
| name | Edm.String |
The name of the custom entity. Display name: Name |
||||||||||||||||
| overriddencreatedon | Edm.DateTimeOffset |
Date and time that the record was migrated. Display name: Record Created On |
||||||||||||||||
| overwritetime | Edm.DateTimeOffset |
For internal use only. Display name: Record Overwrite Time Read only
|
||||||||||||||||
| passwordchangeddate | Edm.DateTimeOffset |
Date for latest password change. Display name: Group Password Changed Date |
||||||||||||||||
| preferredqueuingtype | Edm.Int32 |
Indicates the preferred queuing type in a given machine group Display name: Preferred Queing Type
Default options
|
||||||||||||||||
| primarykeypackage | Edm.String |
Internal Use Only Display name: Primary Key Package |
||||||||||||||||
| primarypublickey | Edm.String |
Internal Use Only. Display name: Primary Public Key |
||||||||||||||||
| provisioningerror | Edm.String |
Display name: Flow group provisioning error |
||||||||||||||||
| provisioningstate | Edm.Int32 |
The provisioning state of the managed machine group. Display name: Provisioning State
Default options
|
||||||||||||||||
| secondarykeypackage | Edm.String |
Internal Use Only. Display name: Secondary Key Package |
||||||||||||||||
| secondarypublickey | Edm.String |
Internal Use Only. Display name: Secondary Public Key |
||||||||||||||||
| solutionid | Edm.Guid |
Unique identifier of the associated solution. Display name: Solution Read only
|
||||||||||||||||
| statecode | Edm.Int32 |
Status of the Flow Machine Group Display name: Status
Default options
|
||||||||||||||||
| statuscode | Edm.Int32 |
Reason for the status of the Flow Machine Group Display name: Status Reason
Default options
|
||||||||||||||||
| timezoneruleversionnumber | Edm.Int32 |
For internal use only. Display name: Time Zone Rule Version Number |
||||||||||||||||
| trytoreusewindowssession | Edm.Boolean |
Indicates whether we will try to reuse non unlocked Windows sessions. Default value is No. Display name: Try to reuse non unlocked Windows sessions.
Default options
|
||||||||||||||||
| usagetype | Edm.Int32 |
Flow Machine Group Usage Type. Display name: Flow Machine Group Usage Type
Default options
|
||||||||||||||||
| utcconversiontimezonecode | Edm.Int32 |
Time zone code that was in use when the record was created. Display name: UTC Conversion Time Zone Code |
||||||||||||||||
| 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. |
| _flowmachineimage_value | flowmachineimage |
Unique identifier for Flow Machine Image associated with Flow Machine Group. |
| _flowmachinenetwork_value | flowmachinenetwork |
Unique identifier for the Flow Machine Network associated with the Flow Machine Group. |
| _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. |
| _ownerid_value | ownerid |
Owner Id |
| _owningbusinessunit_value | owningbusinessunit |
Unique identifier for the business unit that owns the record |
| _owningteam_value | owningteam |
Unique identifier for the team that owns the record. |
| _owninguser_value | owninguser |
Unique identifier for the user that owns the record. |
| _passwordchangedby_value | PasswordChangedBy |
User who initiated the last password change. |
| _rotationstartedby_value | RotationStartedBy |
User who initiated a group key rotation. |
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_flowmachinegroup_createdby |
| createdonbehalfby | systemuser | lk_flowmachinegroup_createdonbehalfby |
| flowmachineimage | flowmachineimage | flowmachinegroup_flowmachineimage |
| flowmachinenetwork | flowmachinenetwork | flowmachinegroup_flowmachinenetwork |
| modifiedby | systemuser | lk_flowmachinegroup_modifiedby |
| modifiedonbehalfby | systemuser | lk_flowmachinegroup_modifiedonbehalfby |
| ownerid | principal | owner_flowmachinegroup |
| owningbusinessunit | businessunit | business_unit_flowmachinegroup |
| owningteam | team | team_flowmachinegroup |
| owninguser | systemuser | user_flowmachinegroup |
| PasswordChangedBy | systemuser | flowmachinegroup_PasswordChangedBy |
| RotationStartedBy | systemuser | flowmachinegroup_RotationStartedBy |
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 |
|---|---|---|
| flowcapacityassignment_flowmachinegroup | flowcapacityassignment | regarding_flowmachinegroup |
| flowcredentialapplication_flowmachinegroup | flowcredentialapplication | flowmachinegroupid |
| flowevent_flowmachinegroup | flowevent | parentobjectid_flowmachinegroup |
| flowmachinegroup_AsyncOperations | asyncoperation | regardingobjectid_flowmachinegroup |
| flowmachinegroup_BulkDeleteFailures | bulkdeletefailure | regardingobjectid_flowmachinegroup |
| flowmachinegroup_DuplicateBaseRecord | duplicaterecord | baserecordid_flowmachinegroup |
| flowmachinegroup_DuplicateMatchingRecord | duplicaterecord | duplicaterecordid_flowmachinegroup |
| flowmachinegroup_flowlog_flowmachinegroupid | flowlog | flowmachinegroupid |
| flowmachinegroup_flowlog_parentobjectid | flowlog | parentobjectid_flowmachinegroup |
| flowmachinegroup_flowmachine | flowmachine | FlowMachineGroupId |
| flowmachinegroup_flowsession_MachineGroupId | flowsession | MachineGroupId |
| flowmachinegroup_MailboxTrackingFolders | mailboxtrackingfolder | regardingobjectid_flowmachinegroup |
| flowmachinegroup_PrincipalObjectAttributeAccesses | principalobjectattributeaccess | objectid_flowmachinegroup |
| flowmachinegroup_ProcessSession | processsession | regardingobjectid_flowmachinegroup |
| flowmachinegroup_SyncErrors | syncerror | regardingobjectid_flowmachinegroup |
Operations
The following operations can be used with the flowmachinegroup entity type.
| Name | Binding |
|---|---|
| CreateFlowCredentialApplication | Bound to Entity |
| CreateMultiple | Not Bound |
| DeleteFlowMachineGroup | Bound to Entity |
| DeleteMultiple | Not Bound |
| GetPublicKey | Bound to Entity |
| GrantAccess | Not Bound |
| IsValidStateTransition | Not Bound |
| ModifyAccess | Not Bound |
| RetrievePrincipalAccess | Not Bound |
| RetrieveSharedPrincipalsAndAccess | Not Bound |
| RevokeAccess | Not Bound |
| RotateGroupKey | Bound to Entity |
| UpdateAccountCredentials | Bound to Entity |
| UpdateMultiple | Not Bound |