Edit

Share via

agreementFileProperties resource type

  • Article

Namespace: microsoft.graph

Represents the properties of a terms-of-use agreement file; including the localized language and the display name. This is an abstract type that's inherited by the following resources:

Inherits from entity.

Methods

None.

Properties

Property Type Description
createdDateTime DateTimeOffset The date time representing when the file 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.
displayName String Localized display name of the policy file of an agreement. The localized display name is shown to end users who view the agreement.
fileData agreementFileData Data that represents the terms of use PDF document. Read-only.
fileName String Name of the agreement file (for example, TOU.pdf). Read-only.
id String The identifier of the agreementFileVersion object. Read-only.
isDefault Boolean If none of the languages matches the client preference, indicates whether this is the default agreement file. If none of the files are marked as default, the first one is treated as the default. Read-only.
isMajorVersion Boolean Indicates whether the agreement file is a major version update. Major version updates invalidate the agreement's acceptances on the corresponding language.
language String The language of the agreement file in the format "languagecode2-country/regioncode2". "languagecode2" is a lowercase two-letter code derived from ISO 639-1, while "country/regioncode2" is derived from ISO 3166 and usually consists of two uppercase letters, or a BCP-47 language tag. For example, U.S. English is en-US. Read-only.

Relationships

None.

JSON representation

The following is a JSON representation of the resource.

{
  "@odata.type": "#microsoft.graph.agreementFileProperties",
  "createdDateTime": "String (timestamp)",
  "displayName": "String",
  "fileData": {
    "@odata.type": "microsoft.graph.agreementFileData"
  },
  "fileName": "String",
  "id": "String (identifier)",
  "isDefault": "Boolean",
  "isMajorVersion": "Boolean",
  "language": "String"
}