Edit

Share via

inboundApiFlow resource type

  • Article

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 flow to import data via an external API into the canonical store.

Inherits from inboundFlow.

Methods

Method Return type Description
Create microsoft.graph.industryData.inboundApiFlow Create a new inboundApiFlow object.
Update microsoft.graph.industryData.inboundApiFlow Update the properties of an inboundApiFlow object.

Properties

Property Type Description
dataDomain microsoft.graph.industryData.inboundDomain The category of data that this flow imports. Inherited from inboundFlow.The possible values are: educationRostering, unknownFutureValue.
displayName String The name of the activity. Inherited from industryDataActivity.
effectiveDateTime DateTimeOffset The time when the flow is first 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. Inherited from inboundFlow.
expirationDateTime DateTimeOffset The time when the flow is no longer 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. Inherited from inboundFlow.
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. Inherited from inboundFlow
year microsoft.graph.industryData.yearTimePeriodDefinition The year associated to the data that this flow brings in. Inherited from inboundFlow

JSON representation

The following JSON representation shows the resource type.

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