Skip to content

industrydata-onerosterapidataconnector.md

Latest commit

 

History

History
71 lines (60 loc) · 4.91 KB

industrydata-onerosterapidataconnector.md

File metadata and controls

71 lines (60 loc) · 4.91 KB
title oneRosterApiDataConnector resource type
description Represents a connection to an OneRoster API data source.
author dakelle
ms.localizationpriority medium
ms.subservice industry-data-etl
doc_type resourcePageType
ms.date 06/05/2024

oneRosterApiDataConnector resource type

Namespace: microsoft.graph.industryData

[!INCLUDE beta-disclaimer]

Represents a connection to an OneRoster API data source.

Inherits from apiDataConnector.

Methods

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

Properties

Property Type Description
apiFormat microsoft.graph.industryData.apiFormat The API format of the external system being connected to. Inherited from apiDataConnector.The possible values are: oneRoster, unknownFutureValue.
apiVersion String The API version of the OneRoster source. Example: 1.1, 1.2
baseUrl String The base URL including the scheme, host, and path for the API (with or without a trailing '/'). Example: https://example.com/ims/oneRoster/v1p1. Inherited from apiDataConnector.
credential microsoft.graph.industryData.credential The base type for all supported credentials. Inherited from apiDataConnector.
displayName String The name of the data connector. Inherited from industryDataConnector.
isContactsEnabled Boolean Indicates whether the user specified to import optional contacts data.
isDemographicsEnabled Boolean Indicates whether the user specified to import optional demographics data.
isFlagsEnabled Boolean Indicates whether the user specified to import optional flags data.

Relationships

Relationship Type Description
sourceSystem microsoft.graph.industryData.sourceSystemDefinition The sourceSystemDefinition object that this connector is connected to. Inherited from industryDataConnector

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.industryData.oneRosterApiDataConnector",
  "id": "String (identifier)",
  "displayName": "String",
  "apiFormat": "String",
  "baseUrl": "String",
  "credential": {
    "@odata.type": "microsoft.graph.industryData.credential"
  },
  "apiVersion": "String",
  "isDemographicsEnabled": "Boolean",
  "isFlagsEnabled": "Boolean",
  "isContactsEnabled": "Boolean"
}