Program Document

The Program Document object provides the ability to upload program documentation using an online link or file upload to the Program object. This object contains the following attributes:

Field
Type
Description

id

string

The business identifier of the Document object

Example: PDM-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.

Example: Online

url

string

The URI to access the document object.

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

language

string

The document's language.

Example: pl-pl

status

string

Status of the document object.

Example: Draft

program

The program to which the document belongs.

Example:

{
    "id": "PRG-1234-5678",    
    "name": "Microsoft AI Cloud Partner",
    "icon": "/static/PRG-1234-1234/logo.png"
}

audit

audit

The audit information object.

Example:

{
  "created": { "at": "...", "by": { } },
  "updated": { "at": "...", "by": { } }
}

Example

{
    "id": "PDM-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",
    "state": "Draft",
    "program": {
      "id": "PRG-1234-5678",    
      "name": "Microsoft AI Cloud Partner",
      "icon": "/static/PRG-1234-1234/logo.png"
     },
    "audit": {
     "created": { "at": "...", "by": { } },
     "updated": { "at": "...", "by": { } }
   }
  }

Last updated

Was this helpful?