Terms

Terms object

The Terms object represents terms as a collection of uploaded PDF or DOCX documents or links to externally hosted documents as an element of a product.

Field	Type	Description
id	string	Terms identifier. Example: "TCS-1234-1234-1234"
href	string	Relative reference to terms to product (/products/{productid}/terms-and-conditions/{termsAndConditionsId} Example: /products/PRD-6822-9898-4256/terms-and-conditions/TCS-3159-1891-0980-8679
name	string	Terms name Example: "Terms of Service"
description	string	Terms description Example: "Terms of Service description"
displayOrder	int	Terms display order Example: "10"
status	Draft Pending Published Unpublished	Terms status Example: "draft"
product	Product	Product to which item is assigned.
audit	AuditObject	Audit events: created, updated. Example: { "created": { "at": "...", "by": { } }, "updated": { "at": "...", "by": { } } }

Example

TERMS OBJECT

{
  "id": "TCS-3159-1891-0980-8679",
  "href": "/products/PRD-6822-9898-4256/terms-and-conditions/TCS-3159-1891-0980-8679",
  "name": "Microsoft 365 Terms of Service",
  "description": "Description of Microsoft 365 Terms of Service",
  "displayOrder": 100,
  "state": "Draft",
  "product": {
    "id": "PRD-6822-9898-4256",
    "href": "/products/PRD-6822-9898-4256",
    "name": "Microsoft 365 online services for commercial"
  },
  "audit": {
    "created": {
      "at": "2024-01-16T21:30:13.1046031",
      "by": {
        "id": "USR-0000-0001"
      }
    },
    "updated": null
  }
}

TermsVariant

The TermsVariant object represents terms variant as an uploaded PDF or DOCX document or a link to an externally hosted document as an element of terms for a product.

Field	Type	Description
id	string	Terms Variant identifier. Example: "TCS-1234-1234-1234-1234"
href	string	Relative reference to the terms item to terms to product (always products/{productId}/terms/{tcid}/terms-item/{termsAndConditionsItemId}) Example: /products/PRD-1234-1234/terms/tcs-1234-1234-1234/terms-item/tcs-1234-1234-1234-1234
type	Online or File	Terms Item type. Example: "Online"
name	string	Terms Variant name. Example: "TCS-1234-1234-1234-1234"
description	string	Terms Variant description. Example: "Terms of Service description in English"
assetUrl	string	URL of the terms item uploaded document or or online document/resource. Example: "https://www.test.com/terms-of-service"
languageCode	string	Terms Item 2-digit language code. Example: "en"
status	Draft Pending Published Unpublished	Terms Item status Example: "Draft"
termsAndConditions	Terms and conditions	Terms to which item is assigned.
audit	AuditObject	Audit events: created, updated. Example: { "created": { "at": "...", "by": { } }, "updated": { "at": "...", "by": { } } }

Example

TERMS VARIANT OBJECT

{
  "id": "TCS-1234-1234-1234-1234",
  "href": "/products/PRD-1234-1234/terms/tcs-1234-1234-1234/terms-item/tcs-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": "/products/PRD-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
  }
}