Create a variant for terms.
The Variant object represents a variant as an uploaded PDF or DOCX document or a link to an externally hosted document as an element of terms for a product.
This object contains the following attributes:
id
string
(Read-only) A unique identifier for the terms variant.
type
string, core
The type of terms variant.
name
string, core
A name for the terms variant.
description
string, core
A description of the terms variant.
assetUrl
string, core
The URL of the uploaded document or online document/resource.
languageCode
string, core
The 2-digit language code for the terms item.
status
string, core
The status of the terms.
termsAndConditions
string
The terms to which the item has been assigned.
audit
object
(Read-only) Represents the object.
{
"id": "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",
"name": "Microsoft 365 Terms of Service"
},
"audit": {
"created": {
"at": "2024-01-16T21:30:13.1046031",
"by": {
"id": "USR-0000-0001"
}
},
"updated": null
}
}Publish a variant for terms.
Unpublish a variant for terms.
Get a variant for terms
Mark a variant for terms for review.
Delete a variant for terms.
Get a list of all variants for terms.
Created
Bad Request
Forbidden
Internal Server Error
No content
POST /public/v1/catalog/products/{productId}/terms/{termsAndConditionsId}/variants HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: multipart/form-data
Accept: */*
Content-Length: 136
{
"variant": {
"type": "Online",
"assetUrl": "text",
"languageCode": "text",
"name": "text",
"description": "text",
"file": "binary"
},
"file": "binary"
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"type": "text",
"assetUrl": "text",
"languageCode": "text",
"description": "text",
"status": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"termsAndConditions": {
"id": "text",
"name": "text",
"revision": 1
},
"fileId": "text"
}OK
Bad Request
Forbidden
Not Found
Internal Server Error
No content
POST /public/v1/catalog/products/{productId}/terms/{termsAndConditionsId}/variants/{id}/publish HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"type": "text",
"assetUrl": "text",
"languageCode": "text",
"description": "text",
"status": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"termsAndConditions": {
"id": "text",
"name": "text",
"revision": 1
},
"fileId": "text"
}OK
Bad Request
Forbidden
Not Found
Internal Server Error
No content
POST /public/v1/catalog/products/{productId}/terms/{termsAndConditionsId}/variants/{id}/unpublish HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"type": "text",
"assetUrl": "text",
"languageCode": "text",
"description": "text",
"status": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"termsAndConditions": {
"id": "text",
"name": "text",
"revision": 1
},
"fileId": "text"
}OK
Moved Permanently
No content
Bad Request
Not Found
GET /public/v1/catalog/products/{productId}/terms/{termsAndConditionsId}/variants/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"type": "text",
"assetUrl": "text",
"languageCode": "text",
"description": "text",
"status": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"termsAndConditions": {
"id": "text",
"name": "text",
"revision": 1
},
"fileId": "text"
}OK
Bad Request
Forbidden
Not Found
Internal Server Error
No content
POST /public/v1/catalog/products/{productId}/terms/{termsAndConditionsId}/variants/{id}/review HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"type": "text",
"assetUrl": "text",
"languageCode": "text",
"description": "text",
"status": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"termsAndConditions": {
"id": "text",
"name": "text",
"revision": 1
},
"fileId": "text"
}No Content
No content
Forbidden
Not Found
Internal Server Error
No content
DELETE /public/v1/catalog/products/{productId}/terms/{termsAndConditionsId}/variants/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
No content
OK
GET /public/v1/catalog/products/{productId}/terms/{termsAndConditionsId}/variants HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
OK
{
"$meta": {
"pagination": {
"offset": 1,
"limit": 1,
"total": 1
},
"omitted": [
"text"
]
},
"data": [
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"type": "text",
"assetUrl": "text",
"languageCode": "text",
"description": "text",
"status": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"termsAndConditions": {
"id": "text",
"name": "text",
"revision": 1
},
"fileId": "text"
}
]
}