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:
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.
{
"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
}
}OK
Moved Permanently
No content
Bad Request
Not Found
GET /public/v1/program/programs/{programId}/terms/{programTermsAndConditionsId}/variants/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"type": "text",
"assetUrl": "text",
"languageCode": "text",
"name": "text",
"description": "text",
"status": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"programTermsAndConditions": {
"id": "text",
"name": "text"
},
"fileId": "text"
}Created
Bad Request
Forbidden
Internal Server Error
No content
POST /public/v1/program/programs/{programId}/terms/{programTermsAndConditionsId}/variants HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: multipart/form-data
Accept: */*
Content-Length: 120
{
"variant": {
"Type": "Online",
"AssetUrl": "text",
"LanguageCode": "text",
"Name": "text",
"Description": "text"
},
"file": "binary"
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"type": "text",
"assetUrl": "text",
"languageCode": "text",
"name": "text",
"description": "text",
"status": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"programTermsAndConditions": {
"id": "text",
"name": "text"
},
"fileId": "text"
}OK
Bad Request
Forbidden
Not Found
Internal Server Error
No content
POST /public/v1/program/programs/{programId}/terms/{programTermsAndConditionsId}/variants/{id}/unpublish HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"type": "text",
"assetUrl": "text",
"languageCode": "text",
"name": "text",
"description": "text",
"status": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"programTermsAndConditions": {
"id": "text",
"name": "text"
},
"fileId": "text"
}OK
GET /public/v1/program/programs/{programId}/terms/{programTermsAndConditionsId}/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": {},
"updated": {}
},
"$meta": {
"omitted": [
"text"
]
},
"type": "text",
"assetUrl": "text",
"languageCode": "text",
"name": "text",
"description": "text",
"status": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"programTermsAndConditions": {
"id": "text",
"name": "text"
},
"fileId": "text"
}
]
}No Content
No content
Forbidden
Not Found
Internal Server Error
No content
DELETE /public/v1/program/programs/{programId}/terms/{programTermsAndConditionsId}/variants/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
No content
OK
Bad Request
Forbidden
Internal Server Error
No content
PUT /public/v1/program/programs/{programId}/terms/{programTermsAndConditionsId}/variants/{id} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 36
{
"name": "text",
"description": "text"
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"type": "text",
"assetUrl": "text",
"languageCode": "text",
"name": "text",
"description": "text",
"status": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"programTermsAndConditions": {
"id": "text",
"name": "text"
},
"fileId": "text"
}OK
Bad Request
Forbidden
Not Found
Internal Server Error
No content
POST /public/v1/program/programs/{programId}/terms/{programTermsAndConditionsId}/variants/{id}/publish HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"type": "text",
"assetUrl": "text",
"languageCode": "text",
"name": "text",
"description": "text",
"status": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"programTermsAndConditions": {
"id": "text",
"name": "text"
},
"fileId": "text"
}