Document

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

Field Name
Data Type
Description

id

string

The ID of the document object.

Example: EDM-1234-5678-0001

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.

Example: https://address.to.media.file.pl/abcde.docx

language

string

The language of the document object.

Example: pl-PL

status

enum

The status of the document object. Allowed values: draft, published, or unpublished.

extension

object

A reference to the extension object.

Example:

audit

object

A reference to the audit object.

Example response

 {
    "id": "EDM-1234-5678-0001",    
    "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": "pl-pl",
    "status": "Draft",
    "extension": {
      "id": "EXT-1234-5678",    
      "name": "Microsoft AI Cloud Partner",
      "icon": "/static/EXT-1234-5678/logo.png"
     },
    "audit": {
     "created": { "at": "...", "by": { } },
     "updated": { "at": "...", "by": { } }
   }
  }

Last updated

Was this helpful?