Lists all documents based on filter criteria.
Create a new document.
Publish a document.
Remove a document.
The Program Document object allows you to upload program documentation using an online link or file upload to the Program object.
This object contains the following attributes:
id
string
Update document.
Get a document by ID.
(Read-only) The business identifier of the document object.
name
string
The name of the document object.
description
string
The 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 document's language.
status
string
Represents the status of the document object.
program
object
Represents the to which the document belongs.
audit
object
Represents the object.
{
"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": { } }
}
}Unpublish a document.
OK
GET /public/v1/program/programs/{programId}/documents HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
OK
{
"$meta": {
"pagination": {
"offset": 1,
"limit": 1,
"total": 1
},
"omitted": [
"text"
]
},
"data": [
{
"id": "text",
"audit": {
"created": {},
"updated": {}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"type": "text",
"description": "text",
"status": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"url": "text",
"language": "text",
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
"[Circular Reference]"
]
}
}
]
}Created
Bad Request
POST /public/v1/program/programs/{programId}/documents HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: multipart/form-data
Accept: */*
Content-Length: 137
{
"document": {
"Name": "text",
"Description": "text",
"Language": "text",
"DocumentType": "Online",
"Url": "text",
"DisplayOrder": 1
},
"file": "binary"
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"type": "text",
"description": "text",
"status": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"url": "text",
"language": "text",
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
}
}OK
Bad Request
Forbidden
Not Found
POST /public/v1/program/programs/{programId}/documents/{id}/publish HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"type": "text",
"description": "text",
"status": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"url": "text",
"language": "text",
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
}
}No Content
No content
Forbidden
Not Found
Internal Server Error
No content
DELETE /public/v1/program/programs/{programId}/documents/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
No content
No Content
No content
Forbidden
Not Found
Internal Server Error
No content
PUT /public/v1/program/programs/{programId}/documents/{id} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 1220
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"type": "text",
"description": "text",
"status": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"language": "text",
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
}
}No content
OK
Moved Permanently
No content
Bad Request
Not Found
GET /public/v1/program/programs/{programId}/documents/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"type": "text",
"description": "text",
"status": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"url": "text",
"language": "text",
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
}
}OK
Bad Request
Forbidden
Not Found
POST /public/v1/program/programs/{programId}/documents/{id}/unpublish HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"type": "text",
"description": "text",
"status": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"url": "text",
"language": "text",
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
}
}