| title | Create inboundApiFlow |
|---|---|
| description | Create a new inboundApiFlow object. |
| author | dakelle |
| ms.localizationpriority | medium |
| ms.subservice | industry-data-etl |
| doc_type | apiPageType |
| ms.date | 06/18/2024 |
Namespace: microsoft.graph.industryData
[!INCLUDE beta-disclaimer]
Create a new inboundApiFlow object.
[!INCLUDE national-cloud-support]
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
[!INCLUDE permissions-table]
POST /external/industryData/inboundFlows| Name | Description |
|---|---|
| Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
| Content-Type | application/json. Required. |
In the request body, supply a JSON representation of the inboundApiFlow object.
The following table lists the required and optional properties for creating an inboundApiFlow object.
| Property | Type | Description |
|---|---|---|
| dataDomain | microsoft.graph.industryData.inboundDomain | The category of data that is being imported in this flow. The possible values are: educationRostering, unknownFutureValue. Required. |
| displayName | String | The name of the process. Inherited from industryDataActivity. Required. |
| 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. Required. |
| 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. Optional. |
| 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. |
If successful, this method returns a 201 Created response code and a microsoft.graph.industryData.inboundApiFlow object in the response body.
The following example shows a request.
POST https://graph.microsoft.com/beta/external/industryData/inboundFlows
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.industryData.inboundApiFlow",
"dataConnector@odata.bind": "https://graph.microsoft.com/beta/external/industryData/dataConnectors/51dca0a0-85f6-4478-f526-08daddab2271",
"dataDomain": "educationRostering",
"displayName": "Inbound rostering flow",
"effectiveDateTime": "2023-03-12T16:40:46.924769+05:30",
"expirationDateTime": "2023-03-13T16:40:46.924769+05:30",
"year@odata.bind": "https://graph.microsoft.com/beta/external/industryData/years/ebf18762-ab92-487e-21d1-08daddab28bb"
}[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
The following example shows the response.
HTTP/1.1 201 Created
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.industryData.inboundApiFlow",
"dataDomain": "educationRostering",
"displayName": "Inbound rostering flow",
"effectiveDateTime": "2023-03-12T11:10:46.924769Z",
"expirationDateTime": "2023-03-13T11:10:46.924769Z",
"id": "7bd62d17-8c37-4494-f68d-08daddab2911",
"readinessStatus": "ready"
}