Create document

Create a new document in catalog management.

post

Path parameters

productIdstringRequired

Body

multipart/form-data

filestring · binaryOptional

Responses

201

Created

application/json

markedForDeletebooleanRead-onlyOptional

markedForUpdatebooleanRead-onlyOptional

urlstring · nullableRead-onlyOptional

languagestring · nullableRead-onlyOptional

statusstring · enumOptionalPossible values:

isDeletedbooleanOptional

revisioninteger · int32Read-onlyOptional

useDeleteStatusbooleanRead-onlyOptional

400

Bad Request

application/json

post/public/v1/catalog/products/{productId}/documents

HTTPcURLJavaScriptPython

POST /public/v1/catalog/products/{productId}/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"
}

{
  "domainEvents": [
    {
      "timeStamp": "2026-08-08T16:45:49.712Z"
    }
  ],
  "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
}