For the complete documentation index, see llms.txt. This page is also available as Markdown.

Program Terms Variant

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

This object contains the following attributes:

Field
Type
Description

id

string

(Read-only) The business identifier of the terms variant.

href

string

(Read-only) The resource URI of the terms variant.

type

string, core

Terms Item type. The possible values are Online or File.

name

string, core

The name of the term's variant.

description

string, core

The description of the term's variant.

assetUrl

string, core

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

languageCode

string, core

A 2-digit language code from the list of language codes in ISO 639 and its corresponding data format. When the type is Online, null will appear as multiple on the UI.

status

string, core

The status of the terms variant. Allowed values are:

  • Draft

  • Published

  • Unpublished

  • Published

program

object

Represents the program to which the term item belongs.

audit

object

(Read-only) Represents the audit object.

Example

THE PROGRAM TERMS VARIANT OBJECT
{
  "id": "TCS-1234-1234-1234-1234",
  "href": "/programs/PRG-1234-1234/terms/TCS-1234-1234-1234/variants/TCV-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",
  "state": "Draft",
  "termsAndConditions": {
    "id": "TCS-1234-1234-1234",
    "href": "/programs/PRG-1234-1234/terms/TCS-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?