Edit

referenceDefinition 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 an enumerated reference value. Each supported industry domain receives a distinct collection of default and customers can further customize them by overriding default values or adding new values to the tenant. The referenceDefinitions are used extensively throughout the system, both for configuration and validating data during transformation.

Each referenceDefinition uses a composite identifier of {referenceType}-{code}. This provides a more natural developer experience as the vast majority of code values are defined by a standard body, which allows developers in specific industry domains to better recognize the format.

The following are examples of types:

  • refRole: Used when associating and validated during import
  • refOrgType: Used when associating and validated during import
  • userMatchTarget: Only used for configuration

Methods

Method Return type Description
List referenceDefinitions microsoft.graph.industryData.referenceDefinition collection Get a list of the referenceDefinition objects and their properties.
Get referenceDefinition microsoft.graph.industryData.referenceDefinition Read the properties and relationships of a referenceDefinition object.

Properties

Property Type Description
code String The code value for the definition that must be unique within the referenceType.
createdDateTime DateTimeOffset The date and time when the definition was created. 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.
isDisabled Boolean Indicates whether the definition has been disabled.
lastModifiedDateTime DateTimeOffset The date and time when the definition was most recently changed. 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.
referenceType String The categorical type for a collection of enumerated values.
sortIndex Int32 The ordering index to present the definitions within a type consistently in user interfaces.
source String The standards body or organization source which defined the code.

Relationships

None.

JSON representation

The following is a JSON representation of the resource.

{
  "@odata.type": "#microsoft.graph.industryData.referenceDefinition",
  "code": "String",
  "createdDateTime": "String (timestamp)",
  "isDisabled": "Boolean",
  "lastModifiedDateTime": "String (timestamp)",
  "referenceType": "String",
  "sortIndex": "Int32",
  "source": "String"
}