Documentation

The Document object provides the ability to upload product documentation (via an online link or file upload) to the product object.

Field	Type	Description
id	string	The identifier for the object.
name	string	The name of the document object. Example: Guide to establishing a reseller relationship
description	string	The description of the document object. Example: Learn what happens when you establish a reseller relationship with SoftwareOne
type	string	The type of the document object.
url	string	The URI to access the document object.
language.name	string	Name of the language. Example: Polish
language.code	string	ISO code of the language. Example: pl-pl
status	string	Status of the document, such as Draft, Published, or Deleted.
product	Product	Reference to the Product object. Example: { "id": "PRD-1111-1111", "name": "Microsoft Office 365 NCE", "icon": "/static/PRD-1111-1111-1111/logo.png" }
audit	Audit Object	Reference to the Audit object. Example: { "created": { "at": "...", "by": { } }, "updated": { "at": "...", "by": { } } }

Example

DOCUMENT OBJECT

 {
    "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": { } }
   }
  }