Update Document

Update document.

put

Path parameters

programIdstringRequired

idstringRequired

Body

idstringOptional

namestringOptional

typestringOptional

descriptionstringOptional

statusall ofOptional

string · enumOptionalPossible values:

filenamestring | nullableOptional

sizeinteger · int32 | nullableOptional

contentTypestringOptional

urlstringRead-onlyOptional

languagestringOptional

Responses

204

No Content

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

put

/public/v1/program/programs/{programId}/documents/{id}

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": "2025-12-17T08:39:14.188Z",
      "by": {}
    },
    "updated": {
      "at": "2025-12-17T08:39:14.188Z",
      "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

PreviousDelete Document NextPublish Document

Last updated 7 months ago

Was this helpful?

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": "2025-12-17T08:39:14.188Z", "by": {} }, "updated": { "at": "2025-12-17T08:39:14.188Z", "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 } } ] } }