Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
The following diagram shows the possible states for the documentation object in the Marketplace Platform and the transition between these states:
Draft
The documentation object is being created by the vendor. The object is not visible to the clients yet in the marketplace.
Pending
The vendor has submitted the documentation object to SoftwareOne Operations for review and publishing.
Published
The documentation object is visible in the marketplace.
Unpublished
The documentation object is not visible in the marketplace.
Deleted
The document object no longer exists. It's no longer part of the product definition and can't be used.
Create a new document in catalog management.
The Document object lets you upload product documentation (via an online link or file upload) to the product object.
This object contains the following attributes:
id
string
Lists all documents based on filter criteria.
Gets a document by ID.
(Read-only) The identifier for the object.
name
string
The name of the document.
description
string
A description of the document.
type
string
The type of the document.
url
string
The URI to access the document.
language.name
string
The name of the language.
language.code
string
The ISO code of the language.
status
string
The status of the document.
product
object
Represents the object.
audit
object
Represents the 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",
"name": "Microsoft Office 365 NCE",
"icon": "/static/PRD-1111-1111-1111/logo.png"
},
"audit": {
"created": { "at": "...", "by": { } },
"updated": { "at": "...", "by": { } }
}
}Removes a document.
Update document.
Mark a document for review.
Publishes a document.
Unpublish a document.
Created
Bad Request
POST /public/v1/catalog/products/{productId}/documents HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: multipart/form-data
Accept: */*
Content-Length: 153
{
"document": {
"name": "text",
"description": "text",
"language": "text",
"documentType": "Online",
"url": "text",
"displayOrder": 1,
"file": "binary"
},
"file": "binary"
}{
"domainEvents": [
{
"timeStamp": "2026-01-01T00:00:00.000Z"
}
],
"markedForDelete": true,
"markedForUpdate": true,
"documentId": {
"value": "text",
"postfixNumber": 1
},
"fileId": {
"value": "text"
},
"url": "text",
"id": {
"value": "text"
},
"language": "text",
"status": "Draft",
"isDeleted": true,
"revision": 1,
"useDeleteStatus": true
}OK
GET /public/v1/catalog/products/{productId}/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": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"type": "text",
"description": "text",
"status": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"url": "text",
"language": "text",
"product": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"status": "text"
}
}
]
}OK
Moved Permanently
No content
Bad Request
Not Found
GET /public/v1/catalog/products/{productId}/documents/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"type": "text",
"description": "text",
"status": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"url": "text",
"language": "text",
"product": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"status": "text"
}
}No Content
No content
Forbidden
Not Found
Internal Server Error
No content
DELETE /public/v1/catalog/products/{productId}/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/catalog/products/{productId}/documents/{id} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 545
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"type": "text",
"description": "text",
"status": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"language": "text",
"product": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"status": "text"
}
}No content
OK
Bad Request
Forbidden
Not Found
POST /public/v1/catalog/products/{productId}/documents/{id}/review HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"type": "text",
"description": "text",
"status": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"url": "text",
"language": "text",
"product": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"status": "text"
}
}OK
Bad Request
Forbidden
Not Found
POST /public/v1/catalog/products/{productId}/documents/{id}/publish HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"type": "text",
"description": "text",
"status": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"url": "text",
"language": "text",
"product": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"status": "text"
}
}OK
Bad Request
Forbidden
Not Found
POST /public/v1/catalog/products/{productId}/documents/{id}/unpublish HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"type": "text",
"description": "text",
"status": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"url": "text",
"language": "text",
"product": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"status": "text"
}
}