Documentation

Documentation object

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
href	string
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 document object. Example: " Polish"
language.name	string	Example: "pl-pl"
language.code	string	Example: "Guide to establishing a reseller relationship"
status	string	Draft, Published, or Deleted.
product	Product	Example: { "id": "PRD-1111-1111", "href": "/catalog/products/PRD-1111-1111", "name": "Microsoft Office 365 NCE", "icon": "/static/PRD-1111-1111-1111/logo.png" }
audit	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",
      "href": "/catalog/products/PRD-1111-1111-1111",
      "name": "Microsoft Office 365 NCE",
      "icon": "/static/PRD-1111-1111-1111/logo.png"
     },
    "audit": {
     "created": { "at": "...", "by": { } },
     "updated": { "at": "...", "by": { } }
   }
  }