inboundFlow resource type

Article
06/05/2024

Namespace: microsoft.graph.industryData

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Represents a base type for all flows that bring data into the canonical store in the Azure Data Lake. An inboundFlow represents an activity that a service runs. This is an abstract type.

By default, the inbound flow activates twice (2x) daily. For more details, see industryDataRun.

Inherits from industryDataActivity.

Base type of inboundFileFlow and inboundApiFlow.

Methods

Method	Return type	Description
List	microsoft.graph.industryData.inboundFlow collection	Get a list of the inboundFlow objects and their properties.
Get	microsoft.graph.industryData.inboundFlow	Read the properties and relationships of an inboundFlow object.
Delete	None	Delete an inboundFlow object.

Properties

Property	Type	Description
dataDomain	microsoft.graph.industryData.inboundDomain	The category of data that this flow imports. The possible values are: `educationRostering`, `unknownFutureValue`.
displayName	String	The name of the activity. Inherited from industryDataActivity.
effectiveDateTime	DateTimeOffset	The start of the time window when the flow is allowed to run. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.
expirationDateTime	DateTimeOffset	The end of the time window when the flow is allowed to run. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.
readinessStatus	microsoft.graph.industryData.readinessStatus	The state of the activity from its creation through when it is ready to do work. Inherited from industryDataActivity. The possible values are: `notReady`, `ready`, `failed`, `disabled`, `expired`, `unknownFutureValue`.

Relationships

Relationship	Type	Description
dataConnector	microsoft.graph.industryData.industryDataConnector	The data connector to the source system from where this flow gets its data.
year	microsoft.graph.industryData.yearTimePeriodDefinition	The year associated to the data that this flow brings in.

JSON representation

The following is a JSON representation of the resource.

{
  "@odata.type": "#microsoft.graph.industryData.inboundFlow",
  "dataDomain": "String",
  "displayName": "String",
  "effectiveDateTime": "String (timestamp)",
  "expirationDateTime": "String (timestamp)",
  "readinessStatus": "String"
}

Share via