For the complete documentation index, see llms.txt. This page is also available as Markdown.

Document

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

Field
Type
Description

id

string

The ID of the document object.

name

string

The name of the document object.

description

string

A description of the document object.

type

string

The type of the document object.

url

string

The URI to access the document object.

language

string

The language of the document object.

status

enum

The status of the document object. Allowed values are:

  • Draft

  • Published

  • Unpublished

extension

object

Represents the extension object.

audit

object

Represents the audit object.

Example

DOCUMENT OBJECT
 {
    "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?