Document
The Document object lets you upload product documentation (via an online link or file upload) to the product object.
This object contains the following attributes:
Field
Type
Description
id
string
(Read-only) The identifier for the object.
name
string
The name of the document.
description
string
A description of the document.
type
string
The type of the document.
url
string
The URI to access the document.
language.name
string
The name of the language.
language.code
string
The ISO code of the language.
status
string
The status of the document.
Example
{
"id": "DOC-1234-1234",
"href": "v1/catalog-management/media/DOC-1234-1234",
"name": "Guide to establishing a reseller relationship",
"description": "Learn what happens when you establish a reseller relationship with SoftwareOne",
"type": "File",
"url": "https://address.to.media.file.pl/abcde.docx",
"language": {
name: "Polish",
code: "pl-pl",
},
"state": "Draft",
"product": {
"id": "PRD-1111-1111-1111",
"name": "Microsoft Office 365 NCE",
"icon": "/static/PRD-1111-1111-1111/logo.png"
},
"audit": {
"created": { "at": "...", "by": { } },
"updated": { "at": "...", "by": { } }
}
}Last updated
Was this helpful?