Variant

The Terms Variant object represents terms variant as an uploaded PDF or DOCX document or a link to an externally hosted document as an element of the terms for an extension.

Field Name
Data Type
Description

id

string

The business identifier of the Terms Variant. Example: ETV-1234-1234-1234-1234

href

string

The resource URI of the Terms Variant. Example: /extensions/EXT-1234-1234/terms/ETC-1234-1234-1234/variants/ETV-1234-1234-1234-1234

type

string

Terms item type.

Example: Online

name

string

Terms Variant name.

Example: Terms of Service - En

description

string

Terms Variant description.

Example: Terms of Service description in English

assetUrl

string

The URL of the terms item uploaded document or online document/resource.

Example: https://www.test.com/terms-of-service

languageCode

string

The terms Item 2-digit language code from the List of ISO 639 language codesarrow-up-right and data format for language. Where type is online, the languageCode null is displayed as multiple on the UI.

Example: en-GB

status

string

Terms Item status.

Example: Draft

terms

object

The terms object to which the variant belongs.

audit

object

A reference to the audit object.

Example response

{
  "id": "ETV-1234-1234-1234-1234",
  "href": "/extensions/EXT-1234-1234/terms/ETC-1234-1234-1234/variants/ETV-1234-1234-1234-1234",
  "name": "Terms and Conditions Variant - EN",
  "description": "Terms and Conditions Variant in English",
  "type": "Online",
  "assetUrl": "https://www.microsoft.com",
  "languageCode": "en",
  "status": "Draft",
  "termsAndConditions": {
    "id": "ETC-1234-1234-1234",
    "href": "/extensions/EXT-1234-1234/terms/ETC-1234-1234-1234",
    "name": "Microsoft 365 Terms of Service"
  },
  "audit": {
    "created": {
      "at": "2024-01-16T21:30:13.1046031",
      "by": {
        "id": "USR-0000-0001"
      }
    },
    "updated": null
  }
}

Last updated

Was this helpful?