flowmachine EntityType

Entity Set Path
[organization URI]/api/data/v9.2/flowmachines
Base Type
crmbaseentity
Display Name
Flow Machine
Primary Key
flowmachineid
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
agentversion Edm.String

Version installed on the machine

Display Name: Agent Version

connectivityconfiguration Edm.String

For Internal Use Only.

Display Name: Connectivity Configuration

createdon Edm.DateTimeOffset

Date and time when the record was created.

Display Name: Created On

Read Only
description Edm.String

Description of the Flow Machine.

Display Name: Description

flowmachineid Edm.Guid

Unique identifier for entity instances

Display Name: Flow Machine

Read Only
hostedmachineerror Edm.String

Hosted flow machine error.

Display Name: Hosted flow machine error.

hostedmachinestate Edm.Int32

The state of the machine if it is hosted.

Display Name: Hosted Machine State

Default Options
Values Label
0 Disabled
1 Enabled
2 Error
hostingtype Edm.Int32

Flow Machine Hosting Type.

Display Name: Flow Machine Hosting Type

Default Options
Values Label
0 Customer
1 Hosted
2 CloudPc
importsequencenumber Edm.Int32

Sequence number of the import that created this record.

Display Name: Import Sequence Number

keydeliverystatus Edm.Int32

Delivery status of the machine's group's key.

Display Name: Machine Key Delivery Status

Default Options
Values Label
1 Default
2 PendingNewKey
3 KeyExpired
keyreceiveddate Edm.DateTimeOffset

Delivery date of the latest group key.

Display Name: Machine Key Received Date

lastheartbeatdate Edm.DateTimeOffset

Last date at which a heartbeat call was received from the machine.

Display Name: Last heartbeat date

machinemetadata Edm.String

For Internal Use Only.

Display Name: Machine Metadata

modifiedon Edm.DateTimeOffset

Date and time when the record was modified.

Display Name: Modified On

Read Only
name Edm.String

The Name of the Flow Machine.

Display Name: Name

overcapacitysince Edm.DateTimeOffset

Date and time of when the machine has been flagged as overcapacity.

Display Name: Overcapacity since

overriddencreatedon Edm.DateTimeOffset

Date and time that the record was migrated.

Display Name: Record Created On

sessioncapacity Edm.Int32

Maximum Number of session in parallel.

Display Name: Session Capacity

statecode Edm.Int32

Status of the Flow Machine

Display Name: Status

Default Options
Values Label
0 Active
1 Inactive
2 Maintenance
statuscode Edm.Int32

Reason for the status of the Flow Machine

Display Name: Status Reason

Default Options
Values Label
1 Active
2 Inactive
3 RequiresReconnection
4 ManualMaintenance
5 DrainMode
6 ToDelete
7 Temporary
8 Error
9 Disabled
10 Provisioning
11 RequiresGroupKey
12 ProvisionedWithError
13 HostedMachineOvercapacity
14 HostedMachineOvercapacityDeleted
15 HostedMachineOvercapacityDisabled
timezoneruleversionnumber Edm.Int32

For internal use only.

Display Name: Time Zone Rule Version Number

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.

_flowmachinegroupid_value FlowMachineGroupId

Group of this Flow Machine.

_flowmachineimageversionid_value FlowMachineImageVersionId

Unique identifier for Flow Machine Image Version associated with Flow Machine.

_flowmachinenetworkid_value FlowMachineNetworkId

Unique identifier for Flow Machine Network associated with Flow Machine.

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

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_flowmachine_createdby
createdonbehalfby systemuser lk_flowmachine_createdonbehalfby
FlowMachineGroupId flowmachinegroup flowmachinegroup_flowmachine
FlowMachineImageVersionId flowmachineimageversion flowmachine_flowmachineimageversion
FlowMachineNetworkId flowmachinenetwork flowmachine_flowmachinenetwork
modifiedby systemuser lk_flowmachine_modifiedby
modifiedonbehalfby systemuser lk_flowmachine_modifiedonbehalfby
ownerid principal owner_flowmachine
owningbusinessunit businessunit business_unit_flowmachine
owningteam team team_flowmachine
owninguser systemuser user_flowmachine

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_flowmachine flowcapacityassignment regarding_flowmachine
flowmachine_AsyncOperations asyncoperation regardingobjectid_flowmachine
flowmachine_BulkDeleteFailures bulkdeletefailure regardingobjectid_flowmachine
flowmachine_flowsession_MachineId flowsession MachineId
flowmachine_MailboxTrackingFolders mailboxtrackingfolder regardingobjectid_flowmachine
flowmachine_PrincipalObjectAttributeAccesses principalobjectattributeaccess objectid_flowmachine
flowmachine_ProcessSession processsession regardingobjectid_flowmachine
flowmachine_SyncErrors syncerror regardingobjectid_flowmachine

Operations

The following operations can be used with the flowmachine entity type.

Name Binding
CreateMultiple Not Bound
GrantAccess Not Bound
IsValidStateTransition Not Bound
LeaveGroup Bound to Entity
ModifyAccess Not Bound
RestartHostedMachine Bound to Entity
RetrievePrincipalAccess Not Bound
RetrieveSharedPrincipalsAndAccess Not Bound
RevokeAccess Not Bound
UpdateMultiple Not Bound

See also