All pages
Powered by GitBook
1 of 1

Loading...

Get document

Get a document by ID.

get
Path parameters
programIdstringRequired
idstringRequired
Query parameters
selectstringOptional
Responses
200

OK

application/json
idstringOptional
atstring · date-time · nullableOptional
idstringOptional
createdall ofOptional
⤷Circular reference to all of
atstring · date-time · nullableOptional
byall ofOptional
⤷Circular reference to all of
omittedstring[]Optional
namestringOptional
iconstring · nullableOptional
atstring · date-time · nullableOptional
idstringOptional
atstring · date-time · nullableOptional
byall ofOptional
⤷Circular reference to all of
updatedall ofOptional
⤷Circular reference to all of
omittedstring[]Optional
namestringOptional
iconstring · nullableOptional
omittedstring[]Optional
namestringOptional
typestringOptional
descriptionstringOptional
statusstring · enumOptionalPossible values:
filenamestring · nullableOptional
sizeinteger · int32 · nullableOptional
contentTypestringOptional
urlstringRead-onlyOptional
languagestringOptional
idstringOptional
namestringOptional
statusstring · enumOptionalPossible values:
applicableTostring · enumOptionalPossible values:
idstringOptional
atstring · date-time · nullableOptional
idstringOptional
atstring · date-time · nullableOptional
byall ofOptional
⤷Circular reference to all of
atstring · date-time · nullableOptional
byall ofOptional
⤷Circular reference to all of
omittedstring[]Optional
namestringOptional
iconstring · nullableOptional
atstring · date-time · nullableOptional
idstringOptional
atstring · date-time · nullableOptional
byall ofOptional
⤷Circular reference to all of
atstring · date-time · nullableOptional
byall ofOptional
⤷Circular reference to all of
omittedstring[]Optional
namestringOptional
iconstring · nullableOptional
atstring · date-time · nullableOptional
idstringOptional
atstring · date-time · nullableOptional
byall ofOptional
⤷Circular reference to all of
atstring · date-time · nullableOptional
byall ofOptional
⤷Circular reference to all of
omittedstring[]Optional
namestringOptional
iconstring · nullableOptional
atstring · date-time · nullableOptional
idstringOptional
atstring · date-time · nullableOptional
byall ofOptional
⤷Circular reference to all of
atstring · date-time · nullableOptional
byall ofOptional
⤷Circular reference to all of
omittedstring[]Optional
namestringOptional
iconstring · nullableOptional
atstring · date-time · nullableOptional
idstringOptional
atstring · date-time · nullableOptional
byall ofOptional
⤷Circular reference to all of
atstring · date-time · nullableOptional
byall ofOptional
⤷Circular reference to all of
omittedstring[]Optional
namestringOptional
iconstring · nullableOptional
omittedstring[]Optional
namestringOptional
shortDescriptionstring · nullableOptional
longDescriptionstring · nullableOptional
operationsstring · nullableOptional
defaultErpItemstring · nullableOptional
websitestringOptional
iconstringOptional
statusstringOptional
idstringOptional
iconstring · nullableOptional
typestring · enumRequiredPossible values:
statusstring · enumRequiredPossible values:
namestring · min: 1 · max: 500Required
productOrderingbooleanOptional
enabledbooleanOptional
namestring · nullableOptional
labelstring · nullableOptional
itemSelectionbooleanOptional
orderQueueChangesbooleanOptional
purchaseOrderDraftbooleanOptional
purchaseOrderQueryingbooleanOptional
changeOrderDraftbooleanOptional
configurationOrderDraftbooleanOptional
terminationOrderbooleanOptional
productRequestbooleanOptional
enabledbooleanOptional
typestring · nullableOptional
enabledbooleanOptional
modestring · enum · nullableOptionalPossible values:
itemCountinteger · int32Optional
ordersPlacedCountinteger · int32Optional
agreementCountinteger · int32Optional
subscriptionCountinteger · int32Optional
requestCountinteger · int32Optional
301

Moved Permanently

No content

400

Bad Request

application/json
typestring · nullableOptional
titlestring · nullableOptional
statusinteger · int32 · nullableOptional
detailstring · nullableOptional
instancestring · nullableOptional
Other propertiesanyOptional
404

Not Found

application/json
typestring · nullableOptional
titlestring · nullableOptional
statusinteger · int32 · nullableOptional
detailstring · nullableOptional
instancestring · nullableOptional
Other propertiesanyOptional
get/public/v1/program/programs/{programId}/documents/{id}
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
        }
      }
    ]
  }
}